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