CallbackRegistry - Android SDK

Summary: Nested Classes | Ctors | Methods | Inherited Methods | [Expand All]

public class

CallbackRegistry

extends Object
implements Cloneable

java.lang.Object
↳	android.databinding.CallbackRegistry<C, T, A>

Known Direct Subclasses

ListChangeRegistry, MapChangeRegistry, PropertyChangeRegistry

Class Overview

A utility for storing and notifying callbacks. This class supports reentrant modification of the callbacks during notification without adversely disrupting notifications. A common pattern for callbacks is to receive a notification and then remove themselves. This class handles this behavior with constant memory under most circumstances.

A subclass of CallbackRegistry.NotifierCallback must be passed to the constructor to define how notifications should be called. That implementation does the actual notification on the listener. It is typically a static instance that can be reused for all similar CallbackRegistries.

This class supports only callbacks with at most three parameters. Typically, these are the notification originator and a parameter, with another to indicate which method to call, but these may be used as required. If more than three parameters are required or primitive types other than the single int provided must be used, A should be some kind of containing structure that the subclass may reuse between notifications.

Summary

Nested Classes
class	CallbackRegistry.NotifierCallback<C, T, A>	Class used to notify events from CallbackRegistry.

Public Constructors
	CallbackRegistry(NotifierCallback<C, T, A> notifier) Creates an EventRegistry that notifies the event with notifier.

Public Methods
synchronized void	add(C callback) Add a callback to be notified.
synchronized void	clear() Removes all callbacks from the list.
synchronized CallbackRegistry<C, T, A>	clone() Creates and returns a copy of this `Object`.
synchronized void	copyCallbacks(List<C> callbacks) Modifies `callbacks` to contain all callbacks in the CallbackRegistry.
synchronized ArrayList<C>	copyCallbacks() Makes a copy of the registered callbacks and returns it.
synchronized boolean	isEmpty() Returns true if there are no registered callbacks or false otherwise.
synchronized void	notifyCallbacks(T sender, int arg, A arg2) Notify all callbacks.
synchronized void	remove(C callback) Remove a callback.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Constructors

public CallbackRegistry (NotifierCallback<C, T, A> notifier)

Creates an EventRegistry that notifies the event with notifier.

Parameters

notifier	The class to use to notify events.

Public Methods

public synchronized void add (C callback)

Add a callback to be notified. If the callback is already in the list, another won't be added. This does not affect current notifications.

Parameters

callback	The callback to add.

public synchronized void clear ()

Removes all callbacks from the list.

public synchronized CallbackRegistry<C, T, A> clone ()

Creates and returns a copy of this Object. The default implementation returns a so-called "shallow" copy: It creates a new instance of the same class and then copies the field values (including object references) from this instance to the new instance. A "deep" copy, in contrast, would also recursively clone nested objects. A subclass that needs to implement this kind of cloning should call super.clone() to create the new instance and then create deep copies of the nested, mutable objects.

Returns

A copy of the CallbackRegistry with all callbacks listening to both instances.

public synchronized void copyCallbacks (List<C> callbacks)

Modifies callbacks to contain all callbacks in the CallbackRegistry.

Parameters

callbacks	modified to contain all callbacks registered to receive events.

public synchronized ArrayList<C> copyCallbacks ()

Makes a copy of the registered callbacks and returns it.

Returns

a copy of the registered callbacks.

public synchronized boolean isEmpty ()

Returns true if there are no registered callbacks or false otherwise.

Returns

true if there are no registered callbacks or false otherwise.

public synchronized void notifyCallbacks (T sender, int arg, A arg2)

Notify all callbacks.

Parameters

sender	The originator. This is an opaque parameter passed to `onNotifyCallback(Object, Object, int, Object)`
arg	An opaque parameter passed to `onNotifyCallback(Object, Object, int, Object)`
arg2	An opaque parameter passed to `onNotifyCallback(Object, Object, int, Object)`

public synchronized void remove (C callback)

Remove a callback. This callback won't be notified after this call completes.

Parameters

callback	The callback to remove.

Results

Annotations

Interfaces

Classes

CallbackRegistry

Class Overview

Summary

Public Constructors

public CallbackRegistry (NotifierCallback<C, T, A> notifier)

Parameters

Public Methods

public synchronized void add (C callback)

Parameters

public synchronized void clear ()

public synchronized CallbackRegistry<C, T, A> clone ()

Returns

public synchronized void copyCallbacks (List<C> callbacks)

Parameters

public synchronized ArrayList<C> copyCallbacks ()

Returns

public synchronized boolean isEmpty ()

Returns

public synchronized void notifyCallbacks (T sender, int arg, A arg2)

Parameters

public synchronized void remove (C callback)

Parameters