speiger.src.collections.chars.lists

Interface CharList

All Superinterfaces:

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

All Known Implementing Classes:

AbstractCharList, CharArrayList

public interface CharList
extends CharCollection, java.util.List<java.lang.Character>

A Type Specific List interface that reduces boxing/unboxing and adds a couple extra quality of life features

Method Summary

Modifier and Type	Method and Description
boolean	add(char e) A Type-Specific add Function to reduce (un)boxing
default boolean	add(java.lang.Character e) Deprecated. Please use the corresponding type-specific function instead.
void	add(int index, char e) A Type-Specific add Function to reduce (un)boxing
boolean	addAll(CharList c) A Type-Specific and optimized addAll function that allows a faster transfer of elements
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
default void	addElements(char... a) A function to fast add elements to the list
default void	addElements(int from, char... a) A function to fast add elements to the list
void	addElements(int from, char[] a, int offset, int length) A function to fast add elements to the list
default boolean	contains(java.lang.Object o) Deprecated. Please use the corresponding type-specific function instead.
char[]	extractElements(int from, int to) A function to fast extract elements out of the list, this removes the elements that were fetched.
default java.lang.Character	get(int index) Deprecated. Please use the corresponding type-specific function instead.
char	getChar(int index) A Type-Specific get function to reduce (un)boxing
default char[]	getElements(int from, char[] a) A function to fast fetch elements from the list
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 indexOf function to reduce (un)boxing
default int	indexOf(java.lang.Object o) Deprecated. Please use the corresponding type-specific function instead.
int	lastIndexOf(char e) A Type-Specific lastIndexOf function to reduce (un)boxing
default int	lastIndexOf(java.lang.Object o) Deprecated. Please use the corresponding type-specific function instead.
CharListIterator	listIterator() A Type-Specific Iterator of listIterator
CharListIterator	listIterator(int index) A Type-Specific Iterator of listIterator
default java.lang.Character	remove(int index) Deprecated. Please use the corresponding type-specific function instead.
default boolean	remove(java.lang.Object o) Deprecated. Please use the corresponding type-specific function instead.
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.
default void	replaceAll(java.util.function.UnaryOperator<java.lang.Character> o) Deprecated. Please use the corresponding type-specific function instead.
default void	replaceChars(java.util.function.IntUnaryOperator o) A Type-Specific replace function to reduce (un)boxing
char	set(int index, char e) A Type-Specific set function to reduce (un)boxing
default java.lang.Character	set(int index, java.lang.Character e) Deprecated. Please use the corresponding type-specific function instead.
void	size(int size) A function to ensure the elements are within the requested size.
default void	sort(CharComparator c) Sorts the elements specified by the Natural order either by using the Comparator or the elements
default void	sort(java.util.Comparator<? super java.lang.Character> c) Deprecated. Please use the corresponding type-specific function instead.
default CharSplititerator	spliterator() A Type Specific Type Splititerator to reduce boxing/unboxing
CharList	subList(int from, int to) A Type-Specific List of subList
default void	unstableSort(CharComparator c) Sorts the elements specified by the Natural order either by using the Comparator or the elements using a unstable sort
default void	unstableSort(java.util.Comparator<? super java.lang.Character> c) Deprecated. Please use the corresponding type-specific function instead.

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

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

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

forEach, forEach

Methods inherited from interface java.util.List

add, addAll, addAll, clear, containsAll, equals, hashCode, isEmpty, iterator, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, stream

Method Detail

add

boolean add(char e)

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

Specified by:

add in interface CharCollection

Parameters:

e - the element to add

Returns:

true if the list was modified

See Also:

List.add(Object)

add

void add(int index,
         char e)

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

Parameters:

e - the element to add

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

See Also:

List.add(int, Object)

addAll

boolean addAll(int index,
               CharCollection c)

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

Parameters:

c - the elements that need to be added

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

Returns:

true if the list was modified

See Also:

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

addAll

boolean addAll(CharList c)

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

Parameters:

c - the elements that need to be added

Returns:

true if the list was modified

addAll

boolean addAll(int index,
               CharList c)

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

Parameters:

