org.gradle.listener

Class DefaultListenerManager

java.lang.Object

org.gradle.listener.DefaultListenerManager

All Implemented Interfaces:

ListenerManager

public class DefaultListenerManager
extends Object
implements ListenerManager

Constructor Summary

Constructors

Constructor and Description
DefaultListenerManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(Class<?> listenerType, String method, Closure listenerClosure) Added a listener implemented via a Groovy closure.
void	addListener(Object listener) Added a listener.
<T> ListenerBroadcast<T>	createAnonymousBroadcaster(Class<T> listenerClass) Returns a broadcaster for the given listenerClass.
ListenerManager	createChild() Creates a child ListenerManager.
<T> T	getBroadcaster(Class<T> listenerClass) Returns a broadcaster for the given listenerClass.
void	removeListener(Object listener) Removes a listener.
void	useLogger(Object logger) Uses the given object as a logger.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultListenerManager

public DefaultListenerManager()

Method Detail

addListener

public void addListener(Object listener)

Description copied from interface: ListenerManager

Added a listener. A single object can implement multiple interfaces, and all interfaces are registered by a single invocation of this method. There is no order dependency: if a broadcaster has already been made for type T, the listener will be registered with it if (listener instanceof T) returns true.

Specified by:

addListener in interface ListenerManager

Parameters:

listener - the listener to add.

addListener

public void addListener(Class<?> listenerType,
               String method,
               Closure listenerClosure)

Description copied from interface: ListenerManager

Added a listener implemented via a Groovy closure. The closure can implement a single method of the given listenerType class. There is no order dependency: if a broadcaster has already been made for listenerType, the closure will be registered with it.

Specified by:

addListener in interface ListenerManager

Parameters:

listenerType - The class of the listener type for which the closure is a method implementation.

method - The name of the method in the listenerType class for which the closure is an implementation.

listenerClosure - The closure containing the implementation of the listener method.

removeListener

public void removeListener(Object listener)

Description copied from interface: ListenerManager

Removes a listener. A single object can implement multiple interfaces, and all interfaces are unregistered by a single invocation of this method. There is no order dependency: if a broadcaster has already been made for type T, the listener will be unregistered with it if (listener instanceof T) returns true.

Specified by:

removeListener in interface ListenerManager

Parameters:

listener - the listener to remove.

useLogger

public void useLogger(Object logger)

Description copied from interface: ListenerManager

Uses the given object as a logger. Each listener class has exactly one logger associated with it. Any existing logger for the listener class is discarded.

Specified by:

useLogger in interface ListenerManager

Parameters:

logger - The new logger to use.

getBroadcaster

public <T> T getBroadcaster(Class<T> listenerClass)

Description copied from interface: ListenerManager

Returns a broadcaster for the given listenerClass. If there are no registered listeners for that type, a broadcaster is returned which does not forward method calls to any listeners. The returned broadcasters are live, that is their list of listeners can be updated by calls to ListenerManager.addListener(Object) and ListenerManager.removeListener(Object) after they have been returned. Broadcasters are also cached, so that repeatedly calling this method with the same listenerClass returns the same broadcaster object.

Specified by:

getBroadcaster in interface ListenerManager

Parameters:

listenerClass - The type of listener for which to return a broadcaster.

Returns:

The broadcaster that forwards method calls to all listeners of the same type that have been (or will be) registered with this manager.

createAnonymousBroadcaster

public <T> ListenerBroadcast<T> createAnonymousBroadcaster(Class<T> listenerClass)

Description copied from interface: ListenerManager

Returns a broadcaster for the given listenerClass. The returned broadcaster will delegate to the canonical broadcaster returned by ListenerManager.getBroadcaster(Class) for the given listener type. However, it can also have listeners assigned/removed directly to/from it. This allows these "anonymous" broadcasters to specialize what listeners receive messages. Each call creates a new broadcaster, so that client code can create as many "facets" of the listener as they need. The client code must provide some way for its users to register listeners on the specialized broadcasters.

Specified by:

createAnonymousBroadcaster in interface ListenerManager

Parameters:

listenerClass - The type of listener for which to create a broadcaster.

Returns:

A broadcaster that forwards method calls to all listeners assigned to it, or of the same type that have been (or will be) registered with this manager.

createChild

public ListenerManager createChild()

Description copied from interface: ListenerManager

Creates a child ListenerManager. All events broadcast in the child will be received by the listeners registered in the parent. However, the reverse is not true: events broadcast in the parent are not received by the listeners in the children. The child inherits the loggers of its parent, though these can be replaced.

Specified by:

createChild in interface ListenerManager

Returns:

The child