StreamBuffer

All Known Implementing Classes:

StreamBufferArrayImpl, StreamBufferImpl
```
public interface StreamBuffer
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`StreamBuffer`	`advance(int relPosition)` Adjust the position by a relative amount.
`StreamBuffer`	`clear()` Clear the contents of the stream buffer, setting position and length to 0.
`StreamBuffer`	`clear(int clearBytes)` Clear bytes from the current position, cutting them from the buffer.
`void`	`consolidateAndFree()` Copies buffer contents into a single heap buffer and frees unused buffers.
`StreamBuffer`	`duplicate()`
`StreamBuffer`	`duplicate(int viewLength)`
`StreamBuffer`	`flip()` Sets the position of the buffer to 0 and resets the insert mode.
`byte`	`get()` Read a byte from the underlying buffers.
`int`	`get(byte[] dst)` Read bytes from the underlying buffers into a byte array.
`int`	`get(byte[] dst, int offset, int length)` Read bytes from the underlying buffers into a byte array, starting at the provided offset and reading a total of length bytes.
`int`	`get(java.nio.ByteBuffer dst)` Read as many bytes as possible from the underlying buffers into a byte buffer.
`char`	`getChar()` Read a char from the underlying buffers.
`double`	`getDouble()` Read a double from the underlying buffers.
`float`	`getFloat()` Read a float from the underlying buffers.
`int`	`getInt()` Read an integer from the underlying buffers.
`long`	`getLong()` Read a long from the underlying buffers.
`short`	`getShort()` Read a short from the underlying buffers.
`void`	`growthPolicy(boolean newGrowth)` Set the current growth policy, defaulting to true.
`boolean`	`hasRemaining()`
`StreamBuffer`	`insert(boolean newInsert)` Set the current insert mode.
`int`	`length()`
`int`	`position()`
`StreamBuffer`	`position(int newPosition)` Set the current buffer position.
`void`	`preAllocate(int minLength)` Pre-allocate buffers for writing, extending the length to the passed size.
`StreamBuffer`	`put(byte value)` Write a byte to the underlying buffers, allocating more if needed.
`StreamBuffer`	`put(byte[] src)` Write a byte array to the underlying buffers, allocating more if needed.
`StreamBuffer`	`put(byte[] src, int offset, int length)` Write part of a byte array to the underlying buffers, starting at the provided offset and limited by the provided length, allocating more if needed.
`StreamBuffer`	`put(java.nio.ByteBuffer... srcBuffers)` Write ByteBuffer contents to the underlying buffers, allocating more if needed.
`StreamBuffer`	`putChar(char value)` Write a char to the underlying buffers, allocating more if needed.
`StreamBuffer`	`putDouble(double value)` Write a double to the underlying buffers, allocating more if needed.
`StreamBuffer`	`putFloat(float value)` Write a float to the underlying buffers, allocating more if needed.
`StreamBuffer`	`putInt(int value)` Write an integer to the underlying buffers, allocating more if needed.
`StreamBuffer`	`putLong(long value)` Write a long to the underlying buffers, allocating more if needed.
`StreamBuffer`	`putNoCopy(java.nio.ByteBuffer... ncBuffers)` Add ByteBuffers to the list of underlying buffers, the position is advanced by the content length.
`StreamBuffer`	`putShort(short value)` Write a short to the underlying buffers, allocating more if needed.
`void`	`recyclePolicy(boolean newRecyle)` Set the current recycle policy, defaulting to false.
`int`	`remaining()`
`StreamBuffer`	`rewind()` Sets the position of the buffer to 0 and resets the insert mode.
`byte[]`	`toByteArray()` Obtain the contents of this buffer as a byte array.
`java.nio.ByteBuffer[]`	`toByteBuffers()` Obtain the contents of this buffer as byte buffers.

- Method Detail
  - length
```
int length()
```
    Returns:
    
    The length of bytes stored in the buffer.
  - position
```
int position()
```
    Returns:
    
    The current position of the buffer.
  - position
```
StreamBuffer position(int newPosition)
```
    Set the current buffer position.
    
    Parameters:
    
    newPosition - An int from 0 to the length of the buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - advance
```
StreamBuffer advance(int relPosition)
```
    Adjust the position by a relative amount.
    
    Parameters:
    
    relPosition - The relative number of bytes to adjust the position.
    
    Returns:
    
    A reference to this stream buffer.
  - remaining
```
int remaining()
```
    Returns:
    
    The number of bytes remaining in this buffer, the length-position.
  - hasRemaining
```
boolean hasRemaining()
```
    Returns:
    
    True if there is at least one byte remaining, false otherwise.
  - insert
```
StreamBuffer insert(boolean newInsert)
```
    Set the current insert mode.
    
    Parameters:
    
    newInsert - True to insert, false to overwrite
    
    Returns:
    
    A reference to this stream buffer.
  - growthPolicy
```
void growthPolicy(boolean newGrowth)
```
    Set the current growth policy, defaulting to true. This setting is ignored while in insert mode. Puts that exceed the length will be allowed if true.
    
    Parameters:
    
    newGrowth - True to grow, false to limit puts to the length.
  - recyclePolicy
```
void recyclePolicy(boolean newRecyle)
```
    Set the current recycle policy, defaulting to false. If true, buffers that erased due to a clear operation may be reused when the buffer grows again.
    
    Parameters:
    
    newGrowth - True to recycle cleared buffers, false to discard them.
  - flip
```
StreamBuffer flip()
```
    Sets the position of the buffer to 0 and resets the insert mode.
    
    Returns:
    
    A reference to this stream buffer.
  - rewind
```
StreamBuffer rewind()
```
    Sets the position of the buffer to 0 and resets the insert mode.
    
    Returns:
    
    A reference to this stream buffer.
  - clear
```
StreamBuffer clear()
```
    Clear the contents of the stream buffer, setting position and length to 0.
    
    Returns:
    
    A reference to this stream buffer.
  - clear
```
StreamBuffer clear(int clearBytes)
```
    Clear bytes from the current position, cutting them from the buffer.
    
    Parameters:
    
    clearBytes - - The number of bytes to clear from the current position.
    
    Returns:
    
    A reference to this stream buffer.
  - duplicate
```
StreamBuffer duplicate()
```
    Returns:
    
    A new stream buffer that shares a read-only view of this buffer's content. Changes to this stream buffer may be reflected in the new buffer in undefined ways. Changes to the new buffer will not alter the original buffer. The new buffer's position, length, and insert mode are independent.
  - duplicate
```
StreamBuffer duplicate(int viewLength)
```
    Parameters:
    
    viewLength - - The number of bytes from the current position to include.
    
    Returns:
    
    A new stream buffer that shares a read-only view of this buffer's content from the current position to the current position plus the given length. Changes to this stream buffer may be reflected in the new buffer in undefined ways. Changes to the new buffer will not alter the original buffer. The new buffer's position, length, and insert mode are independent.
  - preAllocate
```
void preAllocate(int minLength)
```
    Pre-allocate buffers for writing, extending the length to the passed size.
    
    Parameters:
    
    minLength -
  - consolidateAndFree
```
void consolidateAndFree()
```
    Copies buffer contents into a single heap buffer and frees unused buffers.
  - put
```
StreamBuffer put(byte value)
```
    Write a byte to the underlying buffers, allocating more if needed. The position is advanced by 1, and length is adjusted appropriately.
    
    Parameters:
    
    value - The byte to write to buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - putChar
```
StreamBuffer putChar(char value)
```
    Write a char to the underlying buffers, allocating more if needed. The position is advanced by 2, and length is adjusted appropriately.
    
    Parameters:
    
    value - The char to write to buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - putShort
```
StreamBuffer putShort(short value)
```
    Write a short to the underlying buffers, allocating more if needed. The position is advanced by 2, and length is adjusted appropriately.
    
    Parameters:
    
    value - The short to write to buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - putInt
```
StreamBuffer putInt(int value)
```
    Write an integer to the underlying buffers, allocating more if needed. The position is advanced by 4, and length is adjusted appropriately.
    
    Parameters:
    
    value - The integer to write to buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - putLong
```
StreamBuffer putLong(long value)
```
    Write a long to the underlying buffers, allocating more if needed. The position is advanced by 8, and length is adjusted appropriately.
    
    Parameters:
    
    value - The long to write to buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - putFloat
```
StreamBuffer putFloat(float value)
```
    Write a float to the underlying buffers, allocating more if needed. The position is advanced by 4, and length is adjusted appropriately.
    
    Parameters:
    
    value - The float to write to buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - putDouble
```
StreamBuffer putDouble(double value)
```
    Write a double to the underlying buffers, allocating more if needed. The position is advanced by 8, and length is adjusted appropriately.
    
    Parameters:
    
    value - The double to write to buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - put
```
StreamBuffer put(byte[] src)
```
    Write a byte array to the underlying buffers, allocating more if needed. The position is advanced by the length of the array, and length is adjusted appropriately.
    
    Parameters:
    
    src - The byte array to write to buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - put
```
StreamBuffer put(byte[] src,
                 int offset,
                 int length)
