-
public interface RoundEnvironment
注释处理工具框架将为 provide an annotation processor with an object implementing this interface,以便处理器可以查询关于一轮注释处理的信息。- 从以下版本开始:
- 1.6
-
-
方法摘要
所有方法 实例方法 抽象方法 Default Methods 变量和类型 方法 描述 boolean
errorRaised()
如果在前一轮处理中引发错误,则返回true
; 否则返回false
。Set<? extends Element>
getElementsAnnotatedWith(类<? extends Annotation> a)
返回使用给定注释类型注释的元素。Set<? extends Element>
getElementsAnnotatedWith(TypeElement a)
返回使用给定注释类型注释的元素。default Set<? extends Element>
getElementsAnnotatedWithAny(Set<类<? extends Annotation>> annotations)
返回使用一个或多个给定注释类型注释的元素。default Set<? extends Element>
getElementsAnnotatedWithAny(TypeElement... annotations)
返回使用一个或多个给定注释类型注释的元素。Set<? extends Element>
getRootElements()
返回前一轮生成的注释处理的root elements 。boolean
processingOver()
如果此轮生成的类型不受后续轮注释处理的影响,则返回true
; 否则返回false
。
-
-
-
方法详细信息
-
processingOver
boolean processingOver()
如果此轮生成的类型不受后续轮注释处理的影响,则返回true
; 否则返回false
。- 结果
-
true
如果此轮次生成的类型不会受到后续轮次的注释处理; 否则返回false
-
errorRaised
boolean errorRaised()
如果在前一轮处理中出现错误,则返回true
; 否则返回false
。- 结果
-
true
如果在前一轮处理中出现错误; 否则返回false
-
getRootElements
Set<? extends Element> getRootElements()
返回前一轮生成的注释处理的root elements 。- 结果
- 前一轮生成的注释处理的根元素,如果没有,则为空集
-
getElementsAnnotatedWith
Set<? extends Element> getElementsAnnotatedWith(TypeElement a)
返回使用给定注释类型注释的元素。 注释可以直接显示或继承。 仅返回此轮注释处理中包含的包元素,模块元素和类型元素,或者在这些注释处理器中声明的成员,构造函数,参数或类型参数的声明。 包含的类型元素是root types,并且嵌套在其中的任何成员类型。 不考虑包的元素仅仅因为创建了该包的package-info
文件。 同样,仅考虑模块的元素,因为创建了该模块的module-info
文件- 参数
-
a
- 正在请求的注释类型 - 结果
- 使用给定注释类型注释的元素,如果没有注释,则为空集
- 异常
-
IllegalArgumentException
- 如果参数不表示注释类型
-
getElementsAnnotatedWithAny
default Set<? extends Element> getElementsAnnotatedWithAny(TypeElement... annotations)
返回使用一个或多个给定注释类型注释的元素。- API Note:
- 当通过同时查找注释类型及其包含注释类型来处理重复注释时,此方法可能很有用。
- 实现要求:
-
此方法的默认实现创建一个空结果集,遍历每个注释上调用
getElementsAnnotatedWith(TypeElement)
的参数数组中的注释,并将这些结果添加到结果集中。 最后,结果集的内容作为不可修改的集返回。 - 参数
-
annotations
- 正在请求的注释类型 - 结果
- 用一个或多个给定注释类型注释的元素,如果没有,则为空集
- 异常
-
IllegalArgumentException
- 如果参数集的任何元素不表示注释类型 - 从以下版本开始:
- 9
- See The Java™ Language Specification:
- 9.6.3可重复的注释类型
-
getElementsAnnotatedWith
Set<? extends Element> getElementsAnnotatedWith(类<? extends Annotation> a)
返回使用给定注释类型注释的元素。 注释可以直接显示或继承。 仅返回此轮注释处理中包含的包元素,模块元素和类型元素,或者在这些注释处理器中声明的成员,构造函数,参数或类型参数的声明。 包含的类型元素是root types,并且嵌套在其中的任何成员类型。 仅考虑包的元素是因为创建了该包的package-info
文件。 同样,仅考虑模块的元素,因为创建了该模块的module-info
文件- 参数
-
a
- 正在请求的注释类型 - 结果
- 使用给定注释类型注释的元素,如果没有注释,则为空集
- 异常
-
IllegalArgumentException
- 如果参数不表示注释类型
-
getElementsAnnotatedWithAny
default Set<? extends Element> getElementsAnnotatedWithAny(Set<类<? extends Annotation>> annotations)
返回使用一个或多个给定注释类型注释的元素。- API Note:
- 当通过同时查找注释类型及其包含注释类型来处理重复注释时,此方法可能很有用。
- 实现要求:
-
此方法的默认实现创建一个空结果集,迭代每个注释上调用
getElementsAnnotatedWith(Class)
的参数集中的注释,并将这些结果添加到结果集。 最后,结果集的内容作为不可修改的集返回。 - 参数
-
annotations
- 要求的注释类型 - 结果
- 用一个或多个给定注释类型注释的元素,如果没有,则为空集
- 异常
-
IllegalArgumentException
- 如果参数集的任何元素不表示注释类型 - 从以下版本开始:
- 9
- See The Java™ Language Specification:
- 9.6.3可重复的注释类型
-
-