org.codehaus.griffon.runtime.core.event

Class AbstractEventRouter

java.lang.Object

org.codehaus.griffon.runtime.core.event.AbstractEventRouter

All Implemented Interfaces:

EventPublisher, EventRouter

Direct Known Subclasses:

DefaultEventRouter

public abstract class AbstractEventRouter
extends java.lang.Object
implements EventRouter

Author:

Andres Almiray

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractEventRouter.MethodCache
protected static class	AbstractEventRouter.MethodInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.concurrent.atomic.AtomicInteger	EVENT_ROUTER_ID
protected int	eventRouterId
protected java.util.concurrent.ExecutorService	executorService
protected ExecutorServiceManager	executorServiceManager
protected java.util.Map<java.lang.String,java.util.List<java.lang.Object>>	functionalListeners
protected java.util.Map<java.lang.String,java.util.List<java.lang.Object>>	instanceListeners
protected static java.lang.Object[]	LOCK

Constructor Summary

Constructors

Constructor and Description
AbstractEventRouter()

Method Summary

Modifier and Type	Method and Description
<E extends Event> void	addEventListener(java.lang.Class<E> eventClass, CallableWithArgs<?> listener) Adds a callable as an event listener.
<E extends Event> void	addEventListener(java.lang.Class<E> eventClass, RunnableWithArgs listener) Adds a callable as an event listener.
void	addEventListener(java.util.Map<java.lang.String,java.lang.Object> listener) Adds a Map containing event listeners.
void	addEventListener(java.lang.Object listener) Adds an event listener.
void	addEventListener(java.lang.String eventName, CallableWithArgs<?> listener) Adds a callable as an event listener.
void	addEventListener(java.lang.String eventName, RunnableWithArgs listener) Adds a callable as an event listener.
protected java.lang.Object[]	asArray(java.util.List<?> list)
protected java.lang.Runnable	buildPublisher(java.lang.String event, java.util.List<?> params, java.lang.String mode)
protected abstract void	doPublishAsync(java.lang.Runnable publisher)
protected abstract void	doPublishOutsideUI(java.lang.Runnable publisher)
protected void	fireEvent(CallableWithArgs<?> callable, java.util.List<?> params)
protected void	fireEvent(java.lang.Object instance, java.lang.String eventHandler, java.util.List<?> params)
protected void	fireEvent(RunnableWithArgs runnable, java.util.List<?> params)
java.util.Collection<java.lang.Object>	getEventListeners() Returns an immutable snapshot view of all event listeners registered.
java.util.Collection<java.lang.Object>	getEventListeners(java.lang.String eventName) Returns an immutable snapshot view of all event listeners registered for the target event name.
boolean	isEventPublishingEnabled() Returns whether events will be published by the event bus or not.
protected boolean	isNestedListener(java.lang.Object listener, java.lang.Object owner)
void	publishEvent(Event event) Publishes an event.
void	publishEvent(java.lang.String eventName) Publishes an event.
void	publishEvent(java.lang.String eventName, java.util.List<?> params) Publishes an event.
void	publishEventAsync(Event event) Publishes an event.
void	publishEventAsync(java.lang.String eventName) Publishes an event.
void	publishEventAsync(java.lang.String eventName, java.util.List<?> params) Publishes an event.
void	publishEventOutsideUI(Event event) Publishes an event.
void	publishEventOutsideUI(java.lang.String eventName) Publishes an event.
void	publishEventOutsideUI(java.lang.String eventName, java.util.List<?> params) Publishes an event.
<E extends Event> void	removeEventListener(java.lang.Class<E> eventClass, CallableWithArgs<?> listener) Removes a callable as an event listener.
<E extends Event> void	removeEventListener(java.lang.Class<E> eventClass, RunnableWithArgs listener) Removes a callable as an event listener.
void	removeEventListener(java.util.Map<java.lang.String,java.lang.Object> listener) Removes a Map containing event listeners.
void	removeEventListener(java.lang.Object listener) Removes an event listener.
void	removeEventListener(java.lang.String eventName, CallableWithArgs<?> listener) Removes a callable as an event listener.
void	removeEventListener(java.lang.String eventName, RunnableWithArgs listener) Removes a callable as an event listener.
protected boolean	removeNestedListeners(java.lang.Object owner)
protected void	runInsideExecutorService(java.lang.Runnable runnable)
void	setEventPublishingEnabled(boolean enabled) Sets the enabled state for event publishing.
void	setExecutorServiceManager(ExecutorServiceManager executorServiceManager)

