Module java.compiler

Package javax.annotation.processing

Class AbstractProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

所有已实现的接口:

Processor

       public abstract class AbstractProcessor extends Object implements Processor
      

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

在处理器被初始化后，getter方法可以使用可用的工具发出有关值得注意的条件的警告。

只要遵守该类中方法的一般Processor合同，子类就可以自由地重写该类中任何方法的实现和规范。

自1.6版本起:

1.6

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	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，否则返回false。

Methods declared in class java.lang.Object

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

Methods declared in interface javax.annotation.processing.Processor

process

Field Details

processingEnv

             protected ProcessingEnvironment processingEnv
            

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

Constructor Details

AbstractProcessor

             protected AbstractProcessor()
            

子类调用的构造函数。

Method Details

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