モジュール java.compiler
パッケージ javax.annotation.processing

インタフェースRoundEnvironment

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

  • メソッドの詳細

    • processingOver

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

    • errorRaised

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

    • getRootElements

      Set<? extends Element> getRootElements()
      前のラウンドで「生成場所」を処理する注釈の「ルート要素」を返します。
      APIのノート:
      ルート要素は、コンパイル・ユニット(JLSセクション7.3)のトップレベルの宣言に対応します。 ルート要素は最も一般的なtypesですが、packagesまたはmodulesでもかまいません。
      戻り値:
      前回のラウンドで生成された注釈処理のルート要素。存在しなかった場合は空のセット

    • getElementsAnnotatedWith

      Set<? extends Element> getElementsAnnotatedWith(TypeElement a)
      指定された注釈型を使って注釈を付けられた要素を返します。 注釈は、直接使用されていても、継承されていてもかまいません。 このような注釈処理、またはメンバー、コンストラクタ、パラメータ、型パラメータ、あるいはそれらの内部で宣言されたレコード・コンポーネントの宣言では、パッケージ要素、モジュール要素および型要素のみがincludedに戻されます。 含まれる型要素は、ルートの型と、それらの内側にネストされたすべてのメンバーの型です。 パッケージの要素は、そのパッケージのpackage-infoファイルが作成されたために含まれているとはみなされません。 同様に、モジュールのmodule-infoファイルが作成されたため、そのモジュールの要素は含まれているとみなされません。
      パラメータ:
      a - 要求された注釈型
      戻り値:
      指定された注釈型を使って注釈を付けられた要素。存在しない場合は空のセット
      例外:
      IllegalArgumentException - 引数が注釈型を表していない場合

    • getElementsAnnotatedWithAny

      default Set<? extends Element> getElementsAnnotatedWithAny(TypeElement... annotations)
      指定された注釈型の1つ以上で注釈が付けられた要素を返します。
      APIのノート:
      このメソッドは、注釈型とその注釈型を同時に検索して繰り返し注釈を処理する場合に役立ちます。
      実装要件:
      このメソッドのデフォルトの実装では、空の結果セットが作成され、各注釈のgetElementsAnnotatedWith(TypeElement)を呼び出してその結果セットに結果を追加して、引数配列の注釈を反復処理します。 最後に、結果セットの内容は変更不可能なセットとして返されます。
      パラメータ:
      annotations - 注釈型がリクエストされている
      戻り値:
      指定された注釈型の1つ以上で注釈された要素、または存在しない場合は空のセット
      例外:
      IllegalArgumentException - 引数セットの任意の要素が注釈型を表さない場合
      Java言語仕様を参照してください:
      「9.6.3 繰返し可能な注釈インタフェース」
      導入されたバージョン:
      9

    • getElementsAnnotatedWith

      Set<? extends Element> getElementsAnnotatedWith(Class<? extends Annotation> a)
      指定された注釈型を使って注釈を付けられた要素を返します。 注釈は、直接使用されていても、継承されていてもかまいません。 このような注釈処理、またはメンバー、コンストラクタ、パラメータ、型パラメータ、あるいはそれらの内部で宣言されたレコード・コンポーネントの宣言では、パッケージ要素、モジュール要素および型要素のみがincludedに戻されます。 含まれる型要素は、ルートの型と、それらの内側にネストされたすべてのメンバーの型です。 あるパッケージ内の要素は、含まれているとはみなされません。その理由は単純で、そのパッケージのpackage-infoファイルが作成されたからです。 同様に、モジュールのmodule-infoファイルが作成されたため、そのモジュールの要素は含まれているとみなされません。

      ノート: このメソッドを実装すると、通常、注釈型のランタイム反映表現から注釈処理に使用されるClassオブジェクトとして内部変換が実行されます。 ランタイム・コンテキストに存在する注釈型のセットは、特定の環境構成における注釈処理のコンテキストに存在する注釈型のセットとは異なる可能性があります。 ランタイム注釈型が注釈処理コンテキストに存在しない場合、この状況はエラーとして扱われず、その注釈型の要素は見つかりません。

      パラメータ:
      a - 要求された注釈型
      戻り値:
      指定された注釈型を使って注釈を付けられた要素。存在しない場合は空のセット
      例外:
      IllegalArgumentException - 引数が注釈型を表していない場合
      関連項目:

    • getElementsAnnotatedWithAny

      default Set<? extends Element> getElementsAnnotatedWithAny(Set<Class<? extends Annotation>> annotations)
      指定された注釈型の1つ以上で注釈が付けられた要素を返します。

      ノート: このメソッドを実装すると、通常、注釈型のランタイム反映表現から注釈処理に使用されるClassオブジェクトとして内部変換が実行されます。 ランタイム・コンテキストに存在する注釈型のセットは、特定の環境構成における注釈処理のコンテキストに存在する注釈型のセットとは異なる可能性があります。 ランタイム注釈型が注釈処理コンテキストに存在しない場合、この状況はエラーとして扱われず、その注釈型の要素は見つかりません。

      APIのノート:
      このメソッドは、注釈型とその注釈型を同時に検索して繰り返し注釈を処理する場合に役立ちます。
      実装要件:
      このメソッドのデフォルトの実装では空の結果セットが作成され、引数セットの注釈を繰り返して各注釈にgetElementsAnnotatedWith(Class)を呼び出し、その結果を結果セットに追加します。 最後に、結果セットの内容は変更不可能なセットとして返されます。
      パラメータ:
      annotations - 注釈型がリクエストされている
      戻り値:
      指定された注釈型の1つ以上で注釈された要素、または存在しない場合は空のセット
      例外:
      IllegalArgumentException - 引数セットの任意の要素が注釈型を表さない場合
      Java言語仕様を参照してください:
      「9.6.3 繰返し可能な注釈インタフェース」
      導入されたバージョン:
      9
      関連項目: