org.magicwerk.brownies.collections.primitive

Class CharObjGapList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

org.magicwerk.brownies.collections.IList<java.lang.Character>

org.magicwerk.brownies.collections.primitive.CharObjGapList

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.Character>, java.util.Collection<java.lang.Character>, java.util.Deque<java.lang.Character>, java.util.List<java.lang.Character>, java.util.Queue<java.lang.Character>, java.util.RandomAccess

public class CharObjGapList
extends IList<java.lang.Character>

CharObjGapList implements the List interface and uses an instance of CharGapList for storage. It therefore allows to use the advantages of primitive collections like saved memory and improved execution speed when standard list collections are expected.

Note that this implementation is not synchronized.

Version:

$Id: CharObjGapList.java 3311 2016-10-10 13:13:23Z origo $

Author:

Thomas Mauch

See Also:

GapList, CharGapList, Serialized Form

Constructor Summary

Constructors

Constructor and Description
CharObjGapList()
CharObjGapList(java.util.Collection<? extends java.lang.Character> elems)
CharObjGapList(int capacity)

Method Summary

Modifier and Type	Method and Description
boolean	addAll(java.util.Collection<? extends java.lang.Character> coll) Adds all of the elements in the specified collection into this list.
boolean	addAll(IList<? extends java.lang.Character> list2) Adds all of the elements in the specified list into this list.
boolean	addAll(int index, java.util.Collection<? extends java.lang.Character> coll) Inserts all of the elements in the specified collection into this list, starting at the specified position.
boolean	addAll(int index, IList<? extends java.lang.Character> list2) Inserts all of the elements in the specified list into this list, starting at the specified position.
boolean	addArray(java.lang.Character... elems) Adds all specified elements into this list.
boolean	addArray(int index, java.lang.Character... elems) Inserts the specified elements into this list, starting at the specified position.
<K> int	binarySearch(int index, int len, K key, java.util.Comparator<? super K> comparator) Searches the specified range for an object using the binary search algorithm.
int	capacity() Returns capacity of this GapList.
boolean	contains(java.lang.Object elem)
boolean	containsAll(java.util.Collection<?> coll)
boolean	containsAny(java.util.Collection<?> coll) Returns true if any of the elements of the specified collection is contained in the list.
CharObjGapList	copy() Returns a shallow copy of this list instance.
static CharObjGapList	create()
static CharObjGapList	create(java.lang.Character... elems)
static CharObjGapList	create(java.util.Collection<? extends java.lang.Character> elems)
IList<java.lang.Character>	doCreate(int capacity) Create list with specified capacity.
boolean	equals(java.lang.Object obj)
java.lang.Character	get(int index)
GapList<java.lang.Character>	getAll(int index, int len) Returns specified range of elements from list.
java.lang.Character	getDefaultElem()
int	hashCode()
int	indexOf(java.lang.Object elem)
void	init()
void	init(java.lang.Character... elems)
void	init(java.util.Collection<? extends java.lang.Character> elems)
boolean	isEmpty()
int	lastIndexOf(java.lang.Object elem)
void	move(int srcIndex, int dstIndex, int len) Move specified elements.
boolean	remove(java.lang.Object elem)
boolean	removeAll(java.util.Collection<?> coll)
boolean	removeAll(IList<?> coll)
boolean	removeFirstOccurrence(java.lang.Object elem)
boolean	removeLastOccurrence(java.lang.Object elem)
boolean	retainAll(java.util.Collection<?> coll)
boolean	retainAll(IList<?> coll)
void	setAll(int index, java.util.Collection<? extends java.lang.Character> coll) Sets the specified elements.
void	setAll(int index, IList<? extends java.lang.Character> list2) Sets the specified elements.
void	setArray(int index, java.lang.Character... elems) Sets the specified elements.
int	size()
void	sort(int index, int len, java.util.Comparator comparator) Sort specified elements in the list using the specified comparator.
<T> T[]	toArray(java.lang.Class<T> clazz, int index, int len) Returns an array containing the specified elements in this list.
java.lang.Object[]	toArray(int index, int len) Returns an array containing the specified elements in this list.
<T> T[]	toArray(T[] array, int index, int len) Returns an array containing the specified elements in this list.
java.lang.String	toString()
void	trimToSize() An application can use this operation to minimize the storage of an instance.
CharObjGapList	unmodifiableList() Returns an unmodifiable view of this list.

