io.r2dbc.mssql.message.token

Class AbstractDoneToken

java.lang.Object

io.r2dbc.mssql.message.token.AbstractDataToken

io.r2dbc.mssql.message.token.AbstractDoneToken

All Implemented Interfaces:

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

Direct Known Subclasses:

DoneInProcToken, DoneProcToken, DoneToken

public abstract class AbstractDoneToken
extends AbstractDataToken
implements Result.UpdateCount

Abstract base class for Done token implementation classes.

Author:

Mark Paluch

Field Summary

Fields

Modifier and Type	Field and Description
static int	LENGTH Packet length in bytes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDoneToken(byte type, int status, int currentCommand, long rowCount) Creates a new AbstractDoneToken.

Method Summary

Modifier and Type	Method and Description
static boolean	canDecode(io.netty.buffer.ByteBuf buffer) Check whether the ByteBuf can be decoded into an entire AbstractDoneToken.
void	encode(io.netty.buffer.ByteBuf buffer) Encode this token.
boolean	equals(Object o)
int	getCurrentCommand()
long	getRowCount()
int	getStatus()
boolean	hasCount()
static boolean	hasCount(io.r2dbc.mssql.message.Message message) Check whether the the Message has a count.
int	hashCode()
boolean	hasMore()
boolean	isAttentionAck()
static boolean	isAttentionAck(io.r2dbc.mssql.message.Message message) Check whether the Message represents a attention acknowledgement.
boolean	isDone()
static boolean	isDone(io.r2dbc.mssql.message.Message message) Check whether the Message represents a finished done token.
boolean	isError()
String	toString()
long	value()

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

getName, getType

Methods inherited from class java.lang.Object

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

Field Detail

LENGTH

public static final int LENGTH

Packet length in bytes.

See Also:

Constant Field Values

Constructor Detail

AbstractDoneToken

protected AbstractDoneToken(byte type,
                            int status,
                            int currentCommand,
                            long rowCount)

Creates a new AbstractDoneToken.

Parameters:

type - token type.

status - status flags, see AbstractDoneToken constants.

currentCommand - the current command counter.

rowCount - number of columns if hasCount() is set.

Method Detail

isAttentionAck

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

Check whether the Message represents a attention acknowledgement.

Parameters:

message - the message to inspect.

Returns:

true if the Message represents a attention acknowledgement.

Since:

0.9

isDone

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

Check whether the Message represents a finished done token.

Parameters:

message - the message to inspect.

Returns:

true if the Message represents a finished done token.

hasCount

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

Check whether the the Message has a count.

Parameters:

message - the message to inspect.

Returns:

true if the Message has a count.

canDecode

public static boolean canDecode(io.netty.buffer.ByteBuf buffer)

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

Parameters:

buffer - the data buffer.

Returns:

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

Throws:

IllegalArgumentException - when ByteBuf is null.

encode

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

Encode this token.

Parameters:

buffer - the data buffer.

Throws:

IllegalArgumentException - when ByteBuf is null.

getStatus

public int getStatus()

isAttentionAck

public boolean isAttentionAck()

Returns:

true if this token indicates the response is acknowledging the attention request.

isDone

public boolean isDone()

Returns:

true if this token indicates the response is done and has no more rows.

isError

public boolean isError()

Returns:

true if this token indicates the response is done with a preceding error.

hasMore

public boolean hasMore()

Returns:

true if this token indicates the response is not done yet and the stream contains more data.

hasCount

public boolean hasCount()

Returns:

true if this token contains a row count and getRowCount() has a valid value.

getCurrentCommand

public int getCurrentCommand()

Returns:

the application-level command counter.

getRowCount

public long getRowCount()

Returns:

the row count. Only valid if hasCount() is set.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

value

public long value()

Specified by:

value in interface Result.UpdateCount