Class LongBigList

java.lang.Object

org.magicwerk.brownies.collections.primitive.ILongList

org.magicwerk.brownies.collections.primitive.LongBigList

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

LongBigList.ReadOnlyLongBigList

public class LongBigList
extends ILongList

LongBigList 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 LongBigList 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 LongBigList is accessed by several threads at different positions.

Note that the iterators provided are not fail-fast.

Author:

Thomas Mauch

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	LongBigList.ReadOnlyLongBigList	A read-only version of invalid reference Key1List .

Nested classes/interfaces inherited from class ILongList

ILongList.ILongListableFromArray, ILongList.ILongListableFromCollection, ILongList.ILongListableFromList, ILongList.ILongListableFromMult

Constructor Summary

Constructors

Modifier	Constructor	Description
	LongBigList()	Default constructor.
protected	LongBigList(boolean copy, LongBigList that)	Constructor used internally, e.g. for ImmutableLongBigList.
	LongBigList(int blockSize)	Constructor.
	LongBigList(Collection<Long> coll)	Create new list with specified elements.

Method Summary

Modifier and Type	Method	Description
int	binarySearch(int index, int len, long key)	Searches the specified range for an object using the binary search algorithm.
int	blockSize()	Returns block size used for this LongBigList.
int	capacity()	As LongBigList grows and shrinks automatically, the term capacity does not really make sense.
LongBigList	clone()	Returns a shallow copy of this list.
LongBigList	copy()	Returns a shallow copy of this list.
static LongBigList	create()
static LongBigList	create(long... elems)	Create new list with specified elements.
static LongBigList	create(Collection<Long> coll)	Create new list with specified elements.
LongBigList	crop()	Returns a copy this list but without elements.
protected boolean	doAdd(int index, long element)	Helper method for adding an element to the list.
protected boolean	doAddAll(int index, org.magicwerk.brownies.collections.primitive.ILongListable list)	Helper method for adding multiple elements to the list.
protected void	doAssign(ILongList that)	Assign this list the content of the that list.
protected void	doClear()
protected void	doClone(ILongList that)	Initialize this object after the bitwise copy has been made by Object.clone().
protected ILongList	doCreate(int capacity)	Create list with specified capacity.
protected void	doEnsureCapacity(int minCapacity)	Increases the capacity of this list instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
protected long	doGet(int index)	Helper method for getting an element from the list.
protected long	doRemove(int index)	Helper method to remove an element.
protected void	doRemoveAll(int index, int len)	Remove specified range of elements from list.
protected long	doReSet(int index, long elem)	Sets an element at specified position.
protected long	doSet(int index, long elem)	Helper method for setting an element in the list.
static LongBigList	EMPTY()
protected void	finalize()
long	getDefaultElem()
LongBigList	immutableList()	Returns an immutable copy of this list.
boolean	isReadOnly()	Returns true if this list is either unmodifiable or immutable, false otherwise.
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.
LongBigList	unmodifiableList()

Methods inherited from class ILongList

add, add, addAll, addAll, addAll, addAll, addArray, addArray, addArray, addArray, addFirst, addIfAbsent, addLast, addMult, addMult, asILongListable, binarySearch, checkIndex, checkIndexAdd, checkLength, checkLengths, checkNonNull, checkRange, clear, contains, containsAll, containsAny, containsIf, copy, count, countIf, doCreateArray, doGetAll, doIndexOf, doIndexOfIf, doInitAll, doLastIndexOf, doLastIndexOfIf, doModify, doPutAll, doReplace, doRotate, drag, element, ensureCapacity, equals, extract, extractIf, fill, filter, filterMap, flatMap, get, getAll, getAll, getDistinct, getFirst, getFirstOrNull, getIf, getLast, getLastOrNull, getSingle, getSingleOrNull, hashCode, indexOf, indexOf, indexOfIf, indexOfIf, initAll, initAll, initArray, initMult, isEmpty, lastIndexOf, lastIndexOf, lastIndexOfIf, lastIndexOfIf, map, mapFilter, 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, removeIf, removeLast, removeLastOccurrence, replace, replaceAll, replaceAll, replaceArray, replaceMult, resize, retain, retainAll, retainAll, retainIf, reverse, reverse, rotate, rotate, set, setAll, setAll, setArray, setArray, setMult, sort, swap, toArray, toArray, toArray, toArray, toArray, toArray, toString, transferCopy, transferMove, transferRemove, transferSwap, transform, transformedList

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

LongBigList

protected LongBigList(boolean copy,
 LongBigList that)

Constructor used internally, e.g. for ImmutableLongBigList.

Parameters:

copy - true to copy all instance values from source, if false nothing is done

that - list to copy

LongBigList

public LongBigList()

Default constructor. The default block size is used.

LongBigList

public LongBigList(int blockSize)

Constructor.

Parameters:

blockSize - block size

LongBigList

public LongBigList(Collection<Long> coll)

Create new list with specified elements.

Parameters:

coll - collection with element

Method Details

EMPTY

public static LongBigList EMPTY()

Returns:

unmodifiable empty instance

create

public static LongBigList create()

create

