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

インタフェースTypeElement

すべてのスーパー・インタフェース:
AnnotatedConstruct, Element, Parameterizable, QualifiedNameable
public interface TypeElement
extends Element, Parameterizable, QualifiedNameable
クラスまたはインタフェースのプログラム要素を表します。 型とそのメンバーに関する情報へのアクセスを提供します。 列挙型とレコード型はクラスのタイプであり、注釈型はインタフェースのタイプであることに注意してください。

TypeElementはクラスまたはインタフェースの要素を表しますが、DeclaredTypeはクラスまたはインタフェースの型を表します。後者は、前者の使用(または呼出し)です。 単一の要素で型の全ファミリを定義できるジェネリック型との違いがもっともはっきりしています。 たとえば、要素java.util.Setはパラメータ化された型java.util.Set<String>とjava.util.Set<Number> (その他多数)、およびraw型java.util.Setに対応します。

要素のリストを返すこのインタフェースの各メソッドは、プログラム情報の基本となるソースにとって自然な順序でそれらを返します。 たとえば、情報の基本となるソースがJavaソース・コードである場合、要素はソース・コードの順序で返されます。

導入されたバージョン:
1.6
関連項目:
DeclaredType

  • メソッドの詳細

    • asType

      TypeMirror asType()
      この型要素によって定義された型を返します。汎用型を表す要素の「典型的」型を返します。

      ジェネリック要素は型を1つだけではなく、ファミリで定義します。 これが汎用要素の場合、プロトタイプ型が戻されます。これには、独自のフォーマル型パラメータに対応する型変数での要素呼出しが含まれます。 たとえば、ジェネリック・クラス要素であるC<N extends Number>については、パラメータ化された型C<N>が返されます。 Typesユーティリティ・インタフェースには、要素で定義された型の全範囲を取得するための汎用的なメソッドがより多く用意されています。

      定義:
      インタフェースElement内のasType
      戻り値:
      このタイプ要素によって定義されたタイプ
      関連項目:
      Types.asMemberOf(DeclaredType, Element), Types.getDeclaredType(TypeElement, TypeMirror...)

    • getEnclosedElements

      List<? extends Element> getEnclosedElements()
      このクラスまたはインタフェース内で直接宣言されているフィールド、メソッド、コンストラクタ、レコード・コンポーネント、およびメンバー型を返します。 これには、(implicit)デフォルト・コンストラクタやenum型の暗黙のvaluesメソッドやvalueOfメソッドなどのmandated要素が含まれます。
      定義:
      getEnclosedElements、インタフェース: Element
      APIのノート:
      「一般的な精度要件」の特定のインスタンスとこのインタフェースで必要な順序付け動作として、その要素に関する情報の元のソースに対して、囲まれた要素のリストが自然順序で返されます。 たとえば、型に関する情報の発生源がソース・ファイルである場合、要素はソース・コードの順序で返されます。 (ただし、その場合、デフォルト・コンストラクタなどの「暗黙のうちに宣言された」要素の順序は指定されていません。)
      戻り値:
      適切な順序で囲まれている要素。存在しない場合は空のリスト
      Java言語仕様を参照してください:
      8.8.9 デフォルト・コンストラクタ
      8.9.3列挙メンバー
      関連項目:
      getEnclosedElements(), PackageElement.getEnclosedElements(), ModuleElement.getEnclosedElements(), Elements.getAllMembers(javax.lang.model.element.TypeElement)

    • getNestingKind

      NestingKind getNestingKind()
      この型要素の入れ子の種類を返します。
      戻り値:
      この型要素の入れ子の種類

    • getQualifiedName

      Name getQualifiedName()
      この型要素の完全指定名を返します。 より正確には、これは正規名を返します。 正規の名前を持たないローカル・クラスおよび匿名クラスでは、空の名前が返されます。

      ジェネリック型の名前には、仮型パラメータへの参照は含まれません。 たとえば、インタフェースjava.util.Set<E>の完全修飾名は"java.util.Set"です。 ネストされた型は、"java.util.Map.Entry"のように"."を区切りとして使用します。

      定義:
      getQualifiedName、インタフェース: QualifiedNameable
      戻り値:
      このクラスまたはインタフェースの完全指定名。存在しない場合は空の文字列
      Java言語仕様を参照してください:
      6.7 完全修飾名および正規名
      関連項目:
      Elements.getBinaryName(javax.lang.model.element.TypeElement)

    • getSimpleName

      Name getSimpleName()
      この型要素の単純名を返します。 匿名クラスの場合は、空の名前が返されます。
      定義:
      getSimpleName、インタフェース: Element
      戻り値:
      このクラスまたはインタフェースの単純名。匿名クラスの場合は空の名前
      関連項目:
      PackageElement.getSimpleName(), ExecutableElement.getSimpleName(), getSimpleName(), VariableElement.getSimpleName(), ModuleElement.getSimpleName(), RecordComponentElement.getSimpleName()

    • getSuperclass

      TypeMirror getSuperclass()
      この型要素の直接スーパー・クラスを返します。 この型要素がインタフェースまたはjava.lang.Objectクラスを表す場合は、種類NONEを持つNoTypeを返します。
      戻り値:
      直接スーパー・クラス。存在しない場合はNoType

    • getInterfaces

      List<? extends TypeMirror> getInterfaces()
      このクラスにより直接実装されたインタフェース型、またはこのインタフェースにより直接展開されたインタフェース型を返します。
      戻り値:
      このクラスにより直接実装されたインタフェース型、またはこのインタフェースにより直接展開されたインタフェース型。存在しない場合は空のリスト

    • getTypeParameters

      List<? extends TypeParameterElement> getTypeParameters()
      この型要素の仮型パラメータを宣言順に返します。
      定義:
      getTypeParameters、インタフェース: Parameterizable
      戻り値:
      仮型パラメータ。存在しない場合は空のリスト

    • getRecordComponents

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

      この型要素のレコード・コンポーネントを宣言順で返します。
      実装要件:
      このメソッドのデフォルト実装は、変更不可能な空のリストを返します。
      戻り値:
      レコード・コンポーネント、または空のリスト(存在しない場合)
      導入されたバージョン:
      14

    • getPermittedSubclasses

      default List<? extends TypeMirror> getPermittedSubclasses()
      このメソッドは、Java言語のプレビュー機能である「シール済クラス」に関連付けられています。 プレビュー機能は、将来のリリースで削除されるか、Java言語の永続機能にアップグレードされる可能性があります。

      この型要素の許可されたクラスを宣言順に返します。
      実装要件:
      このメソッドのデフォルト実装は、変更不可能な空のリストを返します。
      戻り値:
      許可されたクラス。存在しない場合は空のリスト
      導入されたバージョン:
      15

    • getEnclosingElement

      Element getEnclosingElement()
      トップ・レベル型のパッケージを返し、入れ子の型に対して構文上、直接囲む要素を返します。
      定義:
      getEnclosingElement、インタフェース: Element
      戻り値:
      トップ・レベル型のパッケージ。入れ子の型の場合は構文上、直接囲む要素
      関連項目:
      Elements.getPackageOf(javax.lang.model.element.Element)