Record Class Codec.Field<P,T>

java.lang.Object
java.lang.Record
com.github.darksoulq.abyssallib.common.serialization.Codec.Field<P,T>
Type Parameters:
P - The parent object type containing the field.
T - The type of the field itself.
Record Components:
name - The key identifier for this field in the serialized format.
codec - The codec used to process the field data.
getter - A function used to extract the field value from a parent object instance.
Enclosing interface:
Codec<T>
public static record Codec.Field<P,T>(String name, Codec<T> codec, Function<P,T> getter) extends Record
Represents the definition of a single field within a structured object.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Field(String name, Codec<T> codec, Function<P,T> getter)
    Creates an instance of a Field record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Codec<T>
    codec()
    Returns the value of the codec record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    Function<P,T>
    getter()
    Returns the value of the getter record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    name()
    Returns the value of the name record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Field

      public Field(String name, Codec<T> codec, Function<P,T> getter)
      Creates an instance of a Field record class.
      Parameters:
      name - the value for the name record component
      codec - the value for the codec record component
      getter - the value for the getter 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. 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

    • codec

      public Codec<T> codec()
      Returns the value of the codec record component.
      Returns:
      the value of the codec record component

    • getter

      public Function<P,T> getter()
      Returns the value of the getter record component.
      Returns:
      the value of the getter record component