Package org.machanism.machai.gw.reviewer

Class JavaReviewer

java.lang.Object

org.machanism.machai.gw.reviewer.JavaReviewer

All Implemented Interfaces:

Reviewer

public class JavaReviewer
extends Object
implements Reviewer

Reviewer implementation for Java source files (.java).

Extracts guidance information or comments annotated with the FileProcessor.GUIDANCE_TAG_NAME for documentation input processing, including support for package-info.java and regular Java files.

Constructor Summary

Constructors

Constructor	Description
JavaReviewer()

Method Summary

Modifier and Type	Method	Description
static String	extractPackageName(String content)	Extracts the package name from the content of a package-info.java file.
String[]	getSupportedFileExtentions()	Returns the file extensions supported by this reviewer.
String	perform(File projectDir, File guidancesFile)	Performs analysis on the specified Java source or package-info file, extracting documentation guidance if marked with the appropriate tag.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.machanism.machai.gw.reviewer.Reviewer

setDirGuidanceMap

Constructor Details

JavaReviewer

public JavaReviewer()

Method Details

getSupportedFileExtentions

public String[] getSupportedFileExtentions()

Returns the file extensions supported by this reviewer. This reviewer processes files with extension: java.

Specified by:

getSupportedFileExtentions in interface Reviewer

Returns:

an array of supported file extension strings

perform

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

Performs analysis on the specified Java source or package-info file, extracting documentation guidance if marked with the appropriate tag.

Specified by:

perform in interface Reviewer

Parameters:

projectDir - the root directory of the project for context

guidancesFile - the Java file to be analyzed

Returns:

formatted documentation guidance or null if none found

Throws:

IOException - if an error occurs reading the file

extractPackageName

public static String extractPackageName(String content)

Extracts the package name from the content of a package-info.java file.

Parameters:

content - The full text content of the package-info.java file.

Returns:

The package name, or null if not found.