Interface Deserializer<T>

Type Parameters:

T - The generic type that the deserializer can deserialize

All Known Subinterfaces:

CustomizableDeserializer<T>, DeserializerRegistrar<T>, NullableDeserializer<T>, NullableSerde<T>, NumberSerde<N>, Serde<T>, SerdeRegistrar<T>, TemporalSerde<T>, UpdatingDeserializer<T>

All Known Implementing Classes:

AbstractBsonSerde, AbstractOracleJsonSerde, BsonRepresentationSerde, ByteBufferSerde, CodecBsonDecoder, CustomizedObjectArrayDeserializer, DefaultFormattedTemporalSerde, HealthStatusSerde, InetAddressSerde, InstantSerde, LocalDateSerde, LocalDateTimeSerde, LocalTimeSerde, ObjectArraySerde, ObjectDeserializer, OffsetDateTimeSerde, OracleJsonBinarySerde, OracleJsonDurationSerde, OracleJsonLocaleDateSerde, OracleJsonLocaleDateTimeSerde, OracleJsonLocaleTimeSerde, OracleJsonOffsetDateTimeSerde, OracleJsonZonedDateTimeSerde, YearSerde, ZonedDateTimeSerde

@Indexed(Deserializer.class)
public interface Deserializer<T>

Interface that represents a deserializer.

Author:

Jonas Konrad, graemerocher

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Deserializer.DecoderContext	Context object passed to the deserialize(Decoder, io.micronaut.serde.Deserializer.DecoderContext, io.micronaut.core.type.Argument) method along with the decoder.

Method Summary

Modifier and Type	Method	Description
default @NonNull Deserializer<T>	createSpecific(@NonNull Deserializer.DecoderContext context, @NonNull io.micronaut.core.type.Argument<? super T> type)	Create a new child deserializer or return this if non is necessary for the given context.
@Nullable T	deserialize(@NonNull Decoder decoder, @NonNull Deserializer.DecoderContext context, @NonNull io.micronaut.core.type.Argument<? super T> type)	Deserializes from the current state of the Decoder an object of type T.
default T	deserializeNullable(@NonNull Decoder decoder, @NonNull Deserializer.DecoderContext context, @NonNull io.micronaut.core.type.Argument<? super T> type)	Deserializes from the current state of the Decoder an object of type T.
default @Nullable T	getDefaultValue(@NonNull Deserializer.DecoderContext context, @NonNull io.micronaut.core.type.Argument<? super T> type)	Obtains a default value that can be returned from this deserializer in the case where a value is absent.

Method Details

createSpecific

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

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

Parameters:

context - The decoder context

type - 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

deserialize

@Nullable T deserialize(@NonNull Decoder decoder,
 @NonNull Deserializer.DecoderContext context,
 @NonNull io.micronaut.core.type.Argument<? super T> type)
                 throws IOException

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

Parameters:

decoder - The decoder, never null

context - The decoder context, never null

type - The generic type to be deserialized

Returns:

The deserialized object or null

Throws:

IOException - If an error occurs during deserialization of the object

deserializeNullable

default T deserializeNullable(@NonNull Decoder decoder,
 @NonNull Deserializer.DecoderContext context,
 @NonNull io.micronaut.core.type.Argument<? super T> type)
                       throws IOException

Deserializes from the current state of the Decoder an object of type T. If the decoder value is null, this must be permitted. By default, in this case, this method will return null.

Parameters:

decoder - The decoder, never null

context - The decoder context, never null

type - The generic type to be deserialized

Returns:

The deserialized object or null

Throws:

IOException - If an error occurs during deserialization of the object

Since:

2.0.0

getDefaultValue

default @Nullable T getDefaultValue(@NonNull Deserializer.DecoderContext context,
 @NonNull io.micronaut.core.type.Argument<? super T> type)

Obtains a default value that can be returned from this deserializer in the case where a value is absent.

Parameters:

context - The decoder context, never null

type - The generic type to be deserialized

Returns:

The default value