MergedByteBuffers (litesockets 4.14 API)

All Known Implementing Classes:

AbstractMergedByteBuffers, ReuseableMergedByteBuffers, SimpleMergedByteBuffers, TransactionalByteBuffers
```
public interface MergedByteBuffers
```
This class is used to combine multiple ByteBuffers into 1 simplish to use interface. It provides most of the features of a single ByteBuffer, but with the ability to perform those operations spanning many ByteBuffers. The idea here is to keep from having to copy around and merge ByteBuffers as much as possible. NOTE: This is not threadSafe. It should only be accessed by 1 thread at a time.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BYTES_IN_INT`
`static int`	`BYTES_IN_LONG`
`static int`	`BYTES_IN_SHORT`
`static short`	`UNSIGNED_BYTE_MASK`
`static long`	`UNSIGNED_INT_MASK`
`static int`	`UNSIGNED_SHORT_MASK`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`add(byte[]... ba)` This method allows you to add ByteBuffers to the MergedByteBuffers.
`void`	`add(java.nio.ByteBuffer... buffer)` This method allows you to add ByteBuffers to the MergedByteBuffers.
`void`	`add(MergedByteBuffers... mbb)` This method allows you to add a MergedByteBuffers to another MergedByteBuffers.
`void`	`add(MergedByteBuffers mbb, int maxLength)` This method allows you to add a MergedByteBuffers to another MergedByteBuffers.
`java.io.InputStream`	`asInputStream()`
`void`	`discard(int size)` Discard will drop how ever many bytes you tell it to on the floor.
`void`	`discardFromEnd(int size)` Similar to `discard(int)` except that the bytes removed from this will be from the end of the buffer and discard towards the head.
`MergedByteBuffers`	`duplicate()` Make a complete duplicate of this MergedByteBuffer.
`MergedByteBuffers`	`duplicateAndClean()` This will flush all the data in this MergedByteBuffer into another MergedByteBuffer.
`byte`	`get()` Returns the next byte stored in the MergedByteBuffers.
`int`	`get(byte[] destBytes)` Fills the passed `byte[]` completely with data from the MergedByteBuffer.
`int`	`get(byte[] destBytes, int start, int length)` Fills the passed `byte[]` completely with data from the MergedByteBuffer.
`java.lang.String`	`getAsString(int size)` This will return the specified number of bytes as a String object.
`java.lang.String`	`getAsString(int size, java.nio.charset.Charset charSet)` This will return the specified number of bytes as a String object.
`int`	`getInt()` Returns the next 4 bytes as an `int` value.
`long`	`getLong()` Returns the next 8 bytes as a `long` value.
`short`	`getShort()` Returns the next 2 bytes as a `short` value.
`long`	`getTotalConsumedBytes()` This will return the number of bytes that has been consumed by this MergedByteBuffer.
`short`	`getUnsignedByte()` Returns the next `byte` unsigned as `short` stored in the MergedByteBuffers.
`long`	`getUnsignedInt()` Returns an unsigned short (as an `int`) from the next 2 stored bytes.
`int`	`getUnsignedShort()` Returns an unsigned `short` (as an `int`) from the next 2 stored bytes.
`boolean`	`hasRemaining()` Returns if there is any data pending in this MergedByteBuffer or not.
`int`	`indexOf(byte[] pattern)` Like the indexOf in String object this find a pattern of bytes and reports the position they start at.
`int`	`indexOf(byte[] pattern, int fromPosition)` Like the indexOf in String object this find a pattern of bytes and reports the position they start at.
`int`	`indexOf(java.lang.String pattern)` Like the indexOf in String object this find a pattern of bytes and reports the position they start at.
`int`	`indexOf(java.lang.String pattern, java.nio.charset.Charset charSet)` Like the indexOf in String object this find a pattern of bytes and reports the position they start at.
`int`	`indexOf(java.lang.String pattern, java.nio.charset.Charset charSet, int fromPosition)` Like the indexOf in String object this find a pattern of bytes and reports the position they start at.
`int`	`indexOf(java.lang.String pattern, int fromPosition)` Like the indexOf in String object this find a pattern of bytes and reports the position they start at.
`boolean`	`isAppendable()`
`int`	`nextBufferSize()` Get the size of the next full `ByteBuffer` in the queue.
`java.nio.ByteBuffer`	`popBuffer()` Get the next Complete `ByteBuffer` in its entirety.
`java.nio.ByteBuffer`	`pullBuffer(int size)`
`int`	`remaining()` Check how much data is available in the MergedByteBuffer.

- Field Detail
  - BYTES_IN_LONG
```
static final int BYTES_IN_LONG
```
    See Also:
    
    Constant Field Values
  - BYTES_IN_INT
```
static final int BYTES_IN_INT
```
    See Also:
    
    Constant Field Values
  - BYTES_IN_SHORT
```
static final int BYTES_IN_SHORT
```
    See Also:
    
    Constant Field Values
  - UNSIGNED_BYTE_MASK
```
static final short UNSIGNED_BYTE_MASK
```
    See Also:
    
    Constant Field Values
  - UNSIGNED_SHORT_MASK
```
static final int UNSIGNED_SHORT_MASK
```
    See Also:
    
    Constant Field Values
  - UNSIGNED_INT_MASK
```
static final long UNSIGNED_INT_MASK
```
    See Also:
    
    Constant Field Values
- Method Detail
  - add
```
void add(byte[]... ba)
```
    This method allows you to add ByteBuffers to the MergedByteBuffers. All must be done in order of how you want to pull the data back out.
    
    Parameters:
    
    ba - - The byte[] to add to the MergedByteBuffers
  - add
```
void add(java.nio.ByteBuffer... buffer)
```
    This method allows you to add ByteBuffers to the MergedByteBuffers. All must be done in order of how you want to pull the data back out.
    
    Parameters:
    
    buffer - - The byte buffer to add to the MergedByteBuffers
  - add
```
void add(MergedByteBuffers... mbb)
```
    This method allows you to add a MergedByteBuffers to another MergedByteBuffers. All must be done in order of how you want to pull the data back out.
    
    Parameters:
    
    mbb - - The MergedByteBuffers to put into this MergedByteBuffers
  - add
```
void add(MergedByteBuffers mbb,
         int maxLength)
