griffon.core.event

Interface EventPublisher

All Known Subinterfaces:

EventRouter

All Known Implementing Classes:

AbstractEventPublisher, AbstractEventRouter, DefaultEventPublisher, DefaultEventRouter

public interface EventPublisher

Base contract for classes that can publish events using their own event bus.

Since:

2.0.0

Author:

Andres Almiray

Method Summary

Methods

Modifier and Type	Method and Description
<E extends Event> void	addEventListener(Class<E> eventClass, CallableWithArgs<?> listener) Adds a callable as an event listener.
void	addEventListener(Map<String,CallableWithArgs<?>> listener) Adds a Map containing event listeners.
void	addEventListener(Object listener) Adds an event listener.
void	addEventListener(String eventName, CallableWithArgs<?> listener) Adds a callable as an event listener.
boolean	isEventPublishingEnabled() Returns whether events will be published by the event bus or not.
void	publishEvent(Event event) Publishes an event.
void	publishEvent(String eventName) Publishes an event.
void	publishEvent(String eventName, List<?> args) Publishes an event.
void	publishEventAsync(Event event) Publishes an event.
void	publishEventAsync(String eventName) Publishes an event.
void	publishEventAsync(String eventName, List<?> args) Publishes an event.
void	publishEventOutsideUI(Event event) Publishes an event.
void	publishEventOutsideUI(String eventName) Publishes an event.
void	publishEventOutsideUI(String eventName, List<?> args) Publishes an event.
<E extends Event> void	removeEventListener(Class<E> eventClass, CallableWithArgs<?> listener) Removes a callable as an event listener.
void	removeEventListener(Map<String,CallableWithArgs<?>> listener) Removes a Map containing event listeners.
void	removeEventListener(Object listener) Removes an event listener.
void	removeEventListener(String eventName, CallableWithArgs<?> listener) Removes a callable as an event listener.
void	setEventPublishingEnabled(boolean enabled) Sets the enabled state for event publishing.

Method Detail

addEventListener

void addEventListener(@Nonnull
                    Object listener)

Adds an event listener.

Accepted types are: Script, Map and Object.

Parameters:

listener - an event listener

addEventListener

void addEventListener(@Nonnull
                    String eventName,
                    @Nonnull
                    CallableWithArgs<?> listener)

Adds a callable as an event listener.

Parameters:

eventName - the name of the event

listener - an event listener

addEventListener

void addEventListener(@Nonnull
                    Map<String,CallableWithArgs<?>> listener)

Adds a Map containing event listeners.

An event listener may be a

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

Parameters:

listener - an event listener of type Map

addEventListener

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

Adds a callable as an event listener.

Parameters:

eventClass - the type of the event

listener - an event listener

removeEventListener

void removeEventListener(@Nonnull
                       Object listener)

Removes an event listener.

Accepted types are: Script, Map and Object.

Parameters:

listener - an event listener

removeEventListener

void removeEventListener(@Nonnull
                       String eventName,
                       @Nonnull
                       CallableWithArgs<?> listener)

Removes a callable as an event listener.

Parameters:

eventName - the name of the event

listener - an event listener

removeEventListener

void removeEventListener(@Nonnull
                       Map<String,CallableWithArgs<?>> listener)

Removes a Map containing event listeners.

An event listener may be a

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

Parameters:

listener - an event listener of type Map

removeEventListener

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

Removes a callable as an event listener.

Parameters:

eventClass - the type of the event

listener - an event listener

publishEvent

void publishEvent(@Nonnull
                String eventName)

Publishes an event.

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

Parameters:

eventName - the name of the event

publishEvent

void publishEvent(@Nonnull
                String eventName,
                @Nullable
                List<?> args)

Publishes an event.

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

Parameters:

eventName - the name of the event

args - event arguments sent to listeners

publishEvent

void publishEvent(@Nonnull
                Event event)

Publishes an event.

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

Parameters:

event - the event to be published

publishEventOutsideUI

void publishEventOutsideUI(@Nonnull
                         String eventName)

Publishes an event.

Listeners will be notified outside of the UI thread.

Parameters:

eventName - the name of the event

publishEventOutsideUI

void publishEventOutsideUI(@Nonnull
                         String eventName,
                         @Nullable
                         List<?> args)

Publishes an event.

Listeners will be notified outside of the UI thread.

Parameters:

eventName - the name of the event

args - event arguments sent to listeners

publishEventOutsideUI

void publishEventOutsideUI(@Nonnull
                         Event event)

Publishes an event.

Listeners will be notified outside of the UI thread.

Parameters:

event - the event to be published

publishEventAsync

void publishEventAsync(@Nonnull
                     String eventName)

Publishes an event.

Listeners will be notified in a different thread.

Parameters:

eventName - the name of the event

publishEventAsync

void publishEventAsync(@Nonnull
                     String eventName,
                     @Nullable
                     List<?> args)

Publishes an event.

Listeners will be notified in a different thread.

Parameters:

eventName - the name of the event

args - event arguments sent to listeners

publishEventAsync

void publishEventAsync(@Nonnull
                     Event event)

Publishes an event.

Listeners will be notified in a different thread.

Parameters:

event - the event to be published

isEventPublishingEnabled

boolean isEventPublishingEnabled()

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

Returns:

true if event publishing is enabled; false otherwise.

setEventPublishingEnabled

void setEventPublishingEnabled(boolean enabled)

Sets the enabled state for event publishing.

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

Parameters:

enabled - the value fot the enabled state.