Modul speiger.src.collections

Package speiger.src.collections.objects.lists

Schnittstelle ObjectList<T>

Typparameter:

T - the keyType of elements maintained by this Collection

Alle Superschnittstellen:

Collection<T>, ISizeProvider, Iterable<T>, List<T>, ObjectCollection<T>, ObjectIterable<T>

Alle bekannten Implementierungsklassen:

AbstractObjectList, CopyOnWriteObjectArrayList, ImmutableObjectList, ObjectArrayList, ObjectLinkedList

public interface ObjectList<T>
extends ObjectCollection<T>, List<T>

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

Verschachtelte Klassen - Übersicht

Von Schnittstelle geerbte verschachtelte Klassen/Schnittstellen speiger.src.collections.utils.ISizeProvider

ISizeProvider.CollectionSize

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
boolean	addAll(int index, ObjectCollection<T> c)	A Type-Specific addAll Function to reduce (un)boxing
boolean	addAll(int index, ObjectList<T> c)	A Type-Specific and optimized addAll function that allows a faster transfer of elements
boolean	addAll(ObjectList<T> c)	A Type-Specific and optimized addAll function that allows a faster transfer of elements
default void	addElements(int from, T... a)	A function to fast add elements to the list
void	addElements(int from, T[] a, int offset, int length)	A function to fast add elements to the list
default void	addElements(T... a)	A function to fast add elements to the list
default boolean	addIfAbsent(T e)	A Helper function that will only add elements if it is not present.
default boolean	addIfPresent(T e)	A Helper function that will only add elements if it is present.
ObjectList<T>	copy()	A Function that does a shallow clone of the Collection itself.
<K> K[]	extractElements(int from, int to, Class<K> type)	A function to fast extract elements out of the list, this removes the elements that were fetched.
default void	forEachIndexed(IntObjectConsumer<T> action)	A Indexed forEach implementation that allows you to keep track of how many elements were already iterated over.
default T[]	getElements(int from, T[] a)	A function to fast fetch elements from the list
T[]	getElements(int from, T[] a, int offset, int length)	A function to fast fetch elements from the list
default T	getFirst()	Helper method that returns the first element of a List.
default T	getLast()	Helper method that returns the last element of a List.
ObjectListIterator<T>	indexedIterator(int... indecies)	Creates a Iterator that follows the indecies provided. For example if the Lists Contents is: -1, 0 1 and the indecies are: 0, 1, 2, 2, 1, 0 then the iterator will return the following values: -1, 0, 1, 1, 0, -1
ObjectListIterator<T>	indexedIterator(IntList indecies)	Creates a Iterator that follows the indecies provided. For example if the Lists Contents is: -1, 0 1 and the indecies are: 0, 1, 2, 2, 1, 0 then the iterator will return the following values: -1, 0, 1, 1, 0, -1
ObjectListIterator<T>	listIterator()	A Type-Specific Iterator of listIterator
ObjectListIterator<T>	listIterator(int index)	A Type-Specific Iterator of listIterator
void	removeElements(int from, int to)	a function to fast remove elements from the list.
default T	removeFirst()	Helper method that removes and returns the first element of a List.
default T	removeLast()	Helper method that removes and returns the last element of a List.
default void	replaceAll(UnaryOperator<T> o)	A function to replace all values in the list
ObjectList<T>	reversed()	A Type-Specific List Helper that shows all elements in reverse.
void	size(int size)	A function to ensure the elements are within the requested size.
default void	sort(Comparator<? super T> c)	Sorts the elements specified by the Natural order either by using the Comparator or the elements
default ObjectSplititerator<T>	spliterator()	A Type Specific Type Splititerator to reduce boxing/unboxing
ObjectList<T>	subList(int from, int to)	A Type-Specific List of subList
T	swapRemove(int index)	A Highly Optimized remove function that removes the desired element.
boolean	swapRemove(T e)	A Highly Optimized remove function that removes the desired element.
default ObjectList<T>	synchronize()	Creates a Wrapped List that is Synchronized
default ObjectList<T>	synchronize(Object mutex)	Creates a Wrapped List that is Synchronized
default ObjectList<T>	unmodifiable()	Creates a Wrapped List that is unmodifiable
default void	unstableSort(Comparator<? super T> c)	Sorts the elements specified by the Natural order either by using the Comparator or the elements using a unstable sort

Von Schnittstelle geerbte Methoden java.util.Collection

