compact3

javax.annotation.processing

インタフェースProcessingEnvironment

public interface ProcessingEnvironment

注釈処理ツール・フレームワークは、注釈プロセッサにこのインタフェースを実装したオブジェクトを提供することで、そのプロセッサが、このフレームワークが提供する機能を使って新規ファイルへの書き込み、エラー・メッセージの報告、およびほかのユーティリティの検索を行えるようにします。

サード・パーティが、複数のプロセッサが協調動作しながら単一のソース・ファイルを出力できるようにするFiler拡張など、このインタフェースの機能オブジェクトの付加価値ラッパーを提供したいと考える可能性があります。これを可能にするには、API経由での副作用を互いに確認できるようなコンテキスト内で動作する複数のプロセッサに対し、ツール・インフラストラクチャは、.equalsである対応する機能オブジェクト、.equalsであるFiler、などといったものを提供しなければいけません。さらに、実行中の注釈プロセッサから見て、少なくともヘルパー・クラスの選択されたサブセットが同じクラス・ローダーによってロードされたように見えるよう、ツール呼出しを構成することができなければいけません。(機能オブジェクトが共有状態を管理するため、ラッパー・クラスの実装は、同じ基底機能オブジェクトが以前にラップされたかどうかを知らなければいけない。)

導入されたバージョン:

1.6

メソッドのサマリー

修飾子と型	メソッドと説明
Elements	getElementUtils() 要素で操作するための一部のユーティリティ・メソッドの実装を返します。
Filer	getFiler() 新しいソース・ファイル、クラス・ファイル、または補助ファイルの作成に使用されるファイラを返します。
Locale	getLocale() 現在のロケールを返します。有効なロケールが存在しない場合はnullを返します。
Messager	getMessager() エラー、警告、およびほかの通知を報告するために使用されるメッセンジャを返します。
Map<String,String>	getOptions() 注釈処理ツールに渡されたプロセッサ固有のオプションを返します。
SourceVersion	getSourceVersion() 生成されるすべてのソースおよびクラス・ファイルが準拠すべきソース・バージョンを返します。
Types	getTypeUtils() 型で操作するための一部のユーティリティ・メソッドの実装を返します。

メソッドの詳細

getOptions

Map<String,String> getOptions()

注釈処理ツールに渡されたプロセッサ固有のオプションを返します。オプションは、オプション名対オプション値のマップの形式で返されます。値のないオプションの場合、マップ内の対応する値はnullになります。

プロセッサ固有のオプションを渡す方法の詳細については、使用する特定のツール・インフラストラクチャのドキュメントを参照してください。たとえば、あるコマンド行実装は、プロセッサ固有のオプションの先頭に"-A"のような既知の文字列を付けることでそれらを区別するかもしれませんし、ほかのツール実装は、それとは別の規約に従ったり代替メカニズムを提供したりするかもしれません。あるいは、別の実装は、プロセッサ固有のオプションに加え、ツールに渡されたオプションを検索するための実装固有の方法を提供するかもしれません。

戻り値:

ツールに渡されたプロセッサ固有のオプション

getMessager

Messager getMessager()

エラー、警告、およびほかの通知を報告するために使用されるメッセンジャを返します。

戻り値:

メッセンジャ

getFiler

Filer getFiler()

新しいソース・ファイル、クラス・ファイル、または補助ファイルの作成に使用されるファイラを返します。

戻り値:

ファイラ

getElementUtils

Elements getElementUtils()

要素で操作するための一部のユーティリティ・メソッドの実装を返します。

戻り値:

要素のユーティリティ

getTypeUtils

Types getTypeUtils()

型で操作するための一部のユーティリティ・メソッドの実装を返します。

戻り値:

型ユーティリティ

getSourceVersion

SourceVersion getSourceVersion()

生成されるすべてのソースおよびクラス・ファイルが準拠すべきソース・バージョンを返します。

戻り値:

生成されるソースおよびクラス・ファイルが準拠すべきソース・バージョン

関連項目:

Processor.getSupportedSourceVersion()

getLocale

Locale getLocale()

現在のロケールを返します。有効なロケールが存在しない場合はnullを返します。このロケールを使えば、ローカライズされたメッセージを提供できます。

戻り値:

現在のロケール。有効なロケールが存在しない場合はnull。