speiger.src.collections.chars.lists

Class AbstractCharList

java.lang.Object

java.util.AbstractCollection<java.lang.Character>

speiger.src.collections.chars.collections.AbstractCharCollection

speiger.src.collections.chars.lists.AbstractCharList

All Implemented Interfaces:

java.lang.Iterable<java.lang.Character>, java.util.Collection<java.lang.Character>, java.util.List<java.lang.Character>, CharCollection, CharIterable, CharList

Direct Known Subclasses:

CharArrayList, CharLinkedList, CopyOnWriteCharArrayList, ImmutableCharList

public abstract class AbstractCharList
extends AbstractCharCollection
implements CharList

Abstract implementation of the CharList interface.

Constructor Summary

Constructors

Constructor and Description
AbstractCharList()

Method Summary

Modifier and Type	Method and Description
boolean	add(char e) A Type-Specific implementation of add function that delegates to List.add(int, Object)
void	add(int index, java.lang.Character element) Deprecated. Please use the corresponding type-specific function instead.
boolean	addAll(CharCollection c) A Type-Specific implementation that iterates over the elements and adds them.
boolean	addAll(CharList c) A Type-Specific implementation that iterates over the elements and adds them.
boolean	addAll(java.util.Collection<? extends java.lang.Character> c) Deprecated. Please use the corresponding type-specific function instead.
AbstractCharList	copy() A Function that does a shallow clone of the Collection itself.
boolean	equals(java.lang.Object o) Compares if the list are the same.
int	hashCode() Generates the hashcode based on the values stored in the list.
int	indexOf(char e) The indexOf implementation iterates over all elements and compares them to the search value.
int	indexOf(java.lang.Object o) Deprecated.
CharIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
int	lastIndexOf(char e) The lastIndexOf implementation iterates over all elements and compares them to the search value.
int	lastIndexOf(java.lang.Object o) Deprecated.
CharListIterator	listIterator() A Type-Specific Iterator of listIterator
CharListIterator	listIterator(int index) A Type-Specific Iterator of listIterator
void	size(int size) A function to ensure the elements are within the requested size.
CharList	subList(int fromIndex, int toIndex) A Type-Specific List of subList
boolean	swapRemoveChar(char e) A Highly Optimized remove function that removes the desired element.

Methods inherited from class speiger.src.collections.chars.collections.AbstractCharCollection

add, contains, contains, containsAll, containsAll, containsAny, containsAny, remChar, remove, removeAll, removeAll, retainAll, retainAll, toCharArray, toCharArray

Methods inherited from class java.util.AbstractCollection

clear, isEmpty, removeAll, retainAll, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.chars.lists.CharList

add, add, addAll, addAll, addElements, addElements, addElements, addIfAbsent, addIfPresent, contains, extractElements, fillBuffer, get, getChar, getElements, getElements, remove, remove, removeChar, removeElements, replaceAll, replaceChars, set, set, sort, sort, spliterator, swapRemove, synchronize, synchronize, unmodifiable, unstableSort, unstableSort

Methods inherited from interface speiger.src.collections.chars.collections.CharCollection

addAll, addAll, addAll, contains, containsAll, containsAny, containsAny, parallelPrimitiveStream, pour, primitiveStream, remChar, remIf, removeAll, removeAll, removeIf, retainAll, retainAll, toCharArray, toCharArray

Methods inherited from interface speiger.src.collections.chars.collections.CharIterable

arrayflatMap, asAsync, count, distinct, filter, findFirst, flatMap, forEach, forEach, forEach, limit, map, matchesAll, matchesAny, matchesNone, peek, pourAsList, pourAsSet, reduce, reduce, sorted

Methods inherited from interface java.util.List

addAll, clear, containsAll, isEmpty, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

AbstractCharList

public AbstractCharList()

Method Detail

add

public boolean add(char e)

A Type-Specific implementation of add function that delegates to List.add(int, Object)

Specified by:

add in interface CharCollection

Specified by:

add in interface CharList

Parameters:

e - the element to add

Returns:

true if the list was modified

See Also:

List.add(Object)

add

@Deprecated
public void add(int index,
                             java.lang.Character element)

Deprecated. Please use the corresponding type-specific function instead.

This default implementation delegates to the corresponding type-specific function.

Specified by:

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

addAll

public boolean addAll(CharCollection c)

A Type-Specific implementation that iterates over the elements and adds them.

Specified by:

addAll in interface CharCollection

Overrides:

