ReadableBuffer.ByteBufferReader (Qpid Proton-J API)

java.lang.Object
- org.apache.qpid.proton.codec.ReadableBuffer.ByteBufferReader

All Implemented Interfaces:: ReadableBuffer

Enclosing interface:: ReadableBuffer

public static final class ReadableBuffer.ByteBufferReader
extends java.lang.Object
implements ReadableBuffer

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.qpid.proton.codec.ReadableBuffer
  ReadableBuffer.ByteBufferReader

Constructor Summary

Constructors
Constructor and Description

ByteBufferReader(java.nio.ByteBuffer buffer)

Constructors
Constructor and Description
`ByteBufferReader(java.nio.ByteBuffer buffer)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ReadableBuffer.ByteBufferReader`	`allocate(int size)`
`byte[]`	`array()` Returns the primitive array that backs this buffer if one exists and the buffer is not read-only.
`int`	`arrayOffset()` Returns the offset into the backing array of the first element in the buffer.
`java.nio.ByteBuffer`	`byteBuffer()`
`int`	`capacity()` Returns the capacity of the backing buffer of this ReadableBuffer
`ReadableBuffer`	`clear()` Resets the buffer position to zero and sets the limit to the buffer capacity, the mark value is discarded if set.
`ReadableBuffer`	`duplicate()` Creates a duplicate `ReadableBuffer` to this instance.
`boolean`	`equals(java.lang.Object other)`
`ReadableBuffer`	`flip()` Sets the buffer limit to the current position and the position is set to zero, the mark value reset to undefined.
`byte`	`get()` Reads the byte at the current position and advances the position by 1.
`ReadableBuffer`	`get(byte[] data)` A bulk read method that copies bytes from this buffer into the target byte array.
`ReadableBuffer`	`get(byte[] data, int offset, int length)` A bulk read method that copies bytes from this buffer into the target byte array.
`byte`	`get(int index)` Reads the byte at the given index, the buffer position is not affected.
`ReadableBuffer`	`get(WritableBuffer target)` Copy data from this buffer to the target buffer starting from the current position and continuing until either this buffer's remaining bytes are consumed or the target is full.
`double`	`getDouble()` Reads eight bytes from the buffer and returns them as an double value.
`float`	`getFloat()` Reads four bytes from the buffer and returns them as an float value.
`int`	`getInt()` Reads four bytes from the buffer and returns them as an integer value.
`long`	`getLong()` Reads eight bytes from the buffer and returns them as an long value.
`short`	`getShort()` Reads two bytes from the buffer and returns them as an short value.
`boolean`	`hasArray()` Returns true if this ReadableBuffer is backed by an array which can be accessed by the `ReadableBuffer.array()` and `ReadableBuffer.arrayOffset()` methods.
`int`	`hashCode()`
`boolean`	`hasRemaining()`
`int`	`limit()`
`ReadableBuffer`	`limit(int limit)` Sets the current read limit of this buffer to the given value.
`ReadableBuffer`	`mark()` Mark the current position of this buffer which can be returned to after a read operation by calling `ReadableBuffer.reset()`.
`int`	`position()`
`ReadableBuffer`	`position(int position)` Sets the current position of this buffer to the given value.
`java.lang.String`	`readString(java.nio.charset.CharsetDecoder decoder)` Decodes a String from the buffer using the provided `CharsetDecoder` starting the decode at the current position and reading until the limit is reached.
`java.lang.String`	`readUTF8()` Reads a UTF-8 encoded String from the buffer starting the decode at the current position and reading until the limit is reached.
`ReadableBuffer`	`reclaimRead()` Compact the backing storage of this ReadableBuffer, possibly freeing previously-read portions of pooled data or reducing the number of backing arrays if present.
`int`	`remaining()`
`ReadableBuffer`	`reset()` Reset the buffer's position to a previously marked value, the mark should remain set after calling this method.
`ReadableBuffer`	`rewind()` Resets the buffer position to zero and clears and previously set mark.
`ReadableBuffer`	`slice()` Creates a new ReadableBuffer instance that is a view of the readable portion of this buffer.
`java.lang.String`	`toString()`
`static ReadableBuffer.ByteBufferReader`	`wrap(byte[] array)`
`static ReadableBuffer.ByteBufferReader`	`wrap(java.nio.ByteBuffer buffer)`

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

