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其亚型支持。

getter方法可以issue warnings关于使用处理器后可利用的设施值得注意条件已经initialized 。

只要符合该方法的一般规范Processor ，子类就可以覆盖此类中任何方法的实现和规范。

从以下版本开始：

1.6

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参数的值，通过处理 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

字段详细信息

processingEnv

protected ProcessingEnvironment processingEnv

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

构造方法详细信息

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参数的值，通过处理processingEnv 。 如果在同一对象上多次调用此方法，则将抛出IllegalStateException 。

Specified by:

init在界面 Processor

参数

processingEnv - 工具框架向处理器提供访问环境的环境

异常

IllegalStateException - 如果这个方法被调用不止一次。

process

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

对来自前一轮的类型元素处理一组注释类型，并返回此处理器是否声明这些注释类型。 如果返回true ，则会声明注释类型，不会要求后续处理器进行处理; 如果返回false ，则注释类型是无人认领的，并且后处理器可能被要求处理它们。 处理器可以总是返回相同的布尔值，或者可以根据所选择的标准来改变结果。

如果处理器支持"*"并且根元素没有注释，输入集将为空。 A 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 false。