de.jarnbjo.jsnappy

Class Buffer

java.lang.Object

de.jarnbjo.jsnappy.Buffer

public class Buffer
extends Object

Reusable byte array buffer, which can be used for input/output in the Snappy encoder oder decoder.

Since:

1.0

Author:

Tor-Einar Jarnbjo

Constructor Summary

Constructors

Constructor and Description
Buffer() Creates an unitialized buffer.
Buffer(int capacity) Creates an initialized buffer with the specified capacity.

Method Summary

Methods

Modifier and Type	Method and Description
void	ensureCapacity(int capacity) Ensures that the buffer has a capacity to store the number of bytes.
byte[]	getData() Returns the byte array used as a backing store for this buffer.
int	getLength() Returns the length of this buffer.
void	setLength(int length) Sets the length of this buffer.
byte[]	toByteArray() Returns a copy of the buffers internal array in a newly allocated byte array with the buffer's length.

Methods inherited from class java.lang.Object

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

Constructor Detail

Buffer

public Buffer()

Creates an unitialized buffer.

Buffer

public Buffer(int capacity)

Creates an initialized buffer with the specified capacity.

Parameters:

capacity - initial buffer length in bytes

Method Detail

ensureCapacity

public void ensureCapacity(int capacity)

Ensures that the buffer has a capacity to store the number of bytes. If the internal buffer is too small, a new buffer is allocated and the content of the old buffer copied to the new buffer. If the old buffer is already large enough, no changes are made.

Parameters:

capacity - buffer length in bytes

getData

public byte[] getData()

Returns the byte array used as a backing store for this buffer. Note that invoking ensureCapacity can cause the backing array to be replaced.

Returns:

getLength

public int getLength()

Returns the length of this buffer. The backing array should contain valid data from index 0 to length - 1.

Returns:

setLength

public void setLength(int length)
               throws IllegalStateException,
                      IllegalArgumentException

Sets the length of this buffer. The backing array should contain valid data from index 0 to length - 1.

Parameters:

length - buffer length

Throws:

IllegalStateException - if the buffer is not yet initialized

IllegalArgumentException - if the requested length exceeds the buffers capacity

toByteArray

public byte[] toByteArray()

Returns a copy of the buffers internal array in a newly allocated byte array with the buffer's length.

Returns: