Module dev.argon.esexpr

Package dev.argon.esexpr.codecs

Class BooleanESExprCodec

java.lang.Object

dev.argon.esexpr.ESExprCodec<Boolean>

dev.argon.esexpr.codecs.BooleanESExprCodec

public class BooleanESExprCodec
extends ESExprCodec<Boolean>

A codec for boolean values.

Nested Class Summary

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

ESExprCodec.FailurePath

Field Summary

Fields

Modifier and Type	Field	Description
static final ESExprCodec<Boolean>	INSTANCE	A codec for boolean values.

Method Summary

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

Field Details

INSTANCE

public static final ESExprCodec<Boolean> INSTANCE

A codec for boolean 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<Boolean>

Returns:

The set of tags.

encode

@NotNull
public @NotNull ESExpr encode(@NotNull
 @NotNull Boolean value)

Description copied from class: ESExprCodec

Encode a value into an ESExpr.

Specified by:

encode in class ESExprCodec<Boolean>

Parameters:

value - The value to encode.

Returns:

The encoded ESExpr.

decode

@NotNull
public @NotNull Boolean decode(@NotNull
 @NotNull ESExpr expr,
 @NotNull
 ESExprCodec.FailurePath path)
                        throws DecodeException

Description copied from class: ESExprCodec

Decode an ESExpr into a value.

Specified by:

decode in class ESExprCodec<Boolean>

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.