compact3

javax.annotation.processing

Class AbstractProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

All Implemented Interfaces:

Processor

public abstract class AbstractProcessor
extends Object
implements Processor

一个抽象的注释处理器的设计是最具体的注解处理器的超方便。本课程探讨注释值计算 options， annotation types，和 source version以其亚型的支持。

吸气的方法可能issue warnings值得注意的条件下使用的设施后可用的处理器已经initialized。

派生类可以重写和任何这类的方法规范的实现只要对法的一般Processor合同服从。

从以下版本开始：

一点六

Field Summary

Fields

Modifier and Type	Field and Description
protected ProcessingEnvironment	processingEnv 工具框架提供的处理环境。

构造方法摘要

构造方法

Modifier	Constructor and Description
protected	AbstractProcessor() 子类的构造函数调用。

方法摘要

Modifier and Type	Method and Description
Iterable<? extends Completion>	getCompletions(Element element, AnnotationMirror annotation, ExecutableElement member, String userText) 返回一个完成空。
Set<String>	getSupportedAnnotationTypes() 如果处理器类注释与 SupportedAnnotationTypes，返回一个具有相同的字符串设置为注释不可修改的设置。
Set<String>	getSupportedOptions() 如果处理器类注释与 SupportedOptions，返回一个具有相同的字符串设置为注释不可修改的设置。
SourceVersion	getSupportedSourceVersion() 如果处理器类注释在注释 SupportedSourceVersion，返回源代码版本。
void	init(ProcessingEnvironment processingEnv) 初始化处理器的处理环境，通过设置 processingEnv场的 processingEnv参数的值。
protected boolean	isInitialized() 返回 true如果此对象已 initialized， false否则。
abstract boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) 处理来自于前一轮的类型元素的注释类型的集合，并返回是否这些注释类型所要求的这些注释类型。

Methods inherited from class java.lang.Object

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

Field Detail

processingEnv

protected ProcessingEnvironment processingEnv

工具框架提供的处理环境。

Constructor Detail

AbstractProcessor

protected AbstractProcessor()

子类的构造函数调用。

方法详细信息

getSupportedOptions

public Set<String> getSupportedOptions()

如果处理器类注释与 SupportedOptions，返回一个具有相同的字符串设置为注释不可修改的设置。如果类没有如此注释，则返回一个空集。

Specified by:

getSupportedOptions 接口 Processor

结果

由该处理器所识别的选项，或一个空集如果没有

另请参见：

SupportedOptions

getSupportedAnnotationTypes

public Set<String> getSupportedAnnotationTypes()

如果处理器类注释与 SupportedAnnotationTypes，返回一个具有相同的字符串设置为注释不可修改的设置。如果类没有如此注释，则返回一个空集。

Specified by:

getSupportedAnnotationTypes 接口 Processor

结果

由该处理器支持的注释类型的名称，或一个空集合，如果没有

另请参见：

SupportedAnnotationTypes

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

如果处理器类注释在注释 SupportedSourceVersion，返回源代码版本。如果类不注明， SourceVersion.RELEASE_6返回。

Specified by:

getSupportedSourceVersion 接口 Processor

结果

由该处理器支持的最新版本源代码

另请参见：

SupportedSourceVersion， ProcessingEnvironment.getSourceVersion()

init

public void init(ProcessingEnvironment processingEnv)

初始化处理器的处理环境，通过设置 processingEnv场的 processingEnv参数的值。一个 IllegalStateException将如果调用此方法不止一次的对同一对象的投。

Specified by:

init 接口 Processor

参数

processingEnv环境访问设施的工具框架提供给处理器

异常

如果这种方法被称为 IllegalStateException不止一次。

process

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

处理来自于前一轮的类型元素的注释类型的集合，并返回是否这些注释类型所要求的这些注释类型。如果 true返回，注释类型都声称和随后的处理器将不会被要求处理；如果 false返回，注释类型认领和随后的处理器可能会被要求处理。处理器可能总是返回相同的布尔值，或根据选择的标准可能会改变结果。

输入将空如果处理器支持"*"和根元素没有注释。一个Processor必须妥善处理注释空集。

Specified by:

process 接口 Processor

参数

annotations的注释类型请求被处理

roundEnv -关于当前和前一轮的信息环境

结果

是否由该处理器声称注释类型的集合

getCompletions

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

返回一个完成空。

Specified by:

getCompletions 接口 Processor

参数

element被注释的元素

annotation -（也许部分）注释被应用到元素

member -注释成员返回可能的完成

userText源代码的文本来完成的

结果

的注释表明完井

isInitialized

protected boolean isInitialized()

返回 true如果此对象已 initialized， false否则。

结果

true如果这个对象被初始化，否则 false。