parallelStream, removeIf, stream

Von Schnittstelle geerbte Methoden speiger.src.collections.utils.ISizeProvider

size

Von Schnittstelle geerbte Methoden java.lang.Iterable

forEach

Von Schnittstelle geerbte Methoden java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, remove, remove, removeAll, retainAll, set, size, toArray, toArray

Von Schnittstelle geerbte Methoden speiger.src.collections.objects.collections.ObjectCollection

addAll, addAll, addAll, addAll, containsAll, containsAny, containsAny, iterator, pour, removeAll, removeAll, retainAll, retainAll, toArray

Von Schnittstelle geerbte Methoden speiger.src.collections.objects.collections.ObjectIterable

arrayflatMap, asAsync, count, distinct, filter, findFirst, flatMap, forEach, limit, map, mapToBoolean, mapToByte, mapToDouble, mapToFloat, mapToInt, mapToLong, mapToShort, matchesAll, matchesAny, matchesNone, peek, pourAsList, pourAsSet, reduce, reduce, repeat, sorted

Methodendetails

addIfAbsent

default boolean addIfAbsent(T e)

A Helper function that will only add elements if it is not present.

Parameter:

e - the element to add

Gibt zurück:

true if the list was modified

addIfPresent

default boolean addIfPresent(T e)

A Helper function that will only add elements if it is present.

Parameter:

e - the element to add

Gibt zurück:

true if the list was modified

addAll

boolean addAll(int index,
 ObjectCollection<T> c)

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

Parameter:

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

c - the elements that need to be added

Gibt zurück:

true if the list was modified

Siehe auch:

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

addAll

boolean addAll(ObjectList<T> c)

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

Parameter:

c - the elements that need to be added

Gibt zurück:

true if the list was modified

addAll

boolean addAll(int index,
 ObjectList<T> c)

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

Parameter:

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

c - the elements that need to be added

Gibt zurück:

true if the list was modified

getFirst

default T getFirst()

Helper method that returns the first element of a List. This function was introduced due to how annoying it is to get/remove the last element of a list. This simplifies this process a bit.

Gibt zurück:

first element of the list

getLast

default T getLast()

Helper method that returns the last element of a List. This function was introduced due to how annoying it is to get/remove the last element of a list. This simplifies this process a bit.

Gibt zurück:

last element of the list

removeFirst

default T removeFirst()

Helper method that removes and returns the first element of a List. This function was introduced due to how annoying it is to get/remove the last element of a list. This simplifies this process a bit.

Gibt zurück:

first element of the list and removes it

removeLast

default T removeLast()

Helper method that removes and returns the last element of a List. This function was introduced due to how annoying it is to get/remove the last element of a list. This simplifies this process a bit.

Gibt zurück:

last element of the list and removes it

replaceAll

default void replaceAll(UnaryOperator<T> o)

A function to replace all values in the list

Angegeben von:

replaceAll in Schnittstelle List<T>

Parameter:

o - the action to replace the values

Löst aus:

NullPointerException - if o is null

addElements

default void addElements(T... a)

A function to fast add elements to the list

Parameter:

a - the elements that should be added

Löst aus:

IndexOutOfBoundsException - if from is outside of the lists range

addElements

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

A function to fast add elements to the list

Parameter:

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

a - the elements that should be added

Löst aus:

IndexOutOfBoundsException - if from is outside of the lists range

addElements

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

A function to fast add elements to the list

Parameter:

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

Löst aus:

IndexOutOfBoundsException - if from is outside of the lists range

getElements

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

A function to fast fetch elements from the list

Parameter:

from - index where the list should be fetching elements from

a - the array where the values should be inserted to

Gibt zurück:

the inputArray

Löst aus:

NullPointerException - if the array is null

IndexOutOfBoundsException - if from is outside of the lists range

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

getElements

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

A function to fast fetch elements from the list

Parameter:

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

Gibt zurück:

the inputArray

Löst aus:

NullPointerException - if the array is null

IndexOutOfBoundsException - if from is outside of the lists range

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.

Parameter:

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)

swapRemove

T swapRemove(int index)

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.

Parameter:

index - the index of the element to be removed

Gibt zurück:

the element previously at the specified position

swapRemove

boolean swapRemove(T e)

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.

Parameter:

e - the element that should be removed

Gibt zurück:

true if the element was removed

extractElements

<K> K[] extractElements(int from,
 int to,
 Class<K> type)

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

Typparameter:

