Package org.machanism.machai.gw.reviewer

Class TextReviewer

java.lang.Object

org.machanism.machai.gw.reviewer.TextReviewer

All Implemented Interfaces:

Reviewer

public class TextReviewer
extends Object
implements Reviewer

Reviewer implementation for generic text files (.txt).

Detects guidance in text files and prepares it for documentation workflows, including context propagation by directory.

Constructor Summary

Constructors

Constructor	Description
TextReviewer()

Method Summary

Modifier and Type	Method	Description
String[]	getSupportedFileExtentions()	Returns the file extensions supported by this reviewer.
String	perform(File projectDir, File guidancesFile)	Analyzes a text file for documentation guidance and, if present, updates the context map.
void	setDirGuidanceMap(Map<String,String> dirGuidanceMap)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TextReviewer

public TextReviewer()

Method Details

getSupportedFileExtentions

public String[] getSupportedFileExtentions()

Returns the file extensions supported by this reviewer. This reviewer handles files with the 'txt' extension.

Specified by:

getSupportedFileExtentions in interface Reviewer

Returns:

an array of supported file extension strings

perform

public String perform(File projectDir,
 File guidancesFile)
               throws IOException

Analyzes a text file for documentation guidance and, if present, updates the context map.

Specified by:

perform in interface Reviewer

Parameters:

projectDir - the project context root directory

guidancesFile - the text file to review

Returns:

extracted or formatted guidance, or null if not applicable

Throws:

IOException - if an error occurs reading the file

setDirGuidanceMap

public void setDirGuidanceMap(Map<String,String> dirGuidanceMap)

Specified by:

setDirGuidanceMap in interface Reviewer