org.skyscreamer.yoga.listener

Class RenderingListenerRegistry

java.lang.Object

org.skyscreamer.yoga.listener.RenderingListenerRegistry

public class RenderingListenerRegistry
extends Object

The RenderingListenerRegistry allows you to declare one or more objects that implement the RenderingListener interface. These Rendering Listeners will process or decorate the response from a Yoga call before it is returned to the user.

The RenderingListener objects are stored in an ordered collection, and will be processed in sequence for each Yoga call.

See Also:

RenderingListener

Field Summary

Fields

Modifier and Type	Field and Description
protected Collection<RenderingListener>	listeners

Constructor Summary

Constructors

Constructor and Description
RenderingListenerRegistry(Collection<RenderingListener> listeners) Constructor to initialize the registry with a set of listeners
RenderingListenerRegistry(RenderingListener... listeners) Constructor to initialize the registry with a set of 0 or more listeners

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(RenderingListener listener) Adds a rendering listener to the end of the ordered collection used by the registry
Collection<RenderingListener>	getListeners() Retrieves the ordered collection of rendering listeners used by the registry
void	setListeners(Collection<RenderingListener> listeners) Replaces the ordered collection of rendering listeners used by the registry

Methods inherited from class java.lang.Object

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

Field Detail

listeners

protected Collection<RenderingListener> listeners

Constructor Detail

RenderingListenerRegistry

public RenderingListenerRegistry(RenderingListener... listeners)

Constructor to initialize the registry with a set of 0 or more listeners

Parameters:

listeners - The ordered collection of rendering listeners

RenderingListenerRegistry

public RenderingListenerRegistry(Collection<RenderingListener> listeners)

Constructor to initialize the registry with a set of listeners

Parameters:

listeners - The ordered collection of rendering listeners

Method Detail

getListeners

public Collection<RenderingListener> getListeners()

Retrieves the ordered collection of rendering listeners used by the registry

Returns:

The rendering listeners

addListener

public void addListener(RenderingListener listener)

Adds a rendering listener to the end of the ordered collection used by the registry

Parameters:

listener - The rendering listener to add

setListeners

public void setListeners(Collection<RenderingListener> listeners)

Replaces the ordered collection of rendering listeners used by the registry

Parameters:

listeners - The new collection of rendering listeners