模块 java.compiler

包 javax.annotation.processing

类 AbstractProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

所有已实现的接口：

Processor

public abstract class AbstractProcessor extends Object implements Processor 
      

一个抽象注解处理器，旨在成为大多数具体注解处理器的方便超类。此类检查注解值以计算其子类型支持的 options、注释接口 和 源版本。

getter 方法可能发出警告关于使用处理器后可用设施的值得注意的条件初始化。

只要遵守该方法的一般 Processor 契约，子类就可以自由覆盖此类中任何方法的实现和规范。

自从：

1.6

字段摘要

字段

修饰符和类型	Field	描述
protected ProcessingEnvironment	processingEnv	工具框架提供的处理环境。

构造方法总结

构造方法

修饰符	构造方法	描述
protected	AbstractProcessor()	子类调用的构造方法。

方法总结

修饰符和类型	方法	描述
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，否则返回 false。

在类 java.lang.Object 中声明的方法

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

在接口 javax.annotation.processing.Processor 中声明的方法

process

字段详细信息

processingEnv

protected ProcessingEnvironment  processingEnv
            

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

构造方法详细信息

AbstractProcessor

protected AbstractProcessor()
            

子类调用的构造方法。

方法详情

getSupportedOptions

public Set <String > getSupportedOptions()
            

如果处理器类用 SupportedOptions 注释，则返回一个不可修改的集合，其中包含与注释相同的字符串集。如果类没有这样注释，则返回一个空集。

指定者：

getSupportedOptions 在接口 Processor 中

返回：

此处理器识别的选项，如果没有则为空集

参见：

• SupportedOptions

getSupportedAnnotationTypes

public Set <String > getSupportedAnnotationTypes()
            

如果处理器类用 SupportedAnnotationTypes 注释，则返回一个不可修改的集合，其中包含与注释相同的字符串集。如果类没有这样注释，则返回一个空集。如果 源版本 不支持模块，换句话说，如果它小于或等于 RELEASE_8 ，那么任何前导的 模块前缀 都将从名称中删除。

指定者：

getSupportedAnnotationTypes 在接口 Processor 中

返回：

此处理器支持的注解的名称，如果没有则为空集

参见：

• SupportedAnnotationTypes

getSupportedSourceVersion

public SourceVersion  getSupportedSourceVersion()
            

如果处理器类用 SupportedSourceVersion 注释，则在注释中返回源版本。如果类没有这样注释，则返回 SourceVersion.RELEASE_6 。

指定者：

getSupportedSourceVersion 在接口 Processor 中

返回：

此处理器支持的最新源版本

参见：

• SupportedSourceVersion
• ProcessingEnvironment.getSourceVersion()

init

public void init(ProcessingEnvironment  processingEnv)
            

通过将 processingEnv 字段设置为 processingEnv 参数的值，使用处理环境初始化处理器。如果在同一对象上多次调用此方法，将抛出 IllegalStateException。

指定者：

init 在接口 Processor 中

参数：

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

抛出：

IllegalStateException - 如果多次调用此方法。

getCompletions

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

返回一个空的完成迭代。

指定者：

getCompletions 在接口 Processor 中

参数：

element - 被注释的元素

annotation - 应用于元素的（可能是部分的）注解

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

userText - 待完成的源代码文本

返回：

完成的空迭代

isInitialized

protected boolean isInitialized()
            

如果此对象是 初始化，则返回 true，否则返回 false。

返回：

true 如果这个对象已经 初始化 ，false 否则