org.gradle.listener

Class ListenerBroadcast<T>

java.lang.Object

org.gradle.listener.ListenerBroadcast<T>

Type Parameters:

T - The listener type.

All Implemented Interfaces:

Stoppable, Dispatch<MethodInvocation>, StoppableDispatch<MethodInvocation>

Direct Known Subclasses:

AsyncListenerBroadcast

public class ListenerBroadcast<T>
extends Object
implements StoppableDispatch<MethodInvocation>

Manages a set of listeners of type T. Provides an implementation of T which can be used to broadcast to all registered listeners.

Ordering is maintained for events, so that events are delivered to listeners in the order they are generated. Events are delivered to listeners in the order that listeners are added to this broadcaster.

Constructor Summary

Constructors

Modifier	Constructor and Description
	ListenerBroadcast(Class<T> type)
protected	ListenerBroadcast(Class<T> type, Transformer<StoppableDispatch<MethodInvocation>,StoppableDispatch<MethodInvocation>> transformer)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Dispatch<MethodInvocation> dispatch) Adds a Dispatch to receive events from this broadcast.
void	add(String methodName, Action<?> action) Adds an action to be executed when the given method is called.
void	add(String methodName, Closure closure) Adds a closure to be notified when the given method is called.
void	add(T listener) Adds a listener.
void	addAll(Iterable<? extends T> listeners) Adds the given listeners.
void	dispatch(MethodInvocation event) Broadcasts the given event to all listeners.
T	getSource() Returns the broadcaster.
Class<T>	getType() Returns the type of listener to which this class broadcasts.
void	maybeAdd(Object listener) Adds the given listener if it is an instance of the listener type.
void	remove(Object listener) Removes the given listener.
void	removeAll(Iterable<?> listeners) Removes the given listeners.
void	stop() Stops this dispatch.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListenerBroadcast

public ListenerBroadcast(Class<T> type)

ListenerBroadcast

protected ListenerBroadcast(Class<T> type,
                 Transformer<StoppableDispatch<MethodInvocation>,StoppableDispatch<MethodInvocation>> transformer)

Method Detail

getSource

public T getSource()

Returns the broadcaster. Any method call on this object is broadcast to all listeners.

Returns:

The broadcaster.

getType

public Class<T> getType()

Returns the type of listener to which this class broadcasts.

Returns:

The type of the broadcaster.

add

public void add(T listener)

Adds a listener.

Parameters:

listener - The listener.

addAll

public void addAll(Iterable<? extends T> listeners)

Adds the given listeners.

Parameters:

listeners - The listeners

maybeAdd

public void maybeAdd(Object listener)

Adds the given listener if it is an instance of the listener type.

Parameters:

listener - The listener

add

public void add(Dispatch<MethodInvocation> dispatch)

Adds a Dispatch to receive events from this broadcast.

add

public void add(String methodName,
       Closure closure)

Adds a closure to be notified when the given method is called.

add

public void add(String methodName,
       Action<?> action)

Adds an action to be executed when the given method is called.

remove

public void remove(Object listener)

Removes the given listener.

Parameters:

listener - The listener.

removeAll

public void removeAll(Iterable<?> listeners)

Removes the given listeners.

Parameters:

listeners - The listeners

dispatch

public void dispatch(MethodInvocation event)

Broadcasts the given event to all listeners.

Specified by:

dispatch in interface Dispatch<MethodInvocation>

Parameters:

event - The event

stop

public void stop()

Description copied from interface: StoppableDispatch

Stops this dispatch. Stops accepting new events and blocks until all events have been dispatched.

Specified by:

stop in interface Stoppable

Specified by:

stop in interface StoppableDispatch<MethodInvocation>