com.sun.grizzly.memory
Class ByteBufferWrapper

java.lang.Object
  com.sun.grizzly.memory.ByteBufferWrapper

All Implemented Interfaces:

Buffer<ByteBuffer>, Comparable<Buffer<ByteBuffer>>

Direct Known Subclasses:

DefaultMemoryManager.TrimAwareWrapper, SlabByteBufferWrapper

public class ByteBufferWrapper
extends Object
implements Buffer<ByteBuffer>

Buffer implementation, which uses the ByteBuffer underneath.

Author:

Ken Cavanaugh, John Vieten, Alexey Stashok

See Also:

Buffer, MemoryManager, ByteBuffer

Field Summary

static boolean	DEBUG_MODE
protected ByteBufferManager	memoryManager
protected ByteBuffer	visible

Constructor Summary

protected	ByteBufferWrapper()
	ByteBufferWrapper(ByteBufferManager memoryManager, ByteBuffer underlyingByteBuffer)

Method Summary

ByteBufferWrapper	asReadOnlyBuffer() Creates a new, read-only byte buffer that shares this buffer's content.
int	capacity() Returns this buffer's capacity.
ByteBufferWrapper	clear() Clears this buffer.
ByteBufferWrapper	compact() Compacts this buffer (optional operation).
int	compareTo(Buffer<ByteBuffer> o)
String	contentAsString(Charset charset) Returns Buffer content as String
void	dispose() Notify the allocator that the space for this Buffer is no longer needed.
ByteBufferWrapper	duplicate() Creates a new byte buffer that shares this buffer's content.
boolean	equals(Object obj)
ByteBufferWrapper	flip() Flips this buffer.
byte	get() Relative get method.
ByteBufferWrapper	get(byte[] dst) Relative bulk get method.
ByteBufferWrapper	get(byte[] dst, int offset, int length) Relative bulk get method.
byte	get(int index) Absolute get method.
char	getChar() Relative get method for reading a char value.
char	getChar(int index) Absolute get method for reading a char value.
double	getDouble() Relative get method for reading a double value.
double	getDouble(int index) Absolute get method for reading a double value.
float	getFloat() Relative get method for reading a float value.
float	getFloat(int index) Absolute get method for reading a float value.
int	getInt() Relative get method for reading an int value.
int	getInt(int index) Absolute get method for reading an int value.
long	getLong() Relative get method for reading a long value.
long	getLong(int index) Absolute get method for reading a long value.
short	getShort() Relative get method for reading a short value.
short	getShort(int index) Absolute get method for reading a short value.
int	hashCode()
boolean	hasRemaining() Tells whether there are any elements between the current position and the limit.
boolean	isReadOnly() Tells whether or not this buffer is read-only.
int	limit() Returns this buffer's limit.
ByteBufferWrapper	limit(int newLimit) Sets this buffer's limit.
ByteBufferWrapper	mark() Sets this buffer's mark at its position.
ByteOrder	order() Retrieves this buffer's byte order.
ByteBufferWrapper	order(ByteOrder bo) Modifies this buffer's byte order.
int	position() Returns this buffer's position.
ByteBufferWrapper	position(int newPosition) Sets this buffer's position.
ByteBuffer	prepend(ByteBuffer header) Prepend data from header.position() to header.limit() to the current buffer.
ByteBufferWrapper	put(Buffer src) Relative bulk put method (optional operation).
ByteBufferWrapper	put(byte b) Relative put method (optional operation).
ByteBufferWrapper	put(byte[] src) Relative bulk put method (optional operation).
ByteBufferWrapper	put(byte[] src, int offset, int length) Relative bulk put method (optional operation).
ByteBufferWrapper	put(int index, byte b) Absolute put method (optional operation).
ByteBufferWrapper	putChar(char value) Relative put method for writing a char value (optional operation).
ByteBufferWrapper	putChar(int index, char value) Absolute put method for writing a char value (optional operation).
ByteBufferWrapper	putDouble(double value) Relative put method for writing a double value (optional operation).
ByteBufferWrapper	putDouble(int index, double value) Absolute put method for writing a double value (optional operation).
ByteBufferWrapper	putFloat(float value) Relative put method for writing a float value (optional operation).
ByteBufferWrapper	putFloat(int index, float value) Absolute put method for writing a float value (optional operation).
ByteBufferWrapper	putInt(int value) Relative put method for writing an int value (optional operation).
ByteBufferWrapper	putInt(int index, int value) Absolute put method for writing an int value (optional operation).
ByteBufferWrapper	putLong(int index, long value) Absolute put method for writing a long value (optional operation).
ByteBufferWrapper	putLong(long value) Relative put method for writing a long value (optional operation).
ByteBufferWrapper	putShort(int index, short value) Absolute put method for writing a short value (optional operation).
ByteBufferWrapper	putShort(short value) Relative put method for writing a short value (optional operation).
int	remaining() Returns the number of elements between the current position and the limit.
ByteBufferWrapper	reset() Resets this buffer's position to the previously-marked position.
ByteBufferWrapper	rewind() Rewinds this buffer.
ByteBufferWrapper	slice() Creates a new byte buffer whose content is a shared subsequence of this buffer's content.
String	toString()
void	trim() Trim the buffer by reducing capacity to position, if possible.
ByteBuffer	underlying() Return the JDK underlying buffer

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEBUG_MODE

