Module dev.argon.esexpr

Package dev.argon.esexpr.codecs

Class OptionalCodec<T>

java.lang.Object

dev.argon.esexpr.ESExprCodec<Optional<T>>

dev.argon.esexpr.codecs.OptionalCodec<T>

Type Parameters:

T - The type of the optional value.

public class OptionalCodec<T>
extends ESExprCodec<Optional<T>>

A codec for optional values.

Nested Class Summary

Nested classes/interfaces inherited from class dev.argon.esexpr.ESExprCodec

ESExprCodec.FailurePath

Constructor Summary

Constructors

Constructor	Description
OptionalCodec(ESExprCodec<T> itemCodec)	Create a codec for optional values.

Method Summary

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

Methods inherited from class dev.argon.esexpr.ESExprCodec

decode, optionalCodec

Methods inherited from class java.lang.Object

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

Constructor Details

OptionalCodec

public OptionalCodec(ESExprCodec<T> itemCodec)

Create a codec for optional values.

Parameters:

itemCodec - The underlying codec for the values.

Method Details

tags

public ESExprTagSet tags()

Description copied from class: ESExprCodec

Gets the set of tags of values for this type.

Specified by:

tags in class ESExprCodec<Optional<T>>

Returns:

The set of tags.

isEncodedEqual

public boolean isEncodedEqual(Optional<T> x,
 Optional<T> y)

Description copied from class: ESExprCodec

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

Specified by:

isEncodedEqual in class ESExprCodec<Optional<T>>

Parameters:

x - The first value.

y - The second value.

Returns:

true iff the values are equal when encoded.

encode

public ESExpr encode(Optional<T> value)

Description copied from class: ESExprCodec

Encode a value into an ESExpr.

Specified by:

encode in class ESExprCodec<Optional<T>>

Parameters:

value - The value to encode.

Returns:

The encoded ESExpr.

decode

public Optional<T> decode(ESExpr expr,
 ESExprCodec.FailurePath path)
                   throws DecodeException

Description copied from class: ESExprCodec

Decode an ESExpr into a value.

Specified by:

decode in class ESExprCodec<Optional<T>>

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.