モジュール java.base

パッケージ java.lang.reflect

クラスRecordComponent

java.lang.Object

java.lang.reflect.RecordComponent

すべての実装されたインタフェース:

AnnotatedElement

public final class RecordComponent extends Object implements AnnotatedElement

RecordComponentは、レコード・クラスのコンポーネントに関する情報および動的アクセスを提供します。

Java言語仕様を参照してください:

8.10 レコード・クラス

導入されたバージョン:

16

関連項目:

• Class.getRecordComponents()
• Record

メソッドのサマリー

修飾子と型	メソッド	説明
Method	getAccessor()	このレコード・コンポーネントのアクセッサを表すMethodを返します。
AnnotatedType	getAnnotatedType()	型を使用してこのレコード・コンポーネントの宣言された型を指定するAnnotatedTypeオブジェクトを戻します。
<T extends Annotation> T	getAnnotation(Class<T> annotationClass)	存在する場合は、この要素の指定された型の注釈を返し、そうでない場合はnullを返します。
Annotation[]	getAnnotations()	この要素に存在する注釈を返します。
Annotation[]	getDeclaredAnnotations()	この要素に直接存在する注釈を返します。
Class<?>	getDeclaringRecord()	このレコード・コンポーネントを宣言するレコード・クラスを返します。
String	getGenericSignature()	このレコード・コンポーネントの汎用型シグネチャを記述するStringを返します。
Type	getGenericType()	このレコード・コンポーネントの宣言された型を表すTypeオブジェクトを戻します。
String	getName()	このレコード・コンポーネントの名前を返します。
Class<?>	getType()	このレコード・コンポーネントの宣言された型を識別するClassを戻します。
String	toString()	このレコード・コンポーネントを説明する文字列を返します。

クラスjava.lang.Objectで宣言されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

インタフェースjava.lang.reflect.AnnotatedElementで宣言されたメソッド

getAnnotationsByType, getDeclaredAnnotation, getDeclaredAnnotationsByType, isAnnotationPresent

メソッドの詳細

getName

public String getName()

このレコード・コンポーネントの名前を返します。

戻り値:

このレコード・コンポーネントの名前

getType

public Class<?> getType()

このレコード・コンポーネントの宣言された型を識別するClassを戻します。

戻り値:

このレコード・コンポーネントによって表されるコンポーネントの宣言された型を識別するClass

getGenericSignature

public String getGenericSignature()

このレコード・コンポーネントの汎用型シグネチャを記述するStringを返します。

戻り値:

このレコード・コンポーネントの汎用型シグネチャを記述するString

Java Virtual Machine仕様を参照してください:

4.7.9.1 シグネチャ

getGenericType

public Type getGenericType()

このレコード・コンポーネントの宣言された型を表すTypeオブジェクトを戻します。

レコード・コンポーネントの宣言された型がパラメータ化された型である場合、返されるTypeオブジェクトには、ソース・コードで使用される実際の型引数が反映されます。

基になるレコード・コンポーネントのタイプが、型変数またはパラメータ化された型である場合は、作成されます。 そうでない場合、例外タイプは解決されます。

戻り値:

このレコード・コンポーネントの宣言された型を表すTypeオブジェクト

例外:

GenericSignatureFormatError - 汎用レコード・コンポーネントのシグネチャが「Java Virtual Machine仕様」で指定された形式に準拠していない場合

TypeNotPresentException - 基礎となるレコード・コンポーネントの汎用タイプ・シグネチャが、存在しない型宣言を参照している場合

MalformedParameterizedTypeException - 基礎となるレコード・コンポーネントの汎用シグネチャが、なんらかの理由でインスタンス化できないパラメータ化された型を参照している場合

getAnnotatedType

public AnnotatedType getAnnotatedType()

型を使用してこのレコード・コンポーネントの宣言された型を指定するAnnotatedTypeオブジェクトを戻します。

戻り値:

このレコード・コンポーネントの宣言された型を表すオブジェクト

getAccessor

public Method getAccessor()

このレコード・コンポーネントのアクセッサを表すMethodを返します。

戻り値:

このレコード・コンポーネントのアクセッサを表すMethod

getAnnotation

public <T extends Annotation> T getAnnotation(Class<T> annotationClass)

存在する場合は、この要素の指定された型の注釈を返し、そうでない場合はnullを返します。

このメソッドによって返される注釈は宣言注釈であることに注意してください。

定義:

getAnnotation、インタフェースAnnotatedElement

型パラメータ:

T - 照会し、存在する場合に返す注釈の型。

パラメータ:

annotationClass - 注釈型に対応するClassオブジェクト

戻り値:

存在する場合は、この要素の指定された注釈型の注釈。そうでない場合はnull

例外:

NullPointerException - 指定された注釈クラスがnullの場合

getAnnotations

public Annotation[] getAnnotations()

この要素に存在する注釈を返します。 この要素に存在する注釈がない場合、戻り値は長さ0の配列です。 このメソッドの呼出し元は、返された配列を自由に変更することができ、これはほかの呼出し元に返された配列に影響を及ぼしません。

このメソッドによって返される注釈は宣言注釈であることに注意してください。

定義:

getAnnotations、インタフェースAnnotatedElement

戻り値:

この要素に存在する注釈

getDeclaredAnnotations

public Annotation[] getDeclaredAnnotations()

この要素に直接存在する注釈を返します。 このメソッドは継承された注釈を無視します。 この要素に直接存在する注釈がない場合、戻り値は長さ0の配列です。 このメソッドの呼出し元は、返された配列を自由に変更することができ、これはほかの呼出し元に返された配列に影響を及ぼしません。

このメソッドによって返される注釈は宣言注釈であることに注意してください。

定義:

getDeclaredAnnotations、インタフェースAnnotatedElement

戻り値:

この要素に直接存在する注釈

toString

public String toString()

このレコード・コンポーネントを説明する文字列を返します。 このフォーマットでは、レコード・コンポーネント・タイプの後に空白が続き、その後にレコード・コンポーネントの名前が続きます。 たとえば、

    java.lang.String name
    int age
 

オーバーライド:

toString、クラスObject

戻り値:

このレコード・コンポーネントを説明する文字列

getDeclaringRecord

public Class<?> getDeclaringRecord()

このレコード・コンポーネントを宣言するレコード・クラスを返します。

戻り値:

このレコード・コンポーネントを宣言するレコード・クラスです。