com.bigdata.io

Interface IByteArraySlice

All Known Subinterfaces:

IByteArrayBuffer, IDataRecord, IFixedDataRecord, IKeyBuilder, IManagedByteArray

All Known Implementing Classes:

AbstractFixedByteArrayBuffer, ByteArrayBuffer, DataOutputBuffer, FixedByteArrayBuffer, KeyBuilder

public interface IByteArraySlice

Interface for a slice of a backing byte[].

Version:

$Id$

Author:

Bryan Thompson

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	array() The backing byte[].
int	len() The length of the slice in the array().
int	off() The start of the slice in the array().
byte[]	toByteArray() Return a copy of the data in the slice.

Method Detail

array

byte[] array()

The backing byte[]. This method DOES NOT guarantee that the backing array reference will remain constant. Some implementations use an extensible backing byte[] and will replace the reference when the backing buffer is extended.

off

int off()

The start of the slice in the array().

len

int len()

The length of the slice in the array(). Note: len() has different semantics for some concrete implementations. ByteArrayBuffer.len() always returns the capacity of the backing byte[] while ByteArrayBuffer.pos() returns the #of bytes written onto the backing buffer. In contrast, KeyBuilder.len() is always the #of bytes written onto the backing buffer.

toByteArray

byte[] toByteArray()

Return a copy of the data in the slice.

Returns:

A new array containing data in the slice.