JavaTM Platform
Standard Ed. 6

javax.annotation.processing
接口 RoundEnvironment


public interface RoundEnvironment

注释处理工具框架将提供一个注释处理器和一个实现此接口的对象,这样处理器可以查询有关注释处理的 round 的信息。

从以下版本开始:
1.6

方法摘要
 boolean errorRaised()
          如果在以前的处理 round 中发生错误,则返回 true;否则返回 false
 Set<? extends Element> getElementsAnnotatedWith(Class<? extends Annotation> a)
          返回使用给定注释类型注释的元素。
 Set<? extends Element> getElementsAnnotatedWith(TypeElement a)
          返回使用给定注释类型注释的元素。
 Set<? extends Element> getRootElements()
          返回以前的 round 生成的注释处理根元素。
 boolean processingOver()
          如果此 round 生成的类型不是以注释处理的后续 round 为准,则返回 true;否则返回 false
 

方法详细信息

processingOver

boolean processingOver()
如果此 round 生成的类型不是以注释处理的后续 round 为准,则返回 true;否则返回 false

返回:
如果此 round 生成的类型不是以注释处理的后续 round 为准,则返回 true;否则返回 false

errorRaised

boolean errorRaised()
如果在以前的处理 round 中发生错误,则返回 true;否则返回 false

返回:
如果在以前的处理 round 中发生错误,则返回 true;否则返回 false

getRootElements

Set<? extends Element> getRootElements()
返回以前的 round 生成的注释处理根元素。

返回:
返回以前的 round 生成的注释处理根元素;如果没有这样的元素,则返回一个空集

getElementsAnnotatedWith

Set<? extends Element> getElementsAnnotatedWith(TypeElement a)
返回使用给定注释类型注释的元素。该注释可能直接出现或者被继承。只返回注释处理的此 round 中 包括 的 package 元素和 type 元素、成员声明、参数或者这些元素中声明的类型参数。所包括的 type 元素是 根类型和嵌套在这些类型中的所有成员类型。包中的元素不认为被包含在内,因为已经为该包创建了一个 package-info 文件。

参数:
a - 将被请求的注释类型
返回:
使用给定注释类型注释的元素;如果没有这样的元素,则返回一个空集
抛出:
IllegalArgumentException - 如果参数不表示注释类型

getElementsAnnotatedWith

Set<? extends Element> getElementsAnnotatedWith(Class<? extends Annotation> a)
返回使用给定注释类型注释的元素。该注释可能直接出现或者被继承。只返回注释处理的此 round 中 包括 的 package 元素和 type 元素、成员声明、参数或者这些元素中声明的类型参数。所包括的 type 元素是 根类型和嵌套在这些类型中的所有成员类型。包中的元素不认为被包含在内,因为已经为该包创建了一个 package-info 文件。

参数:
a - 将被请求的注释类型
返回:
使用给定注释类型注释的元素;如果没有这样的元素,则返回一个空集
抛出:
IllegalArgumentException - 如果参数不表示注释类型

JavaTM Platform
Standard Ed. 6

提交错误或意见
有关更多的 API 参考资料和开发人员文档,请参阅 Java SE 开发人员文档。该文档包含更详细的、面向开发人员的描述,以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策