com.matthewtamlin.android_utilities_library.collections

Class ArrayListWithCallbacks<T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<T>

com.matthewtamlin.android_utilities_library.collections.ArrayListWithCallbacks<T>

Type Parameters:

T - the type of objects contained within this collection

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<T>, java.util.Collection<T>, java.util.List<T>, java.util.RandomAccess

public class ArrayListWithCallbacks<T>
extends java.util.ArrayList<T>

An ArrayList which dispatches callback events to registered listeners whenever the Collection is modified.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ArrayListWithCallbacks.OnItemAddedListener Interface definition for callbacks to be invoked whenever an item is added to an ArrayListWithCallbacks.
static interface	ArrayListWithCallbacks.OnItemRemovedListener Interface definition for callbacks to be received whenever an item is removed from an ArrayListWithCallbacks.
static interface	ArrayListWithCallbacks.OnListChangedListener Interface definition for callbacks to be received whenever an ArrayListWithCallbacks is modified.
static interface	ArrayListWithCallbacks.OnListClearedListener Interface definition for callbacks to be received whenever an ArrayListWithCallbacks is cleared.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
ArrayListWithCallbacks() Constructs a new instance of ArrayListWithCallbacks.
ArrayListWithCallbacks(java.util.Collection<T> collection) Constructs a new instance of ArrayListWithCallbacks containing the elements of the specified collection.

Method Summary

Modifier and Type	Method and Description
void	add(int index, T object)
boolean	add(T object)
boolean	addAll(java.util.Collection<? extends T> collection)
boolean	addAll(int index, java.util.Collection<? extends T> collection)
void	addOnItemAddedListener(ArrayListWithCallbacks.OnItemAddedListener listener) Adds an OnItemAddedListener to this ArrayListWithCallbacks.
void	addOnItemRemovedListener(ArrayListWithCallbacks.OnItemRemovedListener listener) Adds an OnItemRemovedListener to this ArrayListWithCallbacks.
void	addOnListChangedListener(ArrayListWithCallbacks.OnListChangedListener listener) Adds an OnListChangedListener to this ArrayListWithCallbacks.
void	addOnListClearedListener(ArrayListWithCallbacks.OnListClearedListener listener) Adds an OnListClearedListener to this ArrayListWithCallbacks.
void	clear()
T	remove(int index)
boolean	remove(java.lang.Object object)
boolean	removeAll(java.util.Collection<?> collection)
void	removeOnItemAddedListener(ArrayListWithCallbacks.OnItemAddedListener listener) Removes an OnItemAddedListener from this ArrayListWithCallbacks.
void	removeOnItemRemovedListener(ArrayListWithCallbacks.OnItemRemovedListener listener) Removes an OnItemRemovedListener from this ArrayListWithCallbacks.
void	removeOnListChangedListener(ArrayListWithCallbacks.OnListChangedListener listener) Removed an OnListChangedListener from this ArrayListWithCallbacks.
void	removeOnListClearedListener(ArrayListWithCallbacks.OnListClearedListener listener) Removes an OnListClearedListener from this ArrayListWithCallbacks.
boolean	retainAll(java.util.Collection<?> collection)
T	set(int index, T object)

Methods inherited from class java.util.ArrayList

clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, removeIf, removeRange, replaceAll, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

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.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

ArrayListWithCallbacks

public ArrayListWithCallbacks()

Constructs a new instance of ArrayListWithCallbacks.

ArrayListWithCallbacks

public ArrayListWithCallbacks(java.util.Collection<T> collection)

Constructs a new instance of ArrayListWithCallbacks containing the elements of the specified collection. This method will not invoke callbacks.

Parameters:

collection - the collection of elements to add

Method Detail

add

public boolean add(T object)

Specified by:

add in interface java.util.Collection<T>

Specified by:

add in interface java.util.List<T>

Overrides:

add in class java.util.ArrayList<T>

add

public void add(int index,
                T object)

Specified by:

add in interface java.util.List<T>