public static LongBigList create(Collection<Long> 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 LongBigList create(long... 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 LongBigList.

Returns:

block size used for this LongBigList

crop

public LongBigList crop()

Description copied from class: ILongList

Returns a copy this list but without elements. The new list will have the same type as this list.

Overrides:

crop in class ILongList

Returns:

an empty copy of this list

isReadOnly

public boolean isReadOnly()

Description copied from class: ILongList

Returns true if this list is either unmodifiable or immutable, false otherwise.

Specified by:

isReadOnly in class ILongList

copy

public LongBigList copy()

Returns a shallow copy of this list. The new list will contain the same elements as the source list, i.e. the elements themselves are not copied. The capacity of the list will be set to the number of elements, i.e. size and capacity are equal. This returned list will be modifiable, i.e. a read-only list will be copied and be modifiable again.

The copy is realized by a copy-on-write approach so also really large lists can efficiently be handled.

Specified by:

copy in class ILongList

Returns:

a modifiable copy of this list

clone

public LongBigList clone()

Returns a shallow copy of this list. The new list will contain the same elements as the source list, i.e. the elements themselves are not copied. The capacity of the list will be set to the number of elements, i.e. size and capacity are equal. If the list is read-only, the same list is returned without change. Use ILongList.copy() to .

The copy is realized by a copy-on-write approach so also really large lists can efficiently be handled.

Overrides:

clone in class ILongList

Returns:

a modifiable copy of this list

doAssign

protected void doAssign(ILongList that)

Description copied from class: ILongList

Assign this list the content of the that list. This is done by bitwise copying so the that list should not be used afterwards.

Specified by:

doAssign in class ILongList

Parameters:

that - list to copy content from

doClone

protected void doClone(ILongList that)

Description copied from class: ILongList

Initialize this object after the bitwise copy has been made by Object.clone().

Specified by:

doClone in class ILongList

Parameters:

that - source object

getDefaultElem

public long getDefaultElem()

Specified by:

getDefaultElem in class ILongList

finalize

protected void finalize()

Overrides:

finalize in class Object

size

public int size()

Specified by:

size in class ILongList

capacity

public int capacity()

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

Specified by:

capacity in class ILongList

Returns:

capacity of this list

doGet

protected long doGet(int index)

Description copied from class: ILongList

Helper method for getting an element from the list. This is the only method which really gets an element. Override if you need to validity checks before getting.

Specified by:

doGet in class ILongList

Parameters:

index - index of element to return

Returns:

the element at the specified position in this list

doSet

protected long doSet(int index,
 long elem)

Description copied from class: ILongList

Helper method for setting an element in the list. This is the only method which really sets an element. Override if you need to validity checks before setting.

Specified by:

doSet in class ILongList

Parameters:

index - index where element will be placed

elem - element to set

Returns:

old element which was at the position

doReSet

protected long doReSet(int index,
 long elem)

Description copied from class: ILongList

Sets an element at specified position. This method is used internally if existing elements will be moved etc. Override if you need to validity checks.

Specified by:

doReSet in class ILongList

Parameters:

index - index where element will be placed

elem - element to set

Returns:

old element which was at the position

doAdd

protected boolean doAdd(int index,
 long element)

Description copied from class: ILongList

Helper method for adding an element to the list. This is the only method which really adds an element. Override if you need to validity checks before adding.

Specified by:

doAdd in class ILongList

Parameters:

index - index where element should be added (-1 means it is up to the implementation to choose the index)

element - element to add

Returns:

true if element has been added, false otherwise

doAddAll

protected boolean doAddAll(int index,
 org.magicwerk.brownies.collections.primitive.ILongListable list)

Description copied from class: ILongList

Helper method for adding multiple elements to the list. This default implementation calls doAdd() for adding each element.

Overrides:

doAddAll in class ILongList

Parameters:

index - index where element should be added (-1 is valid for adding at the end)

list - list with elements to add

Returns:

true if elements have been added, false otherwise

doClear

protected void doClear()

Overrides:

doClear in class ILongList

doRemoveAll

protected void doRemoveAll(int index,
 int len)

Description copied from class: ILongList

Remove specified range of elements from list.

Overrides:

doRemoveAll in class ILongList

Parameters:

index - index of first element to remove

len - number of elements to remove

doRemove

protected long doRemove(int index)

Description copied from class: ILongList

Helper method to remove an element. This is the only method which really removes an element. Override if you need to validity checks before removing.

Specified by:

doRemove in class ILongList

Parameters:

index - index of element to remove

Returns:

removed element

unmodifiableList

public LongBigList unmodifiableList()

Specified by:

unmodifiableList in class ILongList

immutableList

public LongBigList immutableList()

Description copied from class: ILongList

Returns an immutable copy of this list. The returned list is independent from the original list, i.e. changes done later are not seen. Attempts to modify the returned list, whether direct or via its iterator, result in an UnsupportedOperationException. If this list is already immutable, it is returned unchanged. See ILongList.unmodifiableList() to get unmodifiable view of a list.

Specified by:

immutableList in class ILongList

Returns:

an immutable copy of the specified list

doEnsureCapacity

protected void doEnsureCapacity(int minCapacity)

Description copied from class: ILongList

Increases the capacity of this list instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.

Specified by:

doEnsureCapacity in class ILongList

Parameters:

minCapacity - the desired minimum capacity

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 ILongList

doCreate

protected ILongList doCreate(int capacity)

Description copied from class: ILongList

Create list with specified capacity.

Specified by:

doCreate in class ILongList

Parameters:

capacity - initial capacity (use -1 for default capacity)

Returns:

created list

sort

public void sort(int index,
 int len)

Description copied from class: ILongList

Sort specified elements in the list using the specified comparator.

Specified by:

sort in class ILongList

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,
 long key)

Description copied from class: ILongList

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

Note that the method is defined to work with an arbitrary type <K>. This allows to search directly for a key field in the object without the need to construct an object containing the key:

persons.binarySearch("john", new SearchByName());

class SearchByName implements Comparator<Object> {
 public int compare(Object o1, Object o2) {
   String s1 = (o1 instanceof String) ? (String) o1 : ((Name) o1).getName();
   String s2 = (o2 instanceof String) ? (String) o2 : ((Name) o2).getName();
   return s1.compareTo(s2);
 }
}
/

Specified by:

binarySearch in class ILongList

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)