Package io.micronaut.serde

Interface Serializer<T>

Type Parameters:

T - The type to be serialized

All Known Subinterfaces:

CustomizableSerializer<T>, NullableSerde<T>, NumberSerde<N>, ObjectSerializer<T>, Serde<T>, SerdeRegistrar<T>, SerializerRegistrar<T>, TemporalSerde<T>

All Known Implementing Classes:

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

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

Models a build time serializer. That is a class computed at build-time that can be used to serialize an instance of Serializer.

Author:

Jonas Konrad, graemerocher

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Serializer.EncoderContext	Context object passes to the serialize(Encoder, EncoderContext, Argument, Object) method.

Method Summary

Modifier and Type	Method	Description
default @NonNull Serializer<T>	createSpecific(@NonNull Serializer.EncoderContext context, @NonNull io.micronaut.core.type.Argument<? extends T> type)	Create a more specific serializer for the given definition.
default boolean	isAbsent(@NonNull Serializer.EncoderContext context, T value)	Used for JsonInclude.Include#NON_ABSENT checking.
default boolean	isDefault(@NonNull Serializer.EncoderContext context, T value)	Used for JsonInclude.Include#NON_DEFAULT checking.
default boolean	isEmpty(@NonNull Serializer.EncoderContext context, T value)	Used for JsonInclude.Include#NON_EMPTY checking.
void	serialize(@NonNull Encoder encoder, @NonNull Serializer.EncoderContext context, @NonNull io.micronaut.core.type.Argument<? extends T> type, T value)	Serializes the given value using the passed Encoder.

Method Details

createSpecific

@NonNull
default @NonNull Serializer<T> createSpecific(@NonNull
 @NonNull Serializer.EncoderContext context,
 @NonNull
 @NonNull io.micronaut.core.type.Argument<? extends T> type)
                                       throws SerdeException

Create a more specific serializer for the given definition.

Parameters:

context - The encoder context

type - The type definition including any annotation metadata

Returns:

The more specific serializer

Throws:

SerdeException

serialize

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

Serializes the given value using the passed Encoder.

Parameters:

encoder - The encoder to use

context - The encoder context, never null

type - Models the generic type of the value

value - The value, can be null

Throws:

IOException - If an error occurs during serialization

isEmpty

default boolean isEmpty(@NonNull
 @NonNull Serializer.EncoderContext context,
 @Nullable
 T value)

Used for JsonInclude.Include#NON_EMPTY checking.

Parameters:

context - The encoder context

value - The check to check

Returns:

Return true if the value is empty

isAbsent

default boolean isAbsent(@NonNull
 @NonNull Serializer.EncoderContext context,
 @Nullable
 T value)

Used for JsonInclude.Include#NON_ABSENT checking.

Parameters:

context - The encoder context

value - The value to check

Returns:

Return true if the value is absent

isDefault

default boolean isDefault(@NonNull
 @NonNull Serializer.EncoderContext context,
 @NonNull
 T value)

Used for JsonInclude.Include#NON_DEFAULT checking.

Parameters:

context - The encoder context

value - The check to check

Returns:

Return true if the value is the default value

Since:

1.14