compact3

javax.annotation.processing

インタフェースRoundEnvironment

public interface RoundEnvironment

注釈処理ツール・フレームワークは、注釈プロセッサにこのインタフェースを実装したオブジェクトを提供することで、そのプロセッサが、注釈処理のあるラウンドに関する情報の問い合わせを行えるようにします。

導入されたバージョン:

1.6

メソッドのサマリー

修飾子と型	メソッドと説明
boolean	errorRaised() 前回の処理ラウンドでエラーが発生した場合はtrueを返し、それ以外の場合はfalseを返します。
Set<? extends Element>	getElementsAnnotatedWith(Class<? extends Annotation> a) 指定された注釈型を使って注釈を付けられた要素を返します。
Set<? extends Element>	getElementsAnnotatedWith(TypeElement a) 指定された注釈型を使って注釈を付けられた要素を返します。
Set<? extends Element>	getRootElements() 前回のラウンドで生成された注釈処理のルート要素を返します。
boolean	processingOver() このラウンドで生成された型が後続の注釈処理ラウンドの対象にならない場合はtrueを返し、それ以外の場合はfalseを返します。

メソッドの詳細

processingOver

boolean processingOver()

このラウンドで生成された型が後続の注釈処理ラウンドの対象にならない場合はtrueを返し、それ以外の場合はfalseを返します。

戻り値:

このラウンドで生成された型が後続の注釈処理ラウンドの対象にならない場合はtrue、それ以外の場合はfalseを返します

errorRaised

boolean errorRaised()

前回の処理ラウンドでエラーが発生した場合はtrueを返し、それ以外の場合はfalseを返します。

戻り値:

前回の処理ラウンドでエラーが発生した場合はtrue、それ以外の場合はfalse

getRootElements

Set<? extends Element> getRootElements()

前回のラウンドで生成された注釈処理のルート要素を返します。

戻り値:

前回のラウンドで生成された注釈処理のルート要素。存在しなかった場合は空のセット

getElementsAnnotatedWith

Set<? extends Element> getElementsAnnotatedWith(TypeElement a)

指定された注釈型を使って注釈を付けられた要素を返します。注釈は、直接使用されていても、継承されていてもかまいません。この注釈処理ラウンドに含まれるパッケージ要素と型要素、およびそれらの内側で宣言されているメンバー宣言、コンストラクタ宣言、パラメータ宣言、型パラメータ宣言だけが返されます。含まれる型要素は、ルートの型と、それらの内側にネストされたすべてのメンバーの型です。あるパッケージ内の要素は、含まれているとはみなされません。その理由は単純で、そのパッケージのpackage-infoファイルが作成されたからです。

パラメータ:

a - 要求された注釈型

戻り値:

指定された注釈型を使って注釈を付けられた要素。存在しない場合は空のセット

例外:

IllegalArgumentException - 引数が注釈型を表していない場合

getElementsAnnotatedWith

Set<? extends Element> getElementsAnnotatedWith(Class<? extends Annotation> a)

指定された注釈型を使って注釈を付けられた要素を返します。注釈は、直接使用されていても、継承されていてもかまいません。この注釈処理ラウンドに含まれるパッケージ要素と型要素、およびそれらの内側で宣言されているメンバー宣言、コンストラクタ宣言、パラメータ宣言、型パラメータ宣言だけが返されます。含まれる型要素は、ルートの型と、それらの内側にネストされたすべてのメンバーの型です。あるパッケージ内の要素は、含まれているとはみなされません。その理由は単純で、そのパッケージのpackage-infoファイルが作成されたからです。

パラメータ:

a - 要求された注釈型

戻り値:

指定された注釈型を使って注釈を付けられた要素。存在しない場合は空のセット

例外:

IllegalArgumentException - 引数が注釈型を表していない場合