程序包 javax.annotation.processing

类 AbstractProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

所有已实现的接口:

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 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.

从以下版本开始:

1.6

字段概要

字段

限定符和类型	字段	说明
protected ProcessingEnvironment	processingEnv	Processing environment providing by the tool framework.

构造器概要

构造器

限定符	构造器	说明
protected	AbstractProcessor()	Constructor for subclasses to call.

方法概要

限定符和类型	方法	说明
Iterable<? extends Completion>	getCompletions(Element element, AnnotationMirror annotation, ExecutableElement member, String userText)	Returns an empty iterable of completions.
Set<String>	getSupportedAnnotationTypes()	If the processor class is annotated with SupportedAnnotationTypes, return an unmodifiable set with the same set of strings as the annotation.
Set<String>	getSupportedOptions()	If the processor class is annotated with SupportedOptions, return an unmodifiable set with the same set of strings as the annotation.
SourceVersion	getSupportedSourceVersion()	If the processor class is annotated with SupportedSourceVersion, return the source version in the annotation.
void	init(ProcessingEnvironment processingEnv)	Initializes the processor with the processing environment by setting the processingEnv field to the value of the processingEnv argument.
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 types on type elements originating from the prior round and returns whether or not these annotation types are claimed by this processor.

从类继承的方法 java.lang.Object

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

字段详细资料

processingEnv

protected ProcessingEnvironment processingEnv

Processing environment providing by the tool framework.

构造器详细资料

AbstractProcessor

protected AbstractProcessor()

Constructor for subclasses to call.

方法详细资料

getSupportedOptions

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 在接口中 Processor

返回:

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

另请参阅:

SupportedOptions

getSupportedAnnotationTypes

public 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 在接口中 Processor

返回:

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

另请参阅:

SupportedAnnotationTypes

getSupportedSourceVersion

public 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 在接口中 Processor

返回:

the latest source version supported by this processor

另请参阅:

SupportedSourceVersion, ProcessingEnvironment.getSourceVersion()

init

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 在接口中 Processor

参数:

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

抛出:

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 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 在接口中 Processor

参数:

annotations - the annotation types requested to be processed

roundEnv - environment for information about the current and prior round

返回:

whether or not the set of annotation types 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.

指定者:

getCompletions 在接口中 Processor

参数:

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

返回:

suggested completions to the annotation

isInitialized

protected boolean isInitialized()

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

返回:

true if this object has been initialized, false otherwise.