Package host.anzo.commons.processors

Class CommonProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

host.anzo.commons.processors.CommonProcessor

All Implemented Interfaces:

Processor

Direct Known Subclasses:

ExtendedEnumProcessor

public abstract class CommonProcessor
extends AbstractProcessor

Base processor class providing common AST manipulation utilities.

Handles low-level Javac API access and provides:

• Field/Method existence checks
• Qualified type name construction
• JetBrains IDE environment unwrapping
• Logging facilities

Field Summary

Fields

Modifier and Type	Field	Description
protected com.sun.tools.javac.tree.TreeMaker	maker	Factory for creating Javac AST nodes (JCTree).
protected Messager	messager	Interface for reporting errors, warnings, and other notices during annotation processing.
protected com.sun.tools.javac.util.Names	names	Factory for creating Javac Name objects (identifiers).
protected Trees	trees	Utility for working with Javac ASTs (JCTree).

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
CommonProcessor()

Method Summary

Modifier and Type	Method	Description
protected @NotNull String	capitalize(@NotNull String str)	Capitalizes the first character of the input string.
protected com.sun.tools.javac.tree.JCTree.JCExpression	createQualifiedName(@NotNull String fullName)	Creates a Javac AST expression (JCTree.JCExpression) representing a fully qualified name (e.g., java.util.List).
protected boolean	fieldExists(@NotNull com.sun.tools.javac.tree.JCTree.JCClassDecl classDecl, String fieldName)	Checks if a field with the specified name already exists within the given class declaration.
protected @Nullable com.sun.tools.javac.tree.JCTree.JCExpression	findFieldType(@NotNull com.sun.tools.javac.tree.JCTree.JCClassDecl classDecl, String fieldName)	Finds the field type of a given field name in a class declaration.
protected @NotNull com.sun.tools.javac.tree.JCTree.JCExpression	getBoxedType(@NotNull com.sun.tools.javac.tree.JCTree.JCExpression primitiveOrRefType)	Returns the boxed type expression for a given primitive type expression.
SourceVersion	getSupportedSourceVersion()	Specifies the latest supported Java source version.
void	init(ProcessingEnvironment procEnv)	Initializes the processor, setting up common utilities like Messager, TreeMaker, Trees, and Names.
protected void	log(String msg)	Logs an informational message using the processing environment's Messager.
protected void	logError(String msg)	Logs an error message using the processing environment's Messager.
protected void	logWarn(String msg)	Logs a warning message using the processing environment's Messager.
protected boolean	methodExists(@NotNull com.sun.tools.javac.tree.JCTree.JCClassDecl classDecl, String methodName)	Checks if a method with the specified name already exists within the given class declaration.
protected boolean	methodExists(@NotNull com.sun.tools.javac.tree.JCTree.JCClassDecl classDecl, String methodName, int paramCount)	Checks method existence with parameter count constraint

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, isInitialized, process

Methods inherited from class java.lang.Object

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

Field Details

maker

protected com.sun.tools.javac.tree.TreeMaker maker

Factory for creating Javac AST nodes (JCTree). Initialized in init(ProcessingEnvironment).

trees

protected Trees trees

Utility for working with Javac ASTs (JCTree). Initialized in init(ProcessingEnvironment). Provides access to source tree structures.

messager

protected Messager messager

Interface for reporting errors, warnings, and other notices during annotation processing. Obtained from the ProcessingEnvironment.

names

protected com.sun.tools.javac.util.Names names

Factory for creating Javac Name objects (identifiers). Initialized in init(ProcessingEnvironment).

Constructor Details

CommonProcessor

public CommonProcessor()

Method Details

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Specifies the latest supported Java source version.

Specified by:

getSupportedSourceVersion in interface Processor

Overrides:

getSupportedSourceVersion in class AbstractProcessor

Returns:

The latest SourceVersion.

init

public void init(ProcessingEnvironment procEnv)

Initializes the processor, setting up common utilities like Messager, TreeMaker, Trees, and Names.