public static boolean DEBUG_MODE

memoryManager

protected final ByteBufferManager memoryManager

visible

protected ByteBuffer visible

Constructor Detail

ByteBufferWrapper

protected ByteBufferWrapper()

ByteBufferWrapper

public ByteBufferWrapper(ByteBufferManager memoryManager,
                         ByteBuffer underlyingByteBuffer)

Method Detail

prepend

public ByteBuffer prepend(ByteBuffer header)

Description copied from interface: Buffer

Prepend data from header.position() to header.limit() to the current buffer. This will change the value returned by buffer()!

Specified by:

prepend in interface Buffer<ByteBuffer>

trim

public void trim()

Description copied from interface: Buffer

Trim the buffer by reducing capacity to position, if possible. May return without changing capacity. Also resets the position to 0, like reset().

Specified by:

trim in interface Buffer<ByteBuffer>

dispose

public void dispose()

Description copied from interface: Buffer

Notify the allocator that the space for this Buffer is no longer needed. All calls to methods on a Buffer will fail after a call to dispose().

Specified by:

dispose in interface Buffer<ByteBuffer>

underlying

public ByteBuffer underlying()

Description copied from interface: Buffer

Return the JDK underlying buffer

Specified by:

underlying in interface Buffer<ByteBuffer>

Returns:

the JDK underlying buffer

capacity

public int capacity()

Description copied from interface: Buffer

Returns this buffer's capacity.

Specified by:

capacity in interface Buffer<ByteBuffer>

Returns:

The capacity of this buffer

position

public int position()

Description copied from interface: Buffer

Returns this buffer's position.

Specified by:

position in interface Buffer<ByteBuffer>

Returns:

The position of this buffer

position

public ByteBufferWrapper position(int newPosition)

Description copied from interface: Buffer

Sets this buffer's position. If the mark is defined and larger than the new position then it is discarded.

Specified by:

position in interface Buffer<ByteBuffer>

Parameters:

newPosition - The new position value; must be non-negative and no larger than the current limit

Returns:

This buffer

limit

public int limit()

Description copied from interface: Buffer

Returns this buffer's limit.

Specified by:

limit in interface Buffer<ByteBuffer>

Returns:

The limit of this buffer

limit

public ByteBufferWrapper limit(int newLimit)

Description copied from interface: Buffer

Sets this buffer's limit. If the position is larger than the new limit then it is set to the new limit. If the mark is defined and larger than the new limit then it is discarded.

Specified by:

limit in interface Buffer<ByteBuffer>

Parameters:

newLimit - The new limit value; must be non-negative and no larger than this buffer's capacity