Methods inherited from class org.magicwerk.brownies.collections.IList

add, add, addArray, addArray, addFirst, addIfAbsent, addLast, addMult, addMult, binarySearch, clear, clone, containsIf, copy, descendingIterator, drag, element, ensureCapacity, extract, extractIf, fill, filter, filteredList, getAll, getCount, getDistinct, getFirst, getIf, getLast, getSingle, getSingleOrEmpty, indexOf, indexOfIf, initAll, initAll, initArray, initMult, iterator, lastIndexOf, listIterator, listIterator, mappedList, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, put, putAll, putAll, putArray, putMult, remove, remove, remove, removeAll, removeFirst, removeIf, removeLast, replaceAll, replaceAll, replaceArray, replaceMult, resize, retainIf, reverse, reverse, rotate, rotate, set, setArray, setMult, sort, swap, toArray, toArray, toArray, transferCopy, transferMove, transferRemove, transferSwap, transform, transformedList

Methods inherited from class java.util.AbstractList

subList

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

replaceAll, spliterator, subList

Methods inherited from interface java.util.Collection

parallelStream, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

CharObjGapList

public CharObjGapList()

CharObjGapList

public CharObjGapList(int capacity)

CharObjGapList

public CharObjGapList(java.util.Collection<? extends java.lang.Character> elems)

Method Detail

create

public static CharObjGapList create()

create

public static CharObjGapList create(java.lang.Character... elems)

create

public static CharObjGapList create(java.util.Collection<? extends java.lang.Character> elems)

init

public void init()

init

public void init(java.lang.Character... elems)

init

public void init(java.util.Collection<? extends java.lang.Character> elems)

copy

public CharObjGapList copy()

Description copied from class: IList

Returns a shallow copy of this list 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 an IList.

Overrides:

copy in class IList<java.lang.Character>

Returns:

a clone of this instance

See Also:

IList.clone()

getDefaultElem

public java.lang.Character getDefaultElem()

doCreate

public IList<java.lang.Character> doCreate(int capacity)

Description copied from class: IList

Create list with specified capacity.

Parameters:

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

Returns:

created list

size

public int size()

Specified by:

size in interface java.util.Collection<java.lang.Character>

Specified by:

size in interface java.util.Deque<java.lang.Character>

Specified by:

size in interface java.util.List<java.lang.Character>

Specified by:

size in class IList<java.lang.Character>

capacity

public int capacity()

Returns capacity of this GapList. Note that two GapLists 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 IList<java.lang.Character>

Returns:

capacity of this GapList

get

public java.lang.Character get(int index)

Specified by:

get in interface java.util.List<java.lang.Character>

Overrides:

get in class IList<java.lang.Character>

move

public void move(int srcIndex,
                 int dstIndex,
                 int len)

Description copied from class: IList

Move specified elements. Source and destination ranges may overlap. The elements which are moved away are set to null, so the size of the list does not change.

Overrides:

move in class IList<java.lang.Character>

Parameters:

srcIndex - index of first source element to move

dstIndex - index of first destination element to move

len - number of elements to move

trimToSize

public void trimToSize()

Description copied from class: IList

An application can use this operation to minimize the storage of an instance.

Specified by:

trimToSize in class IList<java.lang.Character>

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Collection<java.lang.Character>

Specified by:

equals in interface java.util.List<java.lang.Character>

Overrides:

equals in class IList<java.lang.Character>

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<java.lang.Character>

Specified by:

hashCode in interface java.util.List<java.lang.Character>

Overrides:

hashCode in class IList<java.lang.Character>

toString

public java.lang.String toString()

Overrides:

toString in class IList<java.lang.Character>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<java.lang.Character>

Specified by:

isEmpty in interface java.util.List<java.lang.Character>

Overrides:

isEmpty in class IList<java.lang.Character>

indexOf

public int indexOf(java.lang.Object elem)

Specified by:

indexOf in interface java.util.List<java.lang.Character>