addAll in class AbstractCharCollection

Parameters:

c - the elements that wants to be added

Returns:

true if the list was modified

addAll

public boolean addAll(CharList c)

A Type-Specific implementation that iterates over the elements and adds them.

Specified by:

addAll in interface CharList

Parameters:

c - the elements that wants to be added

Returns:

true if the list was modified

addAll

@Deprecated
public boolean addAll(java.util.Collection<? extends java.lang.Character> c)

Deprecated. Please use the corresponding type-specific function instead.

This default implementation delegates to the corresponding type-specific function.

This default implementation delegates to the corresponding type-specific function.

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 AbstractCharCollection

indexOf

@Deprecated
public int indexOf(java.lang.Object o)

Deprecated.

The IndexOf implementation iterates over all elements and compares them to the search value.

Specified by:

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

Specified by:

indexOf in interface CharList

Parameters:

o - the value that the index is searched for.

Returns:

index of the value that was searched for. -1 if not found

Note:

it is highly suggested not to use this with Primitives because of boxing. But it is still supported because of ObjectComparason that are custom objects and allow to find the contents.

lastIndexOf

@Deprecated
public int lastIndexOf(java.lang.Object o)

Deprecated.

The lastIndexOf implementation iterates over all elements and compares them to the search value.

Specified by:

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

Specified by:

lastIndexOf in interface CharList

Parameters:

o - the value that the index is searched for.

Returns:

the last index of the value that was searched for. -1 if not found

Note:

it is highly suggested not to use this with Primitives because of boxing. But it is still supported because of ObjectComparason that are custom objects and allow to find the contents.

indexOf

public int indexOf(char e)

The indexOf implementation iterates over all elements and compares them to the search value.

Specified by:

indexOf in interface CharList

Parameters:

e - the value that the index is searched for.

Returns:

index of the value that was searched for. -1 if not found

lastIndexOf

public int lastIndexOf(char e)

The lastIndexOf implementation iterates over all elements and compares them to the search value.

Specified by:

lastIndexOf in interface CharList

Parameters:

e - the value that the index is searched for.

Returns:

the last index of the value that was searched for. -1 if not found

swapRemoveChar

public boolean swapRemoveChar(char e)

Description copied from interface: CharList

A Highly Optimized remove function that removes the desired element. But instead of shifting the elements to the left it moves the last element to the removed space.

Specified by:

swapRemoveChar in interface CharList

Parameters:

e - the element that should be removed

Returns:

true if the element was removed

equals

public boolean equals(java.lang.Object o)

Compares if the list are the same.

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 java.lang.Object

hashCode

public int hashCode()

Generates the hashcode based on the values stored in the list.

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 java.lang.Object

subList

public CharList subList(int fromIndex,
                        int toIndex)

Description copied from interface: CharList

A Type-Specific List of subList

Specified by:

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

Specified by:

subList in interface CharList

See Also:

List.subList(int, int)

iterator

public CharIterator iterator()

Description copied from interface: CharCollection

Returns a Type-Specific Iterator to reduce (un)boxing

Specified by:

iterator in interface java.lang.Iterable<java.lang.Character>

Specified by:

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

Specified by:

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

Specified by:

iterator in interface CharCollection

Specified by:

iterator in interface CharIterable

Specified by:

iterator in class AbstractCharCollection

Returns:

a iterator of the collection

See Also:

Collection.iterator()

listIterator

public CharListIterator listIterator()

Description copied from interface: CharList

A Type-Specific Iterator of listIterator

Specified by:

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

Specified by:

listIterator in interface CharList

See Also:

List.listIterator()

listIterator

public CharListIterator listIterator(int index)

Description copied from interface: CharList

A Type-Specific Iterator of listIterator

Specified by:

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

Specified by:

listIterator in interface CharList

See Also:

List.listIterator(int)

size

public void size(int size)

Description copied from interface: CharList

A function to ensure the elements are within the requested size. If smaller then the stored elements they get removed as needed. If bigger it is ensured that enough room is provided depending on the implementation

Specified by:

size in interface CharList

Parameters:

size - the requested amount of elements/room for elements

copy

public AbstractCharList copy()

Description copied from interface: CharCollection

A Function that does a shallow clone of the Collection itself. This function is more optimized then a copy constructor since the Collection does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk

Specified by:

copy in interface CharCollection

Specified by:

copy in interface CharList

Overrides:

copy in class AbstractCharCollection

Returns:

a Shallow Copy of the collection