com.atlassian.plugin.event

Interface PluginEventManager

All Known Implementing Classes:

DefaultPluginEventManager

public interface PluginEventManager

Defines the event manager for use with internal Atlassian Plugins framework events. How listeners are defined is up to the implementation. Implementations should allow listeners to somehow identify which events they would like to listen for, then have the appropriate methods called if the event is the desired class or a subclass/implementation. This means a listener could listen for an event of type java.lang.Object and should be notified for every event.

Method Summary

Methods

Modifier and Type	Method and Description
void	broadcast(java.lang.Object event) Broadcasts an event to all applicable listeners.
void	register(java.lang.Object listener) Registers a listener object
void	unregister(java.lang.Object listener) Unregisters a listener object

Method Detail

register

void register(java.lang.Object listener)

Registers a listener object

Parameters:

listener - The listener instance. Cannot be null.

unregister

void unregister(java.lang.Object listener)

Unregisters a listener object

Parameters:

listener - The listener. Cannot be null.

broadcast

void broadcast(java.lang.Object event)
               throws NotificationException

Broadcasts an event to all applicable listeners.

Parameters:

event - The event object. Cannot be null.

Throws:

NotificationException - If an exception is thrown by one of the Event Listeners.