org.codehaus.griffon.runtime.core.event

Class AbstractEventPublisher

java.lang.Object

org.codehaus.griffon.runtime.core.event.AbstractEventPublisher

All Implemented Interfaces:

EventPublisher

Direct Known Subclasses:

DefaultEventPublisher

public abstract class AbstractEventPublisher
extends java.lang.Object
implements EventPublisher

Since:

2.0.0

Author:

Andres Almiray

Constructor Summary

Constructors

Constructor and Description
AbstractEventPublisher()

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.
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.
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.
void	setEventPublishingEnabled(boolean enabled) Sets the enabled state for event publishing.
void	setEventRouter(EventRouter eventRouter)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractEventPublisher

public AbstractEventPublisher()

Method Detail

setEventRouter

@Inject
public void setEventRouter(@Nonnull
                                   EventRouter eventRouter)

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.

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

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.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

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

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

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 <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

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

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

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

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

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

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

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

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
                              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

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.