speiger.src.collections.chars.lists

Class ImmutableCharList

java.lang.Object

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

speiger.src.collections.chars.collections.AbstractCharCollection

speiger.src.collections.chars.lists.AbstractCharList

speiger.src.collections.chars.lists.ImmutableCharList

All Implemented Interfaces:

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

public class ImmutableCharList
extends AbstractCharList

A Type-Specific Immutable implementation of list that is written to reduce (un)boxing

Nested Class Summary

Nested classes/interfaces inherited from interface speiger.src.collections.utils.ISizeProvider

ISizeProvider.CollectionSize

Constructor Summary

Constructors

Constructor and Description
ImmutableCharList(char... a) Creates a new Immutable copy of the contents of the Array.
ImmutableCharList(char[] a, int length) Creates a new ImmutableList copy of the array with a custom length
ImmutableCharList(char[] a, int offset, int length) Creates a new ImmutableList copy of the array with in the custom range.
ImmutableCharList(CharCollection c) Creates a new Immutable copy of the contents of the Collection.
ImmutableCharList(CharList l) Creates a new Immutable copy of the contents of the List.
ImmutableCharList(java.util.Collection<? extends java.lang.Character> c) Deprecated.

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, char e) A Type-Specific add Function to reduce (un)boxing
boolean	addAll(char[] e, int offset, int length) A Type-Specific Array based addAll method to reduce the amount of Wrapping
boolean	addAll(int index, CharCollection c) A Type-Specific addAll Function to reduce (un)boxing
boolean	addAll(int index, CharList c) A Type-Specific and optimized addAll function that allows a faster transfer of elements
boolean	addAll(int index, java.util.Collection<? extends java.lang.Character> c) Deprecated.
void	addElements(int from, char[] a, int offset, int length) A function to fast add elements to the list
void	clear()
boolean	contains(char e) A Type Specific implementation of the Collection#contains function.
boolean	contains(java.lang.Object o) Deprecated.
ImmutableCharList	copy() A Function that does a shallow clone of the Collection itself.
int	count(CharPredicate filter) Helper function to reduce stream usage that allows to count the valid elements.
char[]	extractElements(int from, int to) A function to fast extract elements out of the list, this removes the elements that were fetched.
char	findFirst(CharPredicate filter) Helper function to reduce stream usage that allows to filter for the first match.
void	forEach(CharConsumer action) A Type Specific foreach function that reduces (un)boxing
<E> void	forEach(E input, ObjectCharConsumer<E> action) Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
char	getChar(int index) A Type-Specific get function to reduce (un)boxing
char[]	getElements(int from, char[] a, int offset, int length) A function to fast fetch elements from the list
int	indexOf(char e) A Type-Specific function to find the index of a given element
int	indexOf(java.lang.Object o) Deprecated.
int	lastIndexOf(char e) A Type-Specific function to find the last index of a given element
int	lastIndexOf(java.lang.Object o) Deprecated.
CharListIterator	listIterator(int index) A Type-Specific Iterator of listIterator
boolean	matchesAll(CharPredicate filter) Helper function to reduce stream usage that allows to filter for all matches.
boolean	matchesAny(CharPredicate filter) Helper function to reduce stream usage that allows to filter for any matches.
boolean	matchesNone(CharPredicate filter) Helper function to reduce stream usage that allows to filter for no matches.
java.util.stream.IntStream	primitiveStream() Returns a Java-Type-Specific Stream to reduce boxing/unboxing.
char	reduce(char identity, CharCharUnaryOperator operator) Performs a reduction on the elements of this Iterable
char	reduce(CharCharUnaryOperator operator) Performs a reduction on the elements of this Iterable
boolean	remChar(char type) A Type-Specific implementation of remove.
boolean	remIf(java.util.function.IntPredicate filter) A Type-Specific removeIf function to reduce (un)boxing.
boolean	removeAll(CharCollection c) A Type-Specific implementation of removeAll.
boolean	removeAll(CharCollection c, CharConsumer r) A Type-Specific removeAll function that reduces (un)boxing.
boolean	removeAll(java.util.Collection<?> c) Deprecated.
char	removeChar(int index) A Type-Specific remove function to reduce (un)boxing
void	removeElements(int from, int to) a function to fast remove elements from the list.
boolean	removeIf(java.util.function.Predicate<? super java.lang.Character> filter) Deprecated.
void	replaceAll(java.util.function.UnaryOperator<java.lang.Character> o) Deprecated.
void	replaceChars(java.util.function.IntUnaryOperator o) A Type-Specific replace function to reduce (un)boxing
boolean	retainAll(CharCollection c) A Type-Specific implementation of retainAll.
boolean	retainAll(CharCollection c, CharConsumer r) A Type-Specific retainAll function that reduces (un)boxing.
boolean	retainAll(java.util.Collection<?> c) Deprecated.
char	set(int index, char e) A Type-Specific set function to reduce (un)boxing
int	size() A function to return the size of the list
void	size(int size) A function to ensure the elements are within the requested size.
void	sort(CharComparator c) Sorts the elements specified by the Natural order either by using the Comparator or the elements
CharSplititerator	spliterator() A Type Specific Type Splititerator to reduce boxing/unboxing
char	swapRemove(int index) A Highly Optimized remove function that removes the desired element.
java.lang.Object[]	toArray() Deprecated.
<E> E[]	toArray(E[] a) Deprecated.
char[]	toCharArray(char[] a) A Type-Specific implementation of toArray.
void	unstableSort(CharComparator c) Sorts the elements specified by the Natural order either by using the Comparator or the elements using a unstable sort

