Class DefaultFormattedTemporalSerde<T extends TemporalAccessor>

java.lang.Object

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

Type Parameters:

T - The temporal type

All Implemented Interfaces:

Deserializer<T>, FormattedDeserializer<T>, FormattedSerde<T>, FormattedSerializer<T>, Serde<T>, Serializer<T>, TemporalSerde<T>

Direct Known Subclasses:

InstantSerde, LocalDateSerde, LocalDateTimeSerde, LocalTimeSerde, OffsetDateTimeSerde, ZonedDateTimeSerde

public abstract sealed class DefaultFormattedTemporalSerde<T extends TemporalAccessor>
extends Object
implements TemporalSerde<T>
permits LocalDateSerde, LocalDateTimeSerde (not exhaustive)

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

Author:

gkrocher

Nested Class Summary

Nested classes/interfaces inherited from interface Deserializer

Deserializer.DecoderContext

Nested classes/interfaces inherited from interface Serializer

Serializer.EncoderContext

Field Summary

Fields inherited from interface TemporalSerde

UTC

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultFormattedTemporalSerde(DateTimeFormatter stringFormatter)

Method Summary

Modifier and Type	Method	Description
protected static Optional<DateTimeFormatter>	createFormatter(SerdeConfiguration configuration)
protected DefaultFormattedTemporalSerde<T>	createSpecific(SerdeConfiguration configuration)	Create the same serde with new configuration.
Deserializer<T>	createSpecific(Deserializer.DecoderContext decoderContext, io.micronaut.core.type.Argument<? super T> context)	Create a new child deserializer or return this if non is necessary for the given context.
Deserializer<T>	createSpecific(Deserializer.DecoderContext decoderContext, io.micronaut.core.type.Argument<? super T> type, FormatConfiguration format)	Create a more specific deserializer for the given definition and format configuration.
Serializer<T>	createSpecific(Serializer.EncoderContext context, io.micronaut.core.type.Argument<? extends T> type)	Create a more specific serializer for the given definition.
Serializer<T>	createSpecific(Serializer.EncoderContext context, io.micronaut.core.type.Argument<? extends T> type, FormatConfiguration format)	Create a more specific serializer for the given definition and format configuration.
protected DefaultFormattedTemporalSerde<T>	createSpecific(DateTimeFormatter stringFormatter, SerdeConfiguration.TimeShape timeWriteShape, SerdeConfiguration.NumericTimeUnit numericUnit)	Create the same serde with a new string formatter and explicit shape-derived values.
protected DefaultFormattedTemporalSerde<T>	createSpecific(DateTimeFormatter stringFormatter, SerdeConfiguration.TimeShape timeWriteShape, SerdeConfiguration.NumericTimeUnit numericUnit, FormatConfiguration format)	Create the same serde with a new string formatter and explicit format-derived values.
protected DefaultFormattedTemporalSerde<T>	createSpecificForDeserialization(DateTimeFormatter stringFormatter, SerdeConfiguration.TimeShape timeWriteShape, SerdeConfiguration.NumericTimeUnit numericUnit, SerdeConfiguration configuration, Set<DeserializationConfiguration.Feature> features)	Create the same serde with deserialization configuration-derived values.
protected DefaultFormattedTemporalSerde<T>	createSpecificForDeserialization(DateTimeFormatter stringFormatter, SerdeConfiguration.TimeShape timeWriteShape, SerdeConfiguration.NumericTimeUnit numericUnit, FormatConfiguration format, Set<DeserializationConfiguration.Feature> features)	Create the same serde with deserialization format-derived values.
protected DefaultFormattedTemporalSerde<T>	createSpecificForSerialization(DateTimeFormatter stringFormatter, SerdeConfiguration.TimeShape timeWriteShape, SerdeConfiguration.NumericTimeUnit numericUnit, FormatConfiguration format, Set<SerializationConfiguration.Feature> features)	Create the same serde with serialization format-derived values.
protected DateTimeFormatter	defaultStringFormatter()
protected DateTimeFormatter	defaultStringFormatter(FormatConfiguration format)
protected DateTimeFormatter	defaultStringFormatter(FormatConfiguration format, Set<SerializationConfiguration.Feature> features)
final T	deserialize(Decoder decoder, Deserializer.DecoderContext decoderContext, io.micronaut.core.type.Argument<? super T> type)	Deserializes from the current state of the Decoder an object of type T.
final void	serialize(Encoder encoder, Serializer.EncoderContext context, io.micronaut.core.type.Argument<? extends T> type, T value)	Serializes the given value using the passed Encoder.

