org.magicwerk.brownies.collections.primitive

Class ByteBigList

java.lang.Object

org.magicwerk.brownies.collections.primitive.IByteList

org.magicwerk.brownies.collections.primitive.ByteBigList

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ByteBigList
extends IByteList

ByteBigList is a list optimized for storing large number of elements. It stores the elements in fixed size blocks and the blocks itself are maintained in a tree for fast access. It also offers specialized methods for bulk processing of elements. Also copying a ByteBigList is efficiently possible as its implemented using a copy-on-write approach.

Note that this implementation is not synchronized. Due to data caching used for exploiting locality of reference, performance can decrease if ByteBigList is accessed by several threads at different positions.

Note that the iterators provided are not fail-fast.

Version:

$Id: ByteBigList.java 2964 2015-10-18 22:43:57Z origo $

Author:

Thomas Mauch

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ByteBigList() Default constructor.
ByteBigList(java.util.Collection<java.lang.Byte> coll) Create new list with specified elements.
ByteBigList(int blockSize) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	binarySearch(int index, int len, byte key) Searches the specified range for an object using the binary search algorithm.
int	blockSize() Returns block size used for this ByteBigList.
int	capacity() As ByteBigList grows and shrinks automatically, the term capacity does not really make sense.
java.lang.Object	clone() Returns a shallow copy of this ByteBigList instance The copy is realized by a copy-on-write approach so also really large lists can efficiently be copied.
ByteBigList	copy() Returns a copy of this ByteBigList instance.
static ByteBigList	create() Create new list.
static ByteBigList	create(byte... elems) Create new list with specified elements.
static ByteBigList	create(java.util.Collection<java.lang.Byte> coll) Create new list with specified elements.
static ByteBigList	EMPTY()
byte	getDefaultElem()
static IByteList	of(byte[] values)
static IByteList	of(java.lang.Byte[] values)
static IByteList	of(java.util.List<java.lang.Byte> values)
int	size()
void	sort(int index, int len) Sort specified elements in the list using the specified comparator.
void	trimToSize() Pack as many elements in the blocks as allowed.
ByteBigList	unmodifiableList() Returns an unmodifiable view of this list.

Methods inherited from class org.magicwerk.brownies.collections.primitive.IByteList

add, add, addAll, addAll, addAll, addAll, addArray, addArray, addFirst, addIfAbsent, addLast, addMult, addMult, binarySearch, clear, contains, containsAll, containsAny, copy, drag, element, ensureCapacity, equals, extract, extractWhere, fill, filter, get, getAll, getAll, getArray, getCount, getDistinct, getFirst, getLast, getWhere, hashCode, indexOf, indexOf, initAll, initAll, initArray, initMult, isEmpty, lastIndexOf, lastIndexOf, mappedList, move, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, put, putAll, putAll, putArray, putMult, remove, remove, remove, removeAll, removeAll, removeAll, removeElem, removeFirst, removeFirstOccurrence, removeLast, removeLastOccurrence, removeWhere, replaceAll, replaceAll, replaceArray, replaceMult, resize, retainAll, retainAll, retainWhere, reverse, reverse, rotate, rotate, set, setAll, setAll, setArray, setMult, sort, swap, toArray, toArray, toArray, toString, transferCopy, transferMove, transferRemove, transferSwap

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ByteBigList

public ByteBigList()

Default constructor. The default block size is used.

ByteBigList

public ByteBigList(int blockSize)

Constructor.

Parameters:

blockSize - block size

ByteBigList

public ByteBigList(java.util.Collection<java.lang.Byte> coll)

Create new list with specified elements.

Parameters:

coll - collection with element

Method Detail

of

public static IByteList of(byte[] values)

of

public static IByteList of(java.lang.Byte[] values)

of

public static IByteList of(java.util.List<java.lang.Byte> values)

EMPTY

public static ByteBigList EMPTY()

Returns:

unmodifiable empty instance

create

public static ByteBigList create()

Create new list.

Parameters:

type - of elements stored in the list

Returns:

created list

create

public static ByteBigList create(java.util.Collection<java.lang.Byte> coll)

Create new list with specified elements.

Parameters:

coll - collection with element

type - of elements stored in the list

Returns:

created list

create

public static ByteBigList create(byte... elems)

Create new list with specified elements.

Parameters:

elems - array with elements

type - of elements stored in the list

Returns:

created list

blockSize

public int blockSize()

Returns block size used for this ByteBigList.

Returns:

block size used for this ByteBigList

copy

public ByteBigList copy()

Returns a copy of this ByteBigList instance. The copy is realized by a copy-on-write approach so also really large lists can efficiently be copied. This method is identical to clone() except that the result is casted to ByteBigList.

Overrides:

copy in class IByteList

Returns:

a copy of this ByteBigList instance

See Also:

IByteList.clone()

clone

public java.lang.Object clone()

Returns a shallow copy of this ByteBigList instance The copy is realized by a copy-on-write approach so also really large lists can efficiently be copied.

Overrides:

clone in class IByteList

Returns:

a copy of this ByteBigList instance

getDefaultElem

public byte getDefaultElem()

size

public int size()

Specified by:

size in class IByteList

capacity

public int capacity()

As ByteBigList grows and shrinks automatically, the term capacity does not really make sense. Therefore always -1 is returned.

Specified by:

capacity in class IByteList

Returns:

capacity of this list

unmodifiableList

public ByteBigList unmodifiableList()

Description copied from class: IByteList

Returns an unmodifiable view of this list. This method allows modules to provide users with "read-only" access to internal lists. Query operations on the returned list "read through" to the specified list, and attempts to modify the returned list, whether direct or via its iterator, result in an UnsupportedOperationException.

Specified by:

unmodifiableList in class IByteList

Returns:

an unmodifiable view of the specified list

trimToSize

public void trimToSize()

Pack as many elements in the blocks as allowed. An application can use this operation to minimize the storage of an instance.

Specified by:

trimToSize in class IByteList

sort

public void sort(int index,
        int len)

Description copied from class: IByteList

Sort specified elements in the list using the specified comparator.

Specified by:

sort in class IByteList

Parameters:

index - index of first element to sort

len - number of elements to sort

See Also:

Arrays.sort(int[])

binarySearch

public int binarySearch(int index,
               int len,
               byte key)

Description copied from class: IByteList

Searches the specified range for an object using the binary search algorithm.

Specified by:

binarySearch in class IByteList

Parameters:

index - index of first element to search

len - number of elements to search

key - the value to be searched for

Returns:

index of the search key, if it is contained in the array; otherwise, (-(insertion point) - 1). The insertion point is defined as the point at which the key would be inserted into the array: the index of the first element greater than the key, or a.length if all elements in the array are less than the specified key. Note that this guarantees that the return value will be >= 0 if and only if the key is found.

See Also:

Arrays.binarySearch(long[], long)