org.magicwerk.brownies.collections.primitive

Class CharBigList

java.lang.Object

org.magicwerk.brownies.collections.primitive.ICharList

org.magicwerk.brownies.collections.primitive.CharBigList

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CharBigList
extends ICharList

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

Note that the iterators provided are not fail-fast.

Version:

$Id: CharBigList.java 2531 2014-10-24 13:04:07Z origo $

Author:

Thomas Mauch

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CharBigList.CharBlock A block stores in maximum blockSize number of elements.

Constructor Summary

Constructors

Constructor and Description
CharBigList() Default constructor.
CharBigList(java.util.Collection<java.lang.Character> coll) Create new list with specified elements.
CharBigList(int blockSize) Constructor.
CharBigList(java.lang.String str)

Method Summary

Methods

Modifier and Type	Method and Description
int	binarySearch(int index, int len, char key) Searches the specified range for an object using the binary search algorithm.
int	blockSize() Returns block size used for this CharBigList.
int	capacity() Returns capacity of this list.
java.lang.Object	clone() Returns a shallow copy of this CharBigList instance The copy is realized by a copy-on-write approach so also really large lists can efficiently be copied.
CharBigList	copy() Returns a copy of this CharBigList instance.
static CharBigList	create() Create new list.
static CharBigList	create(char... elems) Create new list with specified elements.
static CharBigList	create(java.util.Collection<java.lang.Character> coll) Create new list with specified elements.
static CharBigList	create(java.lang.String str)
static CharBigList	EMPTY()
char	getDefaultElem()
void	init() Initialize the list to be empty.
void	init(char... elems) Initialize the list to have the specified elements.
void	init(java.util.Collection<java.lang.Character> that) Initialize the list to have all elements in the specified collection.
void	init(java.lang.String str)
static ICharList	of(char[] values)
static ICharList	of(java.lang.Character[] values)
static ICharList	of(java.util.List<java.lang.Character> 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.
CharBigList	unmodifiableList() Returns an unmodifiable view of this list.

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

add, add, addAll, addAll, addAll, addAll, addAll, addAll, addFirst, addIfAbsent, addLast, binarySearch, clear, contains, containsAll, containsAny, copy, copy, drag, element, ensureCapacity, equals, extract, fill, fill, filter, get, getAll, getAll, getArray, getCount, getDistinct, getFirst, getLast, hashCode, indexOf, init, isEmpty, lastIndexOf, mappedList, merge, move, move, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, remove, remove, remove, removeAll, removeAll, removeAll, removeElem, removeFirst, removeFirstOccurrence, removeLast, removeLastOccurrence, resize, retainAll, retainAll, reverse, reverse, rotate, rotate, set, setAll, setAll, setAll, sort, swap, swap, toArray, toArray, toArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CharBigList

public CharBigList()

Default constructor. The default block size is used.

CharBigList

public CharBigList(int blockSize)

Constructor.

Parameters:

blockSize - block size

CharBigList

public CharBigList(java.util.Collection<java.lang.Character> coll)

Create new list with specified elements.

Parameters:

coll - collection with element

type - of elements stored in the list

CharBigList

public CharBigList(java.lang.String str)

Method Detail

of

public static ICharList of(char[] values)

of

public static ICharList of(java.lang.Character[] values)

of

public static ICharList of(java.util.List<java.lang.Character> values)

EMPTY

public static CharBigList EMPTY()

Returns:

unmodifiable empty instance

create

public static CharBigList create()

Create new list.

Parameters:

type - of elements stored in the list

Returns:

created list

create

public static CharBigList create(java.util.Collection<java.lang.Character> 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 CharBigList create(char... elems)

Create new list with specified elements.

Parameters:

elems - array with elements

type - of elements stored in the list

Returns:

created list

init

public void init()

Initialize the list to be empty.

init

public void init(char... elems)

Initialize the list to have the specified elements.

Parameters:

elems - elements

init

public void init(java.util.Collection<java.lang.Character> that)

Initialize the list to have all elements in the specified collection.

Parameters:

that - collection

blockSize

public int blockSize()

Returns block size used for this CharBigList.

Returns:

block size used for this CharBigList

copy

public CharBigList copy()

Returns a copy of this CharBigList 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 CharBigList.

Overrides:

copy in class ICharList

Returns:

a copy of this CharBigList instance

See Also:

ICharList.clone()

clone

public java.lang.Object clone()

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

Overrides:

clone in class ICharList

Returns:

a copy of this CharBigList instance

See Also:

Cloneable

getDefaultElem

public char getDefaultElem()

size

public int size()

Specified by:

size in class ICharList

capacity

public int capacity()

Returns capacity of this list. Note that two lists are considered equal even if they have a distinct capacity. Also the capacity can be changed by operations like clone() etc. For CharBigList, always -1 is returned.

Specified by:

capacity in class ICharList

Returns:

capacity of this list

unmodifiableList

public CharBigList unmodifiableList()

Description copied from class: ICharList

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 ICharList

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 ICharList

sort

public void sort(int index,
        int len)

Description copied from class: ICharList

Sort specified elements in the list using the specified comparator.

Specified by:

sort in class ICharList

Parameters:

index - index of first element to sort

len - number of elements to sort

See Also:

Arrays.sort(long[])

binarySearch

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

Description copied from class: ICharList

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

Specified by:

binarySearch in class ICharList

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)

create

public static CharBigList create(java.lang.String str)

init

public void init(java.lang.String str)