c - the elements that need to be added

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

Returns:

true if the list was modified

getChar

char getChar(int index)

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

Parameters:

index - the index of the value that is requested

Returns:

the value at the given index

Throws:

java.lang.IndexOutOfBoundsException - if the index is not within the list range

See Also:

List.get(int)

set

char set(int index,
         char e)

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

Throws:

java.lang.IndexOutOfBoundsException - if the index is not within the list range

See Also:

List.set(int, Object)

removeChar

char removeChar(int index)

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)

indexOf

int indexOf(char e)

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

Parameters:

e - the element that is searched for

Returns:

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

Note:

does not support null values

lastIndexOf

int lastIndexOf(char e)

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

Parameters:

e - the element that is searched for

Returns:

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

Note:

does not support null values

replaceChars

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

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

Parameters:

o - the action to replace the values

Throws:

java.lang.NullPointerException - if o is null

addElements

default void addElements(char... a)

A function to fast add elements to the list

Parameters:

a - the elements that should be added

Throws:

java.lang.IndexOutOfBoundsException - if from is outside of the lists range

addElements

default void addElements(int from,
                         char... a)

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

Throws:

java.lang.IndexOutOfBoundsException - if from is outside of the lists range

addElements

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

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

Throws:

java.lang.IndexOutOfBoundsException - if from is outside of the lists range

java.lang.IllegalStateException - if offset or length are smaller then 0 or exceed the array length

getElements

default char[] getElements(int from,
                           char[] a)

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

Returns:

the inputArray

Throws:

java.lang.NullPointerException - if the array is null

java.lang.IndexOutOfBoundsException - if from is outside of the lists range

java.lang.IllegalStateException - if offset or length are smaller then 0 or exceed the array length

getElements

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

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

Throws:

java.lang.NullPointerException - if the array is null

java.lang.IndexOutOfBoundsException - if from is outside of the lists range

java.lang.IllegalStateException - if offset or length are smaller then 0 or exceed the array length

removeElements

void removeElements(int from,
                    int to)

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

char[] extractElements(int from,
                       int to)

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

sort

@Deprecated
default void sort(java.util.Comparator<? super java.lang.Character> c)

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

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

Specified by:

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

sort

default void sort(CharComparator c)

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

@Deprecated
default void unstableSort(java.util.Comparator<? super java.lang.Character> c)

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

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

Parameters:

c - the sorter of the elements, can be null

unstableSort

default void unstableSort(CharComparator c)

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)

listIterator

CharListIterator listIterator()

A Type-Specific Iterator of listIterator

Specified by:

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

See Also:

List.listIterator()

listIterator

CharListIterator listIterator(int index)

A Type-Specific Iterator of listIterator

Specified by:

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

See Also:

List.listIterator(int)

subList

CharList subList(int from,
                 int to)

A Type-Specific List of subList

Specified by:

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

See Also:

List.subList(int, int)

size

void size(int size)

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

Parameters:

size - the requested amount of elements/room for elements

add

@Deprecated
default boolean add(java.lang.Character e)

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:

add in interface CharCollection

Specified by:

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

Specified by:

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

get

@Deprecated
default java.lang.Character get(int index)

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

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

Specified by:

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

set

@Deprecated
default java.lang.Character set(int index,
                                             java.lang.Character e)

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

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

Specified by:

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

indexOf

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

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

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

Specified by:

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

lastIndexOf

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

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

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

Specified by:

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

contains

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

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:

contains in interface CharCollection

Specified by:

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

Specified by:

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

remove

@Deprecated
default boolean remove(java.lang.Object o)

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:

remove in interface CharCollection

Specified by:

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

Specified by:

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

remove

@Deprecated
default java.lang.Character remove(int index)

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

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

Specified by:

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

replaceAll

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

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

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

Specified by:

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

spliterator

default CharSplititerator spliterator()

A Type Specific Type Splititerator to reduce boxing/unboxing

Specified by:

spliterator in interface CharCollection

Specified by:

spliterator in interface CharIterable

Specified by:

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

Specified by:

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

Specified by:

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

Returns:

type specific splititerator