com.singlestore.jdbc.plugin.codec

Class BlobCodec

java.lang.Object

com.singlestore.jdbc.plugin.codec.BlobCodec

All Implemented Interfaces:

Codec<Blob>

public class BlobCodec
extends Object
implements Codec<Blob>

Field Summary

Fields

Modifier and Type	Field and Description
static BlobCodec	INSTANCE

Constructor Summary

Constructors

Constructor and Description
BlobCodec()

Method Summary

Modifier and Type	Method and Description
boolean	canDecode(com.singlestore.jdbc.client.ColumnDecoder column, Class<?> type) If codec can decode this a server datatype to a java class type
boolean	canEncode(Object value) Can Codec encode the java object type
String	className() Codec native type
Blob	decodeBinary(com.singlestore.jdbc.client.ReadableByteBuf buf, MutableInt length, com.singlestore.jdbc.client.ColumnDecoder column, Calendar cal) Decode from a mysql packet binary encoded a value to codec java type
Blob	decodeText(com.singlestore.jdbc.client.ReadableByteBuf buf, MutableInt length, com.singlestore.jdbc.client.ColumnDecoder column, Calendar cal) Decode from a mysql packet text encoded a value to codec java type
void	encodeBinary(Writer encoder, Object value, Calendar cal, Long maxLength) Binary encode value to writer
byte[]	encodeData(Blob value, Long maxLength) binary encoding value to a byte[]
void	encodeLongData(Writer encoder, Blob value, Long maxLength) binary encoding value to a long data packet
void	encodeText(Writer encoder, com.singlestore.jdbc.client.Context context, Object value, Calendar cal, Long maxLength) Text encode value to writer
int	getApproximateTextProtocolLength(Object value) Approximate length in bytes.
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

Methods inherited from interface com.singlestore.jdbc.plugin.Codec

canEncodeLongData, encodeBinaryAsString

Field Detail

INSTANCE

public static final BlobCodec INSTANCE

Constructor Detail

BlobCodec

public BlobCodec()

Method Detail

className

public String className()

Description copied from interface: Codec

Codec native type

Specified by:

className in interface Codec<Blob>

Returns:

code native return type

canDecode

public boolean canDecode(com.singlestore.jdbc.client.ColumnDecoder column,
                         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<Blob>

Parameters:

column - server datatype

type - java return class

Returns:

true if codec can decode it

canEncode

public boolean canEncode(Object value)

Description copied from interface: Codec

Can Codec encode the java object type

Specified by:

canEncode in interface Codec<Blob>

Parameters:

value - java object type

Returns:

true if codec can encode java type

getApproximateTextProtocolLength

public int getApproximateTextProtocolLength(Object value)
                                     throws SQLException

Description copied from interface: Codec

Approximate length in bytes.

Specified by:

getApproximateTextProtocolLength in interface Codec<Blob>

Parameters:

value - to calculate

Returns:

value length in bytes

Throws:

SQLException

decodeText

public Blob decodeText(com.singlestore.jdbc.client.ReadableByteBuf buf,
                       MutableInt length,
                       com.singlestore.jdbc.client.ColumnDecoder column,
                       Calendar cal)
                throws 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<Blob>

Parameters:

buf - mysql packet buffer

length - encoded value length

column - server column metadata

cal - calendar

Returns:

decoded value

Throws:

SQLDataException - if unexpected error occurs during decoding

decodeBinary

public Blob decodeBinary(com.singlestore.jdbc.client.ReadableByteBuf buf,
                         MutableInt length,
                         com.singlestore.jdbc.client.ColumnDecoder column,
                         Calendar cal)
                  throws 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<Blob>

Parameters:

buf - mysql packet buffer

length - encoded value length

column - server column metadata

cal - calendar

Returns:

decoded value

Throws:

SQLDataException - if unexpected error occurs during decoding

encodeText

public void encodeText(Writer encoder,
                       com.singlestore.jdbc.client.Context context,
                       Object value,
                       Calendar cal,
                       Long maxLength)
                throws IOException,
                       SQLException

Description copied from interface: Codec

Text encode value to writer

Specified by:

encodeText in interface Codec<Blob>

Parameters:

encoder - writer

context - connection context

value - value to encode

cal - calendar

maxLength - maximum value length

Throws:

IOException - if any socket error occurs

SQLException - if encoding error occurs

encodeBinary

public void encodeBinary(Writer encoder,
                         Object value,
                         Calendar cal,
                         Long maxLength)
                  throws IOException,
                         SQLException

Description copied from interface: Codec

Binary encode value to writer

Specified by:

encodeBinary in interface Codec<Blob>

Parameters:

encoder - writer

value - value to encode

cal - calendar

maxLength - maximum value length

Throws:

IOException - if any socket error occurs

SQLException - if encoding error occurs

encodeLongData

public void encodeLongData(Writer encoder,
                           Blob value,
                           Long maxLength)
                    throws IOException,
                           SQLException

Description copied from interface: Codec

binary encoding value to a long data packet

Specified by:

encodeLongData in interface Codec<Blob>

Parameters:

encoder - writer

value - value to encode

maxLength - maximum length value

Throws:

IOException - if any socket error occurs

SQLException - if encoding error occurs

encodeData

public byte[] encodeData(Blob value,
                         Long maxLength)
                  throws IOException,
                         SQLException

Description copied from interface: Codec

binary encoding value to a byte[]

Specified by:

encodeData in interface Codec<Blob>

Parameters:

value - value to encode

maxLength - maximum length value

Returns:

encoded value

Throws:

IOException - if any socket error occurs

SQLException - if encoding error occurs

getBinaryEncodeType

public int getBinaryEncodeType()

Description copied from interface: Codec

Return server encoding data type

Specified by:

getBinaryEncodeType in interface Codec<Blob>

Returns:

server encoding data type