Record Class Codec.EitherCodec<A,B>

java.lang.Object
java.lang.Record
com.github.darksoulq.abyssallib.common.serialization.Codec.EitherCodec<A,B>
Type Parameters:
A - The type of the Left branch.
B - The type of the Right branch.
Record Components:
left - Codec for the Left branch.
right - Codec for the Right branch.
All Implemented Interfaces:
Codec<Either<A,B>>
Enclosing interface:
Codec<T>
public static record Codec.EitherCodec<A,B>(Codec<A> left, Codec<B> right) extends Record implements Codec<Either<A,B>>
Internal implementation for handling the Either type, allowing for bifurcated data structures.

  • Constructor Details

    • EitherCodec

      public EitherCodec(Codec<A> left, Codec<B> right)
      Creates an instance of a EitherCodec record class.
      Parameters:
      left - the value for the left record component
      right - the value for the right record component

  • Method Details

    • decode

      public <D> Either<A,B> decode(DynamicOps<D> ops, D input)
      Decodes data into an Either container.
      Specified by:
      decode in interface Codec<A>
      Type Parameters:
      D - The data format type.
      Parameters:
      ops - The operation provider.
      input - The input data.
      Returns:
      An Either instance.

    • encode

      public <D> D encode(DynamicOps<D> ops, Either<A,B> either)
      Encodes an Either container into serialized data.
      Specified by:
      encode in interface Codec<A>
      Type Parameters:
      D - The data format type.
      Parameters:
      ops - The operation provider.
      either - The Either container.
      Returns:
      The serialized data.

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

    • left

      public Codec<A> left()
      Returns the value of the left record component.
      Returns:
      the value of the left record component

    • right

      public Codec<B> right()
      Returns the value of the right record component.
      Returns:
      the value of the right record component