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 types, 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.
protected ProcessingEnvironment processingEnv
Processing environment providing by the tool framework.
protected AbstractProcessor()
Constructor for subclasses to call.
public Set<String> getSupportedOptions()
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.
getSupportedOptions in interface Processor
SupportedOptionspublic Set<String> getSupportedAnnotationTypes()
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.
getSupportedAnnotationTypes in interface Processor
SupportedAnnotationTypespublic SourceVersion getSupportedSourceVersion()
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.
getSupportedSourceVersion in interface Processor
SupportedSourceVersion, ProcessingEnvironment.getSourceVersion()
public void init(ProcessingEnvironment processingEnv)
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.
init in interface Processor
processingEnv - environment to access facilities the tool framework provides to the processorIllegalStateException - if this method is called more than once.public abstract boolean process(Set<? extends TypeElement> annotations,
RoundEnvironment roundEnv) Processes a set of annotation types on type elements originating from the prior round and returns whether or not these annotation types are claimed by this processor. If true is returned, the annotation types are claimed and subsequent processors will not be asked to process them; if false is returned, the annotation types 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 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.
process in interface Processor
annotations - the annotation types requested to be processedroundEnv - environment for information about the current and prior roundpublic Iterable<? extends Completion> getCompletions(Element element,
AnnotationMirror annotation,
ExecutableElement member,
String userText) Returns an empty iterable of completions.
getCompletions in interface Processor
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 completedprotected boolean isInitialized()
Returns true if this object has been initialized, false otherwise.
true if this object has been initialized, false otherwise.
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.