模块 java.compiler
包 javax.annotation.processing

接口 ProcessingEnvironment

public interface ProcessingEnvironment
注释处理工具框架将 为注解处理器提供一个实现该接口的对象 因此处理器可以使用框架提供的设施来编写新文件、报告错误消息和查找其他实用程序。

第三方可能希望从该接口提供围绕设施对象的增值包装，例如允许多个处理器协调写出单个源文件的Filer扩展。为了实现这一点，对于运行在上下文中的处理器来说，通过 API 可以看到它们的副作用，工具基础设施必须提供相应的设施对象，即 .equals、Filers 和 .equals，等等。此外，必须能够配置工具调用，以便从运行的注解处理器的角度来看，至少所选的帮助类子集被视为由相同的类加载器加载。 （由于设施对象管理共享状态，包装器类的实现必须知道之前是否已经包装了相同的基础设施对象。）

自从：
1.6

  • 方法总结

    修饰符和类型
    方法
    描述
    Elements
    getElementUtils()
    返回一些用于操作元素的实用方法的实现。
    Filer
    getFiler()
    返回用于创建新源文件、类文件或辅助文件的文件管理器。
    Locale
    getLocale()
    返回当前locale或 null 如果没有locale有效。
    Messager
    getMessager()
    返回用于报告错误、警告和其他通知的消息程序。
    Map<String,String>
    getOptions()
    返回传递给注释处理工具的特定于处理器的选项。
    SourceVersion
    getSourceVersion()
    返回任何生成的 source 和 类 文件应符合的源版本。
    Types
    getTypeUtils()
    返回一些用于对类型进行操作的实用方法的实现。
    default boolean
    isPreviewEnabled()
    如果启用了 preview features，则返回 true，否则返回 false。

  • 方法详情

    • getOptions

      Map <String ,String > getOptions()
      返回传递给注释处理工具的特定于处理器的选项。选项以从选项名称到选项值的映射形式返回。对于没有值的选项，map中对应的值为 null 。

      有关如何传递特定于处理器的选项的详细信息，请参阅正在使用的特定工具基础结构的文档。例如，命令行实现可以通过在它们前面加上已知字符串（如 "-A" ）来区分特定于处理器的选项；其他工具实现可能遵循不同的约定或提供替代机制。除了特定于处理器的选项之外，给定的实现还可以提供特定于实现的方法来查找传递给工具的选项。

      返回：
      传递给注释处理工具的特定于处理器的选项

    • getMessager

      Messager  getMessager()
      返回用于报告错误、警告和其他通知的消息程序。
      返回：
      用于报告错误、警告和其他通知的消息程序

    • getFiler

      Filer  getFiler()
      返回用于创建新源文件、类文件或辅助文件的文件管理器。
      返回：
      用于创建新源文件、类文件或辅助文件的文件管理器

    • getElementUtils

      Elements  getElementUtils()
      返回一些用于操作元素的实用方法的实现。
      返回：
      一些用于操作元素的实用方法的实现

    • getTypeUtils

      Types  getTypeUtils()
      返回一些用于对类型进行操作的实用方法的实现。
      返回：
      一些用于操作类型的实用方法的实现

    • getSourceVersion

      SourceVersion  getSourceVersion()
      返回任何生成的 source 和 类 文件应符合的源版本。
      返回：
      任何生成的 source 和 类 文件应符合的源版本
      参见：

    • getLocale

      Locale  getLocale()
      返回当前locale或 null 如果没有locale有效。locale可用于提供本地化的 消息 。
      返回：
      当前locale或 null 如果没有有效的locale

    • isPreviewEnabled

      default boolean isPreviewEnabled()
      如果启用了 preview features，则返回 true，否则返回 false。
      实现要求：
      此方法的默认实现返回 false 。
      返回：
      是否启用预览功能
      自从：
      13