T - The listener type.E - The MutableFlags type used to indicate which events occurred.public final class ListenerSet<T,E extends MutableFlags> extends Object
Events are guaranteed to arrive in the order in which they happened even if a new event is triggered recursively from another listener.
Events are also guaranteed to be only sent to the listeners registered at the time the event was enqueued and haven't been removed since.
| Modifier and Type | Class | Description |
|---|---|---|
static interface |
ListenerSet.Event<T> |
An event sent to a listener.
|
static interface |
ListenerSet.IterationFinishedEvent<T,E extends MutableFlags> |
An event sent to a listener when all other events sent during one
Looper message queue
iteration were handled by the listener. |
| Constructor | Description |
|---|---|
ListenerSet(Looper looper,
Clock clock,
Supplier<E> eventFlagsSupplier,
ListenerSet.IterationFinishedEvent<T,E> iterationFinishedEvent) |
Creates a new listener set.
|
| Modifier and Type | Method | Description |
|---|---|---|
void |
add(T listener) |
Adds a listener to the set.
|
ListenerSet<T,E> |
copy(Looper looper,
ListenerSet.IterationFinishedEvent<T,E> iterationFinishedEvent) |
Copies the listener set.
|
void |
flushEvents() |
Notifies listeners of events previously enqueued with
queueEvent(int, Event). |
void |
lazyRelease(int releaseEventFlag,
ListenerSet.Event<T> releaseEvent) |
Releases the set of listeners after all already scheduled
Looper messages were able to
trigger final events. |
void |
queueEvent(int eventFlag,
ListenerSet.Event<T> event) |
Adds an event that is sent to the listeners when
flushEvents() is called. |
void |
release() |
Releases the set of listeners immediately.
|
void |
remove(T listener) |
Removes a listener from the set.
|
void |
sendEvent(int eventFlag,
ListenerSet.Event<T> event) |
public ListenerSet(Looper looper, Clock clock, Supplier<E> eventFlagsSupplier, ListenerSet.IterationFinishedEvent<T,E> iterationFinishedEvent)
looper - A Looper used to call listeners on. The same Looper must be used
to call all other methods of this class.clock - A Clock.eventFlagsSupplier - A Supplier for new instances of the event flags
type.iterationFinishedEvent - An ListenerSet.IterationFinishedEvent sent when all other events sent
during one Looper message queue iteration were handled by the listeners.@CheckResult public ListenerSet<T,E> copy(Looper looper, ListenerSet.IterationFinishedEvent<T,E> iterationFinishedEvent)
looper - The new Looper for the copied listener set.iterationFinishedEvent - The new ListenerSet.IterationFinishedEvent sent when all other events
sent during one Looper message queue iteration were handled by the listeners.public void add(T listener)
If a listener is already present, it will not be added again.
listener - The listener to be added.public void remove(T listener)
If the listener is not present, nothing happens.
listener - The listener to be removed.public void queueEvent(int eventFlag,
ListenerSet.Event<T> event)
flushEvents() is called.eventFlag - An integer indicating the type of the event, or C.INDEX_UNSET to
report this event without flag.event - The event.public void flushEvents()
queueEvent(int, Event).public void sendEvent(int eventFlag,
ListenerSet.Event<T> event)
eventFlag - An integer flag indicating the type of the event, or C.INDEX_UNSET to
report this event without flag.event - The event.public void release()
This will ensure no events are sent to any listener after this method has been called.
public void lazyRelease(int releaseEventFlag,
ListenerSet.Event<T> releaseEvent)
Looper messages were able to
trigger final events.
After the specified released callback event, no other events are sent to a listener.
releaseEventFlag - An integer flag indicating the type of the release event, or C.INDEX_UNSET to report this event without a flag.releaseEvent - The release event.