com.cinchapi.concourse.util

Class ByteBuffers

Object

ByteBuffers

public abstract class ByteBuffers
extends Object

Additional utility methods for ByteBuffers that are not found in the ByteBuffer class.

Constructor Summary

Constructors

Constructor and Description
ByteBuffers()

Method Summary

Modifier and Type	Method and Description
static ByteBuffer	asReadOnlyBuffer(ByteBuffer source) Return a ByteBuffer that is a new read-only buffer that shares the content of source and has the same byte order, but maintains a distinct position, mark and limit.
static ByteBuffer	clone(ByteBuffer buffer) Return a clone of buffer that has a copy of all its content and the same position and limit.
static void	copyAndRewindSource(ByteBuffer source, ByteBuffer destination) Transfer the bytes from source to destination and resets source so that its position remains unchanged.
static ByteBuffer	decodeFromHex(String hex) Decode the hexadeciaml string and return the resulting binary data.
static String	encodeAsHex(ByteBuffer bytes) Encode the bytes as a hexadecimal string.
static String	encodeAsHexString(ByteBuffer buffer) Encode the remaining bytes in as ByteBuffer as a hex string and maintain the current position.
static ByteBuffer	expand(ByteBuffer destination, ByteBuffer source) Copy the remaining bytes in the source buffer to the destination, expanding if necessary in order to accommodate the bytes from source.
static ByteBuffer	expandInt(ByteBuffer destination, int value) Put the value into destination, expanding if necessary in order to accommodate the new bytes.
static ByteBuffer	fromString(String string) Return a byte buffer that has the UTF-8 encoding for string.
static ByteBuffer	get(ByteBuffer buffer, int length) Return a ByteBuffer that has a copy of length bytes from buffer starting from the current position.
static boolean	getBoolean(ByteBuffer buffer) Relative get method.
static <T extends Enum<?>> T	getEnum(ByteBuffer buffer, Class<T> clazz) Relative get method.
static ByteBuffer	getRemaining(ByteBuffer buffer) Return a ByteBuffer that has a copy of all the remaining bytes from buffer starting from the current position.
static String	getString(ByteBuffer buffer) Relative get method.
static String	getString(ByteBuffer buffer, Charset charset) Relative get method.
static ByteBuffer	nullByteBuffer() Return a ByteBuffer that contains a single null byte.
static void	putString(String source, ByteBuffer destination) Put the UTF-8 encoding for the source string into the destination byte buffer and increment the position by the length of the strings byte sequence.
static ByteBuffer	rewind(ByteBuffer buffer) The exact same as Buffer.rewind() except it returns a typed ByteBuffer instead of a generic Buffer.
static ByteBuffer	slice(ByteBuffer buffer, int length) Return a new ByteBuffer whose content is a shared subsequence of the content in buffer starting at the current position to current position + length (non-inclusive).
static ByteBuffer	slice(ByteBuffer buffer, int position, int length) Return a new ByteBuffer whose content is a shared subsequence of the content in buffer starting at position to position + length (non-inclusive).
static byte[]	toByteArray(ByteBuffer buffer) Return a byte array with the content of buffer.
static CharBuffer	toCharBuffer(ByteBuffer buffer) Return a UTF-8 CharBuffer representation of the bytes in the buffer.
static CharBuffer	toCharBuffer(ByteBuffer buffer, Charset charset) Return a CharBuffer representation of the bytes in the buffer encoded with the charset.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ByteBuffers

public ByteBuffers()

Method Detail

asReadOnlyBuffer

public static ByteBuffer asReadOnlyBuffer(ByteBuffer source)

Return a ByteBuffer that is a new read-only buffer that shares the content of source and has the same byte order, but maintains a distinct position, mark and limit.

Parameters:

source -

Returns:

the new, read-only byte buffer

clone

public static ByteBuffer clone(ByteBuffer buffer)

Return a clone of buffer that has a copy of all its content and the same position and limit. Unlike the ByteBuffer.slice() method, the returned clone does not share its content with buffer, so subsequent operations to buffer or its clone will be completely independent and won't affect the other.

Parameters:

buffer -

Returns:

a clone of buffer

copyAndRewindSource

public static void copyAndRewindSource(ByteBuffer source,
                                       ByteBuffer destination)

Transfer the bytes from source to destination and resets source so that its position remains unchanged. The position of the destination is incremented by the number of bytes that are transferred.

Parameters:

source -

destination -

decodeFromHex

public static ByteBuffer decodeFromHex(String hex)

Decode the hexadeciaml string and return the resulting binary data.

Parameters:

hex -

Returns:

the binary data

encodeAsHex

public static String encodeAsHex(ByteBuffer bytes)

Encode the bytes as a hexadecimal string.

Parameters:

bytes -

Returns:

the hex string

encodeAsHexString

public static String encodeAsHexString(ByteBuffer buffer)

Encode the remaining bytes in as ByteBuffer as a hex string and maintain the current position.

Parameters:

buffer -

Returns:

the hex string

expand

public static ByteBuffer expand(ByteBuffer destination,
                                ByteBuffer source)

