Class AbstractProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

All Implemented Interfaces:

Processor

public abstract class AbstractProcessor
extends Object
implements Processor

An abstract annotation processor designed to be a convenient superclass for most concrete annotation processors. This class examines annotation values to compute the options, annotation interfaces, and source version supported by its subtypes.

The getter methods may issue warnings about noteworthy conditions using the facilities available after the processor has been initialized.

Subclasses are free to override the implementation and specification of any of the methods in this class as long as the general Processor contract for that method is obeyed.

Since:

1.6

Field Summary

Fields

Modifier and Type	Field	Description
protected ProcessingEnvironment	processingEnv	Processing environment providing by the tool framework.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractProcessor()	Constructor for subclasses to call.

Method Summary

Modifier and Type	Method	Description
Iterable<? extends Completion>	getCompletions(Element element, AnnotationMirror annotation, ExecutableElement member, String userText)	Returns an empty iterable of completions.
Set<String>	getSupportedAnnotationTypes()	Returns the names of the annotation interfaces supported by this processor.
Set<String>	getSupportedOptions()	Returns the options recognized by this processor.
SourceVersion	getSupportedSourceVersion()	Returns the latest source version supported by this annotation processor.
void	init(ProcessingEnvironment processingEnv)	Initializes the processor with the processing environment.
protected boolean	isInitialized()	Returns true if this object has been initialized, false otherwise.
abstract boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)	Processes a set of annotation interfaces on root elements originating from the prior round and returns whether or not these annotation interfaces are claimed by this processor.

Methods declared in class Object

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

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
String	toString()	Answers a string containing a concise, human-readable description of the receiver.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Field Details

processingEnv

protected ProcessingEnvironment processingEnv

Processing environment providing by the tool framework.

Constructor Details

AbstractProcessor

protected AbstractProcessor()

Constructor for subclasses to call.

Method Details

getSupportedOptions

public Set<String> getSupportedOptions()

Returns the options recognized by this processor.

Specified by:

getSupportedOptions in interface Processor

Implementation Requirements:

If the processor class is annotated with SupportedOptions, return an unmodifiable set with the same set of strings as the annotation. If the class is not so annotated, an empty set is returned.

Returns:

the options recognized by this processor, or an empty set if none

See Also:

• SupportedOptions

getSupportedAnnotationTypes

public Set<String> getSupportedAnnotationTypes()

Returns the names of the annotation interfaces supported by this processor.

Specified by:

getSupportedAnnotationTypes in interface Processor

Implementation Requirements:

If the processor class is annotated with SupportedAnnotationTypes, return an unmodifiable set with the same set of strings as the annotation. If the class is not so annotated, an empty set is returned. If the source version does not support modules, in other words if it is less than or equal to RELEASE_8, then any leading module prefixes are stripped from the names.

Returns:

the names of the annotation interfaces supported by this processor or an empty set if none

See Also:

• SupportedAnnotationTypes

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Returns the latest source version supported by this annotation processor.

Specified by:

getSupportedSourceVersion in interface Processor

Implementation Requirements:

If the processor class is annotated with SupportedSourceVersion, return the source version in the annotation. If the class is not so annotated, SourceVersion.RELEASE_6 is returned.

Returns:

the latest source version supported by this annotation processor

See Also:

• SupportedSourceVersion
• ProcessingEnvironment.getSourceVersion()

init

public void init(ProcessingEnvironment processingEnv)

Initializes the processor with the processing environment.

Specified by:

init in interface Processor

Implementation Requirements:

Initializes the processor with the processing environment by setting the processingEnv field to the value of the processingEnv argument. An IllegalStateException will be thrown if this method is called more than once on the same object.

Parameters:

processingEnv - environment to access facilities the tool framework provides to the processor

Throws:

IllegalStateException - if this method is called more than once.

process

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

Processes a set of annotation interfaces on root elements originating from the prior round and returns whether or not these annotation interfaces are claimed by this processor. If true is returned, the annotation interfaces are claimed and subsequent processors will not be asked to process them; if false is returned, the annotation interfaces are unclaimed and subsequent processors may be asked to process them. A processor may always return the same boolean value or may vary the result based on its own chosen criteria.

The input set will be empty if the processor supports "*" and the root elements have no annotations. A Processor must gracefully handle an empty set of annotations.

Specified by:

process in interface Processor

Parameters:

annotations - the annotation interfaces requested to be processed

roundEnv - environment for information about the current and prior round

Returns:

whether or not the set of annotation interfaces are claimed by this processor

getCompletions

public Iterable<? extends Completion> getCompletions(Element element,
 AnnotationMirror annotation,
 ExecutableElement member,
 String userText)

Returns an empty iterable of completions.

Specified by:

getCompletions in interface Processor

Parameters:

element - the element being annotated

annotation - the (perhaps partial) annotation being applied to the element

member - the annotation member to return possible completions for

userText - source code text to be completed

Returns:

an empty iterable of completions

isInitialized

protected boolean isInitialized()

Returns true if this object has been initialized, false otherwise.

Returns:

true if this object has been initialized, false otherwise