模块 java.compiler
包 javax.annotation.processing

接口 RoundEnvironment

public interface RoundEnvironment
注释处理工具框架将为注解处理器提供一个实现该接口的对象以便处理器可以查询有关一轮注释处理的信息。
自从：
1.6

  • 方法详情

    • processingOver

      boolean processingOver()
      如果此轮生成的类型将不受后续轮注释处理的影响，则返回 true；否则返回 false。
      返回：
      true 如果这一轮生成的类型将不受后续一轮注释处理的影响；否则返回 false

    • errorRaised

      boolean errorRaised()
      如果在前一轮处理中出现错误，则返回 true；否则返回 false。
      返回：
      true 如果在前一轮处理中出现错误；否则返回 false

    • getRootElements

      Set <? extends Element > getRootElements()
      返回上一轮注释处理生成的的根元素。
      API 注意：
      根元素对应于编译单元中的顶级声明（JLS 部分 7.3 ）。根元素最常见的是 types ，但也可以是 packages 或 modules 。
      返回：
      前一轮生成的注释处理的根元素，如果没有则为空集

    • getElementsAnnotatedWith

      Set <? extends Element > getElementsAnnotatedWith(TypeElement  a)
      返回使用给定注释接口注释的元素。注解可能直接出现，也可能被继承。仅包元素、模块元素和类型元素包括在这一轮注释处理中，返回成员声明、构造函数、参数、类型参数或其中声明的记录组件。包含的类型元素是 根类型 以及嵌套在其中的任何成员类型。包的元素不被视为包含在内，仅仅是因为为该包创建了 package-info 文件。同样，仅仅因为为该模块创建了 module-info 文件，模块的元素不会被视为包含在内。
      参数：
      a - 被请求的注解接口
      返回：
      用给定的注释接口注释的元素，如果没有则为空集
      抛出：
      IllegalArgumentException - 如果参数不表示注释接口

    • getElementsAnnotatedWithAny

      default Set <? extends Element > getElementsAnnotatedWithAny(TypeElement ... annotations)
      返回使用一个或多个给定注释接口注释的元素。
      API 注意：
      当通过同时查找注解接口及其包含的注解接口来处理重复注解时，此方法可能很有用。
      实现要求：
      此方法的默认实现创建一个空结果集，遍历参数数组中的注释，在每个注释上调用 getElementsAnnotatedWith(TypeElement) 并将这些结果添加到结果集中。最后，结果集的内容作为不可修改的集返回。
      参数：
      annotations - 正在请求注释接口
      返回：
      用一个或多个给定注释接口注释的元素，如果没有则为空集
      抛出：
      IllegalArgumentException - 如果参数集的任何元素不表示注释接口
      看Java 语言规范:
      9.6.3 可重复的注解接口
      自从：
      9

    • getElementsAnnotatedWith

      Set <? extends Element > getElementsAnnotatedWith(Class <? extends Annotation > a)
      返回使用给定注释接口注释的元素。注解可能直接出现，也可能被继承。仅包元素、模块元素和类型元素包括在这一轮注释处理中，返回成员声明、构造函数、参数、类型参数或其中声明的记录组件。包含的类型元素是 根类型 以及嵌套在其中的任何成员类型。包中的元素不会仅仅因为为该包创建了 package-info 文件而被视为包含在内。同样，仅仅因为为该模块创建了 module-info 文件，模块的元素不会被视为包含在内。

      注意：此方法的实现通常执行从作为 Class 对象的注释接口的运行时反射表示到用于注释处理的不同表示的内部转换。运行时上下文中存在的一组注释接口可能不同于特定环境配置中注释处理上下文中存在的一组注释接口。如果注释处理上下文中不存在运行时注释接口，则这种情况不会被视为错误，也不会为该注释接口找到任何元素。

      参数：
      a - 被请求的注解接口
      返回：
      用给定的注释接口注释的元素，如果没有则为空集
      抛出：
      IllegalArgumentException - 如果参数不表示注释接口
      参见：

    • getElementsAnnotatedWithAny

      default Set <? extends Element > getElementsAnnotatedWithAny(Set <Class <? extends Annotation >> annotations)
      返回使用一个或多个给定注释接口注释的元素。

      注意：此方法的实现通常执行从作为 Class 对象的注释接口的运行时反射表示到用于注释处理的不同表示的内部转换。运行时上下文中存在的一组注释接口可能不同于特定环境配置中注释处理上下文中存在的一组注释接口。如果注释处理上下文中不存在运行时注释接口，则这种情况不会被视为错误，也不会为该注释接口找到任何元素。

      API 注意：
      当通过同时查找注解接口及其包含的注解接口来处理重复注解时，此方法可能很有用。
      实现要求：
      此方法的默认实现创建一个空结果集，迭代参数集中的注释，在每个注释上调用 getElementsAnnotatedWith(Class) 并将这些结果添加到结果集中。最后，结果集的内容作为不可修改的集返回。
      参数：
      annotations - 正在请求注释接口
      返回：
      用一个或多个给定注释接口注释的元素，如果没有则为空集
      抛出：
      IllegalArgumentException - 如果参数集的任何元素不表示注释接口
      看Java 语言规范:
      9.6.3 可重复的注解接口
      自从：
      9
      参见：