K - the keyType of elements maintained by this Collection

Parameter:

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)

type - the type of the OutputArray

Gibt zurück:

a array of the elements that were fetched

sort

default void sort(Comparator<? super T> c)

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

Angegeben von:

sort in Schnittstelle List<T>

Siehe auch:

• List.sort(Comparator)

unstableSort

default void unstableSort(Comparator<? super T> c)

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

Parameter:

c - the sorter of the elements, can be null

Siehe auch:

• List.sort(Comparator)

forEachIndexed

default void forEachIndexed(IntObjectConsumer<T> action)

A Indexed forEach implementation that allows you to keep track of how many elements were already iterated over.

Angegeben von:

forEachIndexed in Schnittstelle ObjectIterable<T>

Parameter:

action - The action to be performed for each element

Löst aus:

NullPointerException - if the specified action is null

listIterator

ObjectListIterator<T> listIterator()

A Type-Specific Iterator of listIterator

Angegeben von:

listIterator in Schnittstelle List<T>

Siehe auch:

• List.listIterator()

listIterator

ObjectListIterator<T> listIterator(int index)

A Type-Specific Iterator of listIterator

Angegeben von:

listIterator in Schnittstelle List<T>

Siehe auch:

• List.listIterator(int)

indexedIterator

ObjectListIterator<T> indexedIterator(int... indecies)

Creates a Iterator that follows the indecies provided.
For example if the Lists Contents is:
-1, 0 1
and the indecies are:
0, 1, 2, 2, 1, 0
then the iterator will return the following values:
-1, 0, 1, 1, 0, -1

Parameter:

indecies - that should be used for the iteration.

Gibt zurück:

a custom indexed iterator

indexedIterator

ObjectListIterator<T> indexedIterator(IntList indecies)

Creates a Iterator that follows the indecies provided.
For example if the Lists Contents is:
-1, 0 1
and the indecies are:
0, 1, 2, 2, 1, 0
then the iterator will return the following values:
-1, 0, 1, 1, 0, -1

Parameter:

indecies - that should be used for the iteration.

Gibt zurück:

a custom indexed iterator

subList

ObjectList<T> subList(int from,
 int to)

A Type-Specific List of subList

Angegeben von:

subList in Schnittstelle List<T>

Siehe auch:

• List.subList(int, int)

reversed

ObjectList<T> reversed()

A Type-Specific List Helper that shows all elements in reverse.

Gibt zurück:

a list wrapper that has all elements reversed!

synchronize

default ObjectList<T> synchronize()

Creates a Wrapped List that is Synchronized

Angegeben von:

synchronize in Schnittstelle ObjectCollection<T>

Gibt zurück:

a new List that is synchronized

Siehe auch:

• ObjectLists.synchronize(speiger.src.collections.objects.lists.ObjectList<T>)

synchronize

default ObjectList<T> synchronize(Object mutex)

Creates a Wrapped List that is Synchronized

Angegeben von:

synchronize in Schnittstelle ObjectCollection<T>

Parameter:

mutex - is the controller of the synchronization block

Gibt zurück:

a new List Wrapper that is synchronized

Siehe auch:

• ObjectLists.synchronize(speiger.src.collections.objects.lists.ObjectList<T>)

unmodifiable

default ObjectList<T> unmodifiable()

Creates a Wrapped List that is unmodifiable

Angegeben von:

unmodifiable in Schnittstelle ObjectCollection<T>

Gibt zurück:

a new List Wrapper that is unmodifiable

Siehe auch:

• ObjectLists.unmodifiable(speiger.src.collections.objects.lists.ObjectList<T>)

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

Parameter:

size - the requested amount of elements/room for elements

copy

ObjectList<T> copy()

Beschreibung aus Schnittstelle kopiert: ObjectCollection

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

Angegeben von:

copy in Schnittstelle ObjectCollection<T>

Gibt zurück:

a Shallow Copy of the collection

spliterator

default ObjectSplititerator<T> spliterator()

A Type Specific Type Splititerator to reduce boxing/unboxing

Angegeben von:

spliterator in Schnittstelle Collection<T>

Angegeben von:

spliterator in Schnittstelle Iterable<T>

Angegeben von:

spliterator in Schnittstelle List<T>

Angegeben von:

spliterator in Schnittstelle ObjectCollection<T>

Angegeben von:

spliterator in Schnittstelle ObjectIterable<T>

Gibt zurück:

type specific splititerator