javax.annotation.processing

インタフェース ProcessingEnvironment

public interface ProcessingEnvironment

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

Sun 以外の会社が、複数のプロセッサが協調動作しながら単一のソースファイルを出力できるようにする 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。