PowerBuffer (TrueCommons I/O 2.3.4 API)

java.lang.Object
- net.java.truecommons.io.PowerBuffer<This>

Type Parameters:
This - The type of this power buffer.

All Implemented Interfaces:

Cloneable, Comparable<This>

Direct Known Subclasses:

ImmutableBuffer, MutableBuffer
```
public abstract class PowerBuffer<This extends PowerBuffer<This>>
extends Object
implements Comparable<This>, Cloneable
```
Adapts a ByteBuffer to provide an enhanced API, e.g. for reading unsigned integers. This class is a drop-in replacement for ByteBuffer, so you can use a PowerBuffer wherever you would otherwise use a ByteBuffer.

Author:

Christian Schlichtherle

Method Summary

Methods
Modifier and Type	Method and Description
`static PowerBuffer<?>`	`allocate(int capacity)`
`static PowerBuffer<?>`	`allocateDirect(int capacity)`
`byte[]`	`array()`
`int`	`arrayOffset()`
`CharBuffer`	`asCharBuffer()`
`DoubleBuffer`	`asDoubleBuffer()`
`FloatBuffer`	`asFloatBuffer()`
`abstract ImmutableBuffer`	`asImmutableBuffer()` Returns an immutable buffer view of the adapted byte buffer.
`IntBuffer`	`asIntBuffer()`
`LongBuffer`	`asLongBuffer()`
`abstract MutableBuffer`	`asMutableBuffer()` Returns a mutable buffer view of the adapted byte buffer.
`abstract This`	`asReadOnlyBuffer()`
`ShortBuffer`	`asShortBuffer()`
`This`	`bigEndian()` Sets the byte order to big endian.
`ByteBuffer`	`buffer()` Returns the adapted byte buffer.
`int`	`capacity()`
`This`	`clear()`
`This`	`clone()` Like `duplicate()` but retains the byte oder, too.
`This`	`compact()`
`int`	`compareTo(This that)` Obtains the adapted byte `buffer()` from the given power buffer and forwards the call to `ByteBuffer.compareTo(ByteBuffer)`.
`abstract This`	`duplicate()`
`boolean`	`equals(Object that)` Returns `true` if and only if the given object is an instance of this class and this power buffer's adapted byte buffer compares equal with that power buffer's adapted byte buffer.
`This`	`flip()`
`byte`	`get()`
`This`	`get(byte[] dst)`
`This`	`get(byte[] dst, int offset, int length)`
`byte`	`get(int index)`
`char`	`getChar()`
`char`	`getChar(int index)`
`double`	`getDouble()`
`double`	`getDouble(int index)`
`float`	`getFloat()`
`float`	`getFloat(int index)`
`int`	`getInt()`
`int`	`getInt(int index)`
`long`	`getLong()`
`long`	`getLong(int index)`
`short`	`getShort()`
`short`	`getShort(int index)`
`int`	`getUByte()` Reads an unsigned byte from the current position.
`int`	`getUByte(int index)` Reads an unsigned byte from the given position.
`long`	`getUInt()` Reads an unsigned int from the current position.
`long`	`getUInt(int index)` Reads an unsigned int from the given position.
`int`	`getUShort()` Reads an unsigned short from the current position.
`int`	`getUShort(int index)` Reads an unsigned short from the given position.
`boolean`	`hasArray()`
`int`	`hashCode()`
`boolean`	`hasRemaining()`
`boolean`	`isDirect()`
`abstract boolean`	`isMutable()` Returns `true` if and only if this power buffer is mutable.
`boolean`	`isReadOnly()`
`int`	`limit()`
`This`	`limit(int newLimit)`
`This`	`littleEndian()` Sets the byte order to little endian.
`This`	`load(ReadableByteChannel channel)` Marks this buffer, reads all remaining bytes from the given channel and resets this buffer.
`This`	`mark()`
`ByteOrder`	`order()`
`This`	`order(ByteOrder order)`
`int`	`position()`
`This`	`position(int newPosition)`
`This`	`put(byte b)`
`This`	`put(byte[] src)`
`This`	`put(byte[] src, int offset, int length)`
`This`	`put(ByteBuffer src)`
`This`	`put(int index, byte b)`
`This`	`put(PowerBuffer<?> src)` Obtains the adapted byte `buffer()` from the given power buffer and forwards the call to `put(ByteBuffer)`.
`This`	`putChar(char value)`
`This`	`putChar(int index, char value)`
`This`	`putDouble(double value)`
`This`	`putDouble(int index, double value)`
`This`	`putFloat(float value)`
`This`	`putFloat(int index, float value)`
`This`	`putInt(int value)`
`This`	`putInt(int index, int value)`
`This`	`putLong(int index, long value)`
`This`	`putLong(long value)`
`This`	`putShort(int index, short value)`
`This`	`putShort(short value)`
`int`	`remaining()`
`This`	`reset()`
`This`	`rewind()`
`This`	`save(WritableByteChannel channel)` Marks this buffer, writes all remaining bytes to the given channel and resets this buffer.
`This`	`skip(int skip)` Skips the given number of bytes.
`abstract This`	`slice()`
`String`	`toString()` Returns a string representation of this object for logging and debugging purposes.
`static PowerBuffer<?>`	`wrap(byte[] array)`
`static PowerBuffer<?>`	`wrap(byte[] array, int offset, int length)`
`static PowerBuffer<?>`	`wrap(ByteBuffer buffer)`

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