Methods inherited from class java.lang.Object

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

Field Detail

LOCK

protected static final java.lang.Object[] LOCK

instanceListeners

protected final java.util.Map<java.lang.String,java.util.List<java.lang.Object>> instanceListeners

functionalListeners

protected final java.util.Map<java.lang.String,java.util.List<java.lang.Object>> functionalListeners

EVENT_ROUTER_ID

protected static final java.util.concurrent.atomic.AtomicInteger EVENT_ROUTER_ID

executorServiceManager

protected ExecutorServiceManager executorServiceManager

executorService

protected final java.util.concurrent.ExecutorService executorService

eventRouterId

protected final int eventRouterId

Constructor Detail

AbstractEventRouter

public AbstractEventRouter()

Method Detail

setExecutorServiceManager

@Inject
public void setExecutorServiceManager(@Nonnull
                                              ExecutorServiceManager executorServiceManager)

runInsideExecutorService

protected void runInsideExecutorService(@Nonnull
                                        java.lang.Runnable runnable)

isEventPublishingEnabled

public boolean isEventPublishingEnabled()

Description copied from interface: EventPublisher

Returns whether events will be published by the event bus or not.

Specified by:

isEventPublishingEnabled in interface EventPublisher

Returns:

true if event publishing is enabled; false otherwise.

setEventPublishingEnabled

public void setEventPublishingEnabled(boolean enabled)

Description copied from interface: EventPublisher

Sets the enabled state for event publishing.

Events will be automatically discarded when the enabled state is set to false.

Specified by:

setEventPublishingEnabled in interface EventPublisher

Parameters:

enabled - the value fot the enabled state.

publishEvent

public void publishEvent(@Nonnull
                         java.lang.String eventName)

Description copied from interface: EventPublisher

Publishes an event.

Listeners will be notified in the same thread as the publisher.

Specified by:

publishEvent in interface EventPublisher

Parameters:

eventName - the name of the event

publishEvent

public void publishEvent(@Nonnull
                         java.lang.String eventName,
                         @Nullable
                         java.util.List<?> params)

Description copied from interface: EventPublisher

Publishes an event.

Listeners will be notified in the same thread as the publisher.

Specified by:

publishEvent in interface EventPublisher

Parameters:

eventName - the name of the event

params - event arguments sent to listeners

publishEventOutsideUI

public void publishEventOutsideUI(@Nonnull
                                  java.lang.String eventName)

Description copied from interface: EventPublisher

Publishes an event.

Listeners will be notified outside of the UI thread.

Specified by:

publishEventOutsideUI in interface EventPublisher

Parameters:

eventName - the name of the event

publishEventOutsideUI

public void publishEventOutsideUI(@Nonnull
                                  java.lang.String eventName,
                                  @Nullable
                                  java.util.List<?> params)

Description copied from interface: EventPublisher

Publishes an event.

Listeners will be notified outside of the UI thread.

Specified by:

publishEventOutsideUI in interface EventPublisher

Parameters:

eventName - the name of the event

params - event arguments sent to listeners

doPublishOutsideUI

protected abstract void doPublishOutsideUI(@Nonnull
                                           java.lang.Runnable publisher)

publishEventAsync

public void publishEventAsync(@Nonnull
                              java.lang.String eventName)

Description copied from interface: EventPublisher

