io.asyncer.r2dbc.mysql.codec

Interface Codec<T>

Type Parameters:

T - the type that is handled by this codec.

All Known Subinterfaces:

MassiveCodec<T>, MassiveParameterizedCodec<T>, ParameterizedCodec<T>

public interface Codec<T>

Codec to encode and decode values based on MySQL data binary/text protocol.

Use ParameterizedCodec for support ParameterizedType encoding/decoding.

Method Summary

Modifier and Type	Method and Description
boolean	canDecode(MySqlReadableMetadata metadata, Class<?> target) Checks if the field value can be decoded as specified Class.
boolean	canEncode(Object value) Checks if it can encode the specified value.
T	decode(io.netty.buffer.ByteBuf value, MySqlReadableMetadata metadata, Class<?> target, boolean binary, CodecContext context) Decodes a ByteBuf as specified Class.
MySqlParameter	encode(Object value, CodecContext context) Encode a value to a MySqlParameter.
default @Nullable Class<? extends T>	getMainClass() Gets the main Class that is handled by this codec.

Method Detail

decode

@Nullable
T decode(io.netty.buffer.ByteBuf value,
                   MySqlReadableMetadata metadata,
                   Class<?> target,
                   boolean binary,
                   CodecContext context)

Decodes a ByteBuf as specified Class.

Parameters:

value - the ByteBuf.

metadata - the metadata of the column or the OUT parameter.

target - the specified Class.

binary - if the value should be decoded by binary protocol.

context - the codec context.

Returns:

the decoded result.

canDecode

boolean canDecode(MySqlReadableMetadata metadata,
                  Class<?> target)

Checks if the field value can be decoded as specified Class.

Parameters:

metadata - the metadata of the column or the OUT parameter.

target - the specified Class.

Returns:

if it can decode.

canEncode

boolean canEncode(Object value)

Checks if it can encode the specified value.

Parameters:

value - the specified value.

Returns:

if it can encode.

encode

MySqlParameter encode(Object value,
                      CodecContext context)

Encode a value to a MySqlParameter.

Parameters:

value - the specified value.

context - the codec context.

Returns:

encoded MySqlParameter.

getMainClass

@Nullable
default @Nullable Class<? extends T> getMainClass()

Gets the main Class that is handled by this codec. It is used to fast path the codec lookup if it is not null. If same main Class is handled by multiple codecs, the codec with the highest priority will be used. The priority of the fast path is determined by its order in Codecs.

Returns:

the main Class, or null if it is not in fast path.