- Constructor Detail
  - ByteBufferReader
```
public ByteBufferReader(java.nio.ByteBuffer buffer)
```
- Method Detail
  - allocate
```
public static ReadableBuffer.ByteBufferReader allocate(int size)
```
  - wrap
```
public static ReadableBuffer.ByteBufferReader wrap(java.nio.ByteBuffer buffer)
```
  - wrap
```
public static ReadableBuffer.ByteBufferReader wrap(byte[] array)
```
  - capacity
```
public int capacity()
```
    Description copied from interface: ReadableBuffer
    
    Returns the capacity of the backing buffer of this ReadableBuffer
    
    Specified by:
    
    capacity in interface ReadableBuffer
    
    Returns:
    
    the capacity of the backing buffer of this ReadableBuffer
  - get
```
public byte get()
```
    Description copied from interface: ReadableBuffer
    
    Reads the byte at the current position and advances the position by 1.
    
    Specified by:
    
    get in interface ReadableBuffer
    
    Returns:
    
    the byte at the current position.
  - get
```
public byte get(int index)
```
    Description copied from interface: ReadableBuffer
    
    Reads the byte at the given index, the buffer position is not affected.
    
    Specified by:
    
    get in interface ReadableBuffer
    
    Parameters:
    
    index - The index in the buffer from which to read the byte.
    
    Returns:
    
    the byte value stored at the target index.
  - getInt
```
public int getInt()
```
    Description copied from interface: ReadableBuffer
    
    Reads four bytes from the buffer and returns them as an integer value. The buffer position is advanced by four byes.
    
    Specified by:
    
    getInt in interface ReadableBuffer
    
    Returns:
    
    and integer value composed of bytes read from the buffer.
  - getLong
```
public long getLong()
```
    Description copied from interface: ReadableBuffer
    
    Reads eight bytes from the buffer and returns them as an long value. The buffer position is advanced by eight byes.
    
    Specified by:
    
    getLong in interface ReadableBuffer
    
    Returns:
    
    and long value composed of bytes read from the buffer.
  - getShort
```
public short getShort()
```
    Description copied from interface: ReadableBuffer
    
    Reads two bytes from the buffer and returns them as an short value. The buffer position is advanced by two byes.
    
    Specified by:
    
    getShort in interface ReadableBuffer
    
    Returns:
    
    and short value composed of bytes read from the buffer.
  - getFloat
```
public float getFloat()
```
    Description copied from interface: ReadableBuffer
    
    Reads four bytes from the buffer and returns them as an float value. The buffer position is advanced by four byes.
    
    Specified by:
    
    getFloat in interface ReadableBuffer
    
    Returns:
    
    and float value composed of bytes read from the buffer.
  - getDouble
```
public double getDouble()
```
    Description copied from interface: ReadableBuffer
    
    Reads eight bytes from the buffer and returns them as an double value. The buffer position is advanced by eight byes.
    
    Specified by:
    
    getDouble in interface ReadableBuffer
    
    Returns:
    
    and double value composed of bytes read from the buffer.
  - limit
```
public int limit()
```
    Specified by:
    
    limit in interface ReadableBuffer
    
    Returns:
    
    the current value of this buffer's limit.
  - get
```
public ReadableBuffer get(byte[] data,
                          int offset,
                          int length)
```
    Description copied from interface: ReadableBuffer
    
    A bulk read method that copies bytes from this buffer into the target byte array.
    
    Specified by:
    
    get in interface ReadableBuffer
    
    Parameters:
    
    data - The byte array to copy bytes read from this buffer.
    
    offset - The offset into the given array where the copy starts.
    
    length - The number of bytes to copy into the target array.
    
    Returns:
    
    a reference to this ReadableBuffer instance.
  - get
