ProcessingEnvironment - [ Java参考文档 ] - 在线原生手册

目录搜索

文字

概述

软件包

类

使用

树

已过时

索引

帮助

Java^TM 2 Platform
Standard Ed. 6

上一个类 下一个类

框架 无框架

摘要：嵌套 | 字段 | 构造方法 | 方法

详细信息：字段 | 构造方法 | 方法

javax.annotation.processing
接口 ProcessingEnvironment

public interface ProcessingEnvironment

注释处理工具框架将提供一个具有实现此接口的对象的注释 processor，因此 processor 可以使用该框架提供的设施来编写新文件、报告错误消息并查找其他实用工具。

第三方可能希望提供能包装此接口设施对象的增值包装器，例如，允许多个 processor 协同写出单个源文件的 Filer 扩展。为了实现这一点，对于在其副作用可通过 API 相互可见的上下文中运行的 processor，工具基础设施必须提供相应的设施对象，这些对象是 .equals、作为 .equals 的 Filer 等等。此外，必须能够配置工具调用，使得从运行注释 processor 的角度来看，至少已选定的帮助 (helper) 类子集可视为由相同的类加载器加载。（因为设施对象管理共享状态，所以包装器类的实现必须知道以前是否包装过相同的基本设施对象。）

从以下版本开始：: 1.6

方法摘要
`Elements`	`getElementUtils()` 返回用来在元素上进行操作的某些实用工具方法的实现。
`Filer`	`getFiler()` 返回用来创建新源、类或辅助文件的 Filer。
`Locale`	`getLocale()` 返回当前语言环境；如果没有有效的语言环境，则返回 `null`。
`Messager`	`getMessager()` 返回用来报告错误、警报和其他通知的 Messager。
`Map<String,String>`	`getOptions()` 返回传递给注释处理工具的特定于 processor 的选项。
`SourceVersion`	`getSourceVersion()` 返回任何生成的源和类文件应该符合的源版本。
`Types`	`getTypeUtils()` 返回用来在类型上进行操作的某些实用工具方法的实现。

方法详细信息

getOptions

Map<String,String> getOptions()

返回传递给注释处理工具的特定于 processor 的选项。选项是以从选项名称到选项值的映射形式返回的。对于不包含任何值的选项，映射中的对应值为 null。

关于如何传入特定于 processor 的选项的详细信息，请参阅特定工具基础设施的文档。例如，命令行实现可以通过使用已知字符串（如 "-A"）作为特定于 processor 的选项的前缀来区分它们；其他工具实现可能遵守不同的约定或提供替换机制。除了特定于 processor 的选项外，给定实现还可以提供特定于实现的方式来查找传递给该工具的选项。

返回：: 传递给工具的特定于 processor 的选项

getMessager

Messager getMessager()

返回用来报告错误、警报和其他通知的 Messager。

返回：: Messager

getFiler

Filer getFiler()

返回用来创建新源、类或辅助文件的 Filer。

返回：: Filer

getElementUtils

Elements getElementUtils()

返回用来在元素上进行操作的某些实用工具方法的实现。

返回：: 元素实用工具

getTypeUtils

Types getTypeUtils()

返回用来在类型上进行操作的某些实用工具方法的实现。

返回：: 类型实用工具

getSourceVersion

SourceVersion getSourceVersion()

返回任何生成的源和类文件应该符合的源版本。

返回：: 生成的源和类文件应该符合的源版本
另请参见：: Processor.getSupportedSourceVersion()

getLocale

Locale getLocale()

返回当前语言环境；如果没有有效的语言环境，则返回 null。该语言环境可用来提供本地化的消息。

返回：: 当前语言环境；如果没有有效的语言环境，则返回 null

概述