ByteBuffer (CME STP (Straight Through Processing) Handler Parent 3.2.1 API)

java.lang.Object
- biz.onixs.util.ByteBuffer

All Implemented Interfaces:

Comparable<ByteBuffer>
```
public final class ByteBuffer
extends Object
implements Comparable<ByteBuffer>
```
Bytes sequence kept in pre-allocated bytes array(storage).

Field Summary

Fields
Modifier and Type Field and Description

static int CHECKSUM_MODE

static int MIN_CAPACITY

Fields
Modifier and Type	Field and Description
`static int`	`CHECKSUM_MODE`
`static int`	`MIN_CAPACITY`

Constructor Summary

Constructors
Constructor and Description
`ByteBuffer()` Default constructor which allocates internal storage with min capacity (MIN_CAPACITY).
`ByteBuffer(byte[] buffer)` Constructor which allocates internal storage corresponding to the specified buffer length and copies all bytes from buffer.
`ByteBuffer(byte[] buffer, int length)` Constructor which allocates internal storage corresponding to the specified length and copies length of bytes from buffer.
`ByteBuffer(ByteBuffer byteBuffer)` Copy constructor.
`ByteBuffer(ByteBuffer byteBuffer, int length)` Copy constructor with specified length of bytes to be copied.
`ByteBuffer(ByteBuffer buffer, int offset, int length)` Copy constructor with specified offset and length of bytes to be copied.
`ByteBuffer(int capacity)` Constructor which allocates internal storage according to the specified capacity.
`ByteBuffer(String str)` Constructor which allocates internal storage and copies all bytes encoded from string.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ByteBuffer`	`append(byte b)` Appends a byte to byte buffer.
`ByteBuffer`	`append(byte[] buffer)` Appends bytes array to byte buffer.
`ByteBuffer`	`append(byte[] buffer, int length)` Append bytes array to byte buffer with specified length.
`ByteBuffer`	`append(byte[] buffer, int offset, int length)` Appends bytes array to byte buffer from specified offset with specified length.
`ByteBuffer`	`append(ByteBuffer byteBuffer)` Appends bytes taken from specified byte buffer.
`ByteBuffer`	`append(char c)` Appends a character to byte buffer.
`ByteBuffer`	`append(long value)` Appends bytes array converted from long number.
`ByteBuffer`	`append(String str)` Appends bytes array encoded from string to byte buffer.
`ByteBuffer`	`append(ValuePtr value)` Appends bytes taken from value pointer to byte buffer.
`ByteBuffer`	`appendCheckSum(int checkSum)` Appends bytes array converted from int number in checksum format.
`int`	`capacity()` Returns capacity of the byte buffer.
`ByteBuffer`	`clear()` Clears the byte buffer.
`int`	`compareTo(ByteBuffer o)`
`ByteBuffer`	`copy()` Copies this byte buffer and returns a copy.
`boolean`	`equals(Object obj)`
`ByteBuffer`	`erase(int length)` Erases bytes from the beginning of byte buffer with specified length.
`ByteBuffer`	`erase(int length, int startPsn)` Erases bytes from specified position and with length form byte buffer.
`int`	`findIndex(int startPsn, byte[] subBuffer)` Finds index of bytes sub-sequence in the data of the byte buffer.
`byte[]`	`get()` Returns internal storage(byte array).
`int`	`getCheckSum()` Gets checksum corresponding to bytes kept in byte buffer.
`byte[]`	`getCopy()` Returns copy of bytes kept in byte buffer.
`ByteBuffer`	`incLength(int size)` Increases data size of byte buffer by the specified size.
`ByteBuffer`	`insert(byte[] bytes, int pos)` Inserts the bytes array at the specified position.
`ByteBuffer`	`insert(byte[] buffer, int length, int startPsn)` Inserts the bytes array with length at the specified position.
`ByteBuffer`	`insert(byte[] buffer, int offset, int length, int startPsn)` Inserts the bytes array from specified offset with length at the specified position.
`ByteBuffer`	`insert(ByteBuffer buffer, int startPsn)` Inserts the content of the buffer at the specified position.
`ByteBuffer`	`insert(byte b, int pos)` Inserts the byte at the specified position.
`ByteBuffer`	`insert(byte b, int pos, int times)` Inserts the byte at the specified position and at specified times.
`ByteBuffer`	`insert(char c, int pos)` Inserts the char converted to byte at the specified position.
`ByteBuffer`	`insert(long l, int pos)` Inserts the long number converted to bytes at the specified position.
`ByteBuffer`	`insert(String s, int pos)` Inserts the string encoded to bytes at the specified position.
`int`	`length()` Returns size of data in the byte buffer.
`ByteBuffer`	`overwrite(byte[] buffer, int length)` Overwrites data.
`ByteBuffer`	`overwrite(ByteBuffer byteBuffer)` Overwrites data.
`ByteBuffer`	`overwrite(int startPsn, byte[] buffer, int length)` Overwrites data.
`ByteBuffer`	`overwrite(int startPsn, byte[] buffer, int length, int offset)` Overwrites data.
`ByteBuffer`	`reserve(int expectedCapacity)` Ensures the specified capacity is reserved.
`ByteBuffer`	`reserveSpace(int space)` Reserves additional space in the storage.
`ByteBuffer`	`resize(int newSize)` Resizes data size in byte buffer.
`ByteBuffer`	`reverse()` Reverses data in the byte buffer.
`ByteBuffer`	`reverse(int startIdx)` Reverses data in byte buffer from the specified start index.
`ByteBuffer`	`reverse(int startIdx, int endIdx)` Reverses the specified range of data in byte buffer.
`int`	`size()` Returns size of data in the byte buffer.
`ByteBuffer`	`subBuffer(int offset)` Creates a new byte buffer from the specified offset.
`ByteBuffer`	`subBuffer(int offset, int length)` Creates a new byte buffer from the specified offset and with the specified length.
`String`	`toString()`
`ByteBuffer`	`write(OutputStream outputStream)` Writes the data from the byte buffer into specified output stream.

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - MIN_CAPACITY
```
public static final int MIN_CAPACITY
```
    See Also:
    
    Constant Field Values
  - CHECKSUM_MODE
```
public static final int CHECKSUM_MODE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ByteBuffer
```
public ByteBuffer()
```
    Default constructor which allocates internal storage with min capacity (MIN_CAPACITY).
  - ByteBuffer
