io.r2dbc.mssql.message.header

Class Status

java.lang.Object

io.r2dbc.mssql.message.header.Status

public class Status
extends Object

Packet header status as defined in ch 2.2.3.1.2 Status of the TDS v20180912 spec.

Status is a bit field used to indicate the message state. Status is a 1-byte unsigned char. The following Status bit flags are defined.

Author:

Mark Paluch

See Also:

Status.StatusBit

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Status.StatusBit Packet header status bits as defined in ch 2.2.3.1.2 Status of the TDS v20180912 spec.

Method Summary

Modifier and Type	Method and Description
Status	and(Status.StatusBit bit) Create a Status from the current state and add the Status.StatusBit.
static Status	empty() Return an empty Status.
boolean	equals(Object o)
static Status	fromBitmask(byte bitmask) Create Status Set from the given bitmask.
byte	getValue()
int	hashCode()
boolean	is(Status.StatusBit bit) Check if the header status has set the Status.StatusBit.
Status	not(Status.StatusBit bit) Create a Status from the current state and remove the Status.StatusBit.
static Status	of(Status.StatusBit bit) Create a Status from the given Status.StatusBit.
static Status	of(Status.StatusBit bit, Status.StatusBit... other) Create a Status from the given Status.StatusBits.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

empty

public static Status empty()

Return an empty Status.

Returns:

the empty Status.

fromBitmask

public static Status fromBitmask(byte bitmask)

Create Status Set from the given bitmask.

Parameters:

bitmask - status bitmask.

Returns:

the Status for bitmask.

of

public static Status of(Status.StatusBit bit)

Create a Status from the given Status.StatusBit.

Parameters:

bit - the status bit.

Returns:

the Status from the given Status.StatusBit.

of

public static Status of(Status.StatusBit bit,
                        Status.StatusBit... other)

Create a Status from the given Status.StatusBits.

Parameters:

bit - the status bit.

other - the status bits.

Returns:

the Status from the given Status.StatusBit.

and

public Status and(Status.StatusBit bit)

Create a Status from the current state and add the Status.StatusBit.

Parameters:

bit - the status bit.

Returns:

the Status from the given Status.StatusBit.

not

public Status not(Status.StatusBit bit)

Create a Status from the current state and remove the Status.StatusBit.

Parameters:

bit - the status bit.

Returns:

the Status from the given Status.StatusBit.

is

public boolean is(Status.StatusBit bit)

Check if the header status has set the Status.StatusBit.

Parameters:

bit - the status bit.

Returns:

true of the bit is set; false otherwise.

getValue

public byte getValue()

Returns:

the status byte.

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