```
    Write part of a byte array to the underlying buffers, starting at the provided offset and limited by the provided length, allocating more if needed. The position is advanced by provided length, and length is adjusted appropriately.
    
    Parameters:
    
    value - The byte array to write to buffer.
    
    offset - The starting offset in the byte array.
    
    length - The number of bytes to write from the offset.
    
    Returns:
    
    A reference to this stream buffer.
  - put
```
StreamBuffer put(java.nio.ByteBuffer... srcBuffers)
```
    Write ByteBuffer contents to the underlying buffers, allocating more if needed. The position is advanced by the content length.
    
    Parameters:
    
    srcBuffers - One or more ByteBuffers to copy into this buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - putNoCopy
```
StreamBuffer putNoCopy(java.nio.ByteBuffer... ncBuffers)
```
    Add ByteBuffers to the list of underlying buffers, the position is advanced by the content length. When not in insert mode, the clear(..) method is invoked instead of overwriting the previous content. A reference to the passed ByteBuffers is held and modification to the ByteBuffer will alter the stream buffer in undefined ways, same as with getBuffers().
    
    Parameters:
    
    ncBuffers - One or more byte buffers to copy into this buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - get
```
byte get()
```
    Read a byte from the underlying buffers. The position is advanced by 1.
    
    Returns:
    
    The byte read from the buffer.
  - getChar
```
char getChar()
```
    Read a char from the underlying buffers. The position is advanced by 2.
    
    Returns:
    
    The char read from the buffer.
  - getShort
```
short getShort()
```
    Read a short from the underlying buffers. The position is advanced by 2.
    
    Returns:
    
    The short read from the buffer.
  - getInt
```
int getInt()
```
    Read an integer from the underlying buffers. The position is advanced by 4.
    
    Returns:
    
    The integer read from the buffer.
  - getLong
```
long getLong()
```
    Read a long from the underlying buffers. The position is advanced by 8.
    
    Returns:
    
    The long read from the buffer.
  - getFloat
```
float getFloat()
```
    Read a float from the underlying buffers. The position is advanced by 4.
    
    Returns:
    
    The float read from the buffer.
  - getDouble
```
double getDouble()
```
    Read a double from the underlying buffers. The position is advanced by 8.
    
    Returns:
    
    The double read from the buffer.
  - get
```
int get(byte[] dst)
```
    Read bytes from the underlying buffers into a byte array. The position is advanced by the length of the destination array. If this buffer does not contain enough bytes to completely fill the array, an exception is thrown.
    
    Parameters:
    
    dst - The byte array to read into.
    
    Returns:
    
    The number of bytes copied, always equal to dst.lenght.
  - get
```
int get(byte[] dst,
        int offset,
        int length)
