net.user1.union.core.event
Interface EventProducer

All Known Subinterfaces:

Client, RemoteEventProducer, Room, Security, Server, UPCProcessor

public interface EventProducer

An EventProducer is capable of dispatching events to listeners who have registered to receive those events.

Method Summary

void	addEventListener(java.lang.String event, java.lang.Object callbackObject, java.lang.String callbackMethod) Adds an event listener to this EventProducer.
void	dispatchEvent(java.lang.String eventName, Event evt) Has the event producer dispatch an event.
java.util.Map<java.lang.String,java.lang.Class<? extends Event>>	getEventClassMap() Returns a Map of declared events dispatched by the EventProducer keyed by event name and mapped to the event class that is dispatched.
void	removeEventListener(java.lang.String event, java.lang.Object callbackObject, java.lang.String callbackMethod) Deregisters an event listener for an event from this EventProducer.

Method Detail

addEventListener

void addEventListener(java.lang.String event,
                      java.lang.Object callbackObject,
                      java.lang.String callbackMethod)

Adds an event listener to this EventProducer.

Parameters:

event - - the event the listener is interested in

callbackObject - - the object which will receive the event notification

callbackMethod - - the method that will be invoked on callbackObject for the event notification

removeEventListener

void removeEventListener(java.lang.String event,
                         java.lang.Object callbackObject,
                         java.lang.String callbackMethod)

Deregisters an event listener for an event from this EventProducer.

Parameters:

event - - the event to longer be listened for

callbackObject - - the object which was receiving the event notification

callbackMethod - - the method that was invoked on callbackObject for the event notification

getEventClassMap

java.util.Map<java.lang.String,java.lang.Class<? extends Event>> getEventClassMap()

Returns a Map of declared events dispatched by the EventProducer keyed by event name and mapped to the event class that is dispatched.

Returns:

a Map of declared events dispatched by the EventProducer

dispatchEvent

void dispatchEvent(java.lang.String eventName,
                   Event evt)

Has the event producer dispatch an event.

Parameters:

eventName - - the name of the event to dispatch

evt - - the event Object for the event