Package org.mariadb.jdbc.plugin.codec

Class ByteArrayCodec

java.lang.Object

org.mariadb.jdbc.plugin.codec.ByteArrayCodec

All Implemented Interfaces:

Codec<byte[]>

public class ByteArrayCodec
extends java.lang.Object
implements Codec<byte[]>

Byte array codec.

Field Summary

Fields

Modifier and Type	Field	Description
static byte[]	BINARY_PREFIX	binary prefix
private static java.util.EnumSet<DataType>	COMPATIBLE_TYPES
static ByteArrayCodec	INSTANCE	default instance

Constructor Summary

Constructors

Constructor	Description
ByteArrayCodec()

Method Summary

Modifier and Type	Method	Description
boolean	canDecode(ColumnDecoder column, java.lang.Class<?> type)	If codec can decode this a server datatype to a java class type
boolean	canEncode(java.lang.Object value)	Can Codec encode the java object type
java.lang.String	className()	Codec native type
byte[]	decodeBinary(ReadableByteBuf buf, MutableInt length, ColumnDecoder column, java.util.Calendar cal, Context context)	Decode from a mysql packet binary encoded a value to codec java type
byte[]	decodeText(ReadableByteBuf buf, MutableInt length, ColumnDecoder column, java.util.Calendar cal, Context context)	Decode from a mysql packet text encoded a value to codec java type
void	encodeBinary(Writer encoder, Context context, byte[] value, java.util.Calendar cal, java.lang.Long maxLength)	Binary encode value to writer
void	encodeText(Writer encoder, Context context, byte[] value, java.util.Calendar cal, java.lang.Long maxLength)	Text encode value to writer
int	getApproximateTextProtocolLength(byte[] value, java.lang.Long length)	Get approximate text length, or -1 if unknown
int	getBinaryEncodeType()	Return server encoding data type
private byte[]	getBytes(ReadableByteBuf buf, MutableInt length, ColumnDecoder column)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mariadb.jdbc.plugin.Codec

canEncodeLongData, encodeData, encodeLongData

Field Detail

BINARY_PREFIX

public static final byte[] BINARY_PREFIX

binary prefix

INSTANCE

public static final ByteArrayCodec INSTANCE

default instance

COMPATIBLE_TYPES

private static final java.util.EnumSet<DataType> COMPATIBLE_TYPES

Constructor Detail

ByteArrayCodec

public ByteArrayCodec()

Method Detail

className

public java.lang.String className()

Description copied from interface: Codec

Codec native type

Specified by:

className in interface Codec<byte[]>

Returns:

code native return type

canDecode

public boolean canDecode(ColumnDecoder column,
                         java.lang.Class<?> type)

Description copied from interface: Codec

If codec can decode this a server datatype to a java class type

Specified by:

canDecode in interface Codec<byte[]>

Parameters:

column - server datatype

type - java return class

Returns:

true if codec can decode it

canEncode

public boolean canEncode(java.lang.Object value)

Description copied from interface: Codec

Can Codec encode the java object type

Specified by:

canEncode in interface Codec<byte[]>

Parameters:

value - java object type

Returns:

true if codec can encode java type

decodeText

public byte[] decodeText(ReadableByteBuf buf,
                         MutableInt length,
                         ColumnDecoder column,
                         java.util.Calendar cal,
                         Context context)
                  throws java.sql.SQLDataException

Description copied from interface: Codec

Decode from a mysql packet text encoded a value to codec java type

Specified by:

decodeText in interface Codec<byte[]>

Parameters:

buf - mysql packet buffer

length - encoded value length

column - server column metadata

cal - calendar

context - connection context

Returns:

decoded value

Throws:

java.sql.SQLDataException - if unexpected error occurs during decoding

getBytes

private byte[] getBytes(ReadableByteBuf buf,
                        MutableInt length,
                        ColumnDecoder column)
                 throws java.sql.SQLDataException

Throws:

java.sql.SQLDataException

decodeBinary

public byte[] decodeBinary(ReadableByteBuf buf,
                           MutableInt length,
                           ColumnDecoder column,
                           java.util.Calendar cal,
                           Context context)
                    throws java.sql.SQLDataException

Description copied from interface: Codec

Decode from a mysql packet binary encoded a value to codec java type

Specified by:

decodeBinary in interface Codec<byte[]>

Parameters:

buf - mysql packet buffer

length - encoded value length

column - server column metadata

cal - calendar

context - connection context

Returns:

decoded value

Throws:

java.sql.SQLDataException - if unexpected error occurs during decoding

encodeText

public void encodeText(Writer encoder,
                       Context context,
                       byte[] value,
                       java.util.Calendar cal,
                       java.lang.Long maxLength)
                throws java.io.IOException

Description copied from interface: Codec

Text encode value to writer

Specified by:

encodeText in interface Codec<byte[]>

Parameters:

encoder - writer

context - connection context

value - value to encode

cal - calendar

maxLength - maximum value length

Throws:

java.io.IOException - if any socket error occurs

getApproximateTextProtocolLength

public int getApproximateTextProtocolLength(byte[] value,
                                            java.lang.Long length)

Description copied from interface: Codec

Get approximate text length, or -1 if unknown

Specified by:

getApproximateTextProtocolLength in interface Codec<byte[]>

Parameters:

value - parameter object

length - max length

Returns:

max length if known, -1 if unknown

encodeBinary

public void encodeBinary(Writer encoder,
                         Context context,
                         byte[] value,
                         java.util.Calendar cal,
                         java.lang.Long maxLength)
                  throws java.io.IOException

Description copied from interface: Codec

Binary encode value to writer

Specified by:

encodeBinary in interface Codec<byte[]>

Parameters:

encoder - writer

context - connection context

value - value to encode

cal - calendar

maxLength - maximum value length

Throws:

java.io.IOException - if any socket error occurs

getBinaryEncodeType

public int getBinaryEncodeType()

Description copied from interface: Codec

Return server encoding data type

Specified by:

getBinaryEncodeType in interface Codec<byte[]>

Returns:

server encoding data type