Package dev.prozilla.pine.common.util

Class DeferredList<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<E>

dev.prozilla.pine.common.util.DeferredList<E>

Type Parameters:

E - The type of elements in this list

All Implemented Interfaces:

Destructible, Serializable, Cloneable, Iterable<E>, Collection<E>, List<E>, RandomAccess, SequencedCollection<E>

public class DeferredList<E>
extends ArrayList<E>
implements Destructible

Implementation of an array list which defers modifications of elements until the current iteration is complete, to prevent concurrent modification exceptions.

See Also:

• Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
DeferredList()

Method Summary

Modifier and Type	Method	Description
void	add(int index, E element)
boolean	add(E element)
boolean	addAll(int index, Collection<? extends E> collection)
boolean	addAll(Collection<? extends E> collection)
void	clear()
void	destroy()	Removes all elements from this list.
void	endIteration()	Marks the end of an ongoing iteration of this list.
void	forEach(Consumer<? super E> action)
List<E>	getSnapshot()	Returns a snapshot of what this list will look like after the current iterations are done and the deferred operations are executed.
boolean	isIterating()	Checks if this list is being iterated.
boolean	isSnapshotEmpty()	Checks if the snapshot of this list is empty.
@NotNull Iterator<E>	iterator()
E	remove(int index)
boolean	remove(Object object)
boolean	removeAll(Collection<?> collection)
boolean	removeIf(Predicate<? super E> filter)
int	snapshotSize()	Returns the size of the snapshot of this list.
void	sort(Comparator<? super E> c)
void	startIteration()	Marks the start of a new iteration of this list.

Methods inherited from class java.util.ArrayList

addFirst, addLast, clone, contains, ensureCapacity, equals, get, getFirst, getLast, hashCode, indexOf, isEmpty, lastIndexOf, listIterator, listIterator, removeFirst, removeLast, removeRange, replaceAll, retainAll, set, size, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface java.util.List

containsAll, reversed

Constructor Details

DeferredList

public DeferredList()

Method Details

add

public boolean add(E element)

Specified by:

add in interface Collection<E>

Specified by:

add in interface List<E>

Overrides:

add in class ArrayList<E>

addAll

public boolean addAll(Collection<? extends E> collection)

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface List<E>

Overrides:

addAll in class ArrayList<E>

addAll

public boolean addAll(int index,
 Collection<? extends E> collection)
               throws ConcurrentModificationException

Specified by:

addAll in interface List<E>

Overrides:

addAll in class ArrayList<E>

Throws:

ConcurrentModificationException

add

public void add(int index,
 E element)
         throws ConcurrentModificationException

Specified by:

add in interface List<E>

Overrides:

add in class ArrayList<E>

Throws:

ConcurrentModificationException

remove

public boolean remove(Object object)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface List<E>

Overrides:

remove in class ArrayList<E>

removeAll

public boolean removeAll(Collection<?> collection)

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface List<E>

Overrides:

removeAll in class ArrayList<E>

removeIf

public boolean removeIf(Predicate<? super E> filter)
                 throws ConcurrentModificationException

Specified by:

removeIf in interface Collection<E>

Overrides:

removeIf in class ArrayList<E>

Throws:

ConcurrentModificationException

remove

public E remove(int index)
         throws ConcurrentModificationException

Specified by:

remove in interface List<E>

Overrides:

remove in class ArrayList<E>

Throws:

ConcurrentModificationException

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface List<E>

Overrides:

clear in class ArrayList<E>

snapshotSize

public int snapshotSize()

Returns the size of the snapshot of this list.

Returns:

The size of the snapshot.

isSnapshotEmpty

public boolean isSnapshotEmpty()

Checks if the snapshot of this list is empty.

Returns:

true if the snapshot is empty.

getSnapshot

public List<E> getSnapshot()

Returns a snapshot of what this list will look like after the current iterations are done and the deferred operations are executed.

If there are no current iterations, this will simply return this.

Returns:

A snapshot of this list after executing the deferred operations.

iterator

@NotNull
public @NotNull 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 ArrayList<E>

forEach

public void forEach(Consumer<? super E> action)

Specified by:

forEach in interface Iterable<E>

Overrides:

forEach in class ArrayList<E>

sort

public void sort(Comparator<? super E> c)

Specified by:

sort in interface List<E>

Overrides:

sort in class ArrayList<E>

startIteration

public void startIteration()

Marks the start of a new iteration of this list.

endIteration

public void endIteration()

Marks the end of an ongoing iteration of this list.

isIterating

public boolean isIterating()

Checks if this list is being iterated.

Returns:

true if this list is being iterated.

destroy

public void destroy()

Removes all elements from this list.

Specified by:

destroy in interface Destructible