Module dev.argon.esexpr

Package dev.argon.esexpr

Interface VarargCodec<T,E>

Type Parameters:

T - The type of the variable argument value.

E - The type of the repeated elements.

All Known Implementing Classes:

ListVarargCodec

public interface VarargCodec<T,E>

A codec for variable argument values.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	VarargCodec.PositionalPathBuilder	Builds paths for elements of a variable argument.

Method Summary

Modifier and Type	Method	Description
T	decodeVararg(Deque<ESExpr> exprs, VarargCodec.PositionalPathBuilder pathBuilder)	Decode a list of expressions into a variable argument value.
void	encodeVararg(T value, List<ESExpr> exprs)	Encode a variable argument value into a list of expressions.
boolean	isEncodedEqual(T x, T y)	Determines whether two variable argument values are encoded equally.

Method Details

isEncodedEqual

boolean isEncodedEqual(T x,
 T y)

Determines whether two variable argument values are encoded equally.

Parameters:

x - The first variable argument value.

y - The second variable argument value.

Returns:

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

encodeVararg

void encodeVararg(T value,
 List<ESExpr> exprs)

Encode a variable argument value into a list of expressions.

Parameters:

value - The variable argument value.

exprs - The list to which any expressions will be appended.

decodeVararg

T decodeVararg(Deque<ESExpr> exprs,
 VarargCodec.PositionalPathBuilder pathBuilder)
        throws DecodeException

Decode a list of expressions into a variable argument value.

Parameters:

exprs - The expressions.

pathBuilder - A path builder of the current expressions within the decoded object for diagnostic purposes.

Returns:

The variable argument value.

Throws:

DecodeException - when the value cannot be decoded.