Overrides:

indexOf in class IList<java.lang.Character>

lastIndexOf

public int lastIndexOf(java.lang.Object elem)

Specified by:

lastIndexOf in interface java.util.List<java.lang.Character>

Overrides:

lastIndexOf in class IList<java.lang.Character>

remove

public boolean remove(java.lang.Object elem)

Specified by:

remove in interface java.util.Collection<java.lang.Character>

Specified by:

remove in interface java.util.Deque<java.lang.Character>

Specified by:

remove in interface java.util.List<java.lang.Character>

Overrides:

remove in class IList<java.lang.Character>

contains

public boolean contains(java.lang.Object elem)

Specified by:

contains in interface java.util.Collection<java.lang.Character>

Specified by:

contains in interface java.util.Deque<java.lang.Character>

Specified by:

contains in interface java.util.List<java.lang.Character>

Overrides:

contains in class IList<java.lang.Character>

containsAny

public boolean containsAny(java.util.Collection<?> coll)

Description copied from class: IList

Returns true if any of the elements of the specified collection is contained in the list.

Overrides:

containsAny in class IList<java.lang.Character>

Parameters:

coll - collection with elements to be contained

Returns:

true if any element is contained, false otherwise

containsAll

public boolean containsAll(java.util.Collection<?> coll)

Specified by:

containsAll in interface java.util.Collection<java.lang.Character>

Specified by:

containsAll in interface java.util.List<java.lang.Character>

Overrides:

containsAll in class IList<java.lang.Character>

removeAll

public boolean removeAll(java.util.Collection<?> coll)

Specified by:

removeAll in interface java.util.Collection<java.lang.Character>

Specified by:

removeAll in interface java.util.List<java.lang.Character>

Overrides:

removeAll in class IList<java.lang.Character>

removeAll

public boolean removeAll(IList<?> coll)

Overrides:

removeAll in class IList<java.lang.Character>

See Also:

IList.removeAll(Collection)

retainAll

public boolean retainAll(java.util.Collection<?> coll)

Specified by:

retainAll in interface java.util.Collection<java.lang.Character>

Specified by:

retainAll in interface java.util.List<java.lang.Character>

Overrides:

retainAll in class IList<java.lang.Character>

retainAll

public boolean retainAll(IList<?> coll)

Overrides:

retainAll in class IList<java.lang.Character>

See Also:

IList.retainAll(Collection)

toArray

public java.lang.Object[] toArray(int index,
                                  int len)

Returns an array containing the specified elements in this list.

Overrides:

toArray in class IList<java.lang.Character>

Parameters:

index - index of first element to copy

len - number of elements to copy

Returns:

array containing the specified elements

See Also:

List#toArray()

toArray

public <T> T[] toArray(T[] array,
                       int index,
                       int len)

Returns an array containing the specified elements in this list.

Overrides:

toArray in class IList<java.lang.Character>

Parameters:

array - the array into which the elements of this list are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose

index - index of first element to copy

len - number of elements to copy

Returns:

array containing the specified elements

See Also:

List#toArray(Object[])

toArray

public <T> T[] toArray(java.lang.Class<T> clazz,
                       int index,
                       int len)

Returns an array containing the specified elements in this list.

Overrides:

toArray in class IList<java.lang.Character>

Parameters:

clazz - class for array elements

index - index of first element to copy

len - number of elements to copy

Returns:

array containing the specified elements

addAll

public boolean addAll(java.util.Collection<? extends java.lang.Character> coll)

Description copied from class: IList

Adds all of the elements in the specified collection into this list. The new elements will appear in the list in the order that they are returned by the specified collection's iterator.

Specified by:

addAll in interface java.util.Collection<java.lang.Character>

Specified by:

addAll in interface java.util.List<java.lang.Character>

Overrides:

addAll in class IList<java.lang.Character>

Parameters:

coll - collection containing elements to be added to this list

Returns:

true if this list changed as a result of the call

addAll

public boolean addAll(int index,
                      java.util.Collection<? extends java.lang.Character> coll)

Description copied from class: IList

Inserts all of the elements in the specified collection into this list, starting at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in the list in the order that they are returned by the specified collection's iterator.

