Module dev.argon.esexpr

Package dev.argon.esexpr.codecs

Class OptionalOptionalValueCodec<T>

java.lang.Object

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

Type Parameters:

T - The element type.

All Implemented Interfaces:

OptionalValueCodec<Optional<T>,T>

public class OptionalOptionalValueCodec<T>
extends Object
implements OptionalValueCodec<Optional<T>,T>

An OptionalValueCodec for Optional values.

Constructor Summary

Constructors

Constructor	Description
OptionalOptionalValueCodec(ESExprCodec<T> elementCodec)	Creates an OptionalValueCodec for Optional values.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

OptionalOptionalValueCodec

public OptionalOptionalValueCodec(ESExprCodec<T> elementCodec)

Creates an OptionalValueCodec for Optional values.

Parameters:

elementCodec - A value codec for the element type.

Method Details

isEncodedEqual

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

Description copied from interface: OptionalValueCodec

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

Specified by:

isEncodedEqual in interface OptionalValueCodec<Optional<T>,T>

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

public Optional<ESExpr> encodeOptional(Optional<T> value)

Description copied from interface: OptionalValueCodec

Encode an optional value into an optional expression.

Specified by:

encodeOptional in interface OptionalValueCodec<Optional<T>,T>

Parameters:

value - The optional value.

Returns:

The optional expression.

decodeOptional

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

Description copied from interface: OptionalValueCodec

Decode an optional expression into an optional value.

Specified by:

decodeOptional in interface OptionalValueCodec<Optional<T>,T>

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.