Module dev.argon.esexpr

Package dev.argon.esexpr.codecs

Class ListCodec<T>

java.lang.Object

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

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

Type Parameters:

T - The type of the list elements.

public class ListCodec<T>
extends ESExprCodec<List<T>>

A codec for list values.

Nested Class Summary

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

ESExprCodec.FailurePath

Constructor Summary

Constructors

Constructor	Description
ListCodec(ESExprCodec<T> itemCodec)	Create a codec for list values.

Method Summary

Modifier and Type	Method	Description
@NotNull List<T>	decode(@NotNull ESExpr expr, @NotNull ESExprCodec.FailurePath path)	Decode an ESExpr into a value.
@NotNull ESExpr	encode(@NotNull List<T> value)	Encode a value into an ESExpr.
@NotNull Set<@NotNull ESExprTag>	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

ListCodec

public ListCodec(ESExprCodec<T> itemCodec)

Create a codec for list values.

Parameters:

itemCodec - The underlying codec for the values.

Method Details

tags

@NotNull
public @NotNull Set<@NotNull ESExprTag> tags()

Description copied from class: ESExprCodec

Gets the set of tags of values for this type.

Specified by:

tags in class ESExprCodec<List<T>>

Returns:

The set of tags.

encode

@NotNull
public @NotNull ESExpr encode(@NotNull
 @NotNull List<T> value)

Description copied from class: ESExprCodec

Encode a value into an ESExpr.

Specified by:

encode in class ESExprCodec<List<T>>

Parameters:

value - The value to encode.

Returns:

The encoded ESExpr.

decode

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

Description copied from class: ESExprCodec

Decode an ESExpr into a value.

Specified by:

decode in class ESExprCodec<List<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.