Publishes an event.

Listeners will be notified in a different thread.

Specified by:

publishEventAsync in interface EventPublisher

Parameters:

eventName - the name of the event

publishEventAsync

public void publishEventAsync(@Nonnull
                              java.lang.String eventName,
                              @Nullable
                              java.util.List<?> params)

Description copied from interface: EventPublisher

Publishes an event.

Listeners will be notified in a different thread.

Specified by:

publishEventAsync in interface EventPublisher

Parameters:

eventName - the name of the event

params - event arguments sent to listeners

doPublishAsync

protected abstract void doPublishAsync(@Nonnull
                                       java.lang.Runnable publisher)

publishEvent

public void publishEvent(@Nonnull
                         Event event)

Description copied from interface: EventPublisher

Publishes an event.

Listeners will be notified in the same thread as the publisher.

Specified by:

publishEvent in interface EventPublisher

Parameters:

event - the event to be published

publishEventOutsideUI

public void publishEventOutsideUI(@Nonnull
                                  Event event)

Description copied from interface: EventPublisher

Publishes an event.

Listeners will be notified outside of the UI thread.

Specified by:

publishEventOutsideUI in interface EventPublisher

Parameters:

event - the event to be published

publishEventAsync

public void publishEventAsync(@Nonnull
                              Event event)

Description copied from interface: EventPublisher

Publishes an event.

Listeners will be notified in a different thread.

Specified by:

publishEventAsync in interface EventPublisher

Parameters:

event - the event to be published

removeEventListener

public <E extends Event> void removeEventListener(@Nonnull
                                                  java.lang.Class<E> eventClass,
                                                  @Nonnull
                                                  CallableWithArgs<?> listener)

Description copied from interface: EventPublisher

Removes a callable as an event listener.

Specified by:

removeEventListener in interface EventPublisher

Parameters:

eventClass - the type of the event

listener - an event listener

removeEventListener

public <E extends Event> void removeEventListener(@Nonnull
                                                  java.lang.Class<E> eventClass,
                                                  @Nonnull
                                                  RunnableWithArgs listener)

Description copied from interface: EventPublisher

Removes a callable as an event listener.

Specified by:

removeEventListener in interface EventPublisher

Parameters:

eventClass - the type of the event

listener - an event listener

fireEvent

protected void fireEvent(@Nonnull
                         RunnableWithArgs runnable,
                         @Nonnull
                         java.util.List<?> params)

fireEvent

protected void fireEvent(@Nonnull
                         CallableWithArgs<?> callable,
                         @Nonnull
                         java.util.List<?> params)

fireEvent

protected void fireEvent(@Nonnull
                         java.lang.Object instance,
                         @Nonnull
                         java.lang.String eventHandler,
                         @Nonnull
                         java.util.List<?> params)

addEventListener

public <E extends Event> void addEventListener(@Nonnull
                                               java.lang.Class<E> eventClass,
                                               @Nonnull
                                               CallableWithArgs<?> listener)

Description copied from interface: EventPublisher

Adds a callable as an event listener.

Specified by:

addEventListener in interface EventPublisher

Parameters:

eventClass - the type of the event

listener - an event listener

addEventListener

public <E extends Event> void addEventListener(@Nonnull
                                               java.lang.Class<E> eventClass,
                                               @Nonnull
                                               RunnableWithArgs listener)

Description copied from interface: EventPublisher

Adds a callable as an event listener.

Specified by:

addEventListener in interface EventPublisher

Parameters:

eventClass - the type of the event

listener - an event listener

addEventListener

public void addEventListener(@Nonnull
                             java.lang.Object listener)

Description copied from interface: EventPublisher

Adds an event listener.

Accepted types are: Script, Map and Object.

Specified by:

addEventListener in interface EventPublisher

Parameters:

listener - an event listener

addEventListener

public void addEventListener(@Nonnull
                             java.util.Map<java.lang.String,java.lang.Object> listener)

