Record Class Descriptor

java.lang.Object
java.lang.Record
atlantafx.validation.Descriptor
Record Components:
name - the name of the rule or rule set this descriptor belongs to
attributes - custom key-value attributes
public record Descriptor(String name, Map<String, @Nullable Object> attributes) extends Record
Identifies the rule or rule set that produced a validation result, together with any custom attributes attached to it.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Descriptor
    EMPTY
    A descriptor with an empty name and no attributes.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Descriptor(String name, Map<String, @Nullable Object> attributes)
    Creates an instance of a Descriptor record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String, @Nullable Object>
    attributes()
    Returns the value of the attributes record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    name()
    Returns the value of the name record component.
    static Descriptor
    of(String name, @Nullable Map<String, @Nullable Object> attributes)
    Creates a descriptor with the given name and an immutable copy of the given attributes.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Field Details

    • EMPTY

      public static final Descriptor EMPTY
      A descriptor with an empty name and no attributes.

  • Constructor Details

    • Descriptor

      public Descriptor(String name, Map<String, @Nullable Object> attributes)
      Creates an instance of a Descriptor record class.
      Parameters:
      name - the value for the name record component
      attributes - the value for the attributes record component

  • Method Details

    • of

      public static Descriptor of(String name, @Nullable Map<String, @Nullable Object> attributes)
      Creates a descriptor with the given name and an immutable copy of the given attributes.

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

    • name

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

    • attributes

      public Map<String, @Nullable Object> attributes()
      Returns the value of the attributes record component.
      Returns:
      the value of the attributes record component