Module dev.argon.esexpr

Package dev.argon.esexpr

Interface OptionalValueCodec<T,E>

Type Parameters:

T - The type of the optional value.

E - The type of the optional elements.

All Known Implementing Classes:

OptionalOptionalValueCodec

public interface OptionalValueCodec<T,E>

A codec for optional values.

Method Summary

Modifier and Type	Method	Description
T	decodeOptional(Optional<ESExpr> expr, ESExprCodec.FailurePath path)	Decode an optional expression into an optional value.
Optional<ESExpr>	encodeOptional(T value)	Encode an optional value into an optional expression.
boolean	isEncodedEqual(T x, T y)	Determines if two optional values, after being encoded, are equal.

Method Details

isEncodedEqual

boolean isEncodedEqual(T x,
 T y)

Determines if two optional values, after being encoded, are equal.

Parameters:

x - The first optional value to compare.

y - The second optional value to compare.

Returns:

true if the two values are encoded equally, false otherwise.

encodeOptional

Optional<ESExpr> encodeOptional(T value)

Encode an optional value into an optional expression.

Parameters:

value - The optional value.

Returns:

The optional expression.

decodeOptional

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

Decode an optional expression into an optional value.

Parameters:

expr - The optional expression.

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

Returns:

The optional value.

Throws:

DecodeException - when the value cannot be decoded.