Methods inherited from class Object

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

Methods inherited from interface Deserializer

deserializeNullable, getDefaultValue

Methods inherited from interface Serializer

isAbsent, isDefault, isEmpty

Methods inherited from interface TemporalSerde

query

Constructor Details

DefaultFormattedTemporalSerde

protected DefaultFormattedTemporalSerde(DateTimeFormatter stringFormatter)

Parameters:

stringFormatter - The resolved string formatter

Method Details

createFormatter

protected static Optional<DateTimeFormatter> createFormatter(SerdeConfiguration configuration)

createSpecific

public Serializer<T> createSpecific(Serializer.EncoderContext context,
 io.micronaut.core.type.Argument<? extends T> type)

Description copied from interface: Serializer

Create a more specific serializer for the given definition.

Specified by:

createSpecific in interface Serializer<T extends TemporalAccessor>

Specified by:

createSpecific in interface TemporalSerde<T extends TemporalAccessor>

Parameters:

context - The encoder context

type - The type definition including any annotation metadata

Returns:

The more specific serializer

createSpecific

public Serializer<T> createSpecific(Serializer.EncoderContext context,
 io.micronaut.core.type.Argument<? extends T> type,
 FormatConfiguration format)

Description copied from interface: FormattedSerializer

Create a more specific serializer for the given definition and format configuration.

Specified by:

createSpecific in interface FormattedSerializer<T extends TemporalAccessor>

Specified by:

createSpecific in interface TemporalSerde<T extends TemporalAccessor>

Parameters:

context - The encoder context

type - The type definition including any annotation metadata

format - The format configuration

Returns:

The more specific serializer

createSpecific

public Deserializer<T> createSpecific(Deserializer.DecoderContext decoderContext,
 io.micronaut.core.type.Argument<? super T> context)
                               throws SerdeException

Description copied from interface: Deserializer

Create a new child deserializer or return this if non is necessary for the given context.

Specified by:

createSpecific in interface Deserializer<T extends TemporalAccessor>

Specified by:

createSpecific in interface TemporalSerde<T extends TemporalAccessor>

Parameters:

decoderContext - The decoder context

context - The context, including any annotation metadata and type information to narrow the deserializer type

Returns:

An instance of the same type of deserializer

Throws:

SerdeException

createSpecific

public Deserializer<T> createSpecific(Deserializer.DecoderContext decoderContext,
 io.micronaut.core.type.Argument<? super T> type,
 FormatConfiguration format)
                               throws SerdeException

Description copied from interface: FormattedDeserializer

Create a more specific deserializer for the given definition and format configuration.

Specified by:

createSpecific in interface FormattedDeserializer<T extends TemporalAccessor>

Specified by:

createSpecific in interface TemporalSerde<T extends TemporalAccessor>

Parameters:

decoderContext - The decoder context

type - The type definition including any annotation metadata

format - The format configuration

Returns:

The more specific deserializer

Throws:

SerdeException - If the deserializer cannot be selected

createSpecific

protected DefaultFormattedTemporalSerde<T> createSpecific(SerdeConfiguration configuration)

Create the same serde with new configuration.

Parameters:

configuration - The new configuration

Returns:

The updated serde

createSpecific

protected DefaultFormattedTemporalSerde<T> createSpecific(DateTimeFormatter stringFormatter,
 SerdeConfiguration.TimeShape timeWriteShape,
 SerdeConfiguration.NumericTimeUnit numericUnit)

Create the same serde with a new string formatter and explicit shape-derived values.

