Package com.topjohnwu.superuser

Class CallbackList<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

com.topjohnwu.superuser.CallbackList<E>

All Implemented Interfaces:

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

public abstract class CallbackList<E>
extends AbstractList<E>

An AbstractList that calls onAddElement when a new element is added to the list.

To simplify the API of Shell, both STDOUT and STDERR will output to Lists. This class is useful if you want to trigger a callback every time Shell outputs a new line.

The CallbackList itself does not have a data store. If you need one, you can provide a base List, and this class will delegate its calls to it.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<E>	mBase
protected Executor	mExecutor

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CallbackList()	onAddElement(Object) runs on the main thread; no backing list.
protected	CallbackList(Executor executor)	onAddElement(Object) runs with the executor; no backing list.
protected	CallbackList(Executor executor, List<E> base)	onAddElement(Object) runs with the executor; sets a backing list.
protected	CallbackList(List<E> base)	onAddElement(Object) runs on the main thread; sets a backing list.

Method Summary

Modifier and Type	Method	Description
void	add(int i, E s)
E	get(int i)
abstract void	onAddElement(E e)	The callback when a new element is added.
E	remove(int i)
E	set(int i, E s)
int	size()

Methods inherited from class java.util.AbstractList

add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, 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, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Field Details

mBase

protected List<E> mBase

mExecutor

protected Executor mExecutor

Constructor Details

CallbackList

protected CallbackList()

onAddElement(Object) runs on the main thread; no backing list.

CallbackList

protected CallbackList(@Nullable
 List<E> base)

onAddElement(Object) runs on the main thread; sets a backing list.

CallbackList

protected CallbackList(@NonNull
 Executor executor)

onAddElement(Object) runs with the executor; no backing list.

CallbackList

protected CallbackList(@NonNull
 Executor executor,
 @Nullable
 List<E> base)

onAddElement(Object) runs with the executor; sets a backing list.

Method Details

onAddElement

public abstract void onAddElement(E e)

The callback when a new element is added.

This method will be called after add is called. Which thread it runs on depends on which constructor is used to construct the instance.

Parameters:

e - the new element added to the list.

get

public E get(int i)

Specified by:

get in interface List<E>

Specified by:

get in class AbstractList<E>

See Also:

• List.get(int)

set

public E set(int i,
 E s)

Specified by:

set in interface List<E>

Overrides:

set in class AbstractList<E>

See Also:

• List.set(int, Object)

add

public void add(int i,
 E s)

Specified by:

add in interface List<E>

Overrides:

add in class AbstractList<E>

See Also:

• List.add(int, Object)

remove

public E remove(int i)

Specified by:

remove in interface List<E>

Overrides:

remove in class AbstractList<E>

See Also:

• List.remove(Object)

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>

See Also:

• List.size()