Module dev.argon.esexpr

Package dev.argon.esexpr.codecs

Class StringCodec

java.lang.Object

dev.argon.esexpr.ESExprCodec<String>

dev.argon.esexpr.codecs.StringCodec

public class StringCodec
extends ESExprCodec<String>

A codec for string 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<String>	INSTANCE	A codec for string values.

Method Summary

Modifier and Type	Method	Description
String	decode(ESExpr expr, ESExprCodec.FailurePath path)	Decode an ESExpr into a value.
ESExpr	encode(String value)	Encode a value into an ESExpr.
boolean	isEncodedEqual(String x, String y)	Determines whether two values are equal when encoded as an `ESExpr`.
ESExprTagSet	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<String> INSTANCE

A codec for string values.

Method Details

tags

public ESExprTagSet tags()

Description copied from class: ESExprCodec

Gets the set of tags of values for this type.

Specified by:

tags in class ESExprCodec<String>

Returns:

The set of tags.

isEncodedEqual

public boolean isEncodedEqual(String x,
 String y)

Description copied from class: ESExprCodec

Determines whether two values are equal when encoded as an `ESExpr`.

Specified by:

isEncodedEqual in class ESExprCodec<String>

Parameters:

x - The first value.

y - The second value.

Returns:

true iff the values are equal when encoded.

encode

public ESExpr encode(String value)

Description copied from class: ESExprCodec

Encode a value into an ESExpr.

Specified by:

encode in class ESExprCodec<String>

Parameters:

value - The value to encode.

Returns:

The encoded ESExpr.

decode

public String decode(ESExpr expr,
 ESExprCodec.FailurePath path)
              throws DecodeException

Description copied from class: ESExprCodec

Decode an ESExpr into a value.

Specified by:

decode in class ESExprCodec<String>

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.