org.magicwerk.brownies.collections.primitive

Class CharGapList

java.lang.Object

org.magicwerk.brownies.collections.primitive.ICharList

org.magicwerk.brownies.collections.primitive.CharGapList

All Implemented Interfaces:

java.io.Serializable, java.lang.CharSequence, java.lang.Cloneable

public class CharGapList
extends ICharList

CharGapList 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: CharGapList.java 4092 2018-07-20 00:38:43Z 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
CharGapList() Construct a list with the default initial capacity.
CharGapList(java.util.Collection<java.lang.Character> coll) Construct a list to contain the specified elements.
CharGapList(int capacity) Construct a list with specified initial capacity.
CharGapList(java.lang.String str)

Method Summary

Modifier and Type	Method and Description
boolean	add(char elem)
void	add(int index, char elem)
int	binarySearch(int index, int len, char 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 CharGapList instance (The elements themselves are not copied).
CharGapList	copy() Returns a shallow copy of this CharGapList instance.
static CharGapList	create() Create new list.
static CharGapList	create(char... elems) Create new list with specified elements.
static CharGapList	create(java.util.Collection<java.lang.Character> coll) Create new list with specified elements.
static CharGapList	create(java.lang.String str)
CharGapList	doCreate(int capacity) Create list with specified capacity.
static CharGapList	EMPTY()
void	ensureCapacity(int minCapacity) Increases the capacity of this CharGapList instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
char	get(int index)
CharGapList	getAll(char elem) Returns all elements in the list equal to the specified element.
CharGapList	getAll(int index, int len) Returns specified range of elements from list.
char	getDefaultElem()
void	init(java.lang.String str)
<R> GapList<R>	mappedList(java.util.function.Function<java.lang.Character,R> mapper) Create a new list by applying the specified mapping function to all elements.
char	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 CharGapList instance to be the list's current size.
CharGapList	unmodifiableList() Returns an unmodifiable view of this list.

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

addAll, addAll, addAll, addAll, addArray, addArray, addArray, addArray, addFirst, addIfAbsent, addLast, addMult, addMult, binarySearch, charAt, clear, contains, containsAll, containsAny, containsIf, copy, drag, element, equals, extract, extractIf, fill, filter, filteredList, getCount, getDistinct, getFirst, getIf, getLast, getSingle, getSingleOrEmpty, hashCode, indexOf, indexOf, indexOfIf, initAll, initAll, initArray, initMult, isEmpty, lastIndexOf, lastIndexOf, length, 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, removeIf, removeLast, removeLastOccurrence, replaceAll, replaceAll, replaceArray, replaceMult, resize, retainAll, retainAll, retainIf, reverse, reverse, rotate, rotate, set, setAll, setAll, setArray, setArray, setMult, sort, subSequence, swap, toArray, toArray, toArray, toArray, toArray, toArray, toString, transferCopy, transferMove, transferRemove, transferSwap, transform, transformedList

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Field Detail

DEFAULT_CAPACITY

public static final int DEFAULT_CAPACITY

Default capacity for list

See Also:

Constant Field Values

Constructor Detail

CharGapList

public CharGapList()

Construct a list with the default initial capacity.

CharGapList

public CharGapList(int capacity)

Construct a list with specified initial capacity.

Parameters:

capacity - capacity

CharGapList

public CharGapList(java.util.Collection<java.lang.Character> 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

CharGapList

public CharGapList(java.lang.String str)

Method Detail

EMPTY

public static CharGapList EMPTY()

Returns:

unmodifiable empty instance

create

public static CharGapList create()

Create new list.

Parameters:

type - of elements stored in the list

Returns:

created list

create

public static CharGapList 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 CharGapList create(char... elems)

Create new list with specified elements.

Parameters:

elems - array with elements

type - of elements stored in the list

Returns:

created list

getDefaultElem

public char getDefaultElem()

copy

public CharGapList copy()

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

Overrides:

copy in class ICharList

Returns:

a copy of this CharGapList instance

See Also:

ICharList.clone()

ensureCapacity

public void ensureCapacity(int minCapacity)

Increases the capacity of this CharGapList 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 ICharList

Parameters:

minCapacity - the desired minimum capacity

clone

public java.lang.Object clone()

Returns a shallow copy of this CharGapList 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 ICharList

Returns:

a copy of this CharGapList instance

unmodifiableList

public CharGapList 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

size

public int size()

Specified by:

size in class ICharList

capacity

public int capacity()

Description copied from class: ICharList

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 ICharList

Returns:

capacity of this list

get

public char get(int index)

Overrides:

get in class ICharList

add

public boolean add(char elem)

Overrides:

add in class ICharList

add

public void add(int index,
                char elem)

Overrides:

add in class ICharList

getAll

public CharGapList getAll(int index,
                          int len)

Description copied from class: ICharList

Returns specified range of elements from list.

Overrides:

getAll in class ICharList

Parameters:

index - index of first element to retrieve

len - number of elements to retrieve

Returns:

list containing the specified range of elements

getAll

public CharGapList getAll(char elem)

Description copied from class: ICharList

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

Overrides:

getAll in class ICharList

Parameters:

elem - element to look for

Returns:

all elements in the list equal to the specified element

mappedList

public <R> GapList<R> mappedList(java.util.function.Function<java.lang.Character,R> mapper)

Description copied from class: ICharList

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

Overrides:

mappedList in class ICharList

Parameters:

mapper - mapping function

Returns:

created list

remove

public char remove(int index)

Overrides:

remove in class ICharList

trimToSize

public void trimToSize()

Trims the capacity of this CharGapList 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 ICharList

doCreate

public CharGapList doCreate(int capacity)

Description copied from class: ICharList

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: 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(int[])

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 CharGapList create(java.lang.String str)

init

public void init(java.lang.String str)