Package dev.gmitch215.bytebox.io

Record Class SerialField

java.lang.Object
java.lang.Record
dev.gmitch215.bytebox.io.SerialField
Record Components:
name - the field's name
typeCode - the JVM type code: one of BCDFIJSZ for a primitive, L for a reference, [ for an array
signature - the JVM type signature for a reference or array, and null for a primitive
public record SerialField(String name, char typeCode, String signature) extends Record
One field, as the serialization format describes it.
Since:
1.0.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    SerialField(String name, char typeCode, String signature)
    Creates an instance of a SerialField record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    boolean
    primitive()
    Returns whether this field is a primitive, which decides where it sorts and how it is written.
    String
    signature()
    Returns the value of the signature record component.
    final String
    toString()
    Returns a string representation of this record class.
    char
    typeCode()
    Returns the value of the typeCode record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SerialField

      public SerialField(String name, char typeCode, String signature)
      Creates an instance of a SerialField record class.
      Parameters:
      name - the value for the name record component
      typeCode - the value for the typeCode record component
      signature - the value for the signature record component

  • Method Details

    • primitive

      public boolean primitive()
      Returns whether this field is a primitive, which decides where it sorts and how it is written.
      Returns:
      whether this field is a primitive, which decides where it sorts and how it is written

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

    • name

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

    • typeCode

      public char typeCode()
      Returns the value of the typeCode record component.
      Returns:
      the value of the typeCode record component

    • signature

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