```
public ByteBuffer(int capacity)
```
    Constructor which allocates internal storage according to the specified capacity.
    
    Parameters:
    
    capacity - size of internal byte array
  - ByteBuffer
```
public ByteBuffer(byte[] buffer)
```
    Constructor which allocates internal storage corresponding to the specified buffer length and copies all bytes from buffer.
    
    Parameters:
    
    buffer - bytes array
  - ByteBuffer
```
public ByteBuffer(byte[] buffer,
                  int length)
```
    Constructor which allocates internal storage corresponding to the specified length and copies length of bytes from buffer.
    
    Parameters:
    
    buffer - bytes array
    
    length - length of bytes to be copied
  - ByteBuffer
```
public ByteBuffer(String str)
```
    Constructor which allocates internal storage and copies all bytes encoded from string.
    
    Parameters:
    
    str - string from which byte array is encoded using String.getBytes()
  - ByteBuffer
```
public ByteBuffer(ByteBuffer byteBuffer)
```
    Copy constructor.
    
    Parameters:
    
    byteBuffer - byte buffer to be copied
  - ByteBuffer
```
public ByteBuffer(ByteBuffer byteBuffer,
                  int length)
```
    Copy constructor with specified length of bytes to be copied.
    
    Parameters:
    
    byteBuffer - byte buffer to be copied
    
    length - length of bytes to be copied
  - ByteBuffer
