Module java.compiler
Package javax.annotation.processing

Interface ProcessingEnvironment

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

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

自版本:
1.6

  • Method Details

    • getOptions

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

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

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

    • getMessager

      Messager getMessager()
      返回用于报告错误、警告和其他通知的消息处理器。
      返回:
      用于报告错误、警告和其他通知的消息处理器

    • getFiler

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

    • getElementUtils

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

    • getTypeUtils

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

    • getSourceVersion

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

    • getLocale

      Locale getLocale()
      返回当前的区域设置，如果没有生效的区域设置则返回null。区域设置可用于提供本地化的消息。
      返回:
      当前的区域设置，如果没有生效的区域设置则返回null

    • isPreviewEnabled

      default boolean isPreviewEnabled()
      返回true如果启用了预览特性，否则返回false。
      实现要求:
      此方法的默认实现返回false。
      返回:
      是否启用了预览特性
      自版本:
      13