Returns:

This buffer

mark

public ByteBufferWrapper mark()

Description copied from interface: Buffer

Sets this buffer's mark at its position.

Specified by:

mark in interface Buffer<ByteBuffer>

Returns:

This buffer

reset

public ByteBufferWrapper reset()

Description copied from interface: Buffer

Resets this buffer's position to the previously-marked position.

Invoking this method neither changes nor discards the mark's value.

Specified by:

reset in interface Buffer<ByteBuffer>

Returns:

This buffer

clear

public ByteBufferWrapper clear()

Description copied from interface: Buffer

Clears this buffer. The position is set to zero, the limit is set to the capacity, and the mark is discarded.

Invoke this method before using a sequence of channel-read or put operations to fill this buffer. For example:

 buf.clear();     // Prepare buffer for reading
 in.read(buf);    // Read data

This method does not actually erase the data in the buffer, but it is named as if it did because it will most often be used in situations in which that might as well be the case.

Specified by:

clear in interface Buffer<ByteBuffer>

Returns:

This buffer

flip

public ByteBufferWrapper flip()

Description copied from interface: Buffer

Flips this buffer. The limit is set to the current position and then the position is set to zero. If the mark is defined then it is discarded.

After a sequence of channel-read or put operations, invoke this method to prepare for a sequence of channel-write or relative get operations. For example:

 buf.put(magic);    // Prepend header
 in.read(buf);      // Read data into rest of buffer
 buf.flip();        // Flip buffer
 out.write(buf);    // Write header + data to channel

This method is often used in conjunction with the compact method when transferring data from one place to another.

Specified by:

flip in interface Buffer<ByteBuffer>

Returns:

This buffer

rewind

public ByteBufferWrapper rewind()

Description copied from interface: Buffer

Rewinds this buffer. The position is set to zero and the mark is discarded.

Invoke this method before a sequence of channel-write or get operations, assuming that the limit has already been set appropriately. For example:

 out.write(buf);    // Write remaining data
 buf.rewind();      // Rewind buffer
 buf.get(array);    // Copy data into array

Specified by:

rewind in interface Buffer<ByteBuffer>

Returns:

This buffer

remaining

public int remaining()

Description copied from interface: Buffer

Returns the number of elements between the current position and the limit.

Specified by:

remaining in interface Buffer<ByteBuffer>

Returns:

The number of elements remaining in this buffer

hasRemaining

public boolean hasRemaining()

Description copied from interface: Buffer

Tells whether there are any elements between the current position and the limit.

Specified by:

hasRemaining in interface Buffer<ByteBuffer>

Returns:

true if, and only if, there is at least one element remaining in this buffer

isReadOnly

public boolean isReadOnly()

Description copied from interface: Buffer

Tells whether or not this buffer is read-only.

Specified by:

isReadOnly in interface Buffer<ByteBuffer>

Returns:

true if, and only if, this buffer is read-only

slice

public ByteBufferWrapper slice()

Description copied from interface: Buffer

Creates a new byte buffer whose content is a shared subsequence of this buffer's content.

The content of the new buffer will start at this buffer's current position. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer, and its mark will be undefined. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

Specified by:

slice in interface Buffer<ByteBuffer>

Returns:

The new byte buffer

duplicate

public ByteBufferWrapper duplicate()

Description copied from interface: Buffer

Creates a new byte buffer that shares this buffer's content.

The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.

The new buffer's capacity, limit, position, and mark values will be identical to those of this buffer. The new buffer will be direct if, and only if, this buffer is direct, and it will be read-only if, and only if, this buffer is read-only.

Specified by:

duplicate in interface Buffer<ByteBuffer>

Returns:

The new byte buffer

asReadOnlyBuffer

public ByteBufferWrapper asReadOnlyBuffer()

Description copied from interface: Buffer

Creates a new, read-only byte buffer that shares this buffer's content.

The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer; the new buffer itself, however, will be read-only and will not allow the shared content to be modified. The two buffers' position, limit, and mark values will be independent.

