Module dev.argon.esexpr

Package dev.argon.esexpr

Class ESExprCodec<T>

java.lang.Object

dev.argon.esexpr.ESExprCodec<T>

Type Parameters:

T - The concrete type.

Direct Known Subclasses:

BigIntegerCodec, BooleanCodec, ByteArrayCodec, DoubleCodec, FloatCodec, ImmutableByteListCodec, ImmutableIntListCodec, ImmutableLongListCodec, ImmutableShortListCodec, IntArrayCodec, IntCodecBase, ListCodec, LongArrayCodec, NonNegativeBigIntegerCodec, OptionalCodec, ShortArrayCodec, StringCodec

public abstract class ESExprCodec<T>
extends Object

Encodes and Decodes ESExpr values into concrete types.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ESExprCodec.FailurePath	The path of a decode failure.

Constructor Summary

Constructors

Constructor	Description
ESExprCodec()	Creates a codec.

Method Summary

Modifier and Type	Method	Description
final T	decode(ESExpr expr)	Decode an ESExpr into a value.
abstract T	decode(ESExpr expr, ESExprCodec.FailurePath path)	Decode an ESExpr into a value.
abstract ESExpr	encode(T value)	Encode a value into an ESExpr.
abstract boolean	isEncodedEqual(T x, T y)	Determines whether two values are equal when encoded as an `ESExpr`.
static <T> ESExprCodec<Optional<T>>	optionalCodec(ESExprCodec<T> itemCodec)	A codec for optional values.
abstract ESExprTagSet	tags()	Gets the set of tags of values for this type.

Methods inherited from class java.lang.Object

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

Constructor Details

ESExprCodec

public ESExprCodec()

Creates a codec.

Method Details

tags

public abstract ESExprTagSet tags()

Gets the set of tags of values for this type.

Returns:

The set of tags.

encode

public abstract ESExpr encode(T value)

Encode a value into an ESExpr.

Parameters:

value - The value to encode.

Returns:

The encoded ESExpr.

decode

public final T decode(ESExpr expr)
               throws DecodeException

Decode an ESExpr into a value.

Parameters:

expr - The ESExpr to decode.

Returns:

The decoded value.

Throws:

DecodeException - when the value cannot be decoded.

decode

public abstract T decode(ESExpr expr,
 ESExprCodec.FailurePath path)
                  throws DecodeException

Decode an ESExpr into a value.

Parameters:

expr - The ESExpr to decode.

path - The path of the current value within the decoded object for diagnostic purposes.

Returns:

The decoded value.

Throws:

DecodeException - when the value cannot be decoded.

isEncodedEqual

public abstract boolean isEncodedEqual(T x,
 T y)

Determines whether two values are equal when encoded as an `ESExpr`.

Parameters:

x - The first value.

y - The second value.

Returns:

true iff the values are equal when encoded.

optionalCodec

public static <T> ESExprCodec<Optional<T>> optionalCodec(ESExprCodec<T> itemCodec)

A codec for optional values.

Type Parameters:

T - The type of the optional value.

Parameters:

itemCodec - The underlying codec for the values.

Returns:

The codec.