io.micronaut.serde.support.serdes

Class DefaultFormattedTemporalSerde<T extends java.time.temporal.TemporalAccessor>

java.lang.Object

io.micronaut.serde.support.serdes.DefaultFormattedTemporalSerde<T>

Type Parameters:

T - The temporal type

All Implemented Interfaces:

Deserializer<T>, Serde<T>, Serializer<T>, TemporalSerde<T>, NullableDeserializer<T>, NullableSerde<T>

Direct Known Subclasses:

InstantSerde, LocalDateSerde, LocalDateTimeSerde, LocalTimeSerde, OffsetDateTimeSerde, ZonedDateTimeSerde

public abstract class DefaultFormattedTemporalSerde<T extends java.time.temporal.TemporalAccessor>
extends java.lang.Object
implements TemporalSerde<T>

Super class that can be used for the default date/time formatting.

Author:

gkrocher

Nested Class Summary

Nested classes/interfaces inherited from interface io.micronaut.serde.Serializer

Serializer.EncoderContext

Nested classes/interfaces inherited from interface io.micronaut.serde.Deserializer

Deserializer.DecoderContext

Field Summary

Fields inherited from interface io.micronaut.serde.support.serdes.TemporalSerde

UTC

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultFormattedTemporalSerde(SerdeConfiguration configuration) Allows configuring a default time format for temporal date/time types.

Method Summary

Modifier and Type	Method and Description
T	deserializeNonNull(Decoder decoder, Deserializer.DecoderContext decoderContext, io.micronaut.core.type.Argument<? super T> type) A method that is invoked when the value is known not to be null.
protected abstract T	deserializeNonNullWithoutFormat(Decoder decoder, Deserializer.DecoderContext decoderContext, io.micronaut.core.type.Argument<? super T> type) A method that is invoked when the value is known not to be null.
protected abstract java.time.format.DateTimeFormatter	getDefaultFormatter()
void	serialize(Encoder encoder, Serializer.EncoderContext context, T value, io.micronaut.core.type.Argument<? extends T> type) Serializes the given value using the passed Encoder.
protected abstract void	serializeWithoutFormat(Encoder encoder, Serializer.EncoderContext context, T value, io.micronaut.core.type.Argument<? extends T> type) Serializes the given value using the passed Encoder.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.serde.support.serdes.TemporalSerde

createSpecific, createSpecific, query

Methods inherited from interface io.micronaut.serde.Serializer

isAbsent, isEmpty

Methods inherited from interface io.micronaut.serde.util.NullableDeserializer

allowNull, deserialize

Methods inherited from interface io.micronaut.serde.Deserializer

getDefaultValue

Constructor Detail

DefaultFormattedTemporalSerde

protected DefaultFormattedTemporalSerde(@NonNull
                                        SerdeConfiguration configuration)

Allows configuring a default time format for temporal date/time types.

Parameters:

configuration - The configuration

Method Detail

getDefaultFormatter

@NonNull
protected abstract java.time.format.DateTimeFormatter getDefaultFormatter()

Returns:

The default formatter.

serialize

public final void serialize(Encoder encoder,
                            Serializer.EncoderContext context,
                            T value,
                            io.micronaut.core.type.Argument<? extends T> type)
                     throws java.io.IOException

Description copied from interface: Serializer

Serializes the given value using the passed Encoder.

Specified by:

serialize in interface Serializer<T extends java.time.temporal.TemporalAccessor>

Parameters:

encoder - The encoder to use

context - The encoder context, never null

value - The value, can be null

type - Models the generic type of the value

Throws:

java.io.IOException - If an error occurs during serialization

deserializeNonNull

public final T deserializeNonNull(Decoder decoder,
                                  Deserializer.DecoderContext decoderContext,
                                  io.micronaut.core.type.Argument<? super T> type)
                           throws java.io.IOException

Description copied from interface: NullableDeserializer

A method that is invoked when the value is known not to be null.

Specified by:

deserializeNonNull in interface NullableDeserializer<T extends java.time.temporal.TemporalAccessor>

Parameters:

decoder - The decoder

decoderContext - The decoder context

type - The type

Returns:

The value

Throws:

java.io.IOException - if something goes wrong during deserialization

serializeWithoutFormat

protected abstract void serializeWithoutFormat(Encoder encoder,
                                               Serializer.EncoderContext context,
                                               T value,
                                               io.micronaut.core.type.Argument<? extends T> type)
                                        throws java.io.IOException

Serializes the given value using the passed Encoder.

Parameters:

encoder - The encoder to use

context - The encoder context, never null

value - The value, can be null

type - Models the generic type of the value

Throws:

java.io.IOException - If an error occurs during serialization

deserializeNonNullWithoutFormat

protected abstract T deserializeNonNullWithoutFormat(Decoder decoder,
                                                     Deserializer.DecoderContext decoderContext,
                                                     io.micronaut.core.type.Argument<? super T> type)
                                              throws java.io.IOException

A method that is invoked when the value is known not to be null.

Parameters:

decoder - The decoder

decoderContext - The decoder context

type - The type

Returns:

The value

Throws:

java.io.IOException - if something goes wrong during deserialization