ByteBuffer (javadoc 2.3.0 API)

Type Parameters:

T - buffer type
```
public interface ByteBuffer<T>
```
Interface to allow interfacing with different byte buffer implementations, primarily as an abstraction over Netty.

Since:

1.0

Author:

Graeme Rocher

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`T`	`asNativeBuffer()`
`java.nio.ByteBuffer`	`asNioBuffer()` Exposes this buffer's readable bytes as an NIO `ByteBuffer`.
`java.nio.ByteBuffer`	`asNioBuffer(int index, int length)` Exposes this buffer's sub-region as an NIO `ByteBuffer`.
`ByteBuffer`	`capacity(int capacity)` Adjusts the capacity of this buffer.
`byte`	`getByte(int index)` Get the byte at the specified index.
`int`	`indexOf(byte b)` Find the index of the first occurrence of the given byte.
`int`	`maxCapacity()` Returns the maximum allowed capacity of this buffer.
`byte`	`read()` Gets a byte at the current `readerIndex` and increases the `readerIndex` by `1` in this buffer.
`ByteBuffer`	`read(byte[] destination)` Transfers this buffer's data to the specified destination starting at the current `readerIndex` and increases the `readerIndex` by the number of the transferred bytes (= `dst.length`).
`ByteBuffer`	`read(byte[] destination, int offset, int length)` Transfers this buffer's data to the specified destination starting at the current `readerIndex` and increases the `readerIndex` by the number of the transferred bytes (= `length`).
`int`	`readableBytes()` Returns the number of readable bytes which is equal to `(this.writerIndex - this.readerIndex)`.
`java.lang.CharSequence`	`readCharSequence(int length, java.nio.charset.Charset charset)` Gets a `CharSequence` with the given length at the current `readerIndex` and increases the `readerIndex` by the given length.
`int`	`readerIndex()` Returns the `readerIndex` of this buffer.
`ByteBuffer`	`readerIndex(int readPosition)` Sets the `readerIndex` of this buffer.
`ByteBuffer`	`slice(int index, int length)` Create a new `ByteBuffer` whose contents is a shared subsequence of this data buffer's content.
`byte[]`	`toByteArray()` Create a copy of the underlying storage from `buf` into a byte array.
`java.io.InputStream`	`toInputStream()` Convert the `ByteBuffer` into an input stream.
`java.io.OutputStream`	`toOutputStream()` Convert the `ByteBuffer` into an output stream.
`java.lang.String`	`toString(java.nio.charset.Charset charset)` To string.
`int`	`writableBytes()` Returns the number of writable bytes which is equal to `(this.capacity - this.writerIndex)`.
`ByteBuffer`	`write(byte b)` Sets the specified byte at the current `writerIndex` and increases the `writerIndex` by `1` in this buffer.
`ByteBuffer`	`write(byte[] source)` Transfers the specified source array's data to this buffer starting at the current `writerIndex` and increases the `writerIndex` by the number of the transferred bytes (= `src.length`).
`ByteBuffer`	`write(byte[] source, int offset, int length)` Transfers the specified source array's data to this buffer starting at the current `writerIndex` and increases the `writerIndex` by the number of the transferred bytes (= `length`).
`ByteBuffer`	`write(ByteBuffer... buffers)` Write the given `ByteBuffer` instances to this buffer.
`ByteBuffer`	`write(java.nio.ByteBuffer... buffers)` Write the given `ByteBuffer` instances to this buffer.
`ByteBuffer`	`write(java.lang.CharSequence source, java.nio.charset.Charset charset)` Transfers the specified source CharSequence's data to this buffer starting at the current `writerIndex` and increases the `writerIndex` by the number of the transferred bytes (= `src.length`).
`int`	`writerIndex()` Returns the `writerIndex` of this buffer.
`ByteBuffer`	`writerIndex(int position)` Sets the `writerIndex` of this buffer.

- Method Detail
  - asNativeBuffer
```
T asNativeBuffer()
```
    Returns:
    
    The native buffer type
  - readableBytes
```
int readableBytes()
```
    Returns the number of readable bytes which is equal to (this.writerIndex - this.readerIndex).
    
    Returns:
    
    bytes
  - writableBytes
