io.r2dbc.mssql.message.type

Class Length

java.lang.Object

io.r2dbc.mssql.message.type.Length

public final class Length
extends Object

Descriptor for data length in row results. Use Length to encode/decode length headers of a PLP chunk and PlpLength to encode/decode the the total PLP stream length.

Author:

Mark Paluch

See Also:

PlpLength

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNKNOWN_STREAM_LENGTH
static int	USHORT_NULL

Method Summary

Modifier and Type	Method and Description
static boolean	canDecode(io.netty.buffer.ByteBuf buffer, TypeInformation type) Check whether the ByteBuf can be decoded into an Length.
static Length	decode(io.netty.buffer.ByteBuf buffer, TypeInformation type) Decode a Length for a TypeInformation.
void	encode(io.netty.buffer.ByteBuf buffer, LengthStrategy lengthStrategy)
void	encode(io.netty.buffer.ByteBuf buffer, TypeInformation type)
int	getLength()
boolean	isNull()
static Length	nullLength() Creates a Length that indicates the value is null.
static Length	of(int length) Creates a Length with a given length.
static Length	of(int length, boolean isNull) Creates a Length.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

USHORT_NULL

public static final int USHORT_NULL

See Also:

Constant Field Values

UNKNOWN_STREAM_LENGTH

public static final int UNKNOWN_STREAM_LENGTH

See Also:

Constant Field Values

Method Detail

nullLength

public static Length nullLength()

Creates a Length that indicates the value is null.

Returns:

a Length for null.

of

public static Length of(int length)

Creates a Length with a given length.

Parameters:

length - value length.

Returns:

a Length for a non-null value of the given length.

of

public static Length of(int length,
                        boolean isNull)

Creates a Length.

Parameters:

length - value length.

isNull - true if the value is null.

Returns:

the Length.

decode

public static Length decode(io.netty.buffer.ByteBuf buffer,
                            TypeInformation type)

Decode a Length for a TypeInformation.

Parameters:

buffer - the data buffer.

type - TypeInformation.

Returns:

the Length.

canDecode

public static boolean canDecode(io.netty.buffer.ByteBuf buffer,
                                TypeInformation type)

Check whether the ByteBuf can be decoded into an Length.

Parameters:

buffer - the data buffer.

type - TypeInformation.

Returns:

true if the buffer contains sufficient data to decode a Length.

encode

public void encode(io.netty.buffer.ByteBuf buffer,
                   TypeInformation type)

encode

public void encode(io.netty.buffer.ByteBuf buffer,
                   LengthStrategy lengthStrategy)

getLength

public int getLength()

isNull

public boolean isNull()

toString

public String toString()

Overrides:

toString in class Object