Record Class SchemaNode.FieldSchema

java.lang.Object
java.lang.Record
com.github.darksoulq.abyssallib.common.serialization.schema.SchemaNode.FieldSchema
Record Components:
name - field name
type - field schema
optional - whether the field is optional
defaultValue - default value for the field
description - field description
Enclosing interface:
SchemaNode
public static record SchemaNode.FieldSchema(String name, SchemaNode type, boolean optional, Object defaultValue, String description) extends Record
Describes a field within a record schema.

  • Constructor Details

    • FieldSchema

      public FieldSchema(String name, SchemaNode type, boolean optional, Object defaultValue, String description)
      Creates an instance of a FieldSchema record class.
      Parameters:
      name - the value for the name record component
      type - the value for the type record component
      optional - the value for the optional record component
      defaultValue - the value for the defaultValue record component
      description - the value for the description record component

  • Method Details

    • to

      public <T> T to(DynamicOps<T> ops)
      Converts this field schema into a structural representation.
      Type Parameters:
      T - the target output type
      Parameters:
      ops - the serialization operations provider
      Returns:
      the serialized field

    • 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 the compare method from their corresponding wrapper classes.
      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

    • type

      public SchemaNode type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • optional

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

    • defaultValue

      public Object defaultValue()
      Returns the value of the defaultValue record component.
      Returns:
      the value of the defaultValue record component

    • description

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