```
int writableBytes()
```
    Returns the number of writable bytes which is equal to (this.capacity - this.writerIndex).
    
    Returns:
    
    The bytes
  - maxCapacity
```
int maxCapacity()
```
    Returns the maximum allowed capacity of this buffer. If a user attempts to increase the capacity of this buffer beyond the maximum capacity using capacity(int) or IllegalArgumentException.
    
    Returns:
    
    The max capacity
  - capacity
```
ByteBuffer capacity(int capacity)
```
    Adjusts the capacity of this buffer. If the newCapacity is less than the current capacity, the content of this buffer is truncated. If the newCapacity is greater than the current capacity, the buffer is appended with unspecified data whose length is (newCapacity - currentCapacity).
    
    Parameters:
    
    capacity - capacity
    
    Returns:
    
    The bytebuffer
  - readerIndex
```
int readerIndex()
```
    Returns the readerIndex of this buffer.
    
    Returns:
    
    The index
  - readerIndex
```
ByteBuffer readerIndex(int readPosition)
```
    Sets the readerIndex of this buffer.
    
    Parameters:
    
    readPosition - readPosition
    
    Returns:
    
    The buffer
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the specified readerIndex is less than 0 or greater than this.writerIndex
  - writerIndex
```
int writerIndex()
```
    Returns the writerIndex of this buffer.
    
    Returns:
    
    The index
  - writerIndex
```
ByteBuffer writerIndex(int position)
```
    Sets the writerIndex of this buffer.
    
    Parameters:
    
    position - The position
    
    Returns:
    
    The index as buffer
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the specified writerIndex is less than this.readerIndex or greater than this.capacity
  - read
```
byte read()
```
    Gets a byte at the current readerIndex and increases the readerIndex by 1 in this buffer.
    
    Returns:
    
    bytes
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if this.readableBytes is less than 1
  - readCharSequence
```
java.lang.CharSequence readCharSequence(int length,
                                        java.nio.charset.Charset charset)
```
    Gets a CharSequence with the given length at the current readerIndex and increases the readerIndex by the given length.
    
    Parameters:
    
    length - the length to read
    
    charset - that should be used
    
    Returns:
    
    the sequence
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if length is greater than this.readableBytes
  - read
```
ByteBuffer read(byte[] destination)
```
    Transfers this buffer's data to the specified destination starting at the current readerIndex and increases the readerIndex by the number of the transferred bytes (= dst.length).
    
    Parameters:
    
    destination - destination
    
    Returns:
    
    bytesBuffer
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if dst.length is greater than this.readableBytes
  - read
```
ByteBuffer read(byte[] destination,
                int offset,
                int length)
```
    Transfers this buffer's data to the specified destination starting at the current readerIndex and increases the readerIndex by the number of the transferred bytes (= length).
    
    Parameters:
    
    destination - The destination byte array
    
    offset - the first index of the destination
    
    length - the number of bytes to transfer
    
    Returns:
    
    bytesBuffer
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the specified dstIndex is less than 0, if length is greater than this.readableBytes, or if dstIndex + length is greater than dst.length
  - write
```
ByteBuffer write(byte b)
```
    Sets the specified byte at the current writerIndex and increases the writerIndex by 1 in this buffer. The 24 high-order bits of the specified value are ignored.
    
    Parameters:
    
    b - The byte to write
    
    Returns:
    
    bytesBuffer
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if this.writableBytes is less than 1
  - write
```
ByteBuffer write(byte[] source)
```
    Transfers the specified source array's data to this buffer starting at the current writerIndex and increases the writerIndex by the number of the transferred bytes (= src.length).
    
    Parameters:
    
    source - The source bytes
    
    Returns:
    
    bytesBuffer
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if src.length is greater than this.writableBytes
  - write
```
ByteBuffer write(java.lang.CharSequence source,
                 java.nio.charset.Charset charset)
```
    Transfers the specified source CharSequence's data to this buffer starting at the current writerIndex and increases the writerIndex by the number of the transferred bytes (= src.length).
    
    Parameters:
    
    source - The char sequence
    
    charset - The charset
    
    Returns:
    
    This buffer
  - write