```
public ByteBuffer(ByteBuffer buffer,
                  int offset,
                  int length)
```
    Copy constructor with specified offset and length of bytes to be copied.
    
    Parameters:
    
    buffer - byte buffer to be copied
    
    offset - offset from which bytes should be copied
    
    length - length of bytes to be copied
- Method Detail
  - copy
```
public ByteBuffer copy()
```
    Copies this byte buffer and returns a copy.
    
    Returns:
    
    copy of this byte buffer
  - subBuffer
```
public ByteBuffer subBuffer(int offset)
```
    Creates a new byte buffer from the specified offset.
    
    Parameters:
    
    offset - offset
    
    Returns:
    
    a new byte buffer from the specified offset
  - subBuffer
```
public ByteBuffer subBuffer(int offset,
                            int length)
```
    Creates a new byte buffer from the specified offset and with the specified length.
    
    Parameters:
    
    offset - offset
    
    length - length of new byte buffer
    
    Returns:
    
    a new byte buffer from the specified offset and with the specified length
  - overwrite
```
public ByteBuffer overwrite(ByteBuffer byteBuffer)
```
    Overwrites data.
    The buffer is extended if it is not big enough.
    
    Parameters:
    
    byteBuffer - byte buffer
    
    Returns:
    
    this buffer
  - overwrite
```
public ByteBuffer overwrite(byte[] buffer,
                            int length)
```
    Overwrites data.
    The buffer is extended if it is not big enough.
    
    Parameters:
    
    buffer - buffer to take data from
    
    length - buffer length
    
    Returns:
    
    this buffer
  - overwrite
```
public ByteBuffer overwrite(int startPsn,
                            byte[] buffer,
                            int length)
```
    Overwrites data.
    The buffer is extended if it is not big enough.
    
    Parameters:
    
    startPsn - start position to overwrite, begins from 0
    
    buffer - buffer to take data from
    
    length - buffer length
    
    Returns:
    
    this buffer
  - overwrite
```
public ByteBuffer overwrite(int startPsn,
                            byte[] buffer,
                            int length,
                            int offset)
```
    Overwrites data.
    The buffer is extended if it is not big enough.
    
    Parameters:
    
    startPsn - start position to overwrite, begins from 0
    
    buffer - buffer to take data from
    
    length - buffer length
    
    offset - offset in the buffer to start from, begins from 0
    
    Returns:
    
    this buffer
  - append
```
public ByteBuffer append(ByteBuffer byteBuffer)
```
    Appends bytes taken from specified byte buffer.
    
    Parameters:
    
    byteBuffer - byte buffer
    
    Returns:
    
    this buffer
  - append
```
public ByteBuffer append(char c)
```
    Appends a character to byte buffer.
    
    Parameters:
    
    c - character be appended
    
    Returns:
    
    this buffer
  - append
```
public ByteBuffer append(byte b)
```
    Appends a byte to byte buffer.
    
    Parameters:
    
    b - byte to be appended
    
    Returns:
    
    this buffer
  - append
```
public ByteBuffer append(byte[] buffer)
```
    Appends bytes array to byte buffer.
    
    Parameters:
    
    buffer - bytes array
    
    Returns:
    
    this buffer
  - append
```
public ByteBuffer append(String str)
```
    Appends bytes array encoded from string to byte buffer.
    
    Parameters:
    
    str - string to be appended
    
    Returns:
    
    this buffer
  - append
```
public ByteBuffer append(ValuePtr value)
```
    Appends bytes taken from value pointer to byte buffer.
    
    Parameters:
    
    value - value pointer
    
    Returns:
    
    this buffer
  - append
```
public ByteBuffer append(byte[] buffer,
                         int length)
```
    Append bytes array to byte buffer with specified length.
    
    Parameters:
    
    buffer - bytes array
    
    length - length
    
    Returns:
    
    this buffer
  - append
```
public ByteBuffer append(byte[] buffer,
                         int offset,
                         int length)
```
    Appends bytes array to byte buffer from specified offset with specified length.
    
    Parameters:
    
    buffer - bytes array
    
    offset - offset
    
    length - length
    
    Returns:
    
    this buffer
  - append
