com.bigdata.io

Interface IManagedByteArray

All Superinterfaces:

IByteArraySlice

All Known Subinterfaces:

IByteArrayBuffer, IKeyBuilder

All Known Implementing Classes:

ByteArrayBuffer, DataOutputBuffer, KeyBuilder

public interface IManagedByteArray
extends IByteArraySlice

An interface for a managed byte[]. Implementations of this interface may permit transparent extension of the managed byte[].

Version:

$Id$

Author:

Bryan Thompson

Method Summary

Methods

Modifier and Type	Method and Description
IManagedByteArray	append(byte b) Append a byte into the managed byte[].
IManagedByteArray	append(byte[] a) Append data into the managed byte[].
IManagedByteArray	append(byte[] a, int off, int len) Append data into the managed byte[].
int	capacity() Return the capacity of the backing buffer.
void	ensureCapacity(int capacity) Ensure that the buffer capacity is a least capacity total bytes.
void	ensureFree(int len) Ensure that at least len bytes are free in the buffer.
IManagedByteArray	reset() Reset the buffer length to zero.

Methods inherited from interface com.bigdata.io.IByteArraySlice

array, len, off, toByteArray

Method Detail

reset

IManagedByteArray reset()

Reset the buffer length to zero.

Returns:

this.

append

IManagedByteArray append(byte b)

Append a byte into the managed byte[]. The backing buffer will be automatically extended if necessary.

Parameters:

b - The byte.

append

IManagedByteArray append(byte[] a)

Append data into the managed byte[]. The backing buffer will be automatically extended if necessary.

Parameters:

a - The source data.

append

IManagedByteArray append(byte[] a,
                       int off,
                       int len)

Append data into the managed byte[]. The backing buffer will be automatically extended if necessary.

Parameters:

a - The source data.

off - The offset of the first byte to be copied.

len - The #of bytes to be copied.

capacity

int capacity()

Return the capacity of the backing buffer.

ensureFree

void ensureFree(int len)

Ensure that at least len bytes are free in the buffer. The buffer may be grown by this operation but it will not be truncated.

This operation is equivalent to

 ensureCapacity(len() + len)
 

and the latter is often used as an optimization.

Parameters:

len - The minimum #of free bytes.

ensureCapacity

void ensureCapacity(int capacity)

Ensure that the buffer capacity is a least capacity total bytes. The buffer may be grown by this operation but it will not be truncated.

Parameters:

capacity - The minimum #of bytes in the buffer.