Package io.github.thecsdev.tcdcommons.api.util.collections

Class IdealList<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

io.github.thecsdev.tcdcommons.api.util.collections.IdealList<E>

All Implemented Interfaces:

Iterable<E>, Collection<E>, List<E>

public class IdealList<E>
extends AbstractList<E>
implements Iterable<E>

Tired of built-in list types that never have the one thing you need?
Well fear not, for this one has everything that I will ever need!

Features:

• Resilient to ConcurrentModificationException
• Iterator capable of handling complex concurrent changes
• Features find(Predicate)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected final class	IdealList.IdealListIterator	A ListIterator implementation for IdealList.
protected final class	IdealList.Node	An IdealList node that works similarly to how linked-list nodes work. Tracks the next and previous nodes for a given IdealList entry.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
IdealList()

Method Summary

Modifier and Type	Method	Description
final void	add(int index, E element)
final boolean	add(E element)
boolean	addB(int index, E element)
protected final void	addNode(int index, IdealList<E>.Node node)	Inserts a IdealList<E>.Node at a given index.
void	clear()
protected final void	clearNodes()
boolean	contains(Object entry)
final E	find(Predicate<E> predicate)	Returns the first containing element that matches a given Predicate, or null if such an element is not in this IdealList.
protected final Map.Entry<Integer,IdealList<E>.Node>	findNode(Function<IdealList<E>.Node,Boolean> action)	Finds a IdealList<E>.Node in the __nodes list, that matches a given predicate.
protected final void	forEachNode(Consumer<IdealList<E>.Node> action)	Iterates over all IdealList<E>.Nodes in the __nodes list, and performs an action for each of them.
E	get(int index)
protected final IdealList<E>.@Nullable Node	getFirstNode()	Returns the first IdealList<E>.Node in the __nodes list.
protected final IdealList<E>.@Nullable Node	getLastNode()	Returns the last IdealList<E>.Node in the __nodes list.
protected final IdealList<E>.Node	getNode(int index)
protected final IdealList<E>.@Nullable Node	getNodeOrDefault(int index)	Retrieves a IdealList<E>.Node at a given index, returning null if the index is out of bounds.
int	indexOf(Object entry)
protected final int	indexOfNode(IdealList<E>.Node node)
final boolean	isEmpty()
final Iterator<E>	iterator()
final ListIterator<E>	listIterator()
ListIterator<E>	listIterator(int index)
protected final int	nodeCount()
final E	remove(int index)
final boolean	remove(Object element)
boolean	removeB(int index)
protected final void	removeNode(int index)	Removes a IdealList<E>.Node at a given index.
E	set(int index, E element)
int	size()

Methods inherited from class java.util.AbstractList

addAll, equals, hashCode, lastIndexOf, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

addAll, containsAll, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Constructor Details

IdealList

public IdealList()

Method Details

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface List<E>

Specified by:

size in class AbstractCollection<E>

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface List<E>

Overrides:

isEmpty in class AbstractCollection<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface List<E>

Overrides:

clear in class AbstractList<E>

indexOf

public int indexOf(Object entry)

Specified by:

indexOf in interface List<E>

Overrides:

indexOf in class AbstractList<E>

contains

public boolean contains(Object entry)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface List<E>

Overrides:

contains in class AbstractCollection<E>

get

public E get(int index)
      throws IndexOutOfBoundsException

Specified by:

get in interface List<E>

Specified by:

get in class AbstractList<E>

Throws:

IndexOutOfBoundsException

set

public E set(int index,
 E element)
      throws IndexOutOfBoundsException

Specified by:

set in interface List<E>

Overrides:

set in class AbstractList<E>

Throws:

IndexOutOfBoundsException

add

public final boolean add(E element)

Specified by:

add in interface Collection<E>

Specified by:

add in interface List<E>

Overrides:

add in class AbstractList<E>

add

public final void add(int index,
 E element)
               throws IndexOutOfBoundsException,
UnsupportedOperationException

Specified by:

add in interface List<E>

Overrides:

add in class AbstractList<E>

Throws:

IndexOutOfBoundsException

UnsupportedOperationException

addB

public boolean addB(int index,
 E element)
             throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

remove

public final boolean remove(Object element)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface List<E>

Overrides:

remove in class AbstractCollection<E>

remove

public final E remove(int index)
               throws IndexOutOfBoundsException,
UnsupportedOperationException

Specified by:

remove in interface List<E>

Overrides:

remove in class AbstractList<E>

Throws:

IndexOutOfBoundsException

UnsupportedOperationException

removeB

public boolean removeB(int index)
                throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

iterator

public final Iterator<E> iterator()

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface List<E>

Overrides:

iterator in class AbstractList<E>

listIterator

public final ListIterator<E> listIterator()

Specified by:

listIterator in interface List<E>

Overrides:

listIterator in class AbstractList<E>

listIterator

public ListIterator<E> listIterator(int index)
                             throws IndexOutOfBoundsException

Specified by:

listIterator in interface List<E>

Overrides:

listIterator in class AbstractList<E>

Throws:

IndexOutOfBoundsException

find

public final E find(Predicate<E> predicate)

Returns the first containing element that matches a given Predicate, or null if such an element is not in this IdealList.

Parameters:

predicate - The element Predicate.

Throws:

NullPointerException - if the given predicate is null.

See Also:

• Predicate

nodeCount

protected final int nodeCount()

indexOfNode

protected final int indexOfNode(IdealList<E>.Node node)

clearNodes

protected final void clearNodes()

getNode

protected final IdealList<E>.Node getNode(int index)
                                   throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

getNodeOrDefault

@Nullable
protected final IdealList<E>.@Nullable Node getNodeOrDefault(int index)

Retrieves a IdealList<E>.Node at a given index, returning null if the index is out of bounds.

Parameters:

index - The IdealList<E>.Node index.

addNode

protected final void addNode(int index,
 IdealList<E>.Node node)
                      throws NullPointerException,
IndexOutOfBoundsException

Inserts a IdealList<E>.Node at a given index.

Parameters:

index - The index at which to insert the IdealList<E>.Node

node - The IdealList<E>.Node to insert.

Throws:

NullPointerException

IndexOutOfBoundsException

removeNode

protected final void removeNode(int index)
                         throws IndexOutOfBoundsException

Removes a IdealList<E>.Node at a given index.

Parameters:

index - The IdealList<E>.Node index.

Throws:

IndexOutOfBoundsException

forEachNode

protected final void forEachNode(Consumer<IdealList<E>.Node> action)

Iterates over all IdealList<E>.Nodes in the __nodes list, and performs an action for each of them.

Parameters:

action - The action to perform.

findNode

protected final Map.Entry<Integer,IdealList<E>.Node> findNode(Function<IdealList<E>.Node,Boolean> action)

Finds a IdealList<E>.Node in the __nodes list, that matches a given predicate.

Parameters:

action - The predicate. Return true from the predicate to return the IdealList<E>.Node.

Returns:

A Map.Entry containing the IdealList<E>.Node and its index number. The returned index number will be -1 if a IdealList<E>.Node was not found.

getFirstNode

@Nullable
protected final IdealList<E>.@Nullable Node getFirstNode()

Returns the first IdealList<E>.Node in the __nodes list.

getLastNode

@Nullable
protected final IdealList<E>.@Nullable Node getLastNode()

Returns the last IdealList<E>.Node in the __nodes list.