Methods inherited from class speiger.src.collections.chars.lists.AbstractCharList

add, addAll, addAll, addAll, equals, hashCode, iterator, listIterator, subList, swapRemoveChar

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

add, containsAll, containsAll, containsAny, containsAny, remove, toCharArray

Methods inherited from class java.util.AbstractCollection

isEmpty, 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, addElements, addElements, addIfAbsent, addIfPresent, fillBuffer, forEachIndexed, get, getElements, remove, remove, set, sort, synchronize, synchronize, unmodifiable, unstableSort

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

addAll, addAll, containsAll, containsAny, containsAny, parallelPrimitiveStream, pour, toCharArray

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

arrayflatMap, asAsync, distinct, filter, flatMap, forEach, limit, map, peek, pourAsList, pourAsSet, repeat, sorted

Methods inherited from interface speiger.src.collections.utils.ISizeProvider

of

Methods inherited from interface java.util.List

containsAll, isEmpty

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

ImmutableCharList

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

Deprecated.

Creates a new Immutable copy of the contents of the Collection.

Parameters:

c - the elements that should be added into the list

ImmutableCharList

public ImmutableCharList(CharCollection c)

Creates a new Immutable copy of the contents of the Collection.

Parameters:

c - the elements that should be added into the list

ImmutableCharList

public ImmutableCharList(CharList l)

Creates a new Immutable copy of the contents of the List.

Parameters:

l - the elements that should be added into the list

ImmutableCharList

public ImmutableCharList(char... a)

Creates a new Immutable copy of the contents of the Array.

Parameters:

a - the array that should be copied

ImmutableCharList

public ImmutableCharList(char[] a,
                         int length)

Creates a new ImmutableList copy of the array with a custom length

Parameters:

a - the array that should be copied

length - the desired length that should be copied

ImmutableCharList

public ImmutableCharList(char[] a,
                         int offset,
                         int length)

Creates a new ImmutableList copy of the array with in the custom range.

Parameters:

a - the array that should be copied

offset - the starting offset of where the array should be copied from

length - the desired length that should be copied

Throws:

java.lang.IllegalStateException - if offset is smaller then 0

java.lang.IllegalStateException - if the offset + length exceeds the array length

Method Detail

add

public boolean add(char e)

Description copied from class: AbstractCharList

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

Overrides:

add in class AbstractCharList

Parameters:

e - the element to add

Returns:

true if the list was modified

See Also:

List.add(Object)

add

public void add(int index,
                char e)

Description copied from interface: CharList

A Type-Specific add Function to reduce (un)boxing

Parameters:

index - index at which the specified element is to be inserted

e - the element to add

See Also:

List.add(int, Object)

addAll

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

Deprecated.

addAll

public boolean addAll(int index,
                      CharCollection c)

Description copied from interface: CharList

A Type-Specific addAll Function to reduce (un)boxing

Parameters:

index - index at which the specified elements is to be inserted

c - the elements that need to be added

Returns:

true if the list was modified

See Also:

List.addAll(int, java.util.Collection)

addAll

public boolean addAll(int index,
                      CharList c)

