java.lang.Object
javax.annotation.processing.AbstractProcessor
- All Implemented Interfaces:
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
Modifier and TypeFieldDescriptionprotected ProcessingEnvironment
Processing environment providing by the tool framework. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionIterable
<? extends Completion> getCompletions
(Element element, AnnotationMirror annotation, ExecutableElement member, String userText) Returns an empty iterable of completions.If the processor class is annotated withSupportedAnnotationTypes
, return an unmodifiable set with the same set of strings as the annotation.If the processor class is annotated withSupportedOptions
, return an unmodifiable set with the same set of strings as the annotation.If the processor class is annotated withSupportedSourceVersion
, return the source version in the annotation.void
init
(ProcessingEnvironment processingEnv) Initializes the processor with the processing environment by setting theprocessingEnv
field to the value of theprocessingEnv
argument.protected boolean
-
Field Details
-
processingEnv
Processing environment providing by the tool framework.
-
-
Constructor Details
-
AbstractProcessor
protected AbstractProcessor()Constructor for subclasses to call.
-
-
Method Details
-
getSupportedOptions
If the processor class is annotated withSupportedOptions
, 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.- Specified by:
getSupportedOptions
in interfaceProcessor
- Returns:
- the options recognized by this processor, or an empty set if none
- See Also:
-
getSupportedAnnotationTypes
If the processor class is annotated withSupportedAnnotationTypes
, 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 toRELEASE_8
, then any leading module prefixes are stripped from the names.- Specified by:
getSupportedAnnotationTypes
in interfaceProcessor
- Returns:
- the names of the annotation interfaces supported by this processor, or an empty set if none
- See Also:
-
getSupportedSourceVersion
If the processor class is annotated withSupportedSourceVersion
, return the source version in the annotation. If the class is not so annotated,SourceVersion.RELEASE_6
is returned.- Specified by:
getSupportedSourceVersion
in interfaceProcessor
- Returns:
- the latest source version supported by this processor
- See Also:
-
init
Initializes the processor with the processing environment by setting theprocessingEnv
field to the value of theprocessingEnv
argument. AnIllegalStateException
will be thrown if this method is called more than once on the same object.- Specified by:
init
in interfaceProcessor
- Parameters:
processingEnv
- environment to access facilities the tool framework provides to the processor- Throws:
IllegalStateException
- if this method is called more than once.
-
getCompletions
public Iterable<? extends Completion> getCompletions(Element element, AnnotationMirror annotation, ExecutableElement member, String userText) Returns an empty iterable of completions.- Specified by:
getCompletions
in interfaceProcessor
- Parameters:
element
- the element being annotatedannotation
- the (perhaps partial) annotation being applied to the elementmember
- the annotation member to return possible completions foruserText
- 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
-