Module  java.compiler
软件包  javax.annotation.processing

Interface ProcessingEnvironment


  • public interface ProcessingEnvironment
    注释处理工具框架将由provide an annotation processor with an object implementing this interface进行处理，因此处理器可以使用框架提供的工具来编写新文件，报告错误消息和查找其他实用程序。

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

    从以下版本开始：
    1.6

    • 方法详细信息

      • getOptions

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

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

        结果
        处理器特定的选项传递给工具

      • getMessager

        Messager getMessager​()
        返回用于报告错误，警告和其他通知的信使。
        结果
        消息员

      • getFiler

        Filer getFiler​()
        返回用于创建新的源，类或辅助文件的文件管理器。
        结果
        文件管理员

      • getElementUtils

        Elements getElementUtils​()
        返回一些用于操作元素的实用方法的实现
        结果
        元素实用程序

      • getTypeUtils

        Types getTypeUtils​()
        返回一些用于对类型进行操作的实用方法的实现。
        结果
        类型工具

      • getLocale

        Locale getLocale​()
        如果没有语言环境null则返回当前语言环境或null 。 该地区可用于提供本地化的messages 。
        结果
        当前的区域设置或 null如果没有区域设置生效