public abstract class AbstractTypeProcessor extends AbstractProcessor
Type processing occurs in one round after the tool (e.g. Java compiler) analyzes the source (all sources taken as input to the tool and sources generated by other annotation processors).
The tool infrastructure will interact with classes extending this abstract class as follows.
1-3 are Identical to the
Processor life cycle. 4-5 are unique to
Processorobject is not being used, to create an instance of a processor the tool calls the no-arg constructor of the processor class.
initmethod with an appropriate
getSupportedSourceVersion. These methods are only called once per run, not on each round.
typeProcessmethod on the
Processor. The class is guaranteed to be type-checked Java code and all the tree type and symbol information is resolved.
typeProcessingOvermethod on the
The tool is permitted to ask type processors to process a class once it is analyzed before the
rest of classes are analyzed. The tool is also permitted to stop type processing immediately if
any errors are raised, without invoking
A subclass may override any of the methods in this class, as long as the general
Processor contract is obeyed, with one notable exception.
process(Set, RoundEnvironment) may not be overridden, as it is called during the
declaration annotation phase before classes are analyzed.
|Modifier||Constructor and Description|
Constructor for subclasses to call.
|Modifier and Type||Method and Description|
The use of this method is obsolete in type processors.
Processes a fully-analyzed class that contains a supported annotation (see
A method to be called once all the classes are processed and no error is reported.
A method to be called once before the first call to typeProcess.
getCompletions, getSupportedAnnotationTypes, getSupportedOptions, getSupportedSourceVersion, isInitialized
public void init(ProcessingEnvironment env)
Register a TaskListener that will get called after FLOW.
public final boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
public void typeProcessingStart()
Subclasses may override this method to do any initialization work.
public abstract void typeProcess(TypeElement element, TreePath tree)
The passed class is always valid type-checked Java code.
element- element of the analyzed class
tree- the tree path to the element, with the leaf being a
public void typeProcessingOver()
Subclasses may override this method to do any aggregate analysis (e.g. generate report, persistence) or resource deallocation.
If an error (a Java error or a processor error) is reported, this method is not guaranteed to be invoked.