io.r2dbc.mssql.message.type

Class PlpLength

java.lang.Object

io.r2dbc.mssql.message.type.PlpLength

public final class PlpLength
extends Object

Descriptor for PLP data length in row results. This class encapsulates the total length of a value using a 8 byte unsigned long counter. 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:

Length

Field Summary

Fields

Modifier and Type	Field and Description
static long	PLP_NULL
static long	UNKNOWN_PLP_LEN

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 PlpLength.
static PlpLength	decode(io.netty.buffer.ByteBuf buffer, TypeInformation type) Decode a PlpLength for a TypeInformation.
void	encode(io.netty.buffer.ByteBuf buffer) Encode length or PLP_NULL.
long	getLength()
boolean	isNull()
boolean	isUnknown()
static PlpLength	nullLength() Creates a PlpLength that indicates the value is null.
static PlpLength	of(long length) Creates a PlpLength with a given length.
static PlpLength	of(long length, boolean isNull) Creates a PlpLength.
String	toString()
static PlpLength	unknown() Creates a PlpLength that indicates the value length is unknown.

Methods inherited from class java.lang.Object

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

Field Detail

PLP_NULL

public static final long PLP_NULL

See Also:

Constant Field Values

UNKNOWN_PLP_LEN

public static final long UNKNOWN_PLP_LEN

See Also:

Constant Field Values

Method Detail

unknown

public static PlpLength unknown()

Creates a PlpLength that indicates the value length is unknown.

Returns:

a PlpLength with unknown length.

nullLength

public static PlpLength nullLength()

Creates a PlpLength that indicates the value is null.

Returns:

a PlpLength for null.

of

public static PlpLength of(long length)

Creates a PlpLength with a given length.

Parameters:

length - value length.

Returns:

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

of

public static PlpLength of(long length,
                           boolean isNull)

Creates a PlpLength.

Parameters:

length - value length.

isNull - true if the value is null.

Returns:

the PlpLength.

decode

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

Decode a PlpLength for a TypeInformation.

Parameters:

buffer - the data buffer.

type - TypeInformation.

Returns:

the PlpLength.

canDecode

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

Check whether the ByteBuf can be decoded into an PlpLength.

Parameters:

buffer - the data buffer.

type - TypeInformation.

Returns:

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

encode

public void encode(io.netty.buffer.ByteBuf buffer)

Encode length or PLP_NULL.

Parameters:

buffer - the data buffer.

getLength

public long getLength()

isNull

public boolean isNull()

isUnknown

public boolean isUnknown()

toString

public String toString()

Overrides:

toString in class Object