Package org.mariadb.jdbc.plugin.codec

Class StreamCodec

java.lang.Object

org.mariadb.jdbc.plugin.codec.StreamCodec

All Implemented Interfaces:

Codec<InputStream>

public class StreamCodec
extends Object
implements Codec<InputStream>

InputStream codec

Field Summary

Fields

Modifier and Type	Field	Description
static StreamCodec	INSTANCE	default instance

Constructor Summary

Constructors

Constructor	Description
StreamCodec()

Method Summary

Modifier and Type	Method	Description
boolean	canDecode(org.mariadb.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
boolean	canEncodeLongData()	Indicate if can encode long data
String	className()	Codec native type
InputStream	decodeBinary(org.mariadb.jdbc.client.ReadableByteBuf buf, MutableInt length, org.mariadb.jdbc.client.ColumnDecoder column, Calendar cal)	Decode from a mysql packet binary encoded a value to codec java type
InputStream	decodeText(org.mariadb.jdbc.client.ReadableByteBuf buf, MutableInt length, org.mariadb.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(InputStream value, Long maxLength)	binary encoding value to a byte[]
void	encodeLongData(Writer encoder, InputStream value, Long maxLength)	binary encoding value to a long data packet
void	encodeText(Writer encoder, org.mariadb.jdbc.client.Context context, Object value, Calendar cal, Long maxLen)	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 StreamCodec INSTANCE

default instance

Constructor Detail

StreamCodec

public StreamCodec()

Method Detail

className

public String className()

Description copied from interface: Codec

Codec native type

Specified by:

className in interface Codec<InputStream>

Returns:

code native return type

canDecode

public boolean canDecode(org.mariadb.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<InputStream>

Parameters:

column - server datatype

type - java return class

Returns:

true if codec can decode it

decodeText

public InputStream decodeText(org.mariadb.jdbc.client.ReadableByteBuf buf,
                              MutableInt length,
                              org.mariadb.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<InputStream>

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 InputStream decodeBinary(org.mariadb.jdbc.client.ReadableByteBuf buf,
                                MutableInt length,
                                org.mariadb.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<InputStream>

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

canEncode

public boolean canEncode(Object value)

Description copied from interface: Codec

Can Codec encode the java object type

Specified by:

canEncode in interface Codec<InputStream>

Parameters:

value - java object type

Returns:

true if codec can encode java type

encodeText

public void encodeText(Writer encoder,
                       org.mariadb.jdbc.client.Context context,
                       Object value,
                       Calendar cal,
                       Long maxLen)
                throws IOException

Description copied from interface: Codec

Text encode value to writer

Specified by:

encodeText in interface Codec<InputStream>

Parameters:

encoder - writer

context - connection context

value - value to encode

cal - calendar

maxLen - maximum value length

Throws:

IOException - if any socket error occurs

encodeBinary

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

Description copied from interface: Codec

Binary encode value to writer

Specified by:

encodeBinary in interface Codec<InputStream>

Parameters:

encoder - writer

value - value to encode

cal - calendar

maxLength - maximum value length

Throws:

IOException - if any socket error occurs

encodeLongData

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

Description copied from interface: Codec

binary encoding value to a long data packet

Specified by:

encodeLongData in interface Codec<InputStream>

Parameters:

encoder - writer

value - value to encode

maxLength - maximum length value

Throws:

IOException - if any socket error occurs

encodeData

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

Description copied from interface: Codec

binary encoding value to a byte[]

Specified by:

encodeData in interface Codec<InputStream>

Parameters:

value - value to encode

maxLength - maximum length value

Returns:

encoded value

Throws:

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<InputStream>

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<InputStream>

Returns:

true if possible