```
public ByteBuffer append(long value)
```
    Appends bytes array converted from long number.
    
    Parameters:
    
    value - number
    
    Returns:
    
    this buffer
  - appendCheckSum
```
public ByteBuffer appendCheckSum(int checkSum)
```
    Appends bytes array converted from int number in checksum format.
    
    Parameters:
    
    checkSum - checksum
    
    Returns:
    
    this buffer
  - insert
```
public ByteBuffer insert(ByteBuffer buffer,
                         int startPsn)
```
    Inserts the content of the buffer at the specified position.
    
    Parameters:
    
    buffer - source data buffer to insert from
    
    startPsn - position to insert at in the target (this) buffer
    
    Returns:
    
    this buffer
  - insert
```
public ByteBuffer insert(char c,
                         int pos)
```
    Inserts the char converted to byte at the specified position.
    
    Parameters:
    
    c - char to convert and insert
    
    pos - position to insert at in target (this) buffer
    
    Returns:
    
    this buffer
  - insert
```
public ByteBuffer insert(byte b,
                         int pos)
```
    Inserts the byte at the specified position.
    
    Parameters:
    
    b - byte to insert
    
    pos - position to insert at in target (this) buffer
    
    Returns:
    
    this buffer
  - insert
```
public ByteBuffer insert(byte b,
                         int pos,
                         int times)
```
    Inserts the byte at the specified position and at specified times.
    
    Parameters:
    
    b - byte to insert
    
    pos - position to insert at in the target (this) buffer
    
    times - number of times the same byte to insert at in the target (this) buffer
    
    Returns:
    
    this buffer
  - insert
```
public ByteBuffer insert(long l,
                         int pos)
```
    Inserts the long number converted to bytes at the specified position.
    
    Parameters:
    
    l - long number to convert and insert
    
    pos - position to insert at in target (this) buffer
    
    Returns:
    
    this buffer
  - insert
```
public ByteBuffer insert(String s,
                         int pos)
```
    Inserts the string encoded to bytes at the specified position.
    
    Parameters:
    
    s - string to encode and insert
    
    pos - position to insert at in target (this) buffer
    
    Returns:
    
    this buffer
  - insert
```
public ByteBuffer insert(byte[] bytes,
                         int pos)
```
    Inserts the bytes array at the specified position.
    
    Parameters:
    
    bytes - bytes array to insert
    
    pos - position to insert at in target (this) buffer
    
    Returns:
    
    this buffer
  - insert
```
public ByteBuffer insert(byte[] buffer,
                         int length,
                         int startPsn)
```
    Inserts the bytes array with length at the specified position.
    
    Parameters:
    
    buffer - bytes array to insert
    
    length - length to use
    
    startPsn - position to insert at in target (this) buffer
    
    Returns:
    
    this buffer
  - insert
```
public ByteBuffer insert(byte[] buffer,
                         int offset,
                         int length,
                         int startPsn)
```
    Inserts the bytes array from specified offset with length at the specified position.
    
    Parameters:
    
    buffer - bytes array to insert
    
    offset - offset in bytes array to start from, begins from 0
    
    length - length to use
    
    startPsn - position to insert at in target (this) buffer
    
    Returns:
    
    this buffer
  - capacity
```
public int capacity()
```
    Returns capacity of the byte buffer.
    
    Returns:
    
    capacity of the byte buffer
  - clear
```
public ByteBuffer clear()
```
    Clears the byte buffer.
    
    Returns:
    
    this buffer
  - erase
```
public ByteBuffer erase(int length)
```
    Erases bytes from the beginning of byte buffer with specified length.
    
    Parameters:
    
    length - length of bytes to be removed
    
    Returns:
    
    this buffer
  - erase
```
public ByteBuffer erase(int length,
                        int startPsn)
```
    Erases bytes from specified position and with length form byte buffer.
    
    Parameters:
    
    length - length of bytes to be removed
    
    startPsn - starting position from where bytes will be removed
    
    Returns:
    
    this buffer
  - get
