モジュール java.compiler
パッケージ javax.lang.model.element

インタフェースElementVisitor<R,​P>

型パラメータ:
R - このビジターのメソッドの戻り型。 結果を返すことを必要としないビジターのVoidを使用する。
P - このビジターのメソッドに追加するパラメータの型。 追加のパラメータを必要としないビジターのVoidを使用する。
既知のすべての実装クラス:
AbstractElementVisitor14, AbstractElementVisitor6, AbstractElementVisitor7, AbstractElementVisitor8, AbstractElementVisitor9, ElementKindVisitor14, ElementKindVisitor6, ElementKindVisitor7, ElementKindVisitor8, ElementKindVisitor9, ElementScanner14, ElementScanner6, ElementScanner7, ElementScanner8, ElementScanner9, SimpleElementVisitor14, SimpleElementVisitor6, SimpleElementVisitor7, SimpleElementVisitor8, SimpleElementVisitor9
public interface ElementVisitor<R,​P>
ビジター・デザイン・パターンのスタイルによるプログラム要素のビジターです。 このインタフェースを実装しているクラスは、コンパイル時に要素の種類が未知の場合、要素の操作に使用されます。 ビジターが要素acceptメソッドに渡されると、その要素に最も適用可能なvisitXyzメソッドが呼び出されます。

このインタフェースを実装するクラスは、追加パラメータpがnullのときにNullPointerExceptionをスローする場合としない場合があります。詳細については、クラスの実装に関するドキュメントを参照してください。

警告: Java™プログラミング言語の将来のバージョンに現在は未知の新しい言語構造が追加される場合、それらを格納するために、このインタフェースにメソッドが追加される可能性があります。 したがって、このインタフェースを直接実装するビジター・クラスは、プラットフォームの将来のバージョンでソースの互換性がなくなる可能性があります。 このようなソースの非互換性を回避するために、ビジターの実装では、このインタフェースを実装する適切な抽象ビジター・クラスを拡張することをお薦めします。 ただし、APIは通常、抽象クラスのいずれかではなく、パラメータの型や戻り型などとして、このビジター・インタフェースを使用します。

新しい言語コンストラクトを格納するためのメソッドは、デフォルト・メソッドとして追加された場合、ソースと互換性のある方法で追加されることがあります。 ただし、デフォルトのメソッドはJava SE 8以降のリリースでのみ使用でき、Java SE 8にバンドルされている javax.lang.model.*パッケージはJava SE 7でも実行可能でなければなりません。 したがって、Java SE 8言語機能をカバーするようにjavax.lang.model.*を拡張する場合、デフォルトのメソッドは使用されませんでした。 ただし、Java SE 8以降のプラットフォームでのみ実行する必要があるjavax.lang.model.*パッケージのリビジョンでは、デフォルトのメソッドが使用されます。

導入されたバージョン:
1.6

  • メソッドの詳細

    • visit

      R visit​(Element e, P p)
      要素をビジットします。
      パラメータ:
      e - ビジットする要素
      p - ビジター指定のパラメータ
      戻り値:
      ビジター指定の結果

    • visit

      default R visit​(Element e)
      visit(e, null)と同等の簡易メソッドです。
      実装要件:
      デフォルト実装はvisit(e, null)です。
      パラメータ:
      e - ビジットする要素
      戻り値:
      ビジター指定の結果

    • visitPackage

      R visitPackage​(PackageElement e, P p)
      パッケージ要素をビジットします。
      パラメータ:
      e - ビジットする要素
      p - ビジター指定のパラメータ
      戻り値:
      ビジター指定の結果

    • visitType

      R visitType​(TypeElement e, P p)
      型要素をビジットします。
      パラメータ:
      e - ビジットする要素
      p - ビジター指定のパラメータ
      戻り値:
      ビジター指定の結果

    • visitVariable

      R visitVariable​(VariableElement e, P p)
      変数要素をビジットします。
      パラメータ:
      e - ビジットする要素
      p - ビジター指定のパラメータ
      戻り値:
      ビジター指定の結果

    • visitExecutable

      R visitExecutable​(ExecutableElement e, P p)
      実行可能要素をビジットします。
      パラメータ:
      e - ビジットする要素
      p - ビジター指定のパラメータ
      戻り値:
      ビジター指定の結果

    • visitTypeParameter

      R visitTypeParameter​(TypeParameterElement e, P p)
      型パラメータ要素をビジットします。
      パラメータ:
      e - ビジットする要素
      p - ビジター指定のパラメータ
      戻り値:
      ビジター指定の結果

    • visitUnknown

      R visitUnknown​(Element e, P p)
      未知の種類の要素をビジットします。 これは、言語が拡張され、新しい種類の要素がElement階層に追加された場合に発生します。
      パラメータ:
      e - ビジットする要素
      p - ビジター指定のパラメータ
      戻り値:
      ビジター指定の結果
      例外:
      UnknownElementException - 必要に応じてビジターの実装はこの例外をスローできる

    • visitModule

      default R visitModule​(ModuleElement e, P p)
      モジュール要素をビジットします。
      実装要件:
      デフォルトの実装では、visitUnknown(e, p)を呼び出して ModuleElementを参照します。
      パラメータ:
      e - ビジットする要素
      p - ビジター指定のパラメータ
      戻り値:
      ビジター指定の結果
      導入されたバージョン:
      9

    • visitRecordComponent

      default R visitRecordComponent​(RecordComponentElement e, P p)
      このメソッドは、Java言語のプレビュー機能であるrecordに関連付けられています。 プレビュー機能は、将来のリリースで削除されるか、Java言語の永続機能にアップグレードされる可能性があります。

      レコード・コンポーネント要素を訪問します。
      実装要件:
      デフォルトの実装では、visitUnknown(e, p)を呼び出して RecordComponentElementを参照します。
      パラメータ:
      e - ビジットする要素
      p - ビジター指定のパラメータ
      戻り値:
      ビジター指定の結果
      導入されたバージョン:
      14