Package com.atlassian.event.api

Interface EventListenerRegistrar

All Known Subinterfaces:

EventPublisher

All Known Implementing Classes:

EventPublisherImpl

public interface EventListenerRegistrar

Method Summary

Modifier and Type	Method	Description
void	register(Object listener)	Register a listener to receive events.
void	unregister(Object listener)	Un-register a listener so that it will no longer receive events.
void	unregisterAll()	Un-register all listeners that this registrar knows about.

Method Details

register

void register(@Nonnull
 Object listener)

Register a listener to receive events.

All implementations must support registration of listeners where event handling methods are indicated by the EventListener annotation.

Parameters:

listener - The listener that is being registered

Throws:

NullPointerException - if the listener is null

IllegalArgumentException - if the parameter is not found to be an actual listener

See Also:

• annotation which can be used to indicate event listener methods

unregister

void unregister(@Nonnull
 Object listener)

Un-register a listener so that it will no longer receive events.

If the given listener is not registered, nothing will happen.

Parameters:

listener - The listener to un-register

Throws:

NullPointerException - if the listener is null

unregisterAll

void unregisterAll()

Un-register all listeners that this registrar knows about.