jetbrains.exodus

Interface ByteIterable

All Superinterfaces:

java.lang.Comparable<ByteIterable>

All Known Implementing Classes:

ArrayByteIterable, ArrayByteIterable.EmptyIterable, ByteBufferByteIterable, ByteIterableBase, CompoundByteIterable, CompressedUnsignedLongArrayByteIterable, FileByteIterable, FixedLengthByteIterable

public interface ByteIterable
extends java.lang.Comparable<ByteIterable>

If working with Environment, any key and value should be a ByteIterable. ByteIterable is a mix of iterable and array. It allows to lazily enumerate bytes without boxing. On the other hand, you can get its length using method getLength(). Generally, iterating over bytes of ByteIterable is performed by means of getting ByteIterator.

See Also:

ArrayByteIterable, ByteBufferByteIterable, FileByteIterable, FixedLengthByteIterable, CompoundByteIterable

Field Summary

Fields

Modifier and Type	Field and Description
static ByteIterable	EMPTY
static byte[]	EMPTY_BYTES
static ByteIterator	EMPTY_ITERATOR

Method Summary

Modifier and Type	Method and Description
byte[]	getBytesUnsafe()
int	getLength()
ByteIterator	iterator()
@NotNull ByteIterable	subIterable(int offset, int length)

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

EMPTY_BYTES

static final byte[] EMPTY_BYTES

EMPTY_ITERATOR

static final ByteIterator EMPTY_ITERATOR

EMPTY

static final ByteIterable EMPTY

Method Detail

iterator

ByteIterator iterator()

getBytesUnsafe

byte[] getBytesUnsafe()

Returns:

raw content of the ByteIterable. May return array with length greater than getLength().

getLength

int getLength()

Returns:

length of the ByteIterable.

subIterable

@NotNull
@NotNull ByteIterable subIterable(int offset,
                                           int length)

Parameters:

offset - start offset, inclusive

length - length of the sub-iterable

Returns:

a fixed-length sub-iterable of the ByteIterable starting from offset.