- java.lang.Object
-
- javax.annotation.processing.AbstractProcessor
-
- 实现的所有接口
-
Processor
public abstract class AbstractProcessor extends Object implements Processor
一个抽象注释处理器,旨在成为大多数具体注释处理器的便捷超类。 此类检查注释值来计算options , annotation types和source version其亚型支持。getter方法可以issue warnings关于使用设施可用的处理器后就一直值得注意条件initialized 。
子类是免费的,只要一般覆盖在这个类的执行情况和任何方法规范
Processor
该方法合同服从。- 从以下版本开始:
- 1.6
-
-
字段汇总
字段 变量和类型 字段 描述 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()
-
-
-
字段详细信息
-
processingEnv
protected ProcessingEnvironment processingEnv
由工具框架提供的处理环境。
-
-
方法详细信息
-
getSupportedOptions
public Set<String> getSupportedOptions()
如果处理器类使用SupportedOptions
进行批注,则返回与注释具有相同字符串集的不可修改集。 如果未对类进行批注,则返回空集。- Specified by:
-
getSupportedOptions
在界面Processor
- 结果
- 此处理器可识别的选项,如果没有,则为空集
- 另请参见:
-
SupportedOptions
-
getSupportedAnnotationTypes
public Set<String> getSupportedAnnotationTypes()
如果处理器类使用SupportedAnnotationTypes
进行批注,则返回具有与批注相同的字符串集的不可修改集。 如果未对类进行批注,则返回空集。 如果source version
不支持模块,换句话说,如果它小于或等于RELEASE_8
,则从名称中删除任何前导module prefixes
。- 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
- 如果多次调用此方法。
-
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
如果此对象已初始化,false
。
-
-