ds.funnel.node.event

Class EventDispatcherImpl

java.lang.Object

ds.funnel.node.event.EventDispatcherImpl

All Implemented Interfaces:

EventDispatcher, EventDispatchHandler<Event>, EventHandler<Event>

public class EventDispatcherImpl
extends java.lang.Object
implements EventDispatcher

Constructor Summary

Constructors

Constructor and Description
EventDispatcherImpl()
EventDispatcherImpl(boolean inUseQueue, java.lang.String inDebName)
EventDispatcherImpl(boolean inUseQueue, java.lang.String inDebString, EventDispatcher inParent)

Method Summary

Modifier and Type	Method and Description
<E extends Event> void	dispatch(E event) Dispatch an event, passing the event to matching registered handlers.
void	handle(Event inEvent, java.lang.Exception ex) Called when a matching event is dispatched.
int	handleOrder()
java.lang.Class<Event>	handleType()
void	onCancelHandler() Called when this handler is unregistered with the dispatcher.
boolean	register(java.lang.Object handlerObj) Register a new event handler.
EventDispatchHandler<Event>	setParent(EventDispatchHandler<Event> inParent) Sets the parent event dispatcher.
void	unregister(java.lang.Object handlerObj) Unregister an event handler.
void	unregisterAll() Remove all event handlers.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventDispatcherImpl

public EventDispatcherImpl()

EventDispatcherImpl

public EventDispatcherImpl(boolean inUseQueue,
                           java.lang.String inDebName)

EventDispatcherImpl

public EventDispatcherImpl(boolean inUseQueue,
                           java.lang.String inDebString,
                           EventDispatcher inParent)

Method Detail

handleType

public java.lang.Class<Event> handleType()

Specified by:

handleType in interface EventDispatchHandler<Event>

Returns:

The event class that this handler accepts.

handleOrder

public int handleOrder()

Specified by:

handleOrder in interface EventDispatchHandler<Event>

Returns:

The relative order that this handler will be called.

handle

public void handle(Event inEvent,
                   java.lang.Exception ex)
            throws java.lang.Exception

Description copied from interface: EventDispatchHandler

Called when a matching event is dispatched.

Specified by:

handle in interface EventDispatchHandler<Event>

Specified by:

handle in interface EventHandler<Event>

Parameters:

inEvent - - The dispatched event.

ex - - An exception to pass to the handler

Throws:

java.lang.Exception

onCancelHandler

public void onCancelHandler()

Description copied from interface: EventDispatchHandler

Called when this handler is unregistered with the dispatcher.

Specified by:

onCancelHandler in interface EventDispatchHandler<Event>

register

public boolean register(java.lang.Object handlerObj)
                 throws RegistrationException

Description copied from interface: EventDispatcher

Register a new event handler. The handler is called when a matching event is dispatched.

Specified by:

register in interface EventDispatcher

Parameters:

handlerObj - - The event handler to register with this dispatcher.

Returns:

True on success, false otherwise.

Throws:

RegistrationException

unregister

public void unregister(java.lang.Object handlerObj)

Description copied from interface: EventDispatcher

Unregister an event handler. The handler will no longer be called.

Specified by:

unregister in interface EventDispatcher

Parameters:

handlerObj - - The event handler to register with this dispatcher.

unregisterAll

public void unregisterAll()

Description copied from interface: EventDispatcher

Remove all event handlers.

Specified by:

unregisterAll in interface EventDispatcher

setParent

public EventDispatchHandler<Event> setParent(EventDispatchHandler<Event> inParent)

Description copied from interface: EventDispatcher

Sets the parent event dispatcher. Events will be also be dispatched by the parent.

Specified by:

setParent in interface EventDispatcher

dispatch

public <E extends Event> void dispatch(E event)

Description copied from interface: EventDispatcher

Dispatch an event, passing the event to matching registered handlers.

Specified by:

dispatch in interface EventDispatcher

Parameters:

event - - The event to dispatch.