io.r2dbc.mssql.message.token

Class NbcRowToken

java.lang.Object

io.netty.util.AbstractReferenceCounted

io.r2dbc.mssql.message.token.RowToken

io.r2dbc.mssql.message.token.NbcRowToken

All Implemented Interfaces:

io.netty.util.ReferenceCounted, io.r2dbc.mssql.message.Message, DataToken

public final class NbcRowToken
extends RowToken

NBC Row (Null-bitmap compressed row). Expresses nullability through a bitmap.

Note: PLP values are aggregated in a single ByteBuf and not yet streamed. This is to be fixed.

Author:

Mark Paluch

Field Summary

Fields

Modifier and Type	Field and Description
static byte	TYPE

Method Summary

Modifier and Type	Method and Description
static boolean	canDecode(io.netty.buffer.ByteBuf buffer, Column[] columns) Check whether the ByteBuf can be decoded into an entire NbcRowToken.
static NbcRowToken	decode(io.netty.buffer.ByteBuf buffer, Column[] columns) Decode a NbcRowToken.
io.netty.buffer.ByteBuf	getColumnData(int index) Returns the data for the column at index.
String	getName()
String	toString()

Methods inherited from class io.r2dbc.mssql.message.token.RowToken

deallocate, getType, touch

Methods inherited from class io.netty.util.AbstractReferenceCounted

refCnt, release, release, retain, retain, setRefCnt, touch

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final byte TYPE

See Also:

Constant Field Values

Method Detail

decode

public static NbcRowToken decode(io.netty.buffer.ByteBuf buffer,
                                 Column[] columns)

Decode a NbcRowToken.

Parameters:

buffer - the data buffer.

columns - column descriptors.

Returns:

the RowToken.

canDecode

public static boolean canDecode(io.netty.buffer.ByteBuf buffer,
                                Column[] columns)

Check whether the ByteBuf can be decoded into an entire NbcRowToken.

Parameters:

buffer - the data buffer.

columns - column descriptors.

Returns:

true if the buffer contains sufficient data to entirely decode a row.

getColumnData

public io.netty.buffer.ByteBuf getColumnData(int index)

Description copied from class: RowToken

Returns the data for the column at index.

Overrides:

getColumnData in class RowToken

Parameters:

index - the column index.

Returns:

the data buffer. Can be null if indicated by null-bit compression.

getName

public String getName()

Specified by:

getName in interface DataToken

Overrides:

getName in class RowToken

Returns:

symbolic name of the DataToken.

toString

public String toString()

Overrides:

toString in class Object