- Method Detail
  - allocate
```
public static PowerBuffer<?> allocate(int capacity)
```
    See Also:
    MutableBuffer.allocate(int)
  - allocateDirect
```
public static PowerBuffer<?> allocateDirect(int capacity)
```
    See Also:
    MutableBuffer.allocateDirect(int)
  - array
```
public byte[] array()
```
    See Also:
    ByteBuffer.array()
  - arrayOffset
```
public final int arrayOffset()
```
    See Also:
    ByteBuffer.arrayOffset()
  - asCharBuffer
```
public final CharBuffer asCharBuffer()
```
    See Also:
    ByteBuffer.asCharBuffer()
  - asDoubleBuffer
```
public final DoubleBuffer asDoubleBuffer()
```
    See Also:
    ByteBuffer.asDoubleBuffer()
  - asFloatBuffer
```
public final FloatBuffer asFloatBuffer()
```
    See Also:
    ByteBuffer.asFloatBuffer()
  - asImmutableBuffer
```
public abstract ImmutableBuffer asImmutableBuffer()
```
    Returns an immutable buffer view of the adapted byte buffer. The properties of the returned buffer are equal to the properties of this buffer, including its byte order().
  - asIntBuffer
```
public final IntBuffer asIntBuffer()
```
    See Also:
    ByteBuffer.asIntBuffer()
  - asLongBuffer
```
public final LongBuffer asLongBuffer()
```
    See Also:
    ByteBuffer.asLongBuffer()
  - asMutableBuffer
```
public abstract MutableBuffer asMutableBuffer()
```
    Returns a mutable buffer view of the adapted byte buffer. The properties of the returned buffer are equal to the properties of this buffer, including its byte order().
  - asReadOnlyBuffer
```
public abstract This asReadOnlyBuffer()
```
    See Also:
    ByteBuffer.asReadOnlyBuffer()
  - asShortBuffer
```
public final ShortBuffer asShortBuffer()
```
    See Also:
    ByteBuffer.asShortBuffer()
  - bigEndian
```
public This bigEndian()
```
    Sets the byte order to big endian.
    
    Returns:
    this.
  - buffer
```
public ByteBuffer buffer()
```
    Returns the adapted byte buffer.
    
    Returns:
    The adapted byte buffer.
  - capacity
```
public final int capacity()
```
    See Also:
    Buffer.capacity()
  - clear
```
public This clear()
```
    See Also:
    Buffer.clear()
  - clone
```
public This clone()
```
    Like duplicate() but retains the byte oder, too.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    A duplicate() with the same byte order.
  - compact
```
public This compact()
```
    See Also:
    ByteBuffer.compact()
  - compareTo
```
public final int compareTo(This that)
```
    Obtains the adapted byte buffer() from the given power buffer and forwards the call to ByteBuffer.compareTo(ByteBuffer).
    
    Specified by:
    
    compareTo in interface Comparable<This extends PowerBuffer<This>>
    
    Parameters:
    that - the power buffer to compare with this power buffer.
    
    Returns:
    whether the adapted byte buffer compares less than, equal to or greater than the adapted byte buffer of the given power buffer.
  - duplicate
```
public abstract This duplicate()
```
    See Also:
    ByteBuffer.duplicate()
  - equals
```
public final boolean equals(Object that)
```
    Returns true if and only if the given object is an instance of this class and this power buffer's adapted byte buffer compares equal with that power buffer's adapted byte buffer.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    that - the object to test for equality.
  - flip
```
public This flip()
```
    See Also:
    Buffer.flip()
  - get
```
public byte get()
```
    See Also:
    ByteBuffer.get()
  - get
```
public This get(byte[] dst)
```
    See Also:
    ByteBuffer.get(byte[])
  - get
