org.foxlabs.util

Class ByteBuffer

java.lang.Object

org.foxlabs.util.ByteBuffer

All Implemented Interfaces:

Serializable

public class ByteBuffer
extends Object
implements Serializable

This class defines mutable sequence of bytes. It is like a byte array, but can be modified.

Author:

Fox Mulder

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	data The buffer where data is stored.
protected int	length The number of valid bytes in this buffer.

Constructor Summary

Constructors

Constructor and Description
ByteBuffer() Constructs a new ByteBuffer with default initial capacity.
ByteBuffer(byte[] array) Constructs a new ByteBuffer with the specified initial data.
ByteBuffer(byte[] array, int offset, int count) Constructs a new ByteBuffer with the specified initial data.
ByteBuffer(int capacity) Constructs a new ByteBuffer with the specified initial capacity.

Method Summary

Methods

Modifier and Type	Method and Description
ByteBuffer	append(boolean value) Appends the specified boolean value to this buffer as a 1-byte value.
ByteBuffer	append(boolean[] array) Appends the specified boolean[] array to this buffer.
ByteBuffer	append(boolean[] array, int offset, int count) Appends the specified number of elements from the specified boolean[] array starting from the specified offset to this buffer.
ByteBuffer	append(byte value) Appends the specified byte value to this buffer.
ByteBuffer	append(byte[] array) Appends the specified byte[] array to this buffer.
ByteBuffer	append(byte[] array, int offset, int count) Appends the specified number of elements from the specified byte[] array starting from the specified offset to this buffer.
ByteBuffer	append(ByteBuffer buffer) Appends all the data from the specified buffer to this buffer.
ByteBuffer	append(char value) Appends the specified char value to this buffer as a 2-byte value, high byte first.
ByteBuffer	append(char[] array) Appends the specified char[] array to this buffer.
ByteBuffer	append(char[] array, int offset, int count) Appends the specified number of elements from the specified char[] array starting from the specified offset to this buffer.
ByteBuffer	append(double value) Appends the specified double value to this buffer as a 8-byte quantity, high byte first.
ByteBuffer	append(double[] array) Appends the specified double[] array to this buffer.
ByteBuffer	append(double[] array, int offset, int count) Appends the specified number of elements from the specified double[] array starting from the specified offset to this buffer.
ByteBuffer	append(float value) Appends the specified float value to this buffer as a 4-byte quantity, high byte first.
ByteBuffer	append(float[] array) Appends the specified float[] array to this buffer.
ByteBuffer	append(float[] array, int offset, int count) Appends the specified number of elements from the specified float[] array starting from the specified offset to this buffer.
ByteBuffer	append(int value) Appends the specified int value to this buffer as four bytes, high byte first.
ByteBuffer	append(int[] array) Appends the specified int[] array to this buffer.
ByteBuffer	append(int[] array, int offset, int count) Appends the specified number of elements from the specified int[] array starting from the specified offset to this buffer.
ByteBuffer	append(long value) Appends the specified long value to this buffer as eight bytes, high byte first.
ByteBuffer	append(long[] array) Appends the specified long[] array to this buffer.
ByteBuffer	append(long[] array, int offset, int count) Appends the specified number of elements from the specified long[] array starting from the specified offset to this buffer.
ByteBuffer	append(short value) Appends the specified short value to this buffer as two bytes, high byte first.
ByteBuffer	append(short[] array) Appends the specified short[] array to this buffer.
ByteBuffer	append(short[] array, int offset, int count) Appends the specified number of elements from the specified short[] array starting from the specified offset to this buffer.
void	ensureCapacity(int capacity) Increases the capacity of this buffer if necessary.
byte[]	getBytes() Returns array of bytes from this buffer.
int	length() Returns the number of valid bytes in this buffer.
void	reset() Clears this buffer.

Methods inherited from class java.lang.Object

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

Field Detail

data

protected byte[] data

The buffer where data is stored.

length

protected int length

The number of valid bytes in this buffer.

Constructor Detail

ByteBuffer

public ByteBuffer()

Constructs a new ByteBuffer with default initial capacity.

ByteBuffer

public ByteBuffer(int capacity)

Constructs a new ByteBuffer with the specified initial capacity.

Parameters:

capacity - Initial capacity of the buffer.

ByteBuffer

public ByteBuffer(byte[] array)

Constructs a new ByteBuffer with the specified initial data.

Parameters:

array - Initial data.

ByteBuffer

public ByteBuffer(byte[] array,
          int offset,
          int count)

Constructs a new ByteBuffer with the specified initial data.

Parameters:

array - Initial data.

offset - Start offset in the data.

count - Number of bytes to copy.

Method Detail

length

public int length()

Returns the number of valid bytes in this buffer.

Returns:

The number of valid bytes in this buffer.

append

public ByteBuffer append(byte value)

Appends the specified byte value to this buffer.

Parameters:

value - byte value to append.

Returns:

Reference to this buffer instance.

append

public ByteBuffer append(byte[] array)

Appends the specified byte[] array to this buffer.

Parameters:

array - byte[] array to append.

Returns:

Reference to this buffer instance.

See Also:

append(byte[], int, int)

append

public ByteBuffer append(byte[] array,
                int offset,
                int count)

Appends the specified number of elements from the specified byte[] array starting from the specified offset to this buffer.

Parameters:

array - byte[] array to append.

offset - Start offset in the specified array.

count - Number of elements to append.

Returns:

Reference to this buffer instance.

append

public ByteBuffer append(short value)

Appends the specified short value to this buffer as two bytes, high byte first.

Parameters:

value - short value to append.

Returns:

