Constants (Libraries 2.5 API)

java.lang.Object
- org.jscsi.parser.Constants

```
public final class Constants
extends Object
```
Constants

This class defines all the constants needed by the parsing and serializing process.

Author:

Volker Wildi

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BYTES_PER_INT` The java data type int need `4` bytes.
`static int`	`CONTINUE_FLAG_MASK` Bit mask to extract the continue flag of a `32` bit number.
`static int`	`FIRST_BYTE_MASK` Bit mask to extract the first byte of a `32` bit number.
`static int`	`FIRST_TWO_BYTES_MASK` Bit mask to extract the first two bytes of a `32` bit number.
`static int`	`FOUR_BYTES_SHIFT` Shift a given number by `32` bits or `4` bytes.
`static int`	`FOURTH_BYTE_MASK` Bit mask to extract the fourth byte of a `32` bit number.
`static long`	`LAST_FOUR_BYTES_MASK` Bit mask to extract the last four bytes of a `64` bit number.
`static int`	`LAST_THREE_BYTES_MASK` Bit mask to extract the three last bytes of a `32` bit number.
`static int`	`LAST_TWO_BYTES_MASK` Bit mask to extract the last bytes of a `32` bit number.
`static int`	`LOG_INITIAL_SIZE` The intial size of the StringBuilder used for logging.
`static int`	`MIDDLE_TWO_BYTES_SHIFT` Bit mask to extract the second and third bytes of a `32` bit number.
`static int`	`ONE_BYTE_SHIFT` Shift a given number by `8` bits or `1` byte.
`static int`	`READ_RESIDUAL_OVERFLOW_FLAG_MASK` Set for Bidirectional Read Residual Overflow.
`static int`	`READ_RESIDUAL_UNDERFLOW_FLAG_MASK` Set for Bidirectional Read Residual Underflow.
`static byte`	`RESERVED_BYTE` Reserved fields are marked as zeros in a `byte` data type.
`static int`	`RESERVED_INT` Reserved fields are marked as zeros in a `integer` data type.
`static long`	`RESERVED_LONG` Reserved fields are marked as zeros in a `long` data type.
`static short`	`RESERVED_SHORT` Reserved fields are marked as zeros in a `short` data type.
`static int`	`RESIDUAL_OVERFLOW_FLAG_MASK` Set for Residual Overflow.
`static int`	`RESIDUAL_UNDERFLOW_FLAG_MASK` Set for Residual Underflow.
`static int`	`SECOND_BYTE_MASK` Bit mask to extract the second byte of a `32` bit number.
`static int`	`THIRD_BYTE_MASK` Bit mask to extract the third byte of a `32` bit number.
`static int`	`THREE_BYTES_SHIFT` Shift a given number by `24` bits or `3` bytes.
`static int`	`TWO_BYTES_SHIFT` Shift a given number by `16` bits or `2` bytes.

Constructor Summary

Constructors
Constructor and Description

Constants()

Constructors
Constructor and Description
`Constants()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BYTES_PER_INT
```
public static final int BYTES_PER_INT
```
    The java data type int need 4 bytes.
    
    See Also:
    Constant Field Values
  - LOG_INITIAL_SIZE
```
public static final int LOG_INITIAL_SIZE
```
    The intial size of the StringBuilder used for logging.
    
    See Also:
    Constant Field Values
  - ONE_BYTE_SHIFT
```
public static final int ONE_BYTE_SHIFT
```
    Shift a given number by 8 bits or 1 byte.
    
    See Also:
    Constant Field Values
  - TWO_BYTES_SHIFT
```
public static final int TWO_BYTES_SHIFT
```
    Shift a given number by 16 bits or 2 bytes.
    
    See Also:
    Constant Field Values
  - THREE_BYTES_SHIFT
```
public static final int THREE_BYTES_SHIFT
```
    Shift a given number by 24 bits or 3 bytes.
    
    See Also:
    Constant Field Values
  - FOUR_BYTES_SHIFT
```
public static final int FOUR_BYTES_SHIFT
```
    Shift a given number by 32 bits or 4 bytes.
    
    See Also:
    Constant Field Values
  - FIRST_BYTE_MASK
```
public static final int FIRST_BYTE_MASK
```
    Bit mask to extract the first byte of a 32 bit number.
    
    See Also:
    Constant Field Values
  - SECOND_BYTE_MASK
```
public static final int SECOND_BYTE_MASK
```
    Bit mask to extract the second byte of a 32 bit number.
    
    See Also:
    Constant Field Values
  - THIRD_BYTE_MASK
```
public static final int THIRD_BYTE_MASK
```
    Bit mask to extract the third byte of a 32 bit number.
    
    See Also:
    Constant Field Values
  - FOURTH_BYTE_MASK