Specified by:

addAll in interface java.util.List<java.lang.Character>

Overrides:

addAll in class IList<java.lang.Character>

Parameters:

index - index at which to insert the first element from the specified collection

coll - collection containing elements to be inserted into this list

Returns:

true if this list changed as a result of the call

addArray

public boolean addArray(java.lang.Character... elems)

Description copied from class: IList

Adds all specified elements into this list.

Overrides:

addArray in class IList<java.lang.Character>

Parameters:

elems - elements to be added to this list

Returns:

true if this list changed as a result of the call

addArray

public boolean addArray(int index,
                        java.lang.Character... elems)

Description copied from class: IList

Inserts the specified elements into this list, starting at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices).

Overrides:

addArray in class IList<java.lang.Character>

Parameters:

index - index at which to insert the first element from the specified collection

elems - elements to be inserted into this list

Returns:

true if this list changed as a result of the call

addAll

public boolean addAll(IList<? extends java.lang.Character> list2)

Description copied from class: IList

Adds all of the elements in the specified list into this list.

Overrides:

addAll in class IList<java.lang.Character>

Parameters:

list2 - collection containing elements to be added to this list

Returns:

true if this list changed as a result of the call

addAll

public boolean addAll(int index,
                      IList<? extends java.lang.Character> list2)

Description copied from class: IList

Inserts all of the elements in the specified list into this list, starting at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices).

Overrides:

addAll in class IList<java.lang.Character>

Parameters:

index - index at which to insert the first element from the specified collection

list2 - list containing elements to be inserted into this list

Returns:

true if this list changed as a result of the call

removeFirstOccurrence

public boolean removeFirstOccurrence(java.lang.Object elem)

Specified by:

removeFirstOccurrence in interface java.util.Deque<java.lang.Character>

Overrides:

removeFirstOccurrence in class IList<java.lang.Character>

removeLastOccurrence

public boolean removeLastOccurrence(java.lang.Object elem)

Specified by:

removeLastOccurrence in interface java.util.Deque<java.lang.Character>

Overrides:

removeLastOccurrence in class IList<java.lang.Character>

getAll

public GapList<java.lang.Character> getAll(int index,
                                           int len)

Description copied from class: IList

Returns specified range of elements from list.

Overrides:

getAll in class IList<java.lang.Character>

Parameters:

index - index of first element to retrieve

len - number of elements to retrieve

Returns:

list containing the specified range of elements

setAll

public void setAll(int index,
                   IList<? extends java.lang.Character> list2)

Description copied from class: IList

Sets the specified elements.

Overrides:

setAll in class IList<java.lang.Character>

Parameters:

index - index of first element to set

list2 - list with elements to set

setAll

public void setAll(int index,
                   java.util.Collection<? extends java.lang.Character> coll)

Description copied from class: IList

Sets the specified elements.

Overrides:

setAll in class IList<java.lang.Character>

Parameters:

index - index of first element to set

coll - collection with elements to set

setArray

public void setArray(int index,
                     java.lang.Character... elems)

Description copied from class: IList

Sets the specified elements.

Overrides:

setArray in class IList<java.lang.Character>

Parameters:

index - index of first element to set

elems - array with elements to set

sort

public void sort(int index,
                 int len,
                 java.util.Comparator comparator)

Description copied from class: IList

Sort specified elements in the list using the specified comparator.

Specified by:

sort in class IList<java.lang.Character>

Parameters:

index - index of first element to sort

len - number of elements to sort

comparator - comparator to use for sorting (null means the elements natural ordering should be used)

See Also:

Arrays.sort(int[])

binarySearch

public <K> int binarySearch(int index,
                            int len,
                            K key,
                            java.util.Comparator<? super K> comparator)

Description copied from class: IList

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

Specified by:

binarySearch in class IList<java.lang.Character>

Parameters:

index - index of first element to search

len - number of elements to search

key - the value to be searched for

comparator - the comparator by which the list is ordered. A null value indicates that the elements' natural ordering should be used.

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)

unmodifiableList

public CharObjGapList unmodifiableList()

Description copied from class: IList

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 IList<java.lang.Character>

Returns:

an unmodifiable view of the specified list