This implementation attempts to unwrap the ProcessingEnvironment if it's potentially wrapped by JetBrains tools (like in IntelliJ IDEA) to ensure access to the underlying JavacProcessingEnvironment. If the unwrapping fails or the environment is not a JavacProcessingEnvironment, an error is logged, and the Javac-specific tools (maker, trees, names) will remain null.

Specified by:

init in interface Processor

Overrides:

init in class AbstractProcessor

Parameters:

procEnv - Environment providing access to facilities like Messager, Filer, and Elements.

See Also:

• tryUnwrapJetBrainsProcEnv(Object)

fieldExists

protected boolean fieldExists(@NotNull
 @NotNull com.sun.tools.javac.tree.JCTree.JCClassDecl classDecl,
 String fieldName)

Checks if a field with the specified name already exists within the given class declaration.

Parameters:

classDecl - The Javac AST node representing the class declaration.

fieldName - The name of the field to check for.

Returns:

true if a field with the given name exists, false otherwise.

methodExists

protected boolean methodExists(@NotNull
 @NotNull com.sun.tools.javac.tree.JCTree.JCClassDecl classDecl,
 String methodName)

Checks if a method with the specified name already exists within the given class declaration. Note: This performs a simple name check and does not consider method parameters (overloads).

Parameters:

classDecl - The Javac AST node representing the class declaration.

methodName - The name of the method to check for.

Returns:

true if a method with the given name exists, false otherwise.

methodExists

protected boolean methodExists(@NotNull
 @NotNull com.sun.tools.javac.tree.JCTree.JCClassDecl classDecl,
 String methodName,
 int paramCount)

Checks method existence with parameter count constraint

Parameters:

classDecl - The class declaration to check

methodName - Target method name

paramCount - Expected number of parameters

Returns:

true if method exists with specified name and parameter count

createQualifiedName

protected com.sun.tools.javac.tree.JCTree.JCExpression createQualifiedName(@NotNull
 @NotNull String fullName)

Creates a Javac AST expression (JCTree.JCExpression) representing a fully qualified name (e.g., java.util.List).

Parameters:

fullName - The fully qualified name as a String (e.g., "java.lang.String").

Returns:

A JCTree.JCExpression representing the qualified name, suitable for use in AST generation. This will typically be a JCTree.JCIdent for single-part names or a JCTree.JCFieldAccess (Select) for multi-part names.

findFieldType

@Nullable
protected @Nullable com.sun.tools.javac.tree.JCTree.JCExpression findFieldType(@NotNull
 @NotNull com.sun.tools.javac.tree.JCTree.JCClassDecl classDecl,
 String fieldName)

Finds the field type of a given field name in a class declaration.

Parameters:

classDecl - The class declaration in which to search for the field.

fieldName - The name of the field whose type is to be found.

Returns:

The type of the field if found, otherwise null.

capitalize

@NotNull
protected @NotNull String capitalize(@NotNull
 @NotNull String str)

Capitalizes the first character of the input string.

Parameters:

str - The string to be capitalized.

Returns:

The capitalized string.

getBoxedType

@NotNull
protected @NotNull com.sun.tools.javac.tree.JCTree.JCExpression getBoxedType(@NotNull
 @NotNull com.sun.tools.javac.tree.JCTree.JCExpression primitiveOrRefType)

Returns the boxed type expression for a given primitive type expression. If the input type is not a primitive type, it is returned unchanged.

Parameters:

primitiveOrRefType - The JCTree.JCExpression representing the type.

Returns:

The JCTree.JCExpression for the boxed type or the original type if not primitive.

log

protected void log(String msg)

Logs an informational message using the processing environment's Messager. The message is prefixed with the simple name of this processor class.

Parameters:

msg - The message to log.

logError

protected void logError(String msg)

Logs an error message using the processing environment's Messager. The message is prefixed with the simple name of this processor class. Note that reporting an error typically halts the compilation process.

Parameters:

msg - The error message to log.

logWarn

protected void logWarn(String msg)

Logs a warning message using the processing environment's Messager. The message is prefixed with the simple name of this processor class.

Parameters:

msg - The warning message to log.