Description copied from interface: CharList

A Type-Specific and optimized addAll function that allows a faster transfer of elements

Parameters:

index - index at which the specified elements is to be inserted

c - the elements that need to be added

Returns:

true if the list was modified

addAll

public boolean addAll(char[] e,
                      int offset,
                      int length)

Description copied from interface: CharCollection

A Type-Specific Array based addAll method to reduce the amount of Wrapping

Parameters:

e - the elements that should be added

offset - where to start within the array

length - how many elements of the array should be added

Returns:

if the collection was modified

addElements

public void addElements(int from,
                        char[] a,
                        int offset,
                        int length)

Description copied from interface: CharList

A function to fast add elements to the list

Parameters:

from - the index where the elements should be added into the list

a - the elements that should be added

offset - the start index of the array should be read from

length - how many elements should be read from

getElements

public char[] getElements(int from,
                          char[] a,
                          int offset,
                          int length)

Description copied from interface: CharList

A function to fast fetch elements from the list

Parameters:

from - index where the list should be fetching elements from

a - the array where the values should be inserted to

offset - the startIndex of where the array should be written to

length - the number of elements the values should be fetched from

Returns:

the inputArray

removeElements

public void removeElements(int from,
                           int to)

Description copied from interface: CharList

a function to fast remove elements from the list.

Parameters:

from - the start index of where the elements should be removed from (inclusive)

to - the end index of where the elements should be removed to (exclusive)

extractElements

public char[] extractElements(int from,
                              int to)

Description copied from interface: CharList

A function to fast extract elements out of the list, this removes the elements that were fetched.

Parameters:

from - the start index of where the elements should be fetched from (inclusive)

to - the end index of where the elements should be fetched to (exclusive)

Returns:

a array of the elements that were fetched

contains

@Deprecated
public boolean contains(java.lang.Object o)

Deprecated.

A function to find if the Element is present in this list.

Specified by:

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

Specified by:

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

Specified by:

contains in interface CharCollection

Specified by:

contains in interface CharList

Overrides:

contains in class AbstractCharCollection

Parameters:

o - the element that is searched for

Returns:

if the element was found.

indexOf

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

Deprecated.

A function to find the index of a given element

Specified by:

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

Specified by:

indexOf in interface CharList

Overrides:

indexOf in class AbstractCharList

Parameters:

o - the element that is searched for

Returns:

the index of the element if found. (if not found then -1)

lastIndexOf

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

Deprecated.

A function to find the last index of a given element

Specified by:

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

Specified by:

lastIndexOf in interface CharList

Overrides:

lastIndexOf in class AbstractCharList

Parameters:

o - the element that is searched for

Returns:

the last index of the element if found. (if not found then -1)

contains

public boolean contains(char e)

A Type Specific implementation of the Collection#contains function.

Specified by:

contains in interface CharCollection

Overrides:

contains in class AbstractCharCollection

Parameters:

e - the element that is searched for.

Returns:

if the element was found

indexOf

public int indexOf(char e)

A Type-Specific function to find the index of a given element

Specified by:

indexOf in interface CharList

Overrides:

indexOf in class AbstractCharList

Parameters:

e - the element that is searched for

Returns:

the index of the element if found. (if not found then -1)

lastIndexOf

public int lastIndexOf(char e)

A Type-Specific function to find the last index of a given element

Specified by:

lastIndexOf in interface CharList

Overrides:

lastIndexOf in class AbstractCharList

Parameters:

e - the element that is searched for

Returns:

the last index of the element if found. (if not found then -1)

sort

public void sort(CharComparator c)

Description copied from interface: CharList

Sorts the elements specified by the Natural order either by using the Comparator or the elements

Parameters:

c - the sorter of the elements, can be null

See Also:

List.sort(Comparator), CharArrays.stableSort(char[], CharComparator)

unstableSort

public void unstableSort(CharComparator c)

Description copied from interface: CharList

Sorts the elements specified by the Natural order either by using the Comparator or the elements using a unstable sort

Parameters:

c - the sorter of the elements, can be null

See Also:

List.sort(Comparator), CharArrays.unstableSort(char[], CharComparator)

getChar

public char getChar(int index)

A Type-Specific get function to reduce (un)boxing

Parameters:

index - the index of the element to fetch

Returns:

the value of the requested index

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range

See Also:

