Module dev.argon.esexpr

Package dev.argon.esexpr

Interface ESExprCodec<T>

Type Parameters:

T - The concrete type.

public interface ESExprCodec<T>

Encodes and Decodes ESExpr values into concrete types.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ESExprCodec<BigInteger>	bigIntegerCodec()	A codec for BigInteger values.
static ESExprCodec<Boolean>	booleanCodec()	A codec for Boolean values.
static ESExprCodec<byte[]>	byteArrayCodec()	A codec for byte array values.
default T	decode(ESExpr expr)	Decode an ESExpr into a value.
T	decode(ESExpr expr, ESExprCodec.FailurePath path)	Decode an ESExpr into a value.
static ESExprCodec<Double>	doubleCodec()	A codec for Double values.
ESExpr	encode(T value)	Encode a value into an ESExpr.
static ESExprCodec<Float>	floatCodec()	A codec for Float values.
static ESExprCodec<org.eclipse.collections.api.list.primitive.ImmutableByteList>	immutableByteListCodec()	A codec for ImmutableByteList values.
static ESExprCodec<org.eclipse.collections.api.list.primitive.ImmutableIntList>	immutableIntListCodec()	A codec for ImmutableIntList values.
static ESExprCodec<org.eclipse.collections.api.list.primitive.ImmutableLongList>	immutableLongListCodec()	A codec for ImmutableLongList values.
static <K, V> ESExprCodec<com.google.common.collect.ImmutableMap<K,V>>	immutableMapCodec(ESExprCodec<K> keyCodec, ESExprCodec<V> valueCodec)	Creates an ESExprCodec for encoding and decoding immutable maps.
static <T> ESExprCodec<com.google.common.collect.ImmutableSet<T>>	immutableSetCodec(ESExprCodec<T> elementCodec)	Creates an ESExprCodec for encoding and decoding immutable sets.
static ESExprCodec<org.eclipse.collections.api.list.primitive.ImmutableShortList>	immutableShortListCodec()	A codec for ImmutableShortList values.
static ESExprCodec<int[]>	intArrayCodec()	A codec for int array values.
boolean	isEncodedEqual(T x, T y)	Determines whether two values are equal when encoded as an `ESExpr`.
static <T> ESExprCodec<List<T>>	listCodec(ESExprCodec<T> itemCodec)	A codec for list values.
static ESExprCodec<long[]>	longArrayCodec()	A codec for long array values.
static <K, V> ESExprCodec<Map<K,V>>	mapCodec(ESExprCodec<K> keyCodec, ESExprCodec<V> valueCodec)	Creates an ESExprCodec for encoding and decoding maps.
static <T> ESExprCodec<Optional<T>>	optionalCodec(ESExprCodec<T> itemCodec)	A codec for optional values.
static <T> ESExprCodec<Set<T>>	setCodec(ESExprCodec<T> elementCodec)	Creates an ESExprCodec for encoding and decoding sets of elements.
static ESExprCodec<short[]>	shortArrayCodec()	A codec for short array values.
static ESExprCodec<Byte>	signedByteCodec()	A codec for signed Byte values.
static ESExprCodec<Integer>	signedIntegerCodec()	A codec for signed Integer values.
static ESExprCodec<Long>	signedLongCodec()	A codec for signed Long values.
static ESExprCodec<Short>	signedShortCodec()	A codec for signed Short values.
static ESExprCodec<String>	stringCodec()	A codec for String values.
ESExprTagSet	tags()	Gets the set of tags of values for this type.
static ESExprCodec<com.google.common.primitives.UnsignedInteger>	unsignedIntegerCodec()	A codec for unsigned Integer values.
static ESExprCodec<com.google.common.primitives.UnsignedLong>	unsignedLongCodec()	A codec for unsigned Long values.

Method Details

tags

ESExprTagSet tags()

Gets the set of tags of values for this type.

Returns:

The set of tags.

encode

ESExpr encode(T value)

Encode a value into an ESExpr.

Parameters:

value - The value to encode.

Returns:

The encoded ESExpr.

decode

default 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

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

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

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.

listCodec

static <T> ESExprCodec<List<T>> listCodec(ESExprCodec<T> itemCodec)

A codec for list values.

Type Parameters:

T - The type of the list elements.

Parameters:

itemCodec - The underlying codec for the values.

Returns:

The codec.

booleanCodec

static ESExprCodec<Boolean> booleanCodec()

A codec for Boolean values.

Returns:

The codec.

stringCodec

static ESExprCodec<String> stringCodec()

A codec for String values.

Returns:

The codec.

floatCodec

