Package com.onec.metadata

Record Class AttributeDescriptor

java.lang.Object
java.lang.Record
com.onec.metadata.AttributeDescriptor
public record AttributeDescriptor(String fieldName, String displayName, String columnName, Class<?> javaType, int length, boolean required, boolean isRef, String refTarget, int precision, int scale, boolean visibleInList, boolean visibleInForm, boolean visibleInDetail, int order, String group, String widthHint, String widget, AttributeDescriptor.Constraints constraints, boolean secret, List<String> previousNames) extends Record

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final record 
    AttributeDescriptor.Constraints
    Declarative validation bounds for an attribute, from @Attribute.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AttributeDescriptor(String fieldName, String displayName, String columnName, Class<?> javaType, int length, boolean required, boolean isRef, String refTarget, int precision, int scale, boolean visibleInList, boolean visibleInForm, boolean visibleInDetail, int order, String group, String widthHint, String widget, AttributeDescriptor.Constraints constraints, boolean secret)
    Backward-compatible constructor for callers predating previousNames.
    AttributeDescriptor(String fieldName, String displayName, String columnName, Class<?> javaType, int length, boolean required, boolean isRef, String refTarget, int precision, int scale, boolean visibleInList, boolean visibleInForm, boolean visibleInDetail, int order, String group, String widthHint, String widget, AttributeDescriptor.Constraints constraints, boolean secret, List<String> previousNames)
    Creates an instance of a AttributeDescriptor record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    columnName()
    Returns the value of the columnName record component.
    AttributeDescriptor.Constraints
    constraints()
    Returns the value of the constraints record component.
    String
    displayName()
    Returns the value of the displayName record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    fieldName()
    Returns the value of the fieldName record component.
    String
    group()
    Returns the value of the group record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isRef()
    Returns the value of the isRef record component.
    Class<?>
    javaType()
    Returns the value of the javaType record component.
    int
    length()
    Returns the value of the length record component.
    int
    order()
    Returns the value of the order record component.
    int
    precision()
    Returns the value of the precision record component.
    List<String>
    previousNames()
    Returns the value of the previousNames record component.
    String
    refTarget()
    Returns the value of the refTarget record component.
    boolean
    required()
    Returns the value of the required record component.
    int
    scale()
    Returns the value of the scale record component.
    boolean
    secret()
    Returns the value of the secret record component.
    final String
    toString()
    Returns a string representation of this record class.
    boolean
    visibleInDetail()
    Returns the value of the visibleInDetail record component.
    boolean
    visibleInForm()
    Returns the value of the visibleInForm record component.
    boolean
    visibleInList()
    Returns the value of the visibleInList record component.
    String
    widget()
    Returns the value of the widget record component.
    String
    widthHint()
    Returns the value of the widthHint record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • AttributeDescriptor

      public AttributeDescriptor(String fieldName, String displayName, String columnName, Class<?> javaType, int length, boolean required, boolean isRef, String refTarget, int precision, int scale, boolean visibleInList, boolean visibleInForm, boolean visibleInDetail, int order, String group, String widthHint, String widget, AttributeDescriptor.Constraints constraints, boolean secret)
      Backward-compatible constructor for callers predating previousNames.

    • AttributeDescriptor

      public AttributeDescriptor(String fieldName, String displayName, String columnName, Class<?> javaType, int length, boolean required, boolean isRef, String refTarget, int precision, int scale, boolean visibleInList, boolean visibleInForm, boolean visibleInDetail, int order, String group, String widthHint, String widget, AttributeDescriptor.Constraints constraints, boolean secret, List<String> previousNames)
      Creates an instance of a AttributeDescriptor record class.
      Parameters:
      fieldName - the value for the fieldName record component
      displayName - the value for the displayName record component
      columnName - the value for the columnName record component
      javaType - the value for the javaType record component
      length - the value for the length record component
      required - the value for the required record component
      isRef - the value for the isRef record component
      refTarget - the value for the refTarget record component
      precision - the value for the precision record component
      scale - the value for the scale record component
      visibleInList - the value for the visibleInList record component
      visibleInForm - the value for the visibleInForm record component
      visibleInDetail - the value for the visibleInDetail record component
      order - the value for the order record component
      group - the value for the group record component
      widthHint - the value for the widthHint record component
      widget - the value for the widget record component
      constraints - the value for the constraints record component
      secret - the value for the secret record component
      previousNames - the value for the previousNames record component

  • Method Details

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • fieldName

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

    • displayName

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

    • columnName

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

    • javaType

      public Class<?> javaType()
      Returns the value of the javaType record component.
      Returns:
      the value of the javaType record component

    • length

      public int length()
      Returns the value of the length record component.
      Returns:
      the value of the length record component

    • required

      public boolean required()
      Returns the value of the required record component.
      Returns:
      the value of the required record component

    • isRef

      public boolean isRef()
      Returns the value of the isRef record component.
      Returns:
      the value of the isRef record component

    • refTarget

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

    • precision

      public int precision()
      Returns the value of the precision record component.
      Returns:
      the value of the precision record component

    • scale

      public int scale()
      Returns the value of the scale record component.
      Returns:
      the value of the scale record component

    • visibleInList

      public boolean visibleInList()
      Returns the value of the visibleInList record component.
      Returns:
      the value of the visibleInList record component

    • visibleInForm

      public boolean visibleInForm()
      Returns the value of the visibleInForm record component.
      Returns:
      the value of the visibleInForm record component

    • visibleInDetail

      public boolean visibleInDetail()
      Returns the value of the visibleInDetail record component.
      Returns:
      the value of the visibleInDetail record component

    • order

      public int order()
      Returns the value of the order record component.
      Returns:
      the value of the order record component

    • group

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

    • widthHint

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

    • widget

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

    • constraints

      public AttributeDescriptor.Constraints constraints()
      Returns the value of the constraints record component.
      Returns:
      the value of the constraints record component

    • secret

      public boolean secret()
      Returns the value of the secret record component.
      Returns:
      the value of the secret record component

    • previousNames

      public List<String> previousNames()
      Returns the value of the previousNames record component.
      Returns:
      the value of the previousNames record component