```
public static final int FOURTH_BYTE_MASK
```
    Bit mask to extract the fourth byte of a 32 bit number.
    
    See Also:
    Constant Field Values
  - FIRST_TWO_BYTES_MASK
```
public static final int FIRST_TWO_BYTES_MASK
```
    Bit mask to extract the first two bytes of a 32 bit number.
    
    See Also:
    Constant Field Values
  - MIDDLE_TWO_BYTES_SHIFT
```
public static final int MIDDLE_TWO_BYTES_SHIFT
```
    Bit mask to extract the second and third bytes of a 32 bit number.
    
    See Also:
    Constant Field Values
  - LAST_TWO_BYTES_MASK
```
public static final int LAST_TWO_BYTES_MASK
```
    Bit mask to extract the last bytes of a 32 bit number.
    
    See Also:
    Constant Field Values
  - LAST_THREE_BYTES_MASK
```
public static final int LAST_THREE_BYTES_MASK
```
    Bit mask to extract the three last bytes of a 32 bit number.
    
    See Also:
    Constant Field Values
  - LAST_FOUR_BYTES_MASK
```
public static final long LAST_FOUR_BYTES_MASK
```
    Bit mask to extract the last four bytes of a 64 bit number.
    
    See Also:
    Constant Field Values
  - RESERVED_BYTE
```
public static final byte RESERVED_BYTE
```
    Reserved fields are marked as zeros in a byte data type.
    
    See Also:
    Constant Field Values
  - RESERVED_SHORT
```
public static final short RESERVED_SHORT
```
    Reserved fields are marked as zeros in a short data type.
    
    See Also:
    Constant Field Values
  - RESERVED_INT
```
public static final int RESERVED_INT
```
    Reserved fields are marked as zeros in a integer data type.
    
    See Also:
    Constant Field Values
  - RESERVED_LONG
```
public static final long RESERVED_LONG
```
    Reserved fields are marked as zeros in a long data type.
    
    See Also:
    Constant Field Values
  - CONTINUE_FLAG_MASK
```
public static final int CONTINUE_FLAG_MASK
```
    Bit mask to extract the continue flag of a 32 bit number.
    
    See Also:
    Constant Field Values
  - RESIDUAL_OVERFLOW_FLAG_MASK
```
public static final int RESIDUAL_OVERFLOW_FLAG_MASK
```
    Set for Residual Overflow. In this case, the Residual Count indicates the number of bytes that were not transferred because the initiator's Expected Data Transfer Length was not sufficient. For a bidirectional operation, the Residual Count contains the residual for the write operation.
    
    See Also:
    Constant Field Values
  - RESIDUAL_UNDERFLOW_FLAG_MASK
```
public static final int RESIDUAL_UNDERFLOW_FLAG_MASK
```
    Set for Residual Underflow. In this case, the Residual Count indicates the number of bytes that were not transferred out of the number of bytes that were expected to be transferred. For a bidirectional operation, the Residual Count contains the residual for the write operation.
    
    See Also:
    Constant Field Values
  - READ_RESIDUAL_OVERFLOW_FLAG_MASK
```
public static final int READ_RESIDUAL_OVERFLOW_FLAG_MASK
```
    Set for Bidirectional Read Residual Overflow. In this case, the Bidirectional Read Residual Count indicates the number of bytes that were not transferred to the initiator because the initiator’s Expected Bidirectional Read Data Transfer Length was not sufficient.
    
    See Also:
    Constant Field Values
  - READ_RESIDUAL_UNDERFLOW_FLAG_MASK
```
public static final int READ_RESIDUAL_UNDERFLOW_FLAG_MASK
```
    Set for Bidirectional Read Residual Underflow. In this case, the Bidirectional Read Residual Count indicates the number of bytes that were not transferred to the initiator out of the number of bytes expected to be transferred.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - Constants
```
public Constants()
```

Class Constants

Constants

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BYTES_PER_INT

LOG_INITIAL_SIZE

ONE_BYTE_SHIFT

TWO_BYTES_SHIFT

THREE_BYTES_SHIFT

FOUR_BYTES_SHIFT

FIRST_BYTE_MASK

SECOND_BYTE_MASK

THIRD_BYTE_MASK

FOURTH_BYTE_MASK

FIRST_TWO_BYTES_MASK

MIDDLE_TWO_BYTES_SHIFT

LAST_TWO_BYTES_MASK

LAST_THREE_BYTES_MASK

LAST_FOUR_BYTES_MASK

RESERVED_BYTE

RESERVED_SHORT

RESERVED_INT

RESERVED_LONG

CONTINUE_FLAG_MASK

RESIDUAL_OVERFLOW_FLAG_MASK

RESIDUAL_UNDERFLOW_FLAG_MASK

READ_RESIDUAL_OVERFLOW_FLAG_MASK

READ_RESIDUAL_UNDERFLOW_FLAG_MASK

Constructor Detail

Constants