static ESExprCodec<Float> floatCodec()

A codec for Float values.

Returns:

The codec.

doubleCodec

static ESExprCodec<Double> doubleCodec()

A codec for Double values.

Returns:

The codec.

signedIntegerCodec

static ESExprCodec<Integer> signedIntegerCodec()

A codec for signed Integer values.

Returns:

The codec.

signedLongCodec

static ESExprCodec<Long> signedLongCodec()

A codec for signed Long values.

Returns:

The codec.

signedShortCodec

static ESExprCodec<Short> signedShortCodec()

A codec for signed Short values.

Returns:

The codec.

signedByteCodec

static ESExprCodec<Byte> signedByteCodec()

A codec for signed Byte values.

Returns:

The codec.

unsignedIntegerCodec

static ESExprCodec<com.google.common.primitives.UnsignedInteger> unsignedIntegerCodec()

A codec for unsigned Integer values.

Returns:

The codec.

unsignedLongCodec

static ESExprCodec<com.google.common.primitives.UnsignedLong> unsignedLongCodec()

A codec for unsigned Long values.

Returns:

The codec.

bigIntegerCodec

static ESExprCodec<BigInteger> bigIntegerCodec()

A codec for BigInteger values.

Returns:

The codec.

byteArrayCodec

static ESExprCodec<byte[]> byteArrayCodec()

A codec for byte array values.

Returns:

The codec.

shortArrayCodec

static ESExprCodec<short[]> shortArrayCodec()

A codec for short array values.

Returns:

The codec.

intArrayCodec

static ESExprCodec<int[]> intArrayCodec()

A codec for int array values.

Returns:

The codec.

longArrayCodec

static ESExprCodec<long[]> longArrayCodec()

A codec for long array values.

Returns:

The codec.

immutableByteListCodec

static ESExprCodec<org.eclipse.collections.api.list.primitive.ImmutableByteList> immutableByteListCodec()

A codec for ImmutableByteList values.

Returns:

The codec.

immutableShortListCodec

static ESExprCodec<org.eclipse.collections.api.list.primitive.ImmutableShortList> immutableShortListCodec()

A codec for ImmutableShortList values.

Returns:

The codec.

immutableIntListCodec

static ESExprCodec<org.eclipse.collections.api.list.primitive.ImmutableIntList> immutableIntListCodec()

A codec for ImmutableIntList values.

Returns:

The codec.

immutableLongListCodec

static ESExprCodec<org.eclipse.collections.api.list.primitive.ImmutableLongList> immutableLongListCodec()

A codec for ImmutableLongList values.

Returns:

The codec.

mapCodec

static <K,
V> ESExprCodec<Map<K,V>> mapCodec(ESExprCodec<K> keyCodec,
 ESExprCodec<V> valueCodec)

Creates an ESExprCodec for encoding and decoding maps.

Type Parameters:

K - The type of the keys in the map.

V - The type of the values in the map.

Parameters:

keyCodec - The codec used for encoding and decoding the keys in the map.

valueCodec - The codec used for encoding and decoding the values in the map.

Returns:

An ESExprCodec instance configured to handle maps with the specified key and value types.

immutableMapCodec

static <K,
V>
ESExprCodec<com.google.common.collect.ImmutableMap<K,V>> immutableMapCodec(ESExprCodec<K> keyCodec,
 ESExprCodec<V> valueCodec)

Creates an ESExprCodec for encoding and decoding immutable maps.

Type Parameters:

K - The type of the keys in the map.

V - The type of the values in the map.

Parameters:

keyCodec - The codec used for encoding and decoding the keys in the map.

valueCodec - The codec used for encoding and decoding the values in the map.

Returns:

An ESExprCodec instance configured to handle immutable maps with the specified key and value types.

setCodec

static <T> ESExprCodec<Set<T>> setCodec(ESExprCodec<T> elementCodec)

Creates an ESExprCodec for encoding and decoding sets of elements.

Type Parameters:

T - The type of elements contained in the set.

Parameters:

elementCodec - The codec used for encoding and decoding individual elements within the set.

Returns:

An ESExprCodec instance configured to handle sets of the specified element type.

immutableSetCodec

static <T>
ESExprCodec<com.google.common.collect.ImmutableSet<T>> immutableSetCodec(ESExprCodec<T> elementCodec)

Creates an ESExprCodec for encoding and decoding immutable sets.

Type Parameters:

T - The type of the elements in the set.

Parameters:

elementCodec - The codec used for encoding and decoding the individual elements of the set.

Returns:

An ESExprCodec instance configured to handle immutable sets of the specified element type.