Copy the remaining bytes in the source buffer to the destination, expanding if necessary in order to accommodate the bytes from source.

NOTE: This method may modify the limit for the destination buffer.

Parameters:

destination - the buffer into which the source is copied

source - the buffer that is copied into the destination

Returns:

a possibly expanded copy of destination with the source bytes copied

expandInt

public static ByteBuffer expandInt(ByteBuffer destination,
                                   int value)

Put the value into destination, expanding if necessary in order to accommodate the new bytes.

NOTE: This method may modify the limit for the destination buffer.

Parameters:

destination - the buffer into which the source is copied

value - the value to add to the destination

Returns:

a possibly expanded copy of destination with the value bytes copied

fromString

public static ByteBuffer fromString(String string)

Return a byte buffer that has the UTF-8 encoding for string. This method uses some optimization techniques and is the preferable way to convert strings to byte buffers than doing so manually.

Parameters:

string -

Returns:

the byte buffer with the string data.

get

public static ByteBuffer get(ByteBuffer buffer,
                             int length)

Return a ByteBuffer that has a copy of length bytes from buffer starting from the current position. This method will advance the position of the source buffer.

Parameters:

buffer -

length -

Returns:

a ByteBuffer that has length bytes from buffer

getBoolean

public static boolean getBoolean(ByteBuffer buffer)

Relative get method. Reads the byte at the current position in buffer as a boolean, and then increments the position.

Parameters:

buffer -

Returns:

the boolean value at the current position

getEnum

public static <T extends Enum<?>> T getEnum(ByteBuffer buffer,
                                            Class<T> clazz)

Relative get method. Reads the enum at the current position in buffer and then increments the position by four.

Parameters:

buffer -

clazz -

Returns:

the enum value at the current position

getRemaining

public static ByteBuffer getRemaining(ByteBuffer buffer)

Return a ByteBuffer that has a copy of all the remaining bytes from buffer starting from the current position. This method will advance the position of the source buffer.

Parameters:

buffer - the source buffer

Returns:

a ByteBuffer that has the remaining bytes from buffer

getString

public static String getString(ByteBuffer buffer)

Relative get method. Reads the UTF-8 encoded string at the current position in buffer.

Parameters:

buffer -

Returns:

the string value at the current position

getString

public static String getString(ByteBuffer buffer,
                               Charset charset)

Relative get method. Reads the charset encoded string at the current position in buffer.

Parameters:

buffer -

charset -

Returns:

the string value at the current position

nullByteBuffer

public static ByteBuffer nullByteBuffer()

Return a ByteBuffer that contains a single null byte.

Returns:

a null byte buffer

putString

public static void putString(String source,
                             ByteBuffer destination)

Put the UTF-8 encoding for the source string into the destination byte buffer and increment the position by the length of the strings byte sequence. This method uses some optimization techniques and is the preferable way to add strings to byte buffers than doing so manually.

Parameters:

source -

destination -

rewind

public static ByteBuffer rewind(ByteBuffer buffer)

The exact same as Buffer.rewind() except it returns a typed ByteBuffer instead of a generic Buffer.

Parameters:

buffer -

Returns:

buffer

slice

public static ByteBuffer slice(ByteBuffer buffer,
                               int length)

Return a new ByteBuffer whose content is a shared subsequence of the content in buffer starting at the current position to current position + length (non-inclusive). Invoking this method has the same affect as doing the following:

 buffer.mark();
 int oldLimit = buffer.limit();
 buffer.limit(buffer.position() + length);
 
 ByteBuffer slice = buffer.slice();
 
 buffer.reset();
 buffer.limit(oldLimit);
 

Parameters:

buffer -

length -

Returns:

the new ByteBuffer slice

See Also:

ByteBuffer.slice()

slice

public static ByteBuffer slice(ByteBuffer buffer,
                               int position,
                               int length)

Return a new ByteBuffer whose content is a shared subsequence of the content in buffer starting at position to position + length (non-inclusive). Invoking this method has the same affect as doing the following:

 buffer.mark();
 int oldLimit = buffer.limit();
 buffer.position(position);
 buffer.limit(position + length);
 
 ByteBuffer slice = buffer.slice();
 
 buffer.reset();
 buffer.limit(oldLimit);
 

Parameters:

buffer -

position -

length -

Returns:

the new ByteBuffer slice

See Also:

ByteBuffer.slice()

toByteArray

public static byte[] toByteArray(ByteBuffer buffer)

Return a byte array with the content of buffer. This method returns the byte array that backs buffer if one exists, otherwise it creates a new byte array with the content between the current position of buffer and its limit.

Parameters:

buffer -

Returns:

the byte array with the content of buffer

toCharBuffer

public static CharBuffer toCharBuffer(ByteBuffer buffer)

Return a UTF-8 CharBuffer representation of the bytes in the buffer.

Parameters:

buffer -

Returns:

the char buffer

toCharBuffer

public static CharBuffer toCharBuffer(ByteBuffer buffer,
                                      Charset charset)

Return a CharBuffer representation of the bytes in the buffer encoded with the charset.

Parameters:

buffer -

charset -

Returns:

the char buffer