Class EitherCodec<A,B>

java.lang.Object

com.github.darksoulq.abyssallib.common.serialization.codecs.EitherCodec<A,B>

Type Parameters:

A - Left value type.

B - Right value type.

All Implemented Interfaces:

Codec<Either<A,B>>

public class EitherCodec<A,B>
extends Object
implements Codec<Either<A,B>>

Codec representing a value that may be decoded by either of two codecs.

Nested Class Summary

Nested classes/interfaces inherited from interface Codec

Codec.Decoder<T>, Codec.Encoder<T>, Codec.Pair<A,B>, Codec.Tuple3<A,B,C>, Codec.Tuple4<A,B,C,D>

Constructor Summary

Constructors

Constructor	Description
EitherCodec(Codec<A> left, Codec<B> right)	Creates an either codec.

Method Summary

Modifier and Type	Method	Description
<R> R	accept(CodecVisitor<R> visitor)	Routes this instance into the visitor API to construct contextual schema layouts.
<D> DataResult<Either<A,B>>	decode(DynamicOps<D> ops, D input)	Decodes a serialized input of a specific data format into a Java object.
String	describe()	Outputs a structural description of the expected format for this codec.
<D> DataResult<D>	encode(DynamicOps<D> ops, Either<A,B> either)	Encodes a Java object into its serialized representation.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Codec

collection, comapFlatMap, decodeAsync, describe, encodeAsync, fieldOf, flatComapMap, flatXmap, immutableList, immutableSet, list, maxLength, minLength, nullable, oneOf, optional, optionalFieldOf, optionalFieldOf, orElse, positive, range, regex, restrict, schema, set, structuralEquals, transform, unchecked, validate, validate, versioned, withSchema, xmap

Constructor Details

EitherCodec

public EitherCodec(Codec<A> left,
 Codec<B> right)

Creates an either codec.

Parameters:

left - Left branch codec.

right - Right branch codec.

Method Details

decode

public <D> DataResult<Either<A,B>> decode(DynamicOps<D> ops,
 D input)

Description copied from interface: Codec

Decodes a serialized input of a specific data format into a Java object.

Specified by:

decode in interface Codec<A>

Type Parameters:

D - The type of the serialized data.

Parameters:

ops - The provider defining how to navigate and read data of type D.

input - The raw serialized input to be processed.

Returns:

A DataResult containing the decoded object or an error state.

encode

public <D> DataResult<D> encode(DynamicOps<D> ops,
 Either<A,B> either)

Description copied from interface: Codec

Encodes a Java object into its serialized representation.

Specified by:

encode in interface Codec<A>

Type Parameters:

D - The target type of the serialized data.

Parameters:

ops - The provider defining how to construct data of type D.

either - The Java object instance to be serialized.

Returns:

A DataResult containing the serialized data or an error state.

describe

public String describe()

Description copied from interface: Codec

Outputs a structural description of the expected format for this codec. Useful for schema generation and validation debugging.

Specified by:

describe in interface Codec<A>

Returns:

The schema definition representing the target type.

accept

public <R> R accept(CodecVisitor<R> visitor)

Description copied from interface: Codec

Routes this instance into the visitor API to construct contextual schema layouts.

Specified by:

accept in interface Codec<A>

Type Parameters:

R - The layout target natively returning explicitly mapped variants.

Parameters:

visitor - The evaluation logic instance.

Returns:

Evaluated variant functionally extracting outputs.