StreamBufferImpl

java.lang.Object
- ds.funnel.data.buffer.StreamBufferImpl

All Implemented Interfaces:: StreamBuffer

public class StreamBufferImpl
extends java.lang.Object
implements StreamBuffer

Field Summary

Fields
Modifier and Type Field and Description

java.lang.String debugTag

Fields
Modifier and Type	Field and Description
`java.lang.String`	`debugTag`

Constructor Summary

Constructors
Constructor and Description

StreamBufferImpl()

StreamBufferImpl(byte[] inBytes)

Constructors
Constructor and Description
`StreamBufferImpl()`
`StreamBufferImpl(byte[] inBytes)`

Method Summary

All Methods Instance Methods Concrete 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`	`debugCopy()`
`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 getLength)` 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 dstBuffer)` 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 insert)` 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 putLength)` 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.
`java.lang.String`	`toString()`

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

- Field Detail
  - debugTag
```
public java.lang.String debugTag
```
- Constructor Detail
  - StreamBufferImpl
```
public StreamBufferImpl()
```
  - StreamBufferImpl
```
public StreamBufferImpl(byte[] inBytes)
```
- Method Detail
  - length
```
public int length()
```
    Specified by:
    
    length in interface StreamBuffer
    
    Returns:
    
    The length of bytes stored in the buffer.
  - position
```
public int position()
```
    Specified by:
    
    position in interface StreamBuffer
    
    Returns:
    
    The current position of the buffer.
  - position
```
public StreamBuffer position(int newPosition)
```
    Description copied from interface: StreamBuffer
    
    Set the current buffer position.
    
    Specified by:
    
    position in interface StreamBuffer
    
    Parameters:
    
    newPosition - An int from 0 to the length of the buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - advance
```
public StreamBuffer advance(int relPosition)
```
    Description copied from interface: StreamBuffer
    
    Adjust the position by a relative amount.
    
    Specified by:
    
    advance in interface StreamBuffer
    
    Parameters:
    
    relPosition - The relative number of bytes to adjust the position.
    
    Returns:
    
    A reference to this stream buffer.
  - remaining
```
public int remaining()
```
    Specified by:
    
    remaining in interface StreamBuffer
    
    Returns:
    
    The number of bytes remaining in this buffer, the length-position.
  - hasRemaining
```
public boolean hasRemaining()
```
    Specified by:
    
    hasRemaining in interface StreamBuffer
    
    Returns:
    
    True if there is at least one byte remaining, false otherwise.
  - insert
```
public StreamBuffer insert(boolean insert)
```
    Description copied from interface: StreamBuffer
    
    Set the current insert mode.
    
    Specified by:
    
    insert in interface StreamBuffer
    
    Parameters:
    
    insert - True to insert, false to overwrite
    
    Returns:
    
    A reference to this stream buffer.
  - growthPolicy
```
public void growthPolicy(boolean newGrowth)
```
    Description copied from interface: StreamBuffer
    
    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.
    
    Specified by:
    
    growthPolicy in interface StreamBuffer
    
    Parameters:
    
    newGrowth - True to grow, false to limit puts to the length.
  - recyclePolicy
```
public void recyclePolicy(boolean newRecyle)
```
    Description copied from interface: StreamBuffer
    
    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.
    
    Specified by:
    
    recyclePolicy in interface StreamBuffer
  - flip
```
public StreamBuffer flip()
```
    Description copied from interface: StreamBuffer
    
    Sets the position of the buffer to 0 and resets the insert mode.
    
    Specified by:
    
    flip in interface StreamBuffer
    
    Returns:
    
    A reference to this stream buffer.
  - rewind
```
public StreamBuffer rewind()
```
    Description copied from interface: StreamBuffer
    
    Sets the position of the buffer to 0 and resets the insert mode.
    
    Specified by:
    
    rewind in interface StreamBuffer
    
    Returns:
    
    A reference to this stream buffer.
  - clear
```
public StreamBuffer clear()
```
    Description copied from interface: StreamBuffer
    
    Clear the contents of the stream buffer, setting position and length to 0.
    
    Specified by:
    
    clear in interface StreamBuffer
    
    Returns:
    
    A reference to this stream buffer.
  - clear
