com.github.pyknic.bigarray

Interface ByteImmutableArray

All Known Implementing Classes:

EmptyImmutableArray

public interface ByteImmutableArray

An immutable byte array that can hold a very large number of elements. Implementations of this interface may or may not be backed by a direct buffer depending on the size and how the data contained is structured.

To create a new instance of this interface, use the builder pattern initiated with the builder() method. The actual implementation that is used will depend on the data that is passed to the builder. After the instance has been built, it will be immutable.

Since:

1.0.0

Author:

Emil Forslund

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ByteImmutableArray.Builder A builder for a ByteImmutableArray.

Method Summary

Modifier and Type	Method and Description
static ByteImmutableArray.Builder	builder() Creates a new builder.
byte	getAsByte(long index) Returns the value located at the specified index in the array.
long	length() Returns the length of the array (the number of bytes that can safely be retrieved using the getAsByte(long) method).

Method Detail

getAsByte

byte getAsByte(long index)

Returns the value located at the specified index in the array. If the index is outside the bounds of the array, the behavior is unspecified.

Parameters:

index - the index

Returns:

the value at that index

length

long length()

Returns the length of the array (the number of bytes that can safely be retrieved using the getAsByte(long) method).

Returns:

the length

builder

static ByteImmutableArray.Builder builder()

Creates a new builder. The builder guarantees that appended values will be stored in the same order as they were inserted, but the actual size of the array and how it is backed will be determined when the ByteImmutableArray.Builder.build() method is finally invoked.

The builder should not be used after the ByteImmutableArray.Builder.build()-method has been called.

Returns:

a new builder