io.r2dbc.mssql.message.token

Class DoneToken

java.lang.Object

io.r2dbc.mssql.message.token.AbstractDataToken

io.r2dbc.mssql.message.token.AbstractDoneToken

io.r2dbc.mssql.message.token.DoneToken

All Implemented Interfaces:

io.r2dbc.mssql.message.Message, DataToken, Result.Segment, Result.UpdateCount

public final class DoneToken
extends AbstractDoneToken

Done token.

Author:

Mark Paluch

Field Summary

Fields

Modifier and Type	Field and Description
static byte	TYPE

Fields inherited from class io.r2dbc.mssql.message.token.AbstractDoneToken

LENGTH

Method Summary

Modifier and Type	Method and Description
static DoneToken	count(long rowCount) Creates a new DoneToken with just a rowCount.
static DoneToken	create(long rowCount) Creates a new DoneToken indicating a final packet and rowCount.
static DoneToken	decode(io.netty.buffer.ByteBuf buffer) Decode the DoneToken response from a ByteBuf.
String	getName()
static boolean	isDone(io.r2dbc.mssql.message.Message message) Check whether the the Message represents a finished DoneToken.
static DoneToken	more(long rowCount) Creates a new DoneToken with just a rowCount.

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

canDecode, encode, equals, getCurrentCommand, getRowCount, getStatus, hasCount, hasCount, hashCode, hasMore, isAttentionAck, isAttentionAck, isDone, isError, toString, value

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

getType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final byte TYPE

See Also:

Constant Field Values

Method Detail

create

public static DoneToken create(long rowCount)

Creates a new DoneToken indicating a final packet and rowCount.

Parameters:

rowCount - the row count.

Returns:

the DoneToken.

See Also:

AbstractDoneToken.isDone(), AbstractDoneToken.getRowCount(), AbstractDoneToken.hasCount()

count

public static DoneToken count(long rowCount)

Creates a new DoneToken with just a rowCount.

Parameters:

rowCount - the row count.

Returns:

the DoneToken.

See Also:

AbstractDoneToken.getRowCount(), AbstractDoneToken.hasCount()

more

public static DoneToken more(long rowCount)

Creates a new DoneToken with just a rowCount.

Parameters:

rowCount - the row count.

Returns:

the DoneToken.

See Also:

AbstractDoneToken.getRowCount(), AbstractDoneToken.hasCount()

isDone

public static boolean isDone(io.r2dbc.mssql.message.Message message)

Check whether the the Message represents a finished DoneToken.

Parameters:

message - the message to inspect.

Returns:

true if the Message represents a finished DoneToken.

decode

public static DoneToken decode(io.netty.buffer.ByteBuf buffer)

Decode the DoneToken response from a ByteBuf.

Parameters:

buffer - must not be null.

Returns:

the decoded DoneToken.

getName

public String getName()

Specified by:

getName in interface DataToken

Specified by:

getName in class AbstractDataToken

Returns:

symbolic name of the AbstractDataToken.