com.prozima.pengine
Class EventSender

java.lang.Object
  com.prozima.pengine.EventSender

Direct Known Subclasses:

PEngine

public abstract class EventSender
extends java.lang.Object

Inherited by all classes which can distribute PEngine events. Listeners must register with an instance of this class before they are notified of events. Listeners can register for all events or for only specific events, identified by their unique ID.

Constructor Summary

EventSender()

Method Summary

void	addListener(EventInterface.ID inID, EventListener inListener) Add a listener which will be informed of all events with a specific ID which are fired.
void	addListener(EventListener inListener) Add a listener which will be informed of all events fired by this EventSender.
boolean	removeListener(EventInterface.ID inID, EventListener inListener) Remove a listener which was previously added for a specific ID.
boolean	removeListener(EventListener inListener) Remove a listener which was previously added to the EventSender.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventSender

public EventSender()

Method Detail

addListener

public void addListener(EventInterface.ID inID,
                        EventListener inListener)

Add a listener which will be informed of all events with a specific ID which are fired.

Parameters:

inID - ID of the event for which the listener is being registered. null is never a permitted value for this parameter.

inListener - Listener. null is never a permitted value for this parameter.

addListener

public void addListener(EventListener inListener)

Add a listener which will be informed of all events fired by this EventSender.

Parameters:

inListener - Listener for events. null is never a permitted value for this parameter.

removeListener

public boolean removeListener(EventInterface.ID inID,
                              EventListener inListener)

Remove a listener which was previously added for a specific ID.

Parameters:

inID - ID of the event for which the listener was registered. null is never a permitted value for this parameter.

inListener - Listener. If the listener has never been added, no action is taken. null is never a permitted value for this parameter.

Returns:

true if listener was removed, otherwise false.

removeListener

public boolean removeListener(EventListener inListener)

Remove a listener which was previously added to the EventSender. Method will not remove listeners which were added for a specific ID.

Parameters:

inListener - Listener which receives events. If the listener has never been added, no action is taken. null is never a permitted value for this parameter.

Returns:

true if listener was removed, otherwise false.