1. Description
2. Method Summary
   1. Methods declared in class Object
   2. Methods declared in interface AnnotatedElement
3. Method Details
   1. getName()
   2. getType()
   3. getGenericSignature()
   4. getGenericType()
   5. getAnnotatedType()
   6. getAccessor()
   7. getAnnotation(Class)
   8. getAnnotations()
   9. getDeclaredAnnotations()
   10. toString()
   11. getDeclaringRecord()

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  Method

  getAccessor()

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

  AnnotatedType

  getAnnotatedType()

  Returns an AnnotatedType object that represents the use of a type to specify the declared type of 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.

  Annotation[]

  getAnnotations()

  Returns annotations that are present on this element.

  Annotation[]

  getDeclaredAnnotations()

  Returns annotations that are directly present on this element.

  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.

  Methods declared in class Object

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

  Modifier and Type

  Method

  Description

  protected Object

  clone()

  Creates and returns a copy of this object.

  boolean

  equals(Object obj)

  Indicates whether some other object is "equal to" this one.

  protected void

  finalize()

  Deprecated, for removal: This API element is subject to removal in a future version.

  Finalization is deprecated and subject to removal in a future release.

  final Class<?>

  getClass()

  Returns the runtime class of this Object.

  int

  hashCode()

  Returns a hash code value for this 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.

  final void

  wait()

  Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

  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(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.

  Methods declared in interface AnnotatedElement

  getAnnotationsByType, getDeclaredAnnotation, getDeclaredAnnotationsByType, isAnnotationPresent

  Modifier and Type

  Method

  Description

  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.

  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.

• Method Details

  • getName

    public String getName()

    Returns the name of this record component.

    Returns: the name of this record component

  • getType

    public Class<?> getType()

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

    Returns: a Class identifying the declared type of the component represented by this record component

  • getGenericSignature

    public String getGenericSignature()

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

    Returns: a String that describes the generic type signature for this record component See Java Virtual Machine Specification: 4.7.9.1 Signatures
    

  • getGenericType

    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: 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

  • getAnnotatedType

    public AnnotatedType getAnnotatedType()

    Returns an AnnotatedType object that represents the use of a type to specify the declared type of this record component.

    Returns: an object representing the declared type of this record component

  • getAccessor

    public Method getAccessor()

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

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

  • getAnnotation

    public <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.

    Specified by: getAnnotation in interface AnnotatedElement Type Parameters: T - the type of the annotation to query for and return if present Parameters: annotationClass - the Class object corresponding to the annotation type Returns: this element's annotation for the specified annotation type if present on this element, else null Throws: NullPointerException - if the given annotation class is null

  • getAnnotations

    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.

    Specified by: getAnnotations in interface AnnotatedElement Returns: annotations present on this element

  • getDeclaredAnnotations

    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.

    Specified by: getDeclaredAnnotations in interface AnnotatedElement Returns: annotations directly present on this element

  • toString

    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

    Overrides: toString in class Object Returns: a string describing this record component

  • getDeclaringRecord

    public Class<?> getDeclaringRecord()

    Returns the record class which declares this record component.

    Returns: The record class declaring this record component.

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples. Other versions.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2026, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.