```
    This method allows you to add a MergedByteBuffers to another MergedByteBuffers. All must be done in order of how you want to pull the data back out.
    
    Parameters:
    
    mbb - - The MergedByteBuffers to put into this MergedByteBuffers
    
    maxLength - - Maximum number of bytes to copy out of provided mbb
  - duplicate
```
MergedByteBuffers duplicate()
```
    Make a complete duplicate of this MergedByteBuffer. Both references should function independently, but they are still using the same ByteBuffer backing arrays so any change to the actual byte[] in the backing ByteBuffers will change in both.
    
    Returns:
    
    a new MergedByteBuffers object that duplicates this one, but works independently.
  - duplicateAndClean
```
MergedByteBuffers duplicateAndClean()
```
    This will flush all the data in this MergedByteBuffer into another MergedByteBuffer.
    
    Returns:
    
    a new MergedByteBuffer with the data that was in the original one.
  - indexOf
```
int indexOf(java.lang.String pattern)
```
    Like the indexOf in String object this find a pattern of bytes and reports the position they start at. This defaults to using US-ASCII as the Charset.
    
    Parameters:
    
    pattern - String pattern to search for.
    
    Returns:
    
    an int with the offset of the first occurrence of the given .
  - indexOf
```
int indexOf(java.lang.String pattern,
            java.nio.charset.Charset charSet)
```
    Like the indexOf in String object this find a pattern of bytes and reports the position they start at.
    
    Parameters:
    
    pattern - String pattern to search for.
    
    charSet - the Charset of the string.
    
    Returns:
    
    an int with the offset of the first occurrence of the given .
  - indexOf
```
int indexOf(byte[] pattern)
```
    Like the indexOf in String object this find a pattern of bytes and reports the position they start at.
    
    Parameters:
    
    pattern - byte[] pattern to search for
    
    Returns:
    
    an int with the offset of the first occurrence of the given .
  - indexOf
```
int indexOf(java.lang.String pattern,
            int fromPosition)
```
    Like the indexOf in String object this find a pattern of bytes and reports the position they start at. This defaults to using US-ASCII as the Charset.
    
    Parameters:
    
    pattern - String pattern to search for.
    
    fromPosition - Starting index to search from, inclusive
    
    Returns:
    
    an int with the offset of the first occurrence of the given .
  - indexOf
```
int indexOf(java.lang.String pattern,
            java.nio.charset.Charset charSet,
            int fromPosition)
```
    Like the indexOf in String object this find a pattern of bytes and reports the position they start at.
    
    Parameters:
    
    pattern - String pattern to search for.
    
    charSet - the Charset of the string.
    
    fromPosition - Starting index to search from, inclusive
    
    Returns:
    
    an int with the offset of the first occurrence of the given .
  - indexOf
```
int indexOf(byte[] pattern,
            int fromPosition)