Overrides:

add in class java.util.ArrayList<T>

addAll

public boolean addAll(java.util.Collection<? extends T> collection)

Specified by:

addAll in interface java.util.Collection<T>

Specified by:

addAll in interface java.util.List<T>

Overrides:

addAll in class java.util.ArrayList<T>

addAll

public boolean addAll(int index,
                      java.util.Collection<? extends T> collection)

Specified by:

addAll in interface java.util.List<T>

Overrides:

addAll in class java.util.ArrayList<T>

remove

public T remove(int index)

Specified by:

remove in interface java.util.List<T>

Overrides:

remove in class java.util.ArrayList<T>

remove

public boolean remove(java.lang.Object object)

Specified by:

remove in interface java.util.Collection<T>

Specified by:

remove in interface java.util.List<T>

Overrides:

remove in class java.util.ArrayList<T>

removeAll

public boolean removeAll(java.util.Collection<?> collection)

Specified by:

removeAll in interface java.util.Collection<T>

Specified by:

removeAll in interface java.util.List<T>

Overrides:

removeAll in class java.util.ArrayList<T>

set

public T set(int index,
             T object)

Specified by:

set in interface java.util.List<T>

Overrides:

set in class java.util.ArrayList<T>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<T>

Specified by:

clear in interface java.util.List<T>

Overrides:

clear in class java.util.ArrayList<T>

retainAll

public boolean retainAll(java.util.Collection<?> collection)

Specified by:

retainAll in interface java.util.Collection<T>

Specified by:

retainAll in interface java.util.List<T>

Overrides:

retainAll in class java.util.ArrayList<T>

addOnItemAddedListener

public void addOnItemAddedListener(ArrayListWithCallbacks.OnItemAddedListener listener)

Adds an OnItemAddedListener to this ArrayListWithCallbacks. This method has no effect if null is supplied, or if the listener is already registered.

Parameters:

listener - the listener to add

addOnItemRemovedListener

public void addOnItemRemovedListener(ArrayListWithCallbacks.OnItemRemovedListener listener)

Adds an OnItemRemovedListener to this ArrayListWithCallbacks. This method has no effect if null is supplied, or if the listener is already registered.

Parameters:

listener - the listener to add

addOnListClearedListener

public void addOnListClearedListener(ArrayListWithCallbacks.OnListClearedListener listener)

Adds an OnListClearedListener to this ArrayListWithCallbacks. This method has no effect if null is supplied or if the listener is already registered.

Parameters:

listener - the listener to add

addOnListChangedListener

public void addOnListChangedListener(ArrayListWithCallbacks.OnListChangedListener listener)

Adds an OnListChangedListener to this ArrayListWithCallbacks. this method has no effect if null is supplied or if the listener is already registered.

Parameters:

listener - the listener to add

removeOnItemAddedListener

public void removeOnItemAddedListener(ArrayListWithCallbacks.OnItemAddedListener listener)

Removes an OnItemAddedListener from this ArrayListWithCallbacks. This method has no effect if null is supplied, or if the listener is not registered.

Parameters:

listener - the listener to remove

removeOnItemRemovedListener

public void removeOnItemRemovedListener(ArrayListWithCallbacks.OnItemRemovedListener listener)

Removes an OnItemRemovedListener from this ArrayListWithCallbacks. This method has no effect if null is supplied or if the listener is not registered.

Parameters:

listener - the listener to remove

removeOnListClearedListener

public void removeOnListClearedListener(ArrayListWithCallbacks.OnListClearedListener listener)

Removes an OnListClearedListener from this ArrayListWithCallbacks. This method has no effect if null is supplied or if the listener is not registered.

Parameters:

listener - the listener to remove

removeOnListChangedListener

public void removeOnListChangedListener(ArrayListWithCallbacks.OnListChangedListener listener)

Removed an OnListChangedListener from this ArrayListWithCallbacks. This method has no effect if null is supplied or if the listener is not registered.

Parameters:

listener - the listener to remove