```
public ReadableBuffer get(byte[] data)
```
    Description copied from interface: ReadableBuffer
    
    A bulk read method that copies bytes from this buffer into the target byte array.
    
    Specified by:
    
    get in interface ReadableBuffer
    
    Parameters:
    
    data - The byte array to copy bytes read from this buffer.
    
    Returns:
    
    a reference to this ReadableBuffer instance.
  - flip
```
public ReadableBuffer flip()
```
    Description copied from interface: ReadableBuffer
    
    Sets the buffer limit to the current position and the position is set to zero, the mark value reset to undefined.
    
    Specified by:
    
    flip in interface ReadableBuffer
    
    Returns:
    
    a reference to this ReadableBuffer.
  - position
```
public ReadableBuffer position(int position)
```
    Description copied from interface: ReadableBuffer
    
    Sets the current position of this buffer to the given value. If the buffer mark value is defined and is larger than the newly set position is must be discarded.
    
    Specified by:
    
    position in interface ReadableBuffer
    
    Parameters:
    
    position - The new position to set for this buffer.
    
    Returns:
    
    a reference to this ReadableBuffer.
  - slice
```
public ReadableBuffer slice()
```
    Description copied from interface: ReadableBuffer
    
    Creates a new ReadableBuffer instance that is a view of the readable portion of this buffer. The position will be set to zero and the limit and the reported capacity will match the value returned by this buffer's ReadableBuffer.remaining() method, the mark will be undefined.
    
    Specified by:
    
    slice in interface ReadableBuffer
    
    Returns:
    
    a new ReadableBuffer that is a view of the readable portion of this buffer.
  - limit
```
public ReadableBuffer limit(int limit)
```
    Description copied from interface: ReadableBuffer
    
    Sets the current read limit of this buffer to the given value. If the buffer mark value is defined and is larger than the limit the mark will be discarded. If the position is larger than the new limit it will be reset to the new limit.
    
    Specified by:
    
    limit in interface ReadableBuffer
    
    Parameters:
    
    limit - The new read limit to set for this buffer.
    
    Returns:
    
    a reference to this ReadableBuffer.
  - remaining
```
public int remaining()
```
    Specified by:
    
    remaining in interface ReadableBuffer
    
    Returns:
    
    the remaining number of readable bytes in this buffer.
  - position
```
public int position()
```
    Specified by:
    
    position in interface ReadableBuffer
    
    Returns:
    
    the current position from which the next read operation will start.
  - hasRemaining
```
public boolean hasRemaining()
```
    Specified by:
    
    hasRemaining in interface ReadableBuffer
    
    Returns:
    
    true if there are readable bytes still remaining in this buffer.
  - duplicate
```
public ReadableBuffer duplicate()
```
    Description copied from interface: ReadableBuffer
    
    Creates a duplicate ReadableBuffer to this instance.
    The duplicated buffer will have the same position, limit and mark as this buffer. The two buffers share the same backing data.
    
    Specified by:
    
    duplicate in interface ReadableBuffer
    
    Returns:
    
    a duplicate of this ReadableBuffer.
  - byteBuffer
```
public java.nio.ByteBuffer byteBuffer()
```
    Specified by:
    
    byteBuffer in interface ReadableBuffer
    
    Returns:
    
    a ByteBuffer view of the current readable portion of this buffer.
  - readUTF8
```
public java.lang.String readUTF8()
```
    Description copied from interface: ReadableBuffer
    
    Reads a UTF-8 encoded String from the buffer starting the decode at the current position and reading until the limit is reached. The position is advanced to the limit once this method returns. If there is no bytes remaining in the buffer when this method is called a null is returned.
    
    Specified by:
    
    readUTF8 in interface ReadableBuffer
    
    Returns:
    
    a string decoded from the remaining bytes in this buffer.
  - readString
```
public java.lang.String readString(java.nio.charset.CharsetDecoder decoder)
                            throws java.nio.charset.CharacterCodingException
```
    Description copied from interface: ReadableBuffer
    
    Decodes a String from the buffer using the provided CharsetDecoder starting the decode at the current position and reading until the limit is reached. The position is advanced to the limit once this method returns. If there is no bytes remaining in the buffer when this method is called a null is returned.
    
    Specified by:
    
    readString in interface ReadableBuffer
    
    Returns:
    
    a string decoded from the remaining bytes in this buffer.
    
    Throws:
    
    java.nio.charset.CharacterCodingException - if the encoding is invalid for any reason.
  - hasArray
