Package org.machanism.machai.gw.reviewer
Class TextReviewer
java.lang.Object
org.machanism.machai.gw.reviewer.TextReviewer
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionString[]Returns the file extensions supported by this reviewer.Analyzes a text file for documentation guidance and, if present, updates the context map.voidsetDirGuidanceMap(Map<String, String> dirGuidanceMap)
-
Constructor Details
-
TextReviewer
public TextReviewer()
-
-
Method Details
-
getSupportedFileExtentions
Returns the file extensions supported by this reviewer. This reviewer handles files with the 'txt' extension.- Specified by:
getSupportedFileExtentionsin interfaceReviewer- Returns:
- an array of supported file extension strings
-
perform
Analyzes a text file for documentation guidance and, if present, updates the context map.- Specified by:
performin interfaceReviewer- Parameters:
projectDir- the project context root directoryguidancesFile- the text file to review- Returns:
- extracted or formatted guidance, or
nullif not applicable - Throws:
IOException- if an error occurs reading the file
-
setDirGuidanceMap
- Specified by:
setDirGuidanceMapin interfaceReviewer
-