List.get(int)

copy

public ImmutableCharList 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 AbstractCharList

Returns:

a Shallow Copy of the collection

forEach

public void forEach(CharConsumer action)

A Type Specific foreach function that reduces (un)boxing

Parameters:

action - The action to be performed for each element

Throws:

java.lang.NullPointerException - if the specified action is null

See Also:

Iterable.forEach(java.util.function.Consumer)

ImplSpec:

The default implementation behaves as if:

 	for(int i = 0;i<size;i++)
 		action.accept(data[i]);
 

forEach

public <E> void forEach(E input,
                        ObjectCharConsumer<E> action)

Description copied from interface: CharIterable

Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.

Type Parameters:

E - the generic type of the Object

Parameters:

input - the object that should be included

action - The action to be performed for each element

matchesAny

public boolean matchesAny(CharPredicate filter)

Description copied from interface: CharIterable

Helper function to reduce stream usage that allows to filter for any matches.

Parameters:

filter - that should be applied

Returns:

true if any matches were found

matchesNone

public boolean matchesNone(CharPredicate filter)

Description copied from interface: CharIterable

Helper function to reduce stream usage that allows to filter for no matches.

Parameters:

filter - that should be applied

Returns:

true if no matches were found

matchesAll

public boolean matchesAll(CharPredicate filter)

Description copied from interface: CharIterable

Helper function to reduce stream usage that allows to filter for all matches.

Parameters:

filter - that should be applied

Returns:

true if all matches.

findFirst

public char findFirst(CharPredicate filter)

Description copied from interface: CharIterable

Helper function to reduce stream usage that allows to filter for the first match.

Parameters:

filter - that should be applied

Returns:

the found value or the null equivalent variant.

reduce

public char reduce(char identity,
                   CharCharUnaryOperator operator)

Description copied from interface: CharIterable

Performs a reduction on the elements of this Iterable

Parameters:

identity - the start value

operator - the operation that should be applied

Returns:

the reduction result, returns identity if nothing was found

reduce

public char reduce(CharCharUnaryOperator operator)

Description copied from interface: CharIterable

Performs a reduction on the elements of this Iterable

Parameters:

operator - the operation that should be applied

Returns:

the reduction result, returns null value if nothing was found

count

public int count(CharPredicate filter)

Description copied from interface: CharIterable

Helper function to reduce stream usage that allows to count the valid elements.

Parameters:

filter - that should be applied

Returns:

the amount of Valid Elements

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

Overrides:

listIterator in class AbstractCharList

See Also:

List.listIterator(int)

set

public char set(int index,
                char e)

Description copied from interface: CharList

A Type-Specific set function to reduce (un)boxing

Parameters:

index - index of the element to replace

e - element to be stored at the specified position

Returns:

the element previously at the specified position

See Also:

List.set(int, Object)

replaceAll

@Deprecated
public void replaceAll(java.util.function.UnaryOperator<java.lang.Character> o)

Deprecated.

Description copied from interface: CharList

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

replaceChars

public void replaceChars(java.util.function.IntUnaryOperator o)

Description copied from interface: CharList

A Type-Specific replace function to reduce (un)boxing

Parameters:

o - the action to replace the values

removeChar

public char removeChar(int index)

Description copied from interface: CharList

A Type-Specific remove function to reduce (un)boxing

Parameters:

index - the index of the element to be removed

Returns:

the element previously at the specified position

See Also:

List.remove(int)

swapRemove

public char swapRemove(int index)

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.

Parameters:

index - the index of the element to be removed

Returns:

the element previously at the specified position

remChar

public boolean remChar(char type)

Description copied from class: AbstractCharCollection

A Type-Specific implementation of remove. This implementation iterates over the elements until it finds the element that is searched for or it runs out of elements. It stops after finding the first element

Specified by:

remChar in interface CharCollection

Overrides:

remChar in class AbstractCharCollection

Parameters:

type - the element that is searched for

Returns:

true if the element was found and removed.

See Also:

Collection.remove(Object)

removeAll

@Deprecated
public boolean removeAll(java.util.Collection<?> c)

Deprecated.

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

retainAll

@Deprecated
public boolean retainAll(java.util.Collection<?> c)

Deprecated.

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

removeIf

@Deprecated
public boolean removeIf(java.util.function.Predicate<? super java.lang.Character> filter)

Deprecated.