```
    Read bytes from the underlying buffers into a byte array, starting at the provided offset and reading a total of length bytes. The position is advanced by length.
    
    Parameters:
    
    dst - The byte array to read into.
    
    offset - The starting offset in the byte array.
    
    length - The number of bytes to read into the byte array.
    
    Returns:
    
    The number of bytes copies, always equal to length.
  - get
```
int get(java.nio.ByteBuffer dst)
```
    Read as many bytes as possible from the underlying buffers into a byte buffer. The position of both buffers is advanced by the number of bytes copied.
    
    Parameters:
    
    dst - The byte buffer to read into.
    
    Returns:
    
    The number of bytes copied into the destination buffer.
  - toByteArray
```
byte[] toByteArray()
```
    Obtain the contents of this buffer as a byte array.
    
    Returns:
    
    A byte array holding the contents of this buffer.
  - toByteBuffers
```
java.nio.ByteBuffer[] toByteBuffers()
```
    Obtain the contents of this buffer as byte buffers.
    
    Returns:
    
    An array of byte buffers holding the contents of this buffer.

Interface StreamBuffer

Method Summary

Method Detail

length

position

position

advance

remaining

hasRemaining

insert

growthPolicy

recyclePolicy

flip

rewind

clear

clear

duplicate

duplicate

preAllocate

consolidateAndFree

put

putChar

putShort

putInt

putLong

putFloat

putDouble

put

put

put

putNoCopy

get

getChar

getShort

getInt

getLong

getFloat

getDouble

get

get

get

toByteArray

toByteBuffers