モジュール 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
      関連項目: