org.kocakosm.pitaya.util

Class ByteBuffer

java.lang.Object

org.kocakosm.pitaya.util.ByteBuffer

All Implemented Interfaces:

Serializable, Iterable<Byte>

public final class ByteBuffer
extends Object
implements Iterable<Byte>, Serializable

A buffer that stores a sequence of bytes. Not thread-safe.

Author:

Osman KOCAK

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ByteBuffer() Creates a new ByteBuffer with an initial capacity of 512 bytes.
ByteBuffer(byte... bytes) Creates a new ByteBuffer containing the given data.
ByteBuffer(int capacity) Creates a new ByteBuffer having the given initial capacity.

Method Summary

Methods

Modifier and Type	Method and Description
ByteBuffer	append(byte... bytes) Writes the given bytes to this buffer.
ByteBuffer	append(byte b) Writes the given byte to this buffer.
ByteBuffer	append(byte[] bytes, int off, int len) Writes the given data to this buffer.
ByteBuffer	clear() Clears this buffer.
boolean	equals(Object o)
int	hashCode()
Iterator<Byte>	iterator()
int	size() Returns the number of bytes contained in this buffer.
byte[]	toByteArray() Returns the content of this buffer.
byte[]	toByteArray(int off) Returns the bytes contained in this buffer, starting at off.
byte[]	toByteArray(int off, int len) Returns len bytes from this buffer, starting at off.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteBuffer

public ByteBuffer()

Creates a new ByteBuffer with an initial capacity of 512 bytes.

ByteBuffer

public ByteBuffer(int capacity)

Creates a new ByteBuffer having the given initial capacity.

Parameters:

capacity - the initial capacity.

Throws:

IllegalArgumentException - if capacity < 0.

ByteBuffer

public ByteBuffer(byte... bytes)

Creates a new ByteBuffer containing the given data.

Parameters:

bytes - the buffer's initial content.

Throws:

NullPointerException - if bytes is null.

Method Detail

append

public ByteBuffer append(byte b)

Writes the given byte to this buffer.

Parameters:

b - the byte to write.

Returns:

this object.

append

public ByteBuffer append(byte... bytes)

Writes the given bytes to this buffer.

Parameters:

bytes - the bytes to write.

Returns:

this object.

Throws:

NullPointerException - if bytes is null.

append

public ByteBuffer append(byte[] bytes,
                int off,
                int len)

Writes the given data to this buffer.

Parameters:

bytes - the data to write.

off - the offset.

len - the number of bytes to write.

Returns:

this object.

Throws:

NullPointerException - if bytes is null.

IndexOutOfBoundsException - if off or len is negative or if off + len is greater than the length of the bytes array.

clear

public ByteBuffer clear()

Clears this buffer.

Returns:

this object.

size

public int size()

Returns the number of bytes contained in this buffer.

Returns:

the number of bytes contained in this buffer.

toByteArray

public byte[] toByteArray()

Returns the content of this buffer.

Returns:

the content of this buffer.

toByteArray

public byte[] toByteArray(int off)

Returns the bytes contained in this buffer, starting at off.

Parameters:

off - the starting offset.

Returns:

the requested data bytes.

Throws:

IndexOutOfBoundsException - if off is negative or if off is greater than size().

toByteArray

public byte[] toByteArray(int off,
                 int len)

Returns len bytes from this buffer, starting at off.

Parameters:

off - the starting offset.

len - the number of bytes to return.

Returns:

the requested data bytes.

Throws:

IndexOutOfBoundsException - if off or len is negative or if off + len is greater than size().

iterator

public Iterator<Byte> iterator()

Specified by:

iterator in interface Iterable<Byte>

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object