Package org.mariadb.jdbc.plugin.codec

Class BlobCodec

java.lang.Object

org.mariadb.jdbc.plugin.codec.BlobCodec

All Implemented Interfaces:

Codec<java.sql.Blob>

public class BlobCodec
extends java.lang.Object
implements Codec<java.sql.Blob>

Blob codec

Field Summary

Fields

Modifier and Type	Field	Description
private static java.util.EnumSet<DataType>	COMPATIBLE_TYPES
static BlobCodec	INSTANCE	default instance

Constructor Summary

Constructors

Constructor	Description
BlobCodec()

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
boolean	canEncodeLongData()	Indicate if can encode long data
java.lang.String	className()	Codec native type
java.sql.Blob	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
java.sql.Blob	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
private byte[]	encode(java.io.InputStream is, java.lang.Long maxLength)
void	encodeBinary(Writer encoder, Context context, java.lang.Object value, java.util.Calendar cal, java.lang.Long maxLength)	Binary encode value to writer
byte[]	encodeData(java.sql.Blob value, java.lang.Long maxLength)	binary encoding value to a byte[]
void	encodeLongData(Writer encoder, java.sql.Blob value, java.lang.Long maxLength)	binary encoding value to a long data packet
void	encodeText(Writer encoder, Context context, java.lang.Object value, java.util.Calendar cal, java.lang.Long maxLength)	Text encode value to writer
int	getBinaryEncodeType()	Return server encoding data type

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final BlobCodec INSTANCE

default instance

COMPATIBLE_TYPES

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

Constructor Detail

BlobCodec

public BlobCodec()

Method Detail

className

public java.lang.String className()

Description copied from interface: Codec

Codec native type

Specified by:

className in interface Codec<java.sql.Blob>

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<java.sql.Blob>

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<java.sql.Blob>

Parameters:

value - java object type

Returns:

true if codec can encode java type

decodeText

public java.sql.Blob 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<java.sql.Blob>

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

decodeBinary

public java.sql.Blob 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<java.sql.Blob>

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,
                       java.lang.Object value,
                       java.util.Calendar cal,
                       java.lang.Long maxLength)
                throws java.io.IOException,
                       java.sql.SQLException

Description copied from interface: Codec

Text encode value to writer

Specified by:

encodeText in interface Codec<java.sql.Blob>

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

java.sql.SQLException - if encoding error occurs

encodeBinary

public void encodeBinary(Writer encoder,
                         Context context,
                         java.lang.Object value,
                         java.util.Calendar cal,
                         java.lang.Long maxLength)
                  throws java.io.IOException,
                         java.sql.SQLException

Description copied from interface: Codec

Binary encode value to writer

Specified by:

encodeBinary in interface Codec<java.sql.Blob>

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

java.sql.SQLException - if encoding error occurs

encodeLongData

public void encodeLongData(Writer encoder,
                           java.sql.Blob value,
                           java.lang.Long maxLength)
                    throws java.io.IOException,
                           java.sql.SQLException

Description copied from interface: Codec

binary encoding value to a long data packet

Specified by:

encodeLongData in interface Codec<java.sql.Blob>

Parameters:

encoder - writer

value - value to encode

maxLength - maximum length value

Throws:

java.io.IOException - if any socket error occurs

java.sql.SQLException - if encoding error occurs

encodeData

public byte[] encodeData(java.sql.Blob value,
                         java.lang.Long maxLength)
                  throws java.io.IOException,
                         java.sql.SQLException

Description copied from interface: Codec

binary encoding value to a byte[]

Specified by:

encodeData in interface Codec<java.sql.Blob>

Parameters:

value - value to encode

maxLength - maximum length value

Returns:

encoded value

Throws:

java.io.IOException - if any socket error occurs

java.sql.SQLException - if encoding error occurs

encode

private byte[] encode(java.io.InputStream is,
                      java.lang.Long maxLength)
               throws java.io.IOException

Throws:

java.io.IOException

getBinaryEncodeType

public int getBinaryEncodeType()

Description copied from interface: Codec

Return server encoding data type

Specified by:

getBinaryEncodeType in interface Codec<java.sql.Blob>

Returns:

server encoding data type

canEncodeLongData

public boolean canEncodeLongData()

Description copied from interface: Codec

Indicate if can encode long data

Specified by:

canEncodeLongData in interface Codec<java.sql.Blob>

Returns:

true if possible