The new buffer's capacity, limit, position, and mark values will be identical to those of this buffer.

If this buffer is itself read-only then this method behaves in exactly the same way as the duplicate method.

Specified by:

asReadOnlyBuffer in interface Buffer<ByteBuffer>

Returns:

The new, read-only byte buffer

get

public byte get()

Description copied from interface: Buffer

Relative get method. Reads the byte at this buffer's current position, and then increments the position.

Specified by:

get in interface Buffer<ByteBuffer>

Returns:

The byte at the buffer's current position

get

public byte get(int index)

Description copied from interface: Buffer

Absolute get method. Reads the byte at the given index.

Specified by:

get in interface Buffer<ByteBuffer>

Parameters:

index - The index from which the byte will be read

Returns:

The byte at the given index

put

public ByteBufferWrapper put(byte b)

Description copied from interface: Buffer

Relative put method (optional operation).

Writes the given byte into this buffer at the current position, and then increments the position.

Specified by:

put in interface Buffer<ByteBuffer>

Parameters:

b - The byte to be written

Returns:

This buffer

put

public ByteBufferWrapper put(int index,
                             byte b)

Description copied from interface: Buffer

Absolute put method (optional operation).

Writes the given byte into this buffer at the given index.

Specified by:

put in interface Buffer<ByteBuffer>

Parameters:

index - The index at which the byte will be written

b - The byte value to be written

Returns:

This buffer

get

public ByteBufferWrapper get(byte[] dst)

Description copied from interface: Buffer

Relative bulk get method.

This method transfers bytes from this buffer into the given destination array. An invocation of this method of the form src.get(a) behaves in exactly the same way as the invocation

     src.get(a, 0, a.length) 

Specified by:

get in interface Buffer<ByteBuffer>

Returns:

This buffer

get

public ByteBufferWrapper get(byte[] dst,
                             int offset,
                             int length)

Description copied from interface: Buffer

Relative bulk get method.

This method transfers bytes from this buffer into the given destination array. If there are fewer bytes remaining in the buffer than are required to satisfy the request, that is, if length > remaining(), then no bytes are transferred and a BufferUnderflowException is thrown.

Otherwise, this method copies length bytes from this buffer into the given array, starting at the current position of this buffer and at the given offset in the array. The position of this buffer is then incremented by length.

In other words, an invocation of this method of the form src.get(dst, off, len) has exactly the same effect as the loop

     for (int i = off; i < off + len; i++)
         dst[i] = src.get(); 

except that it first checks that there are sufficient bytes in this buffer and it is potentially much more efficient.

Specified by:

get in interface Buffer<ByteBuffer>

Parameters:

dst - The array into which bytes are to be written

offset - The offset within the array of the first byte to be written; must be non-negative and no larger than dst.length

length - The maximum number of bytes to be written to the given array; must be non-negative and no larger than dst.length - offset

Returns:

This buffer

put

public ByteBufferWrapper put(Buffer src)

Description copied from interface: Buffer

Relative bulk put method (optional operation).

This method transfers the bytes remaining in the given source buffer into this buffer. If there are more bytes remaining in the source buffer than in this buffer, that is, if src.remaining() > remaining(), then no bytes are transferred and a BufferOverflowException is thrown.

Otherwise, this method copies n = src.remaining() bytes from the given buffer into this buffer, starting at each buffer's current position. The positions of both buffers are then incremented by n.

In other words, an invocation of this method of the form dst.put(src) has exactly the same effect as the loop

     while (src.hasRemaining())
         dst.put(src.get()); 

except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.

Specified by:

put in interface Buffer<ByteBuffer>

Parameters:

src - The source buffer from which bytes are to be read; must not be this buffer

Returns:

This buffer

put

public ByteBufferWrapper put(byte[] src)

Description copied from interface: Buffer

Relative bulk put method (optional operation).

This method transfers the entire content of the given source byte array into this buffer. An invocation of this method of the form dst.put(a) behaves in exactly the same way as the invocation

     dst.put(a, 0, a.length) 

