com.day.io

Class ByteBuffer

java.lang.Object

com.day.io.ByteBuffer

public class ByteBuffer
extends Object

This class provides a byte buffer, that is unlimited in capacity.

Since:

antbear

Constructor Summary

Constructors

Constructor and Description
ByteBuffer() Creates a new ByteBuffer-object

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	get() Returns the entire buffer.
int	get(byte[] output, int offset, int num) Transferse up to num bytes to the output buffer starting at offset.
byte[]	get(int num) Returns up to num bytes from this ByteBuffer.
boolean	isEmpty() Checks if the buffer is empty.
int	length() Returns the number of bytes in the queue.
void	put(byte b) Puts one byte at the end of the buffer to be optimized.
void	put(byte[] bytes) Puts the bytes at the end of the buffer
void	put(byte[] input, int offset, int len) Puts length bytes from input starting at offset to the end of this buffer.
void	reset() Resets this ByteBuffer and clears the internal storage.

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteBuffer

public ByteBuffer()

Creates a new ByteBuffer-object

Method Detail

reset

public void reset()

Resets this ByteBuffer and clears the internal storage.

get

public byte[] get()

Returns the entire buffer.

Returns:

a new byte buffer.

get

public byte[] get(int num)

Returns up to num bytes from this ByteBuffer.

Parameters:

num - the number of bytes to return

Returns:

a new buffer with the containig bytes

get

public int get(byte[] output,
      int offset,
      int num)

Transferse up to num bytes to the output buffer starting at offset.

Parameters:

output - the output buffer

offset - the offset

length - the number of bytes to transfer

Returns:

the number of bytes written

put

public void put(byte[] input,
       int offset,
       int len)

Puts length bytes from input starting at offset to the end of this buffer.

Parameters:

input - the input buffer

offset - the offset into the input buffer

length - the number of bytes to transfer

put

public void put(byte[] bytes)

Puts the bytes at the end of the buffer

Parameters:

bytes - the bytes to add to the buffer

put

public void put(byte b)

Puts one byte at the end of the buffer to be optimized.

length

public int length()

Returns the number of bytes in the queue.

isEmpty

public boolean isEmpty()

Checks if the buffer is empty.

Returns:

true if the buffer is empty; false otherwise.