Package host.anzo.commons.processors

Class ExtendedEnumProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

host.anzo.commons.processors.CommonProcessor

host.anzo.commons.processors.ExtendedEnumProcessor

All Implemented Interfaces:

Processor

@AutoService(javax.annotation.processing.Processor.class)
@SupportedAnnotationTypes("host.anzo.commons.annotations.processors.ExtendedEnum")
public class ExtendedEnumProcessor
extends CommonProcessor

An annotation processor that enhances enums annotated with @ExtendedEnum.

This processor automatically adds the following members to the annotated enum:

• A private static final java.util.List<EnumType> cacheList field, initialized with java.util.List.of(values())
• A public static EnumType getValue(int ordinal) method to retrieve an enum constant by its ordinal
• A public static java.util.List<EnumType> getValues() method that returns the cached list

If the cacheKeys attribute of @ExtendedEnum is used:

• For each specified key (field name):
  • A private static final java.util.Map<FieldType, EnumType> cacheMapBy<FieldName> field.
  • A static initializer block to populate this map.
  • A public static EnumType getValueOf<FieldName>(FieldType key) method.

If cacheKeys is not used or is empty:

• A private static final java.util.Map<String, EnumType> cacheMap field (mapping enum constant names).
• Overloaded public static EnumType getValueOf(String name) methods for name lookup.

This avoids repeated array allocation and provides convenient access methods. It relies on the Javac AST manipulation utilities provided by CommonProcessor.

See Also:

• CommonProcessor
• Statics.EXTENDED_ENUM_ANNOTATION_PATH

Field Summary

Fields inherited from class host.anzo.commons.processors.CommonProcessor

maker, messager, names, trees

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor	Description
ExtendedEnumProcessor()

Method Summary

Modifier and Type	Method	Description
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)	Processes annotations for a processing round.

Methods inherited from class host.anzo.commons.processors.CommonProcessor

capitalize, createQualifiedName, fieldExists, findFieldType, getBoxedType, getSupportedSourceVersion, init, log, logError, logWarn, methodExists, methodExists

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, getSupportedAnnotationTypes, getSupportedOptions, isInitialized

Methods inherited from class java.lang.Object

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

Constructor Details

ExtendedEnumProcessor

public ExtendedEnumProcessor()

Method Details

process

public boolean process(Set<? extends TypeElement> annotations,
 RoundEnvironment roundEnv)

Processes annotations for a processing round.

It finds all enums annotated with @ExtendedEnum, verifies processor initialization, and then modifies the AST of each found enum to add the caching field and utility methods.

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

Parameters:

annotations - The annotation types requested to be processed.

roundEnv - Environment for information about the current and prior round.

Returns:

false always, as this processor does not claim the annotations.