Added in API level 34

Summary: Methods | Inherited Methods

RecordComponent

public final class RecordComponent
extends Object implements AnnotatedElement

java.lang.Object
↳	java.lang.reflect.RecordComponent

A RecordComponent provides information about, and dynamic access to, a component of a record class.

See also:

Summary

Public methods
`Method`	`getAccessor()` Returns a `Method` that represents the accessor for this record component.
`<T extends Annotation> T`	`getAnnotation(Class<T> annotationClass)` Returns this element's annotation for the specified type if such an annotation is present, else null. Note that any annotation returned by this method is a declaration annotation.
`Annotation[]`	`getAnnotations()` Returns annotations that are present on this element. Note that any annotations returned by this method are declaration annotations.
`Annotation[]`	`getDeclaredAnnotations()` Returns annotations that are directly present on this element. Note that any annotations returned by this method are declaration annotations.
`Class<?>`	`getDeclaringRecord()` Returns the record class which declares this record component.
`String`	`getGenericSignature()` Returns a `String` that describes the generic type signature for this record component.
`Type`	`getGenericType()` Returns a `Type` object that represents the declared type for this record component.
`String`	`getName()` Returns the name of this record component.
`Class<?>`	`getType()` Returns a `Class` that identifies the declared type for this record component.
`String`	`toString()` Returns a string describing this record component.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.lang.reflect.AnnotatedElement

`abstract <T extends Annotation> T`	`getAnnotation(Class<T> annotationClass)` Returns this element's annotation for the specified type if such an annotation is present, else null.
`abstract Annotation[]`	`getAnnotations()` Returns annotations that are present on this element.
`default <T extends Annotation> T[]`	`getAnnotationsByType(Class<T> annotationClass)` Returns annotations that are associated with this element.
`default <T extends Annotation> T`	`getDeclaredAnnotation(Class<T> annotationClass)` Returns this element's annotation for the specified type if such an annotation is directly present, else null.
`abstract Annotation[]`	`getDeclaredAnnotations()` Returns annotations that are directly present on this element.
`default <T extends Annotation> T[]`	`getDeclaredAnnotationsByType(Class<T> annotationClass)` Returns this element's annotation(s) for the specified type if such annotations are either directly present or indirectly present.
`default boolean`	`isAnnotationPresent(Class<? extends Annotation> annotationClass)` Returns true if an annotation for the specified type is present on this element, else false.

Public methods

getAccessor

Added in API level 34

public Method getAccessor ()

Returns a Method that represents the accessor for this record component.

Returns
`Method`	a `Method` that represents the accessor for this record component

getAnnotation

Added in API level 34

public T getAnnotation (Class<T> annotationClass)

Returns this element's annotation for the specified type if such an annotation is present, else null.

Note that any annotation returned by this method is a declaration annotation.

Parameters
`annotationClass`	`Class`: the Class object corresponding to the annotation type

Returns
`T`	this element's annotation for the specified annotation type if present on this element, else null

Throws
`NullPointerException`

getAnnotations

Added in API level 34

public Annotation[] getAnnotations ()

Returns annotations that are present on this element. If there are no annotations present on this element, the return value is an array of length 0. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.

Note that any annotations returned by this method are declaration annotations.

Returns
`Annotation[]`	annotations present on this element

getDeclaredAnnotations

Added in API level 34

public Annotation[] getDeclaredAnnotations ()

Returns annotations that are directly present on this element. This method ignores inherited annotations. If there are no annotations directly present on this element, the return value is an array of length 0. The caller of this method is free to modify the returned array; it will have no effect on the arrays returned to other callers.

Note that any annotations returned by this method are declaration annotations.

Returns
`Annotation[]`	annotations directly present on this element

getDeclaringRecord

Added in API level 34

public Class<?> getDeclaringRecord ()

Returns the record class which declares this record component.

Returns
`Class<?>`	The record class declaring this record component.

getGenericSignature

Added in API level 34

public String getGenericSignature ()

Returns a String that describes the generic type signature for this record component.

Returns
`String`	a `String` that describes the generic type signature for this record component

getGenericType

Added in API level 34

public Type getGenericType ()

Returns a Type object that represents the declared type for this record component.

If the declared type of the record component is a parameterized type, the Type object returned reflects the actual type arguments used in the source code.

If the type of the underlying record component is a type variable or a parameterized type, it is created. Otherwise, it is resolved.

Returns
`Type`	a `Type` object that represents the declared type for this record component

Throws
`GenericSignatureFormatError`	if the generic record component signature does not conform to the format specified in The Java Virtual Machine Specification
`TypeNotPresentException`	if the generic type signature of the underlying record component refers to a non-existent type declaration
`MalformedParameterizedTypeException`	if the generic signature of the underlying record component refers to a parameterized type that cannot be instantiated for any reason

getName

Added in API level 34

public String getName ()

Returns the name of this record component.

Returns
`String`	the name of this record component

getType

Added in API level 34

public Class<?> getType ()

Returns a Class that identifies the declared type for this record component.

Returns
`Class<?>`	a `Class` identifying the declared type of the component represented by this record component

toString

Added in API level 34

public String toString ()

Returns a string describing this record component. The format is the record component type, followed by a space, followed by the name of the record component. For example:

    java.lang.String name
    int age

Returns
`String`	a string describing this record component