com.atlassian.event.api
Interface EventPublisher

All Known Implementing Classes:

EventPublisherImpl

public interface EventPublisher

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

Since:

2.0

Method Summary

void	publish(java.lang.Object event) Publish an event that will be consumed by all listeners which have registered to receive it.
void	register(java.lang.Object listener) Register a listener to receive events.
void	unRegister(java.lang.Object listener) Un-register a listener so that it will no longer receive events.

Method Detail

publish

void publish(java.lang.Object event)

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

Parameters:

event - the event to publish

Throws:

java.lang.NullPointerException - if the event is null

register

void register(java.lang.Object listener)

Register a listener to receive events.

Parameters:

listener - The listener that is being registered

Throws:

java.lang.NullPointerException - if the listener is null

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

unRegister

void unRegister(java.lang.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:

java.lang.NullPointerException - if the listener is null