```
ByteBuffer write(byte[] source,
                 int offset,
                 int length)
```
    Transfers the specified source array's data to this buffer starting at the current writerIndex and increases the writerIndex by the number of the transferred bytes (= length).
    
    Parameters:
    
    source - The source byte array
    
    offset - the first index of the source
    
    length - the number of bytes to transfer
    
    Returns:
    
    bytesBuffer
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the specified srcIndex is less than 0, if srcIndex + length is greater than src.length, or if length is greater than this.writableBytes
  - write
```
ByteBuffer write(ByteBuffer... buffers)
```
    Write the given ByteBuffer instances to this buffer.
    
    Parameters:
    
    buffers - The buffers to write
    
    Returns:
    
    this buffer
  - write
```
ByteBuffer write(java.nio.ByteBuffer... buffers)
```
    Write the given ByteBuffer instances to this buffer.
    
    Parameters:
    
    buffers - The buffers to write
    
    Returns:
    
    this buffer
  - slice
```
ByteBuffer slice(int index,
                 int length)
```
    Create a new ByteBuffer whose contents is a shared subsequence of this data buffer's content. Data between this byte buffer and the returned buffer is shared; though changes in the returned buffer's position will not be reflected in the reading nor writing position of this data buffer.
    
    Parameters:
    
    index - the index at which to start the slice
    
    length - the length of the slice
    
    Returns:
    
    the specified slice of this data buffer
  - asNioBuffer
```
java.nio.ByteBuffer asNioBuffer()
```
    Exposes this buffer's readable bytes as an NIO ByteBuffer. The returned buffer shares the content with this buffer, while changing the position and limit of the returned NIO buffer does not affect the indexes and marks of this buffer. This method is identical to buf.nioBuffer(buf.readerIndex(), buf.readableBytes()). This method does not modify readerIndex or writerIndex of this buffer. Please note that the returned NIO buffer will not see the changes of this buffer if this buffer is a dynamic buffer and it adjusted its capacity.
    
    Returns:
    
    byteBuffer
    
    Throws:
    
    java.lang.UnsupportedOperationException - if this buffer cannot create a ByteBuffer that shares the content with itself
  - asNioBuffer
```
java.nio.ByteBuffer asNioBuffer(int index,
                                int length)
```
    Exposes this buffer's sub-region as an NIO ByteBuffer. The returned buffer shares the content with this buffer, while changing the position and limit of the returned NIO buffer does not affect the indexes and marks of this buffer. This method does not modify readerIndex or writerIndex of this buffer. Please note that the returned NIO buffer will not see the changes of this buffer if this buffer is a dynamic buffer and it adjusted its capacity.
    
    Parameters:
    
    index - The index
    
    length - The length
    
    Returns:
    
    byteBuffer
    
    Throws:
    
    java.lang.UnsupportedOperationException - if this buffer cannot create a ByteBuffer that shares the content with itself
  - toInputStream
```
java.io.InputStream toInputStream()
```
    Convert the ByteBuffer into an input stream.
    
    Returns:
    
    this buffer as an input stream
  - toOutputStream
```
java.io.OutputStream toOutputStream()
```
    Convert the ByteBuffer into an output stream.
    
    Returns:
    
    this buffer as an input stream
  - toByteArray
```
byte[] toByteArray()
```
    Create a copy of the underlying storage from buf into a byte array. The copy will start at readerIndex() and copy readableBytes() bytes.
    
    Returns:
    
    byte array
  - toString
```
java.lang.String toString(java.nio.charset.Charset charset)
```
    To string.
    
    Parameters:
    
    charset - converted charset
    
    Returns:
    
    string
  - indexOf
```
int indexOf(byte b)
```
    Find the index of the first occurrence of the given byte.
    
    Parameters:
    
    b - The byte to find
    
    Returns:
    
    The index of the byte
  - getByte
```
byte getByte(int index)
```
    Get the byte at the specified index.
    
    Parameters:
    
    index - The index
    
    Returns:
    
    The byte

Interface ByteBuffer<T>

Method Summary

Method Detail

asNativeBuffer

readableBytes

writableBytes

maxCapacity

capacity

readerIndex

readerIndex

writerIndex

writerIndex

read

readCharSequence

read

read

write

write

write

write

write

write

slice

asNioBuffer

asNioBuffer

toInputStream

toOutputStream

toByteArray

toString

indexOf

getByte