Reference to this buffer instance.

append

public ByteBuffer append(short[] array)

Appends the specified short[] array to this buffer.

Parameters:

array - short[] array to append.

Returns:

Reference to this buffer instance.

See Also:

append(short[], int, int)

append

public ByteBuffer append(short[] array,
                int offset,
                int count)

Appends the specified number of elements from the specified short[] array starting from the specified offset to this buffer.

Parameters:

array - short[] array to append.

offset - Start offset in the specified array.

count - Number of elements to append.

Returns:

Reference to this buffer instance.

See Also:

append(short)

append

public ByteBuffer append(int value)

Appends the specified int value to this buffer as four bytes, high byte first.

Parameters:

value - int value to append.

Returns:

Reference to this buffer instance.

append

public ByteBuffer append(int[] array)

Appends the specified int[] array to this buffer.

Parameters:

array - int[] array to append.

Returns:

Reference to this buffer instance.

See Also:

append(int[], int, int)

append

public ByteBuffer append(int[] array,
                int offset,
                int count)

Appends the specified number of elements from the specified int[] array starting from the specified offset to this buffer.

Parameters:

array - int[] array to append.

offset - Start offset in the specified array.

count - Number of elements to append.

Returns:

Reference to this buffer instance.

See Also:

append(int)

append

public ByteBuffer append(long value)

Appends the specified long value to this buffer as eight bytes, high byte first.

Parameters:

value - long value to append.

Returns:

Reference to this buffer instance.

append

public ByteBuffer append(long[] array)

Appends the specified long[] array to this buffer.

Parameters:

array - long[] array to append.

Returns:

Reference to this buffer instance.

See Also:

append(long[], int, int)

append

public ByteBuffer append(long[] array,
                int offset,
                int count)

Appends the specified number of elements from the specified long[] array starting from the specified offset to this buffer.

Parameters:

array - long[] array to append.

offset - Start offset in the specified array.

count - Number of elements to append.

Returns:

Reference to this buffer instance.

See Also:

append(long)

append

public ByteBuffer append(float value)

Appends the specified float value to this buffer as a 4-byte quantity, high byte first.

Parameters:

value - float value to append.

Returns:

Reference to this buffer instance.

See Also:

append(int)

append

public ByteBuffer append(float[] array)

Appends the specified float[] array to this buffer.

Parameters:

array - float[] array to append.

Returns:

Reference to this buffer instance.

See Also:

append(float[], int, int)

append

public ByteBuffer append(float[] array,
                int offset,
                int count)

Appends the specified number of elements from the specified float[] array starting from the specified offset to this buffer.

Parameters:

array - float[] array to append.

offset - Start offset in the specified array.

count - Number of elements to append.

Returns:

Reference to this buffer instance.

See Also:

append(int)

append

public ByteBuffer append(double value)

Appends the specified double value to this buffer as a 8-byte quantity, high byte first.

Parameters:

value - double value to append.

Returns:

Reference to this buffer instance.

See Also:

append(long)

append

public ByteBuffer append(double[] array)

Appends the specified double[] array to this buffer.

Parameters:

array - double[] array to append.

Returns:

Reference to this buffer instance.

See Also:

append(double[], int, int)

append

public ByteBuffer append(double[] array,
                int offset,
                int count)

Appends the specified number of elements from the specified double[] array starting from the specified offset to this buffer.

Parameters:

array - double[] array to append.

offset - Start offset in the specified array.

count - Number of elements to append.

Returns:

Reference to this buffer instance.

See Also:

append(long)

append

public ByteBuffer append(char value)

Appends the specified char value to this buffer as a 2-byte value, high byte first.

Parameters:

value - char value to append.

Returns:

Reference to this buffer instance.

See Also:

append(short)

append

public ByteBuffer append(char[] array)

Appends the specified char[] array to this buffer.

Parameters:

array - char[] array to append.

Returns:

Reference to this buffer instance.

See Also:

append(char[], int, int)

append

public ByteBuffer append(char[] array,
                int offset,
                int count)

Appends the specified number of elements from the specified char[] array starting from the specified offset to this buffer.

Parameters:

array - char[] array to append.

offset - Start offset in the specified array.

count - Number of elements to append.

Returns:

Reference to this buffer instance.

See Also:

append(short)

append

public ByteBuffer append(boolean value)

Appends the specified boolean value to this buffer as a 1-byte value. The value true is appended as 1, the value false is appended as 0.

Parameters:

value - boolean value to append.

Returns:

Reference to this buffer instance.

See Also:

append(byte)

append

public ByteBuffer append(boolean[] array)

Appends the specified boolean[] array to this buffer.

Parameters:

array - boolean[] array to append.

Returns:

Reference to this buffer instance.

See Also:

append(boolean[], int, int)

append

public ByteBuffer append(boolean[] array,
                int offset,
                int count)

Appends the specified number of elements from the specified boolean[] array starting from the specified offset to this buffer.

Parameters:

array - boolean[] array to append.

offset - Start offset in the specified array.

count - Number of elements to append.

Returns:

Reference to this buffer instance.

See Also:

append(byte)

append

public ByteBuffer append(ByteBuffer buffer)

Appends all the data from the specified buffer to this buffer.

Parameters:

buffer - Buffer to append.

Returns:

Reference to this buffer instance.

reset

public void reset()

Clears this buffer.

ensureCapacity

public void ensureCapacity(int capacity)

Increases the capacity of this buffer if necessary.

Parameters:

capacity - Desired minimum capacity.

getBytes

public byte[] getBytes()

Returns array of bytes from this buffer.

Returns:

Array of bytes from this buffer.