```
public This get(byte[] dst,
       int offset,
       int length)
```
    See Also:
    ByteBuffer.get(byte[], int, int)
  - get
```
public final byte get(int index)
```
    See Also:
    ByteBuffer.get(int)
  - getChar
```
public char getChar()
```
    See Also:
    ByteBuffer.getChar()
  - getChar
```
public final char getChar(int index)
```
    See Also:
    ByteBuffer.getChar(int)
  - getDouble
```
public double getDouble()
```
    See Also:
    ByteBuffer.getDouble()
  - getDouble
```
public final double getDouble(int index)
```
    See Also:
    ByteBuffer.getDouble(int)
  - getFloat
```
public float getFloat()
```
    See Also:
    ByteBuffer.getFloat()
  - getFloat
```
public final float getFloat(int index)
```
    See Also:
    ByteBuffer.getFloat(int)
  - getInt
```
public int getInt()
```
    See Also:
    ByteBuffer.getInt()
  - getInt
```
public final int getInt(int index)
```
    See Also:
    ByteBuffer.getInt(int)
  - getLong
```
public long getLong()
```
    See Also:
    ByteBuffer.getLong()
  - getLong
```
public final long getLong(int index)
```
    See Also:
    ByteBuffer.getLong(int)
  - getShort
```
public short getShort()
```
    See Also:
    ByteBuffer.getShort()
  - getShort
```
public final short getShort(int index)
```
    See Also:
    ByteBuffer.getShort(int)
  - getUByte
```
public int getUByte()
```
    Reads an unsigned byte from the current position.
    
    Returns:
    The unsigned byte, cast to an integer.
  - getUByte
```
public final int getUByte(int index)
```
    Reads an unsigned byte from the given position.
    
    Parameters:
    index - the index position.
    
    Returns:
    The unsigned byte, cast to an integer.
  - getUInt
```
public long getUInt()
```
    Reads an unsigned int from the current position.
    
    Returns:
    The unsigned int, cast to a long.
  - getUInt
```
public final long getUInt(int index)
```
    Reads an unsigned int from the given position.
    
    Parameters:
    index - the index position.
    
    Returns:
    The unsigned int, cast to a long.
  - getUShort
```
public int getUShort()
```
    Reads an unsigned short from the current position.
    
    Returns:
    The unsigned short, cast to an integer.
  - getUShort
```
public final int getUShort(int index)
```
    Reads an unsigned short from the given position.
    
    Parameters:
    index - the index position.
    
    Returns:
    The unsigned short, cast to an integer.
  - hasArray
```
public final boolean hasArray()
```
    See Also:
    ByteBuffer.hasArray()
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
    
    See Also:
    ByteBuffer.hashCode()
  - hasRemaining
```
public final boolean hasRemaining()
```
    See Also:
    Buffer.hasRemaining()
  - isDirect
```
public final boolean isDirect()
```
    See Also:
    ByteBuffer.isDirect()
  - isMutable
```
public abstract boolean isMutable()
```
    Returns true if and only if this power buffer is mutable.
  - isReadOnly
```
public final boolean isReadOnly()
```
    See Also:
    Buffer.isReadOnly()
  - limit
```
public final int limit()
```
    See Also:
    Buffer.limit()
  - limit
```
public This limit(int newLimit)
```
    See Also:
    Buffer.limit(int)
  - littleEndian
```
public This littleEndian()
```
    Sets the byte order to little endian.
    
    Returns:
    this.
  - load
```
public This load(ReadableByteChannel channel)
                                    throws EOFException,
                                           IOException
```
    Marks this buffer, reads all remaining bytes from the given channel and resets this buffer. If an IOException occurs or the end-of-file is reached before this buffer has been entirely filled, then it does not get reset and the IOException or an EOFException gets thrown respectively.
    
    Parameters:
    channel - the channel.
    
    Returns:
    this.
    
    Throws:
    
    EOFException - on unexpected end-of-file.
    
    IOException - on any I/O error.
  - mark
```
public This mark()
```
    See Also:
    Buffer.mark()
  - order
```
public final ByteOrder order()
```
    See Also:
    ByteBuffer.order()
  - order
```
public This order(ByteOrder order)
```
    See Also:
    ByteBuffer.order(ByteOrder)
  - position
```
public final int position()
```
    See Also:
    Buffer.position()
  - position
```
public This position(int newPosition)
```
    See Also:
    Buffer.position(int)
  - put
```
public This put(byte b)
```
    See Also:
    ByteBuffer.put(byte)
  - put
```
public This put(byte[] src)
```
    See Also:
    ByteBuffer.put(byte[])
  - put
```
public This put(byte[] src,
       int offset,
       int length)
```
    See Also:
    ByteBuffer.put(byte[], int, int)
  - put