Description copied from interface: CharCollection

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

removeAll

public boolean removeAll(CharCollection c)

Description copied from class: AbstractCharCollection

A Type-Specific implementation of removeAll. This Implementation iterates over all elements and removes them as they were found in the other collection.

Specified by:

removeAll in interface CharCollection

Overrides:

removeAll in class AbstractCharCollection

Parameters:

c - the elements that should be deleted

Returns:

true if the collection was modified.

See Also:

Collection.removeAll(Collection)

retainAll

public boolean retainAll(CharCollection c)

Description copied from class: AbstractCharCollection

A Type-Specific implementation of retainAll. This Implementation iterates over all elements and removes them as they were not found in the other collection.

Specified by:

retainAll in interface CharCollection

Overrides:

retainAll in class AbstractCharCollection

Parameters:

c - the elements that should be kept

Returns:

true if the collection was modified.

See Also:

Collection.retainAll(Collection)

removeAll

public boolean removeAll(CharCollection c,
                         CharConsumer r)

Description copied from interface: CharCollection

A Type-Specific removeAll function that reduces (un)boxing. It also notifies the remover of which exact element is going to be removed.

Specified by:

removeAll in interface CharCollection

Overrides:

removeAll in class AbstractCharCollection

Parameters:

c - the collection of elements that should be removed

r - elements that got removed

Returns:

true if any element was removed

See Also:

Collection.removeAll(Collection)

retainAll

public boolean retainAll(CharCollection c,
                         CharConsumer r)

Description copied from interface: CharCollection

A Type-Specific retainAll function that reduces (un)boxing. It also notifies the remover of which exact element is going to be removed.

Specified by:

retainAll in interface CharCollection

Overrides:

retainAll in class AbstractCharCollection

Parameters:

c - the collection of elements that should be kept

r - elements that got removed

Returns:

true if any element was removed

See Also:

Collection.retainAll(Collection)

remIf

public boolean remIf(java.util.function.IntPredicate filter)

Description copied from interface: CharCollection

A Type-Specific removeIf function to reduce (un)boxing.

Removes elements that were selected by the filter

Parameters:

filter - Filters the elements that should be removed

Returns:

true if the collection was modified

See Also:

Collection.removeIf(Predicate)

toArray

@Deprecated
public java.lang.Object[] toArray()

Deprecated.

A toArray implementation that ensures the Array itself is a Object.

Specified by:

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

Specified by:

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

Overrides:

toArray in class java.util.AbstractCollection<java.lang.Character>

Returns:

a Array of the elements in the list

toArray

@Deprecated
public <E> E[] toArray(E[] a)

Deprecated.

A toArray implementation that ensures the Array itself is a Object.

Specified by:

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

Specified by:

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

Overrides:

toArray in class java.util.AbstractCollection<java.lang.Character>

Parameters:

a - original array. If null a Object array with the right size is created. If to small the Array of the same type is created with the right size

Returns:

a Array of the elements in the list

toCharArray

public char[] toCharArray(char[] a)

Description copied from class: AbstractCharCollection

A Type-Specific implementation of toArray. This implementation iterates over all elements and unwraps them into primitive type.

Specified by:

toCharArray in interface CharCollection

Overrides:

toCharArray in class AbstractCharCollection

Parameters:

a - array that the elements should be injected to. If null or to small a new array with the right size is created

Returns:

an array containing all of the elements in this collection

See Also:

Collection.toArray(Object[])

size

public int size()

A function to return the size of the list

Specified by:

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

Specified by:

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

Specified by:

size in interface ISizeProvider

Specified by:

size in class java.util.AbstractCollection<java.lang.Character>

Returns:

the size of elements in the list

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

Overrides:

size in class AbstractCharList

Parameters:

size - the requested amount of elements/room for elements

clear

public void clear()

Specified by:

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

Specified by:

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

Overrides:

clear in class java.util.AbstractCollection<java.lang.Character>

primitiveStream

public java.util.stream.IntStream primitiveStream()

Returns a Java-Type-Specific Stream to reduce boxing/unboxing.

Returns:

a Stream of the closest java type

Note:

characteristics are ordered, sized, subsized

spliterator

public CharSplititerator spliterator()

A Type Specific Type Splititerator to reduce boxing/unboxing

Returns:

type specific splititerator

Note:

characteristics are ordered, sized, subsized