Record Class JavaRecordComponent

java.lang.Object
java.lang.Record
dev.archunitjava.model.JavaRecordComponent
All Implemented Interfaces:
Comparable<JavaRecordComponent>
public record JavaRecordComponent(JavaTypeName owner, String name, String descriptor, GenericFieldView typeView, List<JavaAnnotationOccurrence> annotations, DeclarationLocation location) extends Record implements Comparable<JavaRecordComponent>
Immutable record component, distinct from its generated field and accessor.

  • Constructor Details

    • JavaRecordComponent

      public JavaRecordComponent(JavaTypeName owner, String name, String descriptor, GenericFieldView typeView, List<JavaAnnotationOccurrence> annotations, DeclarationLocation location)
      Creates an instance of a JavaRecordComponent record class.
      Parameters:
      owner - the value for the owner record component
      name - the value for the name record component
      descriptor - the value for the descriptor record component
      typeView - the value for the typeView record component
      annotations - the value for the annotations record component
      location - the value for the location record component

  • Method Details

    • type

      public JvmType type()

    • compareTo

      public int compareTo(JavaRecordComponent other)
      Specified by:
      compareTo in interface Comparable<JavaRecordComponent>

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • owner

      public JavaTypeName owner()
      Returns the value of the owner record component.
      Returns:
      the value of the owner record component

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • descriptor

      public String descriptor()
      Returns the value of the descriptor record component.
      Returns:
      the value of the descriptor record component

    • typeView

      public GenericFieldView typeView()
      Returns the value of the typeView record component.
      Returns:
      the value of the typeView record component

    • annotations

      public List<JavaAnnotationOccurrence> annotations()
      Returns the value of the annotations record component.
      Returns:
      the value of the annotations record component

    • location

      public DeclarationLocation location()
      Returns the value of the location record component.
      Returns:
      the value of the location record component