```
public StreamBuffer clear(int clearBytes)
```
    Description copied from interface: StreamBuffer
    
    Clear bytes from the current position, cutting them from the buffer.
    
    Specified by:
    
    clear in interface StreamBuffer
    
    Parameters:
    
    clearBytes - - The number of bytes to clear from the current position.
    
    Returns:
    
    A reference to this stream buffer.
  - debugCopy
```
public StreamBuffer debugCopy()
```
  - duplicate
```
public StreamBuffer duplicate()
```
    Specified by:
    
    duplicate in interface StreamBuffer
    
    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
```
public StreamBuffer duplicate(int viewLength)
```
    Specified by:
    
    duplicate in interface StreamBuffer
    
    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
```
public void preAllocate(int minLength)
```
    Description copied from interface: StreamBuffer
    
    Pre-allocate buffers for writing, extending the length to the passed size.
    
    Specified by:
    
    preAllocate in interface StreamBuffer
  - consolidateAndFree
```
public void consolidateAndFree()
```
    Description copied from interface: StreamBuffer
    
    Copies buffer contents into a single heap buffer and frees unused buffers.
    
    Specified by:
    
    consolidateAndFree in interface StreamBuffer
  - put
```
public StreamBuffer put(byte value)
```
    Description copied from interface: StreamBuffer
    
    Write a byte to the underlying buffers, allocating more if needed. The position is advanced by 1, and length is adjusted appropriately.
    
    Specified by:
    
    put in interface StreamBuffer
    
    Parameters:
    
    value - The byte to write to buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - putChar
```
public StreamBuffer putChar(char value)
```
    Description copied from interface: StreamBuffer
    
    Write a char to the underlying buffers, allocating more if needed. The position is advanced by 2, and length is adjusted appropriately.
    
    Specified by:
    
    putChar in interface StreamBuffer
    
    Parameters:
    
    value - The char to write to buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - putShort
```
public StreamBuffer putShort(short value)
```
    Description copied from interface: StreamBuffer
    
    Write a short to the underlying buffers, allocating more if needed. The position is advanced by 2, and length is adjusted appropriately.
    
    Specified by:
    
    putShort in interface StreamBuffer
    
    Parameters:
    
    value - The short to write to buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - putInt
```
public StreamBuffer putInt(int value)
```
    Description copied from interface: StreamBuffer
    
    Write an integer to the underlying buffers, allocating more if needed. The position is advanced by 4, and length is adjusted appropriately.
    
    Specified by:
    
    putInt in interface StreamBuffer
    
    Parameters:
    
    value - The integer to write to buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - putLong
```
public StreamBuffer putLong(long value)
```
    Description copied from interface: StreamBuffer
    
    Write a long to the underlying buffers, allocating more if needed. The position is advanced by 8, and length is adjusted appropriately.
    
    Specified by:
    
    putLong in interface StreamBuffer
    
    Parameters:
    
    value - The long to write to buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - putFloat
```
public StreamBuffer putFloat(float value)
```
    Description copied from interface: StreamBuffer
    
    Write a float to the underlying buffers, allocating more if needed. The position is advanced by 4, and length is adjusted appropriately.
    
    Specified by:
    
    putFloat in interface StreamBuffer
    
    Parameters:
    
    value - The float to write to buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - putDouble
```
public StreamBuffer putDouble(double value)
```
    Description copied from interface: StreamBuffer
    
    Write a double to the underlying buffers, allocating more if needed. The position is advanced by 8, and length is adjusted appropriately.
    
    Specified by:
    
    putDouble in interface StreamBuffer
    
    Parameters:
    
    value - The double to write to buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - put
```
public StreamBuffer put(byte[] src)
```
    Description copied from interface: StreamBuffer
    
    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.
    
    Specified by:
    
    put in interface StreamBuffer
    
    Parameters:
    
    src - The byte array to write to buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - put
```
public StreamBuffer put(byte[] src,
                        int offset,
                        int putLength)
```
    Description copied from interface: StreamBuffer
    
    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.
    
    Specified by:
    
    put in interface StreamBuffer
    
    offset - The starting offset in the byte array.
    
    putLength - The number of bytes to write from the offset.
    
    Returns:
    
    A reference to this stream buffer.
  - put
```
public StreamBuffer put(java.nio.ByteBuffer... srcBuffers)
```
    Description copied from interface: StreamBuffer
    
    Write ByteBuffer contents to the underlying buffers, allocating more if needed. The position is advanced by the content length.
    
    Specified by:
    
    put in interface StreamBuffer
    
    Parameters:
    
    srcBuffers - One or more ByteBuffers to copy into this buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - putNoCopy