```
public byte[] get()
```
    Returns internal storage(byte array).
    
    Returns:
    
    internal storage(byte array)
  - getCopy
```
public byte[] getCopy()
```
    Returns copy of bytes kept in byte buffer.
    
    Returns:
    
    copy of bytes kept in byte buffer
  - getCheckSum
```
public int getCheckSum()
```
    Gets checksum corresponding to bytes kept in byte buffer.
    
    Returns:
    
    checksum corresponding to bytes kept in byte buffer
  - reserveSpace
```
public ByteBuffer reserveSpace(int space)
```
    Reserves additional space in the storage.
    
    Parameters:
    
    space - number of bytes added to storage
    
    Returns:
    
    this buffer
  - reserve
```
public ByteBuffer reserve(int expectedCapacity)
```
    Ensures the specified capacity is reserved.
    
    Parameters:
    
    expectedCapacity - capacity to be reserved
    
    Returns:
    
    this buffer
  - size
```
public int size()
```
    Returns size of data in the byte buffer.
    
    Returns:
    
    size of data in the byte buffer
  - length
```
public int length()
```
    Returns size of data in the byte buffer.
    
    Returns:
    
    size of data in the byte buffer
  - resize
```
public ByteBuffer resize(int newSize)
```
    Resizes data size in byte buffer.
    The buffer is extended if it is not big enough.
    
    Parameters:
    
    newSize - new size of the data
    
    Returns:
    
    this buffer
  - incLength
```
public ByteBuffer incLength(int size)
```
    Increases data size of byte buffer by the specified size.
    The buffer is extended if it is not big enough.
    
    Parameters:
    
    size - number of bytes the data of byte buffer to be increased
    
    Returns:
    
    this buffer
  - reverse
```
public ByteBuffer reverse()
```
    Reverses data in the byte buffer.
    
    Returns:
    
    this buffer
  - reverse
```
public ByteBuffer reverse(int startIdx)
```
    Reverses data in byte buffer from the specified start index.
    
    Parameters:
    
    startIdx - start index in the byte buffer from where data should be reversed
    
    Returns:
    
    this buffer
  - reverse
```
public ByteBuffer reverse(int startIdx,
                          int endIdx)
```
    Reverses the specified range of data in byte buffer.
    
    Parameters:
    
    startIdx - start index of the range to be reversed
    
    endIdx - end index of the range to be reversed
    
    Returns:
    
    this buffer
  - findIndex
```
public int findIndex(int startPsn,
                     byte[] subBuffer)
```
    Finds index of bytes sub-sequence in the data of the byte buffer.
    
    Parameters:
    
    startPsn - start position the finding will begin
    
    subBuffer - bytes sub-sequence to be found
    
    Returns:
    
    index of found bytes sub-sequence, or -1 otherwise
  - write
```
public ByteBuffer write(OutputStream outputStream)
                 throws IOException
```
    Writes the data from the byte buffer into specified output stream.
    
    Parameters:
    
    outputStream - output stream the data to be written
    
    Returns:
    
    this buffer
    
    Throws:
    
    IOException - if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - compareTo
```
public int compareTo(ByteBuffer o)
```
    Specified by:
    
    compareTo in interface Comparable<ByteBuffer>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ByteBuffer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MIN_CAPACITY

CHECKSUM_MODE

Constructor Detail

ByteBuffer

ByteBuffer

ByteBuffer

ByteBuffer

ByteBuffer

ByteBuffer

ByteBuffer

ByteBuffer

Method Detail

copy

subBuffer

subBuffer

overwrite

overwrite

overwrite

overwrite

append

append

append

append

append

append

append

append

append

appendCheckSum

insert

insert

insert

insert

insert

insert

insert

insert

insert

capacity

clear

erase

erase

get

getCopy

getCheckSum

reserveSpace

reserve

size

length

resize

incLength

reverse

reverse

reverse

findIndex

write

equals

compareTo

toString