Package heronarts.lx.utils

Class LXEngineThreadArrayList<T>

java.lang.Object

heronarts.lx.utils.LXEngineThreadArrayList<T>

Type Parameters:

T - Type of object stored by the list

All Implemented Interfaces:

Iterable<T>, Collection<T>, List<T>, RandomAccess, SequencedCollection<T>

public class LXEngineThreadArrayList<T>
extends Object
implements List<T>, RandomAccess

The LXEngineArrayList is a utility class that offers similar semantics to CopyOnWriteArrayList, but for the scenario in which it's understood that only the LXEngine thread ever writes to the list, while the UI thread may be frequently reading the list. A single persistent underlying ArrayList is used to represent the engine's copy of the list, and a copy is prepared for the UI thread on-demand. Transaction-like semantics are available for complex edit operations that may perform multiple changes before generating a new UI-thread copy.

Field Summary

Fields

Modifier and Type	Field	Description
final MutableParameter	changed

Constructor Summary

Constructors

Constructor	Description
LXEngineThreadArrayList()

Method Summary

Modifier and Type	Method	Description
void	add(int index, T element)
boolean	add(T e)
boolean	addAll(int index, Collection<? extends T> c)
boolean	addAll(Collection<? extends T> c)
LXEngineThreadArrayList<T>	begin()	Begin a modification session on this list.
void	clear()
LXEngineThreadArrayList<T>	commit()	Commit changes to the engine list and create a copy for the UI thread.
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
T	get(int index)
List<T>	getUIThreadList()
int	indexOf(Object o)
boolean	isEmpty()
Iterator<T>	iterator()
int	lastIndexOf(Object o)
ListIterator<T>	listIterator()
ListIterator<T>	listIterator(int index)
T	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
void	removeRange(int fromIndex, int toIndex)
boolean	retainAll(Collection<?> c)
T	set(int index, T element)
void	set(List<T> contents)	Clear the full list and replace its content by the other list
int	size()
List<T>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<V> V[]	toArray(V[] a)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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

addFirst, addLast, equals, getFirst, getLast, hashCode, removeFirst, removeLast, replaceAll, reversed, sort, spliterator

Field Details

changed

public final MutableParameter changed

Constructor Details

LXEngineThreadArrayList

public LXEngineThreadArrayList()

Method Details

begin

public LXEngineThreadArrayList<T> begin()

Begin a modification session on this list. Changes will not update the UI copy unil commit() is called.

Returns:

this

commit

public LXEngineThreadArrayList<T> commit()

Commit changes to the engine list and create a copy for the UI thread.

Returns:

this

set

public void set(List<T> contents)

Clear the full list and replace its content by the other list

Parameters:

contents - List contents

getUIThreadList

public List<T> getUIThreadList()

size

public int size()

Specified by:

size in interface Collection<T>

Specified by:

size in interface List<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T>

Specified by:

isEmpty in interface List<T>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<T>

Specified by:

contains in interface List<T>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface List<T>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

toArray

public <V> V[] toArray(V[] a)

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

add

public boolean add(T e)

Specified by:

add in interface Collection<T>

Specified by:

add in interface List<T>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface List<T>

removeRange

public void removeRange(int fromIndex,
 int toIndex)

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<T>

Specified by:

containsAll in interface List<T>

addAll

public boolean addAll(Collection<? extends T> c)

Specified by:

addAll in interface Collection<T>

Specified by:

addAll in interface List<T>

addAll

public boolean addAll(int index,
 Collection<? extends T> c)

Specified by:

addAll in interface List<T>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<T>

Specified by:

removeAll in interface List<T>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<T>

Specified by:

retainAll in interface List<T>

clear

public void clear()

Specified by:

clear in interface Collection<T>

Specified by:

clear in interface List<T>

get

public T get(int index)

Specified by:

get in interface List<T>

set

public T set(int index,
 T element)

Specified by:

set in interface List<T>

add

public void add(int index,
 T element)

Specified by:

add in interface List<T>

remove

public T remove(int index)

Specified by:

remove in interface List<T>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<T>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<T>

listIterator

public ListIterator<T> listIterator()

Specified by:

listIterator in interface List<T>

listIterator

public ListIterator<T> listIterator(int index)

Specified by:

listIterator in interface List<T>

subList

public List<T> subList(int fromIndex,
 int toIndex)

Specified by:

subList in interface List<T>