Description copied from interface: EventPublisher

Adds a Map containing event listeners.

An event listener may be

• a RunnableWithArgs
• a CallableWithArgs

Maps require handlers to be named as eventName only.

Some examples of eventHandler names are: StartupStart, MyCoolEvent. Event names must follow the camelCase naming convention.

Specified by:

addEventListener in interface EventPublisher

Parameters:

listener - an event listener of type Map

removeEventListener

public void removeEventListener(@Nonnull
                                java.lang.Object listener)

Description copied from interface: EventPublisher

Removes an event listener.

Accepted types are: Script, Map and Object.

Specified by:

removeEventListener in interface EventPublisher

Parameters:

listener - an event listener

removeEventListener

public void removeEventListener(@Nonnull
                                java.util.Map<java.lang.String,java.lang.Object> listener)

Description copied from interface: EventPublisher

Removes a Map containing event listeners.

An event listener may be

• a RunnableWithArgs
• a CallableWithArgs

Maps require handlers to be named as eventName only.

Some examples of eventHandler names are: StartupStart, MyCoolEvent. Event names must follow the camelCase naming convention.

Specified by:

removeEventListener in interface EventPublisher

Parameters:

listener - an event listener of type Map

addEventListener

public void addEventListener(@Nonnull
                             java.lang.String eventName,
                             @Nonnull
                             CallableWithArgs<?> listener)

Description copied from interface: EventPublisher

Adds a callable as an event listener.

Specified by:

addEventListener in interface EventPublisher

Parameters:

eventName - the name of the event

listener - an event listener

addEventListener

public void addEventListener(@Nonnull
                             java.lang.String eventName,
                             @Nonnull
                             RunnableWithArgs listener)

Description copied from interface: EventPublisher

Adds a callable as an event listener.

Specified by:

addEventListener in interface EventPublisher

Parameters:

eventName - the name of the event

listener - an event listener

removeEventListener

public void removeEventListener(@Nonnull
                                java.lang.String eventName,
                                @Nonnull
                                CallableWithArgs<?> listener)

Description copied from interface: EventPublisher

Removes a callable as an event listener.

Specified by:

removeEventListener in interface EventPublisher

Parameters:

eventName - the name of the event

listener - an event listener

removeEventListener

public void removeEventListener(@Nonnull
                                java.lang.String eventName,
                                @Nonnull
                                RunnableWithArgs listener)

Description copied from interface: EventPublisher

Removes a callable as an event listener.

Specified by:

removeEventListener in interface EventPublisher

Parameters:

eventName - the name of the event

listener - an event listener

getEventListeners

@Nonnull
public java.util.Collection<java.lang.Object> getEventListeners()

Description copied from interface: EventPublisher

Returns an immutable snapshot view of all event listeners registered.

Specified by:

getEventListeners in interface EventPublisher

Returns:

an immutable collection of all registered listeners.

getEventListeners

@Nonnull
public java.util.Collection<java.lang.Object> getEventListeners(@Nonnull
                                                                         java.lang.String eventName)

Description copied from interface: EventPublisher

Returns an immutable snapshot view of all event listeners registered for the target event name.

Specified by:

getEventListeners in interface EventPublisher

Parameters:

eventName - the name of the event

Returns:

an immutable collection of all registered listeners for the target event name.

buildPublisher

protected java.lang.Runnable buildPublisher(@Nonnull
                                            java.lang.String event,
                                            @Nonnull
                                            java.util.List<?> params,
                                            @Nonnull
                                            java.lang.String mode)

removeNestedListeners

protected boolean removeNestedListeners(@Nonnull
                                        java.lang.Object owner)

isNestedListener

protected boolean isNestedListener(@Nonnull
                                   java.lang.Object listener,
                                   @Nonnull
                                   java.lang.Object owner)

asArray

protected java.lang.Object[] asArray(@Nonnull
                                     java.util.List<?> list)