org.magicwerk.brownies.collections.primitive

Class BooleanGapList

java.lang.Object

org.magicwerk.brownies.collections.primitive.IBooleanList

org.magicwerk.brownies.collections.primitive.BooleanGapList

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class BooleanGapList
extends IBooleanList

BooleanGapList combines the strengths of both ArrayList and LinkedList. It is implemented to offer both efficient random access to elements by index (as ArrayList does) and at the same time efficient adding and removing elements to and from beginning and end (as LinkedList does). It also exploits the locality of reference often seen in applications to further improve performance, e.g. for iterating over the list.

Note that this implementation is not synchronized.

Note that the iterators provided are not fail-fast.

Version:

$Id: BooleanGapList.java 3141 2016-04-12 22:50:04Z origo $

Author:

Thomas Mauch

See Also:

List, ArrayList, LinkedList, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CAPACITY Default capacity for list

Constructor Summary

Constructors

Constructor and Description
BooleanGapList() Construct a list with the default initial capacity.
BooleanGapList(java.util.Collection<java.lang.Boolean> coll) Construct a list to contain the specified elements.
BooleanGapList(int capacity) Construct a list with specified initial capacity.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(boolean elem)
void	add(int index, boolean elem)
int	binarySearch(int index, int len, boolean key) Searches the specified range for an object using the binary search algorithm.
int	capacity() Returns capacity of this list.
java.lang.Object	clone() Returns a shallow copy of this BooleanGapList instance (The elements themselves are not copied).
BooleanGapList	copy() Returns a shallow copy of this BooleanGapList instance.
static BooleanGapList	create() Create new list.
static BooleanGapList	create(boolean... elems) Create new list with specified elements.
static BooleanGapList	create(java.util.Collection<java.lang.Boolean> coll) Create new list with specified elements.
IBooleanList	doCreate(int capacity) Create list with specified capacity.
static BooleanGapList	EMPTY()
void	ensureCapacity(int minCapacity) Increases the capacity of this BooleanGapList instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
boolean	get(int index)
BooleanGapList	getAll(boolean elem) Returns all elements in the list equal to the specified element.
BooleanGapList	getAll(int index, int len) Returns specified range of elements from list.
boolean	getDefaultElem()
void	init() Initialize the list to be empty.
void	init(boolean... elems) Initialize the list to contain the specified elements only.
void	init(java.util.Collection<java.lang.Boolean> coll) Initialize the list to contain the specified elements only.
<R> GapList<R>	mappedList(IFunction<java.lang.Boolean,R> mapper) Create a new list by applying the specified mapper to all elements.
boolean	remove(int index)
int	size()
void	sort(int index, int len) Sort specified elements in the list using the specified comparator.
void	trimToSize() Trims the capacity of this BooleanGapList instance to be the list's current size.
BooleanGapList	unmodifiableList() Returns an unmodifiable view of this list.

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

addAll, addAll, addAll, addAll, addArray, addArray, addFirst, addIfAbsent, addLast, addMult, addMult, binarySearch, clear, contains, containsAll, containsAny, copy, drag, element, equals, extract, extractWhere, fill, filter, getArray, getCount, getDistinct, getFirst, getLast, getWhere, hashCode, indexOf, indexOf, initAll, initAll, initArray, initMult, isEmpty, lastIndexOf, lastIndexOf, move, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, put, putAll, putAll, putArray, putMult, 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

Field Detail

DEFAULT_CAPACITY

public static final int DEFAULT_CAPACITY

Default capacity for list

See Also:

Constant Field Values

Constructor Detail

BooleanGapList

public BooleanGapList()

Construct a list with the default initial capacity.

BooleanGapList

public BooleanGapList(int capacity)

Construct a list with specified initial capacity.

Parameters:

capacity - capacity

BooleanGapList

public BooleanGapList(java.util.Collection<java.lang.Boolean> coll)