```
    Like the indexOf in String object this find a pattern of bytes and reports the position they start at.
    
    Parameters:
    
    pattern - byte[] pattern to search for
    
    fromPosition - Starting index to search from, inclusive
    
    Returns:
    
    an int with the offset of the first occurrence of the given .
  - remaining
```
int remaining()
```
    Check how much data is available in the MergedByteBuffer.
    
    Returns:
    
    the current about of space remaining in the MergedByteBuffer.
  - hasRemaining
```
boolean hasRemaining()
```
    Returns if there is any data pending in this MergedByteBuffer or not. This can be more efficient then calling remaining() on some implementations of MergedByteBuffers.
    
    Returns:
    
    the current about of space remaining in the MergedByteBuffers.
  - get
```
byte get()
```
    Returns the next byte stored in the MergedByteBuffers.
    
    Returns:
    
    the next single Byte from the MergedByteBuffers.
  - getUnsignedByte
```
short getUnsignedByte()
```
    Returns the next byte unsigned as short stored in the MergedByteBuffers.
    
    Returns:
    
    the next single unsigned byte as short from the MergedByteBuffers.
  - getUnsignedShort
```
int getUnsignedShort()
```
    Returns an unsigned short (as an int) from the next 2 stored bytes.
    
    Returns:
    
    the next 2 byte as an int (unsigned Short)
  - getShort
```
short getShort()
```
    Returns the next 2 bytes as a short value.
    
    Returns:
    
    short of the next 2 bytes.
  - getInt
```
int getInt()
```
    Returns the next 4 bytes as an int value.
    
    Returns:
    
    an int from the next 4 bytes
  - getUnsignedInt
```
long getUnsignedInt()
```
    Returns an unsigned short (as an int) from the next 2 stored bytes.
    
    Returns:
    
    the next 2 byte as an int (unsigned Short)
  - getLong
```
long getLong()
```
    Returns the next 8 bytes as a long value.
    
    Returns:
    
    a long from the next 8 bytes.
  - get
```
int get(byte[] destBytes)
```
    Fills the passed byte[] completely with data from the MergedByteBuffer.
    
    Parameters:
    
    destBytes - fills the given byteArray with the next bytes from the MergedByteBuffer.
    
    Returns:
    
    number of bytes copied into destBytes.
  - get
```
int get(byte[] destBytes,
        int start,
        int length)
```
    Fills the passed byte[] completely with data from the MergedByteBuffer.
    
    Parameters:
    
    destBytes - fills the given byteArray with the next bytes from the MergedByteBuffer.
    
    start - starting position to fill in the byte[].
    
    length - how much data to copy into the buffer.
    
    Returns:
    
    number of bytes copied into destBytes.
  - nextBufferSize
```
int nextBufferSize()
```
    Get the size of the next full ByteBuffer in the queue.
    
    Returns:
    
    the size of the next ByteBuffer in the queue.
  - popBuffer
```
java.nio.ByteBuffer popBuffer()
```
    Get the next Complete ByteBuffer in its entirety. This byteBuffer could be any size and it will just pull it off the queue and return it. If remaining() is 0 you will get an empty ByteBuffer.
    
    Returns:
    
    the next ByteBuffer in the queue.
  - pullBuffer
```
java.nio.ByteBuffer pullBuffer(int size)
```
    Parameters:
    
    size - size of the ByteBuffer to pull out of the MergedByteBuffer.
    
    Returns:
    
    a ByteBuffer of %SIZE% bytes.
  - discard
```
void discard(int size)
```
    Discard will drop how ever many bytes you tell it to on the floor.
    
    Parameters:
    
    size - the number of bytes to discard.
  - discardFromEnd
```
void discardFromEnd(int size)
```
    Similar to discard(int) except that the bytes removed from this will be from the end of the buffer and discard towards the head.
    
    Parameters:
    
    size - the number of bytes to discard.
  - getAsString
```
java.lang.String getAsString(int size)
```
    This will return the specified number of bytes as a String object. This will default to using the US-ASCII Charset.
    
    Parameters:
    
    size - the number of bytes to put into the string.
    
    Returns:
    
    as String Object with set number of bytes in it.
  - getAsString
```
java.lang.String getAsString(int size,
                             java.nio.charset.Charset charSet)
```
    This will return the specified number of bytes as a String object.
    
    Parameters:
    
    size - the number of bytes to put into the string.
    
    charSet - the Charset of the String to return.
    
    Returns:
    
    as String Object with set number of bytes in it.
  - getTotalConsumedBytes
```
long getTotalConsumedBytes()
```
    This will return the number of bytes that has been consumed by this MergedByteBuffer.
    
    Returns:
    
    The total number of bytes that haven been pushed through this MergedByteBuffer.
  - isAppendable
```
boolean isAppendable()
```
    Returns:
    
    true if ByteByffers can be added to this MergedByteBuffers or false if they can not be.
  - asInputStream
```
java.io.InputStream asInputStream()
```

Interface MergedByteBuffers

Field Summary

Method Summary

Field Detail

BYTES_IN_LONG

BYTES_IN_INT

BYTES_IN_SHORT

UNSIGNED_BYTE_MASK

UNSIGNED_SHORT_MASK

UNSIGNED_INT_MASK

Method Detail

add

add

add

add

duplicate

duplicateAndClean

indexOf

indexOf

indexOf

indexOf

indexOf

indexOf

remaining

hasRemaining

get

getUnsignedByte

getUnsignedShort

getShort

getInt

getUnsignedInt

getLong

get

get

nextBufferSize

popBuffer

pullBuffer

discard

discardFromEnd

getAsString

getAsString

getTotalConsumedBytes

isAppendable

asInputStream