com.atlassian.event

Interface EventManager

All Known Implementing Classes:

LegacyEventManager

Deprecated.

since 2.0, use EventPublisher

public interface EventManager

Interface to manage events. It essentially allows to register event listeners and publish events.

Since:

1.0

Method Summary

Methods

Modifier and Type	Method and Description
void	publishEvent(Event event) Deprecated. Publish an event that will be consumed by all listeners which have registered to receive it.
void	registerListener(String listenerKey, EventListener listener) Deprecated. Register a listener to receive events.
void	unregisterListener(String listenerKey) Deprecated. Un-register a listener so that it will no longer receive events.

Method Detail

publishEvent

void publishEvent(Event event)

Deprecated.

Publish an event that will be consumed by all listeners which have registered to receive it.

Parameters:

event - the event to publish

Throws:

NullPointerException - if the event is null

registerListener

void registerListener(String listenerKey,
                    EventListener listener)

Deprecated.

Register a listener to receive events. If you register a listener with the same key as an existing listener, the previous listener with that key will be unregistered.

Parameters:

listenerKey - A unique key for this listener. If the listener is a plugin module, use the module's complete key

listener - The listener that is being registered

Throws:

NullPointerException - if the listenerKey or listener is null

IllegalArgumentException - if the listener key is empty (i.e. null or empty String)

unregisterListener

void unregisterListener(String listenerKey)

Deprecated.

Un-register a listener so that it will no longer receive events. If no listener is registered under this key, nothing will happen.

Parameters:

listenerKey - the key under which the listener was registered.

Throws:

IllegalArgumentException - if the listener key is empty (i.e. null or empty String)