Package com.fauna.codec.codecs

Class OptionalCodec<E,L extends java.util.Optional<E>>

java.lang.Object

com.fauna.codec.codecs.BaseCodec<L>

com.fauna.codec.codecs.OptionalCodec<E,L>

Type Parameters:

E - The type of the value inside the Optional.

L - The type of the Optional (Optional).

All Implemented Interfaces:

Codec<L>

public final class OptionalCodec<E,L extends java.util.Optional<E>>
extends BaseCodec<L>

Codec for encoding and decoding Optional types.

Field Summary

Fields inherited from class com.fauna.codec.codecs.BaseCodec

TAGS

Constructor Summary

Constructors

Constructor	Description
OptionalCodec(Codec<E> valueCodec)	Constructs a OptionalCodec with the specified Codec.

Method Summary

Modifier and Type	Method	Description
L	decode(UTF8FaunaParser parser)	Decodes an object from the provided UTF8FaunaParser.
void	encode(UTF8FaunaGenerator gen, L obj)	Encodes the specified object using the provided UTF8FaunaGenerator.
java.lang.Class<?>	getCodecClass()	Gets the class associated with this codec.
FaunaType[]	getSupportedTypes()	Gets the set of supported Fauna data types for this codec.

Methods inherited from class com.fauna.codec.codecs.BaseCodec

unexpectedTokenExceptionMessage, unexpectedTypeWhileDecoding, unsupportedTypeDecodingMessage, unsupportedTypeMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionalCodec

public OptionalCodec(Codec<E> valueCodec)

Constructs a OptionalCodec with the specified Codec.

Parameters:

valueCodec - The codec to use for the value.

Method Detail

decode

public L decode(UTF8FaunaParser parser)
         throws CodecException

Description copied from interface: Codec

Decodes an object from the provided UTF8FaunaParser.

Parameters:

parser - The parser to use for reading and decoding the data.

Returns:

The decoded object of type T.

Throws:

CodecException - If an error occurs during decoding.

encode

public void encode(UTF8FaunaGenerator gen,
                   L obj)
            throws CodecException

Description copied from interface: Codec

Encodes the specified object using the provided UTF8FaunaGenerator.

Parameters:

gen - The generator to use for writing and encoding the data.

obj - The object of type T to encode.

Throws:

CodecException - If an error occurs during encoding.

getCodecClass

public java.lang.Class<?> getCodecClass()

Description copied from interface: Codec

Gets the class associated with this codec.

Returns:

The Class type that this codec handles.

getSupportedTypes

public FaunaType[] getSupportedTypes()

Description copied from interface: Codec

Gets the set of supported Fauna data types for this codec.

Returns:

An array of FaunaType values representing the supported types.