Parameters:

stringFormatter - The resolved string formatter

timeWriteShape - The time write shape

numericUnit - The numeric time unit

Returns:

The updated serde

createSpecific

protected DefaultFormattedTemporalSerde<T> createSpecific(DateTimeFormatter stringFormatter,
 SerdeConfiguration.TimeShape timeWriteShape,
 SerdeConfiguration.NumericTimeUnit numericUnit,
 FormatConfiguration format)

Create the same serde with a new string formatter and explicit format-derived values.

Parameters:

stringFormatter - The resolved string formatter

timeWriteShape - The time write shape

numericUnit - The numeric time unit

format - The format configuration

Returns:

The updated serde

createSpecificForSerialization

protected DefaultFormattedTemporalSerde<T> createSpecificForSerialization(DateTimeFormatter stringFormatter,
 SerdeConfiguration.TimeShape timeWriteShape,
 SerdeConfiguration.NumericTimeUnit numericUnit,
 FormatConfiguration format,
 Set<SerializationConfiguration.Feature> features)

Create the same serde with serialization format-derived values.

Parameters:

stringFormatter - The resolved string formatter

timeWriteShape - The time write shape

numericUnit - The numeric time unit

format - The format configuration

features - The active serialization features

Returns:

The updated serde

createSpecificForDeserialization

protected DefaultFormattedTemporalSerde<T> createSpecificForDeserialization(DateTimeFormatter stringFormatter,
 SerdeConfiguration.TimeShape timeWriteShape,
 SerdeConfiguration.NumericTimeUnit numericUnit,
 FormatConfiguration format,
 Set<DeserializationConfiguration.Feature> features)

Create the same serde with deserialization format-derived values.

Parameters:

stringFormatter - The resolved string formatter

timeWriteShape - The time write shape

numericUnit - The numeric time unit

format - The format configuration

features - The active deserialization features

Returns:

The updated serde

createSpecificForDeserialization

protected DefaultFormattedTemporalSerde<T> createSpecificForDeserialization(DateTimeFormatter stringFormatter,
 SerdeConfiguration.TimeShape timeWriteShape,
 SerdeConfiguration.NumericTimeUnit numericUnit,
 SerdeConfiguration configuration,
 Set<DeserializationConfiguration.Feature> features)

Create the same serde with deserialization configuration-derived values.

Parameters:

stringFormatter - The resolved string formatter

timeWriteShape - The time write shape

numericUnit - The numeric time unit

configuration - The serde configuration

features - The active deserialization features

Returns:

The updated serde

serialize

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

Description copied from interface: Serializer

Serializes the given value using the passed Encoder.

Specified by:

serialize in interface Serializer<T extends TemporalAccessor>

Parameters:

encoder - The encoder to use

context - The encoder context, never null

type - Models the generic type of the value

value - The value to serialize, never null. Callers should encode null values directly.

Throws:

IOException - If an error occurs during serialization

deserialize

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

Description copied from interface: Deserializer

Deserializes from the current state of the Decoder an object of type T.

Specified by:

deserialize in interface Deserializer<T extends TemporalAccessor>

Parameters:

decoder - The decoder, never null

decoderContext - The decoder context, never null

type - The generic type to be deserialized

Returns:

The deserialized object, never null. Use Deserializer.deserializeNullable(Decoder, DecoderContext, Argument) when the decoder value can be null.

Throws:

IOException - If an error occurs during deserialization of the object

defaultStringFormatter

protected DateTimeFormatter defaultStringFormatter()

Returns:

The default formatter to use when configuration doesn't define one.

defaultStringFormatter

protected DateTimeFormatter defaultStringFormatter(FormatConfiguration format)

Parameters:

format - The format configuration

Returns:

The default formatter to use for this format when configuration doesn't define one.

defaultStringFormatter

protected DateTimeFormatter defaultStringFormatter(FormatConfiguration format,
 Set<SerializationConfiguration.Feature> features)

Parameters:

format - The format configuration

features - The active serialization features

Returns:

The default formatter to use for this format when configuration doesn't define one.