```
public boolean hasArray()
```
    Description copied from interface: ReadableBuffer
    
    Returns true if this ReadableBuffer is backed by an array which can be accessed by the ReadableBuffer.array() and ReadableBuffer.arrayOffset() methods.
    
    Specified by:
    
    hasArray in interface ReadableBuffer
    
    Returns:
    
    true if the buffer is backed by a primitive array.
  - array
```
public byte[] array()
```
    Description copied from interface: ReadableBuffer
    
    Returns the primitive array that backs this buffer if one exists and the buffer is not read-only. The caller should have checked the ReadableBuffer.hasArray() method before calling this method.
    
    Specified by:
    
    array in interface ReadableBuffer
    
    Returns:
    
    the array that backs this buffer is available.
  - arrayOffset
```
public int arrayOffset()
```
    Description copied from interface: ReadableBuffer
    
    Returns the offset into the backing array of the first element in the buffer. The caller should have checked the ReadableBuffer.hasArray() method before calling this method.
    
    Specified by:
    
    arrayOffset in interface ReadableBuffer
    
    Returns:
    
    the offset into the backing array of the first element in the buffer.
  - reclaimRead
```
public ReadableBuffer reclaimRead()
```
    Description copied from interface: ReadableBuffer
    
    Compact the backing storage of this ReadableBuffer, possibly freeing previously-read portions of pooled data or reducing the number of backing arrays if present.
    This is an optional operation and care should be taken in its implementation.
    
    Specified by:
    
    reclaimRead in interface ReadableBuffer
    
    Returns:
    
    a reference to this buffer
  - mark
```
public ReadableBuffer mark()
```
    Description copied from interface: ReadableBuffer
    
    Mark the current position of this buffer which can be returned to after a read operation by calling ReadableBuffer.reset().
    
    Specified by:
    
    mark in interface ReadableBuffer
    
    Returns:
    
    a reference to this ReadableBuffer.
  - reset
```
public ReadableBuffer reset()
```
    Description copied from interface: ReadableBuffer
    
    Reset the buffer's position to a previously marked value, the mark should remain set after calling this method.
    
    Specified by:
    
    reset in interface ReadableBuffer
    
    Returns:
    
    a reference to this ReadableBuffer.
  - rewind
```
public ReadableBuffer rewind()
```
    Description copied from interface: ReadableBuffer
    
    Resets the buffer position to zero and clears and previously set mark.
    
    Specified by:
    
    rewind in interface ReadableBuffer
    
    Returns:
    
    a reference to this ReadableBuffer.
  - clear
```
public ReadableBuffer clear()
```
    Description copied from interface: ReadableBuffer
    
    Resets the buffer position to zero and sets the limit to the buffer capacity, the mark value is discarded if set.
    
    Specified by:
    
    clear in interface ReadableBuffer
    
    Returns:
    
    a reference to this ReadableBuffer.
  - get
```
public ReadableBuffer get(WritableBuffer target)
```
    Description copied from interface: ReadableBuffer
    
    Copy data from this buffer to the target buffer starting from the current position and continuing until either this buffer's remaining bytes are consumed or the target is full.
    
    Specified by:
    
    get in interface ReadableBuffer
    
    Parameters:
    
    target - The WritableBuffer to transfer this buffer's data to.
    
    Returns:
    
    a reference to this ReadableBuffer instance.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object other)
```
    Overrides:
    
    equals in class java.lang.Object

Class ReadableBuffer.ByteBufferReader

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.qpid.proton.codec.ReadableBuffer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ByteBufferReader

Method Detail

allocate

wrap

wrap

capacity

get

get

getInt

getLong

getShort

getFloat

getDouble

limit

get

get

flip

position

slice

limit

remaining

position

hasRemaining

duplicate

byteBuffer

readUTF8

readString

hasArray

array

arrayOffset

reclaimRead

mark

reset

rewind

clear

get

toString

hashCode

equals