```
public StreamBuffer putNoCopy(java.nio.ByteBuffer... ncBuffers)
```
    Description copied from interface: StreamBuffer
    
    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().
    
    Specified by:
    
    putNoCopy in interface StreamBuffer
    
    Parameters:
    
    ncBuffers - One or more byte buffers to copy into this buffer.
    
    Returns:
    
    A reference to this stream buffer.
  - get
```
public byte get()
```
    Description copied from interface: StreamBuffer
    
    Read a byte from the underlying buffers. The position is advanced by 1.
    
    Specified by:
    
    get in interface StreamBuffer
    
    Returns:
    
    The byte read from the buffer.
  - getChar
```
public char getChar()
```
    Description copied from interface: StreamBuffer
    
    Read a char from the underlying buffers. The position is advanced by 2.
    
    Specified by:
    
    getChar in interface StreamBuffer
    
    Returns:
    
    The char read from the buffer.
  - getShort
```
public short getShort()
```
    Description copied from interface: StreamBuffer
    
    Read a short from the underlying buffers. The position is advanced by 2.
    
    Specified by:
    
    getShort in interface StreamBuffer
    
    Returns:
    
    The short read from the buffer.
  - getInt
```
public int getInt()
```
    Description copied from interface: StreamBuffer
    
    Read an integer from the underlying buffers. The position is advanced by 4.
    
    Specified by:
    
    getInt in interface StreamBuffer
    
    Returns:
    
    The integer read from the buffer.
  - getLong
```
public long getLong()
```
    Description copied from interface: StreamBuffer
    
    Read a long from the underlying buffers. The position is advanced by 8.
    
    Specified by:
    
    getLong in interface StreamBuffer
    
    Returns:
    
    The long read from the buffer.
  - getFloat
```
public float getFloat()
```
    Description copied from interface: StreamBuffer
    
    Read a float from the underlying buffers. The position is advanced by 4.
    
    Specified by:
    
    getFloat in interface StreamBuffer
    
    Returns:
    
    The float read from the buffer.
  - getDouble
```
public double getDouble()
```
    Description copied from interface: StreamBuffer
    
    Read a double from the underlying buffers. The position is advanced by 8.
    
    Specified by:
    
    getDouble in interface StreamBuffer
    
    Returns:
    
    The double read from the buffer.
  - get
```
public int get(byte[] dst)
```
    Description copied from interface: StreamBuffer
    
    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.
    
    Specified by:
    
    get in interface StreamBuffer
    
    Parameters:
    
    dst - The byte array to read into.
    
    Returns:
    
    The number of bytes copied, always equal to dst.lenght.
  - get
```
public int get(byte[] dst,
               int offset,
               int getLength)
```
    Description copied from interface: StreamBuffer
    
    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.
    
    Specified by:
    
    get in interface StreamBuffer
    
    Parameters:
    
    dst - The byte array to read into.
    
    offset - The starting offset in the byte array.
    
    getLength - The number of bytes to read into the byte array.
    
    Returns:
    
    The number of bytes copies, always equal to length.
  - get
```
public int get(java.nio.ByteBuffer dstBuffer)
```
    Description copied from interface: StreamBuffer
    
    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.
    
    Specified by:
    
    get in interface StreamBuffer
    
    Parameters:
    
    dstBuffer - The byte buffer to read into.
    
    Returns:
    
    The number of bytes copied into the destination buffer.
  - toByteArray
```
public byte[] toByteArray()
```
    Description copied from interface: StreamBuffer
    
    Obtain the contents of this buffer as a byte array.
    
    Specified by:
    
    toByteArray in interface StreamBuffer
    
    Returns:
    
    A byte array holding the contents of this buffer.
  - toByteBuffers
```
public java.nio.ByteBuffer[] toByteBuffers()
```
    Description copied from interface: StreamBuffer
    
    Obtain the contents of this buffer as byte buffers.
    
    Specified by:
    
    toByteBuffers in interface StreamBuffer
    
    Returns:
    
    An array of byte buffers holding the contents of this buffer.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class StreamBufferImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

debugTag

Constructor Detail

StreamBufferImpl

StreamBufferImpl

Method Detail

length

position

position

advance

remaining

hasRemaining

insert

growthPolicy

recyclePolicy

flip

rewind

clear

clear

debugCopy

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

toString