com.atlassian.plugin.event.impl

Class DefaultPluginEventManager

java.lang.Object

com.atlassian.plugin.event.impl.DefaultPluginEventManager

All Implemented Interfaces:

PluginEventManager

public class DefaultPluginEventManager
extends Object
implements PluginEventManager

Simple, synchronous event manager that uses one or more method selectors to determine event listeners.

The default method selectors are MethodNameListenerMethodSelector and AnnotationListenerMethodSelector.

Constructor Summary

Constructors

Constructor and Description
DefaultPluginEventManager()
DefaultPluginEventManager(com.atlassian.event.api.EventPublisher eventPublisher) Delegate all event publication to the supplied EventPublisher.
DefaultPluginEventManager(ListenerMethodSelector... selectors) Uses the supplied selectors to determine listener methods.
DefaultPluginEventManager(ScopeManager scopeManager) Deprecated. in 5.0 for removal in 6.0 when ScopeManager will be removed. Use DefaultPluginEventManager() instead.
DefaultPluginEventManager(ScopeManager scopeManager, ListenerMethodSelector... selectors) Deprecated. in 5.0 for removal in 6.0 when ScopeManager will be removed. Use DefaultPluginEventManager(ListenerMethodSelector[]) instead.

Method Summary

Modifier and Type	Method and Description
void	broadcast(Object event) Broadcasts an event to all applicable listeners.
com.atlassian.event.api.EventPublisher	getEventPublisher()
void	register(Object listener) Registers a listener object
void	unregister(Object listener) Unregisters a listener object

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPluginEventManager

public DefaultPluginEventManager()

DefaultPluginEventManager

public DefaultPluginEventManager(ListenerMethodSelector... selectors)

Uses the supplied selectors to determine listener methods.

Parameters:

selectors - used to determine which are listener methods

DefaultPluginEventManager

@Deprecated
public DefaultPluginEventManager(ScopeManager scopeManager)

Deprecated. in 5.0 for removal in 6.0 when ScopeManager will be removed. Use DefaultPluginEventManager() instead.

DefaultPluginEventManager

@Deprecated
public DefaultPluginEventManager(ScopeManager scopeManager,
                                             ListenerMethodSelector... selectors)

Deprecated. in 5.0 for removal in 6.0 when ScopeManager will be removed. Use DefaultPluginEventManager(ListenerMethodSelector[]) instead.

DefaultPluginEventManager

public DefaultPluginEventManager(com.atlassian.event.api.EventPublisher eventPublisher)

Delegate all event publication to the supplied EventPublisher.

Method Detail

register

public void register(Object listener)

Description copied from interface: PluginEventManager

Registers a listener object

Specified by:

register in interface PluginEventManager

Parameters:

listener - The listener instance. Cannot be null.

unregister

public void unregister(Object listener)

Description copied from interface: PluginEventManager

Unregisters a listener object

Specified by:

unregister in interface PluginEventManager

Parameters:

listener - The listener. Cannot be null.

broadcast

public void broadcast(Object event)
               throws NotificationException

Description copied from interface: PluginEventManager

Broadcasts an event to all applicable listeners.

Specified by:

broadcast in interface PluginEventManager

Parameters:

event - The event object. Cannot be null.

Throws:

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

getEventPublisher

public com.atlassian.event.api.EventPublisher getEventPublisher()