com.sun.mirror.apt
インタフェース AnnotationProcessorEnvironment

public interface AnnotationProcessorEnvironment

注釈プロセッサが必要とする状態をカプセル化している環境。注釈処理ツールは、この環境をすべての注釈プロセッサで利用できるようにします。

注釈処理ツールが呼び出されると、操作する型宣言のセットが与えられます。これらは「指定された」型と呼ばれます。この呼び出しに「含まれる」型宣言は、指定された型とその内部に入れ子になった型で構成されます。

DeclarationFilter は、メソッドが宣言のコレクションを返すときに必要な項目だけを簡単に選択する方法を提供します。

導入されたバージョン:

1.5

メソッドの概要

void	addListener(AnnotationProcessorListener listener) リスナーを追加します。
Collection<Declaration>	getDeclarationsAnnotatedWith(AnnotationTypeDeclaration a) 指定された注釈型を使って注釈を付けられた宣言を返します。
Declarations	getDeclarationUtils() 宣言で操作するための一部のユーティリティメソッドの実装を返します。
Filer	getFiler() 新しいソースファイル、クラスファイル、または補助ファイルの作成に使用されるフィルタを返します。
Messager	getMessager() エラー、警告、およびほかの通知を報告するために使用されるメッセージャを返します。
Map<String,String>	getOptions() 注釈処理ツールに渡されたオプションを返します。
PackageDeclaration	getPackage(String name) 完全修飾名を指定されたパッケージの宣言を返します。
Collection<TypeDeclaration>	getSpecifiedTypeDeclarations() 注釈処理ツールが呼び出されたときに指定された型の宣言を返します。
TypeDeclaration	getTypeDeclaration(String name) 完全修飾名を指定された型の宣言を返します。
Collection<TypeDeclaration>	getTypeDeclarations() 注釈処理ツールのこの呼び出しに含まれる型の宣言を返す簡易メソッドです。
Types	getTypeUtils() 型で操作するための一部のユーティリティメソッドの実装を返します。
void	removeListener(AnnotationProcessorListener listener) リスナーを削除します。

メソッドの詳細

getOptions

Map<String,String> getOptions()

注釈処理ツールに渡されたオプションを返します。オプションは、「-encoding」などのオプション名対オプション値のマップの形式で返されます。「-help」などの値のないオプションの場合、マップの対応する値は null になります。

「-A」で始まるオプションはプロセッサに固有です。このようなオプションはツールで認識されませんが、一部の注釈プロセッサで使用できるように作成されています。

戻り値:

ツールに渡されたオプション

getMessager

Messager getMessager()

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

戻り値:

メッセージャ

getFiler

Filer getFiler()

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

戻り値:

フィルタ

getSpecifiedTypeDeclarations

Collection<TypeDeclaration> getSpecifiedTypeDeclarations()

注釈処理ツールが呼び出されたときに指定された型の宣言を返します。

戻り値:

ツールが呼び出されたときに指定された型、ない場合は空のコレクション

getPackage

PackageDeclaration getPackage(String name)

完全修飾名を指定されたパッケージの宣言を返します。

パラメータ:

name - 完全修飾パッケージ名、名前のないパッケージの場合は ""

戻り値:

名前付きパッケージの宣言、見つからなかった場合は null

getTypeDeclaration

TypeDeclaration getTypeDeclaration(String name)

完全修飾名を指定された型の宣言を返します。

パラメータ:

name - 完全修飾の型名

戻り値:

名前付きの型の宣言、見つからなかった場合は null

getTypeDeclarations

Collection<TypeDeclaration> getTypeDeclarations()

注釈処理ツールのこの呼び出しに含まれる型の宣言を返す簡易メソッドです。

戻り値:

ツールのこの呼び出しに含まれる型の宣言、ない場合は空のコレクション

getDeclarationsAnnotatedWith

Collection<Declaration> getDeclarationsAnnotatedWith(AnnotationTypeDeclaration a)

指定された注釈型を使って注釈を付けられた宣言を返します。注釈処理ツールのこの呼び出しに含まれる型の宣言だけ、あるいはこれらの中で宣言されたメンバ、パラメータ、または型パラメータの宣言が返されます。

パラメータ:

a - 要求された注釈型

戻り値:

指定された注釈型を使って注釈を付けられた宣言、ない場合は空のコレクション

getDeclarationUtils

Declarations getDeclarationUtils()

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

戻り値:

宣言ユーティリティ

getTypeUtils

Types getTypeUtils()

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

戻り値:

型ユーティリティ

addListener

void addListener(AnnotationProcessorListener listener)

リスナーを追加します。待機するためにこのリスナーが現在登録されている場合は、再度追加しても何の効果もありません。

パラメータ:

listener - 追加されるリスナー

例外:

NullPointerException - リスナーが null の場合

removeListener

void removeListener(AnnotationProcessorListener listener)

リスナーを削除します。このリスナーが現在待機していない場合、メソッドで呼び出しても何の効果もありません。

パラメータ:

listener - 削除されるリスナー

例外:

NullPointerException - リスナーが null の場合