```
public This put(ByteBuffer src)
```
    See Also:
    ByteBuffer.put(ByteBuffer)
  - put
```
public final This put(int index,
       byte b)
```
    See Also:
    ByteBuffer.put(int, byte)
  - put
```
public final This put(PowerBuffer<?> src)
```
    Obtains the adapted byte buffer() from the given power buffer and forwards the call to put(ByteBuffer).
    
    Parameters:
    src - the power buffer with the contents to put into this power buffer.
    
    Returns:
    this
  - putChar
```
public This putChar(char value)
```
    See Also:
    ByteBuffer.putChar(char)
  - putChar
```
public final This putChar(int index,
           char value)
```
    See Also:
    ByteBuffer.putChar(int, char)
  - putDouble
```
public This putDouble(double value)
```
    See Also:
    ByteBuffer.putDouble(double)
  - putDouble
```
public final This putDouble(int index,
             double value)
```
    See Also:
    ByteBuffer.putDouble(int, double)
  - putFloat
```
public This putFloat(float value)
```
    See Also:
    ByteBuffer.putFloat(float)
  - putFloat
```
public final This putFloat(int index,
            float value)
```
    See Also:
    ByteBuffer.putFloat(int, float)
  - putInt
```
public This putInt(int value)
```
    See Also:
    ByteBuffer.putInt(int)
  - putInt
```
public final This putInt(int index,
          int value)
```
    See Also:
    ByteBuffer.putInt(int, int)
  - putLong
```
public final This putLong(int index,
           long value)
```
    See Also:
    ByteBuffer.putLong(int, long)
  - putLong
```
public This putLong(long value)
```
    See Also:
    ByteBuffer.putLong(long)
  - putShort
```
public final This putShort(int index,
            short value)
```
    See Also:
    ByteBuffer.putShort(int, short)
  - putShort
```
public This putShort(short value)
```
    See Also:
    ByteBuffer.putShort(short)
  - remaining
```
public final int remaining()
```
    See Also:
    Buffer.remaining()
  - reset
```
public This reset()
```
    See Also:
    Buffer.reset()
  - rewind
```
public This rewind()
```
    See Also:
    Buffer.rewind()
  - save
```
public This save(WritableByteChannel channel)
                                    throws IOException
```
    Marks this buffer, writes all remaining bytes to the given channel and resets this buffer. If an IOException occurs, then this buffer does not get reset and the IOException gets thrown.
    
    Parameters:
    channel - the channel.
    
    Returns:
    this.
    
    Throws:
    
    IOException - on any I/O error.
  - skip
```
public This skip(int skip)
```
    Skips the given number of bytes. This is a relative move operation to the buffer's position.
    
    Parameters:
    skip - the number of bytes to move forwards. May be negative to move backwards, too.
    
    Returns:
    this.
    
    Throws:
    
    IllegalArgumentException - if attempting to move outside the buffer bounds.
  - slice
```
public abstract This slice()
```
    See Also:
    ByteBuffer.slice()
  - toString
```
public final String toString()
```
    Returns a string representation of this object for logging and debugging purposes.
    
    Overrides:
    
    toString in class Object
  - wrap
```
public static PowerBuffer<?> wrap(byte[] array)
```
    See Also:
    MutableBuffer.wrap(byte[])
  - wrap
```
public static PowerBuffer<?> wrap(byte[] array,
                  int offset,
                  int length)
```
    See Also:
    MutableBuffer.wrap(byte[], int, int)
  - wrap
```
public static PowerBuffer<?> wrap(ByteBuffer buffer)
```
    See Also:
    MutableBuffer.wrap(ByteBuffer)

Class PowerBuffer<This extends PowerBuffer<This>>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

allocate

allocateDirect

array

arrayOffset

asCharBuffer

asDoubleBuffer

asFloatBuffer

asImmutableBuffer

asIntBuffer

asLongBuffer

asMutableBuffer

asReadOnlyBuffer

asShortBuffer

bigEndian

buffer

capacity

clear

clone

compact

compareTo

duplicate

equals

flip

get

get

get

get

getChar

getChar

getDouble

getDouble

getFloat

getFloat

getInt

getInt

getLong

getLong

getShort

getShort

getUByte

getUByte

getUInt

getUInt

getUShort

getUShort

hasArray

hashCode

hasRemaining

isDirect

isMutable

isReadOnly

limit

limit

littleEndian

load

mark

order

order

position

position

put

put

put

put

put

put

putChar

putChar

putDouble

putDouble

putFloat

putFloat

putInt

putInt

putLong

putLong