Specified by:

put in interface Buffer<ByteBuffer>

Returns:

This buffer

put

public ByteBufferWrapper put(byte[] src,
                             int offset,
                             int length)

Description copied from interface: Buffer

Relative bulk put method (optional operation).

This method transfers bytes into this buffer from the given source array. If there are more bytes to be copied from the array than remain in this buffer, that is, if length > remaining(), then no bytes are transferred and a BufferOverflowException is thrown.

Otherwise, this method copies length bytes from the given array into this buffer, starting at the given offset in the array and at the current position of this buffer. The position of this buffer is then incremented by length.

In other words, an invocation of this method of the form dst.put(src, off, len) has exactly the same effect as the loop

     for (int i = off; i < off + len; i++)
         dst.put(a[i]); 

except that it first checks that there is sufficient space in this buffer and it is potentially much more efficient.

Specified by:

put in interface Buffer<ByteBuffer>

Parameters:

src - The array from which bytes are to be read

offset - The offset within the array of the first byte to be read; must be non-negative and no larger than array.length

length - The number of bytes to be read from the given array; must be non-negative and no larger than array.length - offset

Returns:

This buffer

compact

public ByteBufferWrapper compact()

Description copied from interface: Buffer

Compacts this buffer (optional operation).

The bytes between the buffer's current position and its limit, if any, are copied to the beginning of the buffer. That is, the byte at index p = position() is copied to index zero, the byte at index p + 1 is copied to index one, and so forth until the byte at index limit() - 1 is copied to index n = limit() - 1 - p. The buffer's position is then set to n+1 and its limit is set to its capacity. The mark, if defined, is discarded.

The buffer's position is set to the number of bytes copied, rather than to zero, so that an invocation of this method can be followed immediately by an invocation of another relative put method.

Invoke this method after writing data from a buffer in case the write was incomplete. The following loop, for example, copies bytes from one channel to another via the buffer buf:

 buf.clear();          // Prepare buffer for use
 for (;;) {
     if (in.read(buf) < 0 && !buf.hasRemaining())
         break;        // No more bytes to transfer
     buf.flip();
     out.write(buf);
     buf.compact();    // In case of partial write
 }

Specified by:

compact in interface Buffer<ByteBuffer>

Returns:

This buffer

order

public ByteOrder order()

Description copied from interface: Buffer

Retrieves this buffer's byte order.

The byte order is used when reading or writing multibyte values, and when creating buffers that are views of this byte buffer. The order of a newly-created byte buffer is always BIG_ENDIAN.

Specified by:

order in interface Buffer<ByteBuffer>

Returns:

This buffer's byte order

order

public ByteBufferWrapper order(ByteOrder bo)

Description copied from interface: Buffer

Modifies this buffer's byte order.

Specified by:

order in interface Buffer<ByteBuffer>

Parameters:

bo - The new byte order, either BIG_ENDIAN or LITTLE_ENDIAN

Returns:

This buffer

getChar

public char getChar()

Description copied from interface: Buffer

Relative get method for reading a char value.

Reads the next two bytes at this buffer's current position, composing them into a char value according to the current byte order, and then increments the position by two.

Specified by:

getChar in interface Buffer<ByteBuffer>

Returns:

The char value at the buffer's current position

getChar

public char getChar(int index)

Description copied from interface: Buffer

Absolute get method for reading a char value.

Reads two bytes at the given index, composing them into a char value according to the current byte order.

Specified by:

getChar in interface Buffer<ByteBuffer>

Parameters:

index - The index from which the bytes will be read

Returns:

The char value at the given index

putChar

public ByteBufferWrapper putChar(char value)

Description copied from interface: Buffer

Relative put method for writing a char value (optional operation).

Writes two bytes containing the given char value, in the current byte order, into this buffer at the current position, and then increments the position by two.

Specified by:

putChar in interface Buffer<ByteBuffer>

Parameters:

value - The char value to be written

