- すべてのスーパー・インタフェース:
AnnotatedConstruct,Element,Parameterizable,QualifiedNameable
public interface TypeElement extends Element, Parameterizable, QualifiedNameable
クラスまたはインタフェースのプログラム要素を表します。 クラスまたはインタフェースとそのメンバーに関する情報へのアクセスを提供します。 enumクラスとrecordクラスは特殊な種類のクラスであり、annotationインタフェースは特殊な種類のインタフェースです。
TypeElementはクラスまたはインタフェースの要素を表しますが、DeclaredTypeはクラスまたはインタフェースの型を表します。後者は、前者の使用(または呼出し)です。 単一の要素で型の全ファミリを定義できるジェネリック型との違いがもっともはっきりしています。 たとえば、要素java.util.Setはパラメータ化された型java.util.Set<String>とjava.util.Set<Number> (その他多数)、およびraw型java.util.Setに対応します。
要素のリストを返すこのインタフェースの各メソッドは、プログラム情報の基本となるソースにとって自然な順序でそれらを返します。 たとえば、情報の基本となるソースがJavaソース・コードである場合、要素はソース・コードの順序で返されます。
- APIのノート:
- 表されるクラスまたはインタフェースは、「参照表現」 (ソース・コードまたは実行可能ファイルの出力のいずれか)を持つことができます。 複数のクラスおよびインタフェースが同じ参照表現バッキング構造を共有できます。 たとえば、同じソース・ファイル内で複数のクラスおよびインタフェースを宣言できますが、次のものに限定されません:
- top-levelクラスまたはインタフェースおよび補助クラスおよびインタフェース
- 最上位クラスまたはインタフェースおよびその中の「ネストされたクラスおよびインタフェース」
注釈処理のコンテキストでは、タイプ要素は次のようになります:
- 最初の入力からツールの実行に作成される
- プロセッサによって書き込まれた「ソース・コード」または「クラス・ファイル」から作成
- 構成済環境での「問合せ対象」
- 導入されたバージョン:
- 1.6
- 関連項目:
-
メソッドのサマリー
修飾子と型メソッド説明asType()このクラスまたはインタフェース要素によって定義された型を返し、汎用型を表す要素の「プロトタイプ」を返します。このクラスまたはインタフェースで直接宣言されているフィールド、メソッド、コンストラクタ、レコード・コンポーネント、およびメンバー・クラスとインタフェースを返します。トップレベルのクラスまたはインタフェースのパッケージを戻し、「ネスト」クラスまたはインタフェースを直接囲んでいる字句要素を戻します。List<? extends TypeMirror> このクラスにより直接実装されたインタフェース型、またはこのインタフェースにより直接展開されたインタフェース型を返します。このクラスまたはインタフェース要素の「ネストの種類」を返します。default List<? extends TypeMirror> このクラスまたはインタフェース要素の許可されたクラスを宣言順に返します。このクラスまたはインタフェース要素の完全修飾名を返します。default List<? extends RecordComponentElement> このクラスまたはインタフェース要素のレコード・コンポーネントを宣言順に返します。このクラスまたはインタフェース要素の単純名を返します。このクラスまたはインタフェース要素の直接スーパークラスを返します。List<? extends TypeParameterElement> このクラスまたはインタフェース要素の仮型パラメータを宣言順に返します。インタフェースjavax.lang.model.element.Elementで宣言されたメソッド
accept, equals, getAnnotation, getAnnotationMirrors, getAnnotationsByType, getKind, getModifiers, hashCode
-
メソッドの詳細
-
asType
TypeMirror asType()このクラスまたはインタフェース要素によって定義された型を返し、汎用型を表す要素の「プロトタイプ」を返します。ジェネリック要素は型を1つだけではなく、ファミリで定義します。 これが汎用要素の場合、プロトタイプ型が戻されます。これには、独自のフォーマル型パラメータに対応する型変数での要素呼出しが含まれます。 たとえば、ジェネリック・クラス要素である
C<N extends Number>については、パラメータ化された型C<N>が返されます。 それ以外の場合、非汎用クラスまたはインタフェースでは、プロトタイプ型ミラーは型の使用に対応します。 プロトタイプ自体を含め、プロトタイプ型のコンポーネントには注釈が付いていません。 -
getEnclosedElements
このクラスまたはインタフェースで直接宣言されているフィールド、メソッド、コンストラクタ、レコード・コンポーネント、およびメンバー・クラスとインタフェースを返します。 これには、(implicit)デフォルト・コンストラクタや、列挙型クラスの暗黙的なvaluesおよびvalueOfメソッドなどのmandated要素が含まれます。- 定義:
getEnclosedElements、インタフェースElement- APIのノート:
- 「一般的な精度要件」の特定のインスタンスおよびこのインタフェースに必要な順序付け動作として、囲まれた要素のリストが、クラスまたはインタフェースに関する情報の元のソースに対して自然な順序で返されます。 たとえば、クラスまたはインタフェースに関する情報がソース・ファイルに由来する場合、要素はソース・コード順に返されます。 (ただし、その場合、デフォルト・コンストラクタなどの「暗黙のうちに宣言された」要素の順序は指定されません。)
- 戻り値:
- 適切な順序で囲まれている要素。存在しない場合は空のリスト
- Java言語仕様を参照してください:
-
「8.8.9 デフォルト・コンストラクタ」
「8.9.3 列挙メンバー」
「8.10.3 レコード・メンバー」 - 関連項目:
-
getNestingKind
-
getQualifiedName
Name getQualifiedName()このクラスまたはインタフェース要素の完全修飾名を返します。 より正確には、これは正規名を返します。 正規名を持たないローカル・クラスおよび匿名クラスの場合は、「名前が空です」が返されます。汎用クラスまたはインタフェースの名前には、その仮型パラメータへの参照は含まれません。 たとえば、インタフェース
java.util.Set<E>の完全修飾名は"java.util.Set"です。 ネストされたクラスおよびインタフェースは、"java.util.Map.Entry"と同様に、セパレータとして"."を使用します。- 定義:
getQualifiedName、インタフェースQualifiedNameable- 戻り値:
- このクラスまたはインタフェースの完全指定名。存在しない場合は空の文字列
- Java言語仕様を参照してください:
-
6.7 完全修飾名および正規名
- 関連項目:
-
getSimpleName
Name getSimpleName()このクラスまたはインタフェース要素の単純名を返します。 無名クラスの場合は、「名前が空です」が返されます。- 定義:
getSimpleName、インタフェースElement- 戻り値:
- このクラスまたはインタフェースの単純名。匿名クラスの場合は空の名前
- 関連項目:
-
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()このクラスまたはインタフェース要素のレコード・コンポーネントを宣言順に返します。- 実装要件:
- このメソッドのデフォルト実装は、変更不可能な空のリストを返します。
- 戻り値:
- レコード・コンポーネント、または空のリスト(存在しない場合)
- 導入されたバージョン:
- 16
-
getPermittedSubclasses
default List<? extends TypeMirror> getPermittedSubclasses()このクラスまたはインタフェース要素の許可されたクラスを宣言順に返します。 インタフェースでは、許可されたサブクラスおよびサブインタフェースが返されることに注意してください。- 実装要件:
- このメソッドのデフォルト実装は、変更不可能な空のリストを返します。
- 戻り値:
- 許可されたクラス。存在しない場合は空のリスト
- Java言語仕様を参照してください:
-
「8.1.6 許可された直接サブクラス」
「9.1.4 許可された直接サブクラスおよびサブインタフェース」 - 導入されたバージョン:
- 17
-
getEnclosingElement
Element getEnclosingElement()トップレベルのクラスまたはインタフェースのパッケージを戻し、「ネスト」クラスまたはインタフェースを直接囲んでいる字句要素を戻します。- 定義:
getEnclosingElement、インタフェースElement- 戻り値:
- トップレベルのクラスまたはインタフェースのパッケージ。ネストされたクラスまたはインタフェースを直接囲む要素
- 関連項目:
-