Construct a list to contain the specified elements. The list will have an initial capacity to hold these elements.

Parameters:

coll - collection with elements

Method Detail

EMPTY

public static BooleanGapList EMPTY()

Returns:

unmodifiable empty instance

create

public static BooleanGapList create()

Create new list.

Parameters:

type - of elements stored in the list

Returns:

created list

create

public static BooleanGapList create(java.util.Collection<java.lang.Boolean> 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 BooleanGapList create(boolean... 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. The list will have the default initial capacity.

init

public void init(java.util.Collection<java.lang.Boolean> coll)

Initialize the list to contain the specified elements only. The list will have an initial capacity to hold these elements.

Parameters:

coll - collection with elements

init

public void init(boolean... elems)

Initialize the list to contain the specified elements only. The list will have an initial capacity to hold these elements.

Parameters:

elems - array with elements

getDefaultElem

public boolean getDefaultElem()

copy

public BooleanGapList copy()

Returns a shallow copy of this BooleanGapList instance. (the new list will contain the same elements as the source list, i.e. the elements themselves are not copied). This method is identical to clone() except that the result is casted to BooleanGapList.

Overrides:

copy in class IBooleanList

Returns:

a copy of this BooleanGapList instance

See Also:

IBooleanList.clone()

ensureCapacity

public void ensureCapacity(int minCapacity)

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

Overrides:

ensureCapacity in class IBooleanList

Parameters:

minCapacity - the desired minimum capacity

clone

public java.lang.Object clone()

Returns a shallow copy of this BooleanGapList instance (The elements themselves are not copied). The capacity of the list will be set to the number of elements, so after calling clone(), size and capacity are equal.

Overrides:

clone in class IBooleanList

Returns:

a copy of this BooleanGapList instance

unmodifiableList

public BooleanGapList unmodifiableList()

Description copied from class: IBooleanList

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 IBooleanList

Returns:

an unmodifiable view of the specified list

size

public int size()

Specified by:

size in class IBooleanList

capacity

public int capacity()

Description copied from class: IBooleanList

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.

Specified by:

capacity in class IBooleanList

Returns:

capacity of this list

get

public boolean get(int index)

Overrides:

get in class IBooleanList

add

public boolean add(boolean elem)

Overrides:

add in class IBooleanList

add

public void add(int index,
       boolean elem)

Overrides:

add in class IBooleanList

getAll

public BooleanGapList getAll(int index,
                    int len)

Description copied from class: IBooleanList

Returns specified range of elements from list.

Overrides:

getAll in class IBooleanList

Parameters:

index - index of first element to retrieve

len - number of elements to retrieve

Returns:

list containing the specified range of elements

getAll

public BooleanGapList getAll(boolean elem)

Description copied from class: IBooleanList

Returns all elements in the list equal to the specified element.

Overrides:

getAll in class IBooleanList

Parameters:

elem - element to look for

Returns:

all elements in the list equal to the specified element

mappedList

public <R> GapList<R> mappedList(IFunction<java.lang.Boolean,R> mapper)

Description copied from class: IBooleanList

Create a new list by applying the specified mapper to all elements.

Overrides:

mappedList in class IBooleanList

Parameters:

mapper - mapper function

Returns:

created list

remove

public boolean remove(int index)

Overrides:

remove in class IBooleanList

trimToSize

public void trimToSize()

Trims the capacity of this BooleanGapList instance to be the list's current size. An application can use this operation to minimize the storage of an instance.

Specified by:

trimToSize in class IBooleanList

doCreate

public IBooleanList doCreate(int capacity)

Description copied from class: IBooleanList

Create list with specified capacity.

Parameters:

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

Returns:

created list

sort

public void sort(int index,
        int len)

Description copied from class: IBooleanList

Sort specified elements in the list using the specified comparator.

Specified by:

sort in class IBooleanList

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

Description copied from class: IBooleanList

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

Specified by:

binarySearch in class IBooleanList

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)