Returns:

This buffer

putChar

public ByteBufferWrapper putChar(int index,
                                 char value)

Description copied from interface: Buffer

Absolute put method for writing a char value (optional operation).

Writes two bytes containing the given char value, in the current byte order, into this buffer at the given index.

Specified by:

putChar in interface Buffer<ByteBuffer>

Parameters:

index - The index at which the bytes will be written

value - The char value to be written

Returns:

This buffer

getShort

public short getShort()

Description copied from interface: Buffer

Relative get method for reading a short value.

Reads the next two bytes at this buffer's current position, composing them into a short value according to the current byte order, and then increments the position by two.

Specified by:

getShort in interface Buffer<ByteBuffer>

Returns:

The short value at the buffer's current position

getShort

public short getShort(int index)

Description copied from interface: Buffer

Absolute get method for reading a short value.

Reads two bytes at the given index, composing them into a short value according to the current byte order.

Specified by:

getShort in interface Buffer<ByteBuffer>

Parameters:

index - The index from which the bytes will be read

Returns:

The short value at the given index

putShort

public ByteBufferWrapper putShort(short value)

Description copied from interface: Buffer

Relative put method for writing a short value (optional operation).

Writes two bytes containing the given short value, in the current byte order, into this buffer at the current position, and then increments the position by two.

Specified by:

putShort in interface Buffer<ByteBuffer>

Parameters:

value - The short value to be written

Returns:

This buffer

putShort

public ByteBufferWrapper putShort(int index,
                                  short value)

Description copied from interface: Buffer

Absolute put method for writing a short value (optional operation).

Writes two bytes containing the given short value, in the current byte order, into this buffer at the given index.

Specified by:

putShort in interface Buffer<ByteBuffer>

Parameters:

index - The index at which the bytes will be written

value - The short value to be written

Returns:

This buffer

getInt

public int getInt()

Description copied from interface: Buffer

Relative get method for reading an int value.

Reads the next four bytes at this buffer's current position, composing them into an int value according to the current byte order, and then increments the position by four.

Specified by:

getInt in interface Buffer<ByteBuffer>

Returns:

The int value at the buffer's current position

getInt

public int getInt(int index)

Description copied from interface: Buffer

Absolute get method for reading an int value.

Reads four bytes at the given index, composing them into a int value according to the current byte order.

Specified by:

getInt in interface Buffer<ByteBuffer>

Parameters:

index - The index from which the bytes will be read

Returns:

The int value at the given index

putInt

public ByteBufferWrapper putInt(int value)

Description copied from interface: Buffer

Relative put method for writing an int value (optional operation).

Writes four bytes containing the given int value, in the current byte order, into this buffer at the current position, and then increments the position by four.

Specified by:

putInt in interface Buffer<ByteBuffer>

Parameters:

value - The int value to be written

Returns:

This buffer

putInt

public ByteBufferWrapper putInt(int index,
                                int value)

Description copied from interface: Buffer

Absolute put method for writing an int value (optional operation).

Writes four bytes containing the given int value, in the current byte order, into this buffer at the given index.

Specified by:

putInt in interface Buffer<ByteBuffer>

Parameters:

index - The index at which the bytes will be written

value - The int value to be written

Returns:

This buffer

getLong

public long getLong()

Description copied from interface: Buffer

Relative get method for reading a long value.

Reads the next eight bytes at this buffer's current position, composing them into a long value according to the current byte order, and then increments the position by eight.

Specified by:

getLong in interface Buffer<ByteBuffer>

Returns:

The long value at the buffer's current position

getLong

public long getLong(int index)

Description copied from interface: Buffer

Absolute get method for reading a long value.

Reads eight bytes at the given index, composing them into a long value according to the current byte order.

Specified by:

getLong in interface Buffer<ByteBuffer>

Parameters:

index - The index from which the bytes will be read

Returns:

The long value at the given index

putLong

public ByteBufferWrapper putLong(long value)

Description copied from interface: Buffer

Relative put method for writing a long value (optional operation).

Writes eight bytes containing the given long value, in the current byte order, into this buffer at the current position, and then increments the position by eight.

Specified by:

putLong in interface Buffer<ByteBuffer>

Parameters:

value - The long value to be written

Returns:

This buffer

putLong

public ByteBufferWrapper putLong(int index,
                                 long value)

Description copied from interface: Buffer

Absolute put method for writing a long value (optional operation).

Writes eight bytes containing the given long value, in the current byte order, into this buffer at the given index.

Specified by:

putLong in interface Buffer<ByteBuffer>

Parameters:

index - The index at which the bytes will be written

value - The long value to be written

Returns:

This buffer

getFloat

public float getFloat()

Description copied from interface: Buffer

Relative get method for reading a float value.

Reads the next four bytes at this buffer's current position, composing them into a float value according to the current byte order, and then increments the position by four.

Specified by:

getFloat in interface Buffer<ByteBuffer>

Returns:

The float value at the buffer's current position

getFloat

public float getFloat(int index)

Description copied from interface: Buffer

Absolute get method for reading a float value.

Reads four bytes at the given index, composing them into a float value according to the current byte order.

Specified by:

getFloat in interface Buffer<ByteBuffer>

Parameters:

index - The index from which the bytes will be read

Returns:

The float value at the given index

putFloat

public ByteBufferWrapper putFloat(float value)

Description copied from interface: Buffer

Relative put method for writing a float value (optional operation).

Writes four bytes containing the given float value, in the current byte order, into this buffer at the current position, and then increments the position by four.

Specified by:

putFloat in interface Buffer<ByteBuffer>

Parameters:

value - The float value to be written

Returns:

This buffer

putFloat

public ByteBufferWrapper putFloat(int index,
                                  float value)

Description copied from interface: Buffer

Absolute put method for writing a float value (optional operation).

Writes four bytes containing the given float value, in the current byte order, into this buffer at the given index.

Specified by:

putFloat in interface Buffer<ByteBuffer>

Parameters:

index - The index at which the bytes will be written

value - The float value to be written

Returns:

This buffer

getDouble

public double getDouble()

Description copied from interface: Buffer

Relative get method for reading a double value.

Reads the next eight bytes at this buffer's current position, composing them into a double value according to the current byte order, and then increments the position by eight.

Specified by:

getDouble in interface Buffer<ByteBuffer>

Returns:

The double value at the buffer's current position

getDouble

public double getDouble(int index)

Description copied from interface: Buffer

Absolute get method for reading a double value.

Reads eight bytes at the given index, composing them into a double value according to the current byte order.

Specified by:

getDouble in interface Buffer<ByteBuffer>

Parameters:

index - The index from which the bytes will be read

Returns:

The double value at the given index

putDouble

public ByteBufferWrapper putDouble(double value)

Description copied from interface: Buffer

Relative put method for writing a double value (optional operation).

Writes eight bytes containing the given double value, in the current byte order, into this buffer at the current position, and then increments the position by eight.

Specified by:

putDouble in interface Buffer<ByteBuffer>

Parameters:

value - The double value to be written

Returns:

This buffer

putDouble

public ByteBufferWrapper putDouble(int index,
                                   double value)

Description copied from interface: Buffer

Absolute put method for writing a double value (optional operation).

Writes eight bytes containing the given double value, in the current byte order, into this buffer at the given index.

Specified by:

putDouble in interface Buffer<ByteBuffer>

Parameters:

index - The index at which the bytes will be written

value - The double value to be written

Returns:

This buffer

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(Buffer<ByteBuffer> o)

Specified by:

compareTo in interface Comparable<Buffer<ByteBuffer>>

contentAsString

public String contentAsString(Charset charset)

Description copied from interface: Buffer

Returns Buffer content as String

Specified by:

contentAsString in interface Buffer<ByteBuffer>

Parameters:

charset - the Charset, which will be use for byte[] -> String transformation.

Returns:

String representation of this Buffer content.