ds.funnel.node.task

Class DispatchEventTask<E extends Event,T>

java.lang.Object

ds.funnel.node.task.Task<T>

ds.funnel.node.task.DispatchEventTask<E,T>

All Implemented Interfaces:

EventDispatchHandler<E>, EventHandler<E>, java.lang.Runnable

Direct Known Subclasses:

DispatchReplyTask

public abstract class DispatchEventTask<E extends Event,T>
extends Task<T>
implements EventDispatchHandler<E>

Field Summary

Fields inherited from class ds.funnel.node.task.Task

AUTOSTART, IGNORENULL, RUNONCE

Constructor Summary

Constructors

Constructor and Description
DispatchEventTask(java.lang.Class<E> inType)
DispatchEventTask(int inFlags, java.lang.Class<E> inType)

Method Summary

Modifier and Type	Method and Description
void	cancel()
void	handle(E inEvent, java.lang.Exception ex) Called when a matching event is dispatched.
int	handleOrder()
java.lang.Class<E>	handleType()
void	onCancelHandler() Called when this handler is unregistered with the dispatcher.
void	startTaskEvent()
void	startTaskEvent(EventDispatcher inDispatch)
void	startTaskEvent(EventDispatcher inDispatch, long milliTimeout)

Methods inherited from class ds.funnel.node.task.Task

chainTask, getResult, getResult, getResultNow, isCancelled, run, startTask

Methods inherited from class java.lang.Object

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

Constructor Detail

DispatchEventTask

public DispatchEventTask(java.lang.Class<E> inType)

DispatchEventTask

public DispatchEventTask(int inFlags,
                         java.lang.Class<E> inType)

Method Detail

handleType

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

Specified by:

handleType in interface EventDispatchHandler<E extends Event>

Returns:

The event class that this handler accepts.

handleOrder

public int handleOrder()

Specified by:

handleOrder in interface EventDispatchHandler<E extends Event>

Returns:

The relative order that this handler will be called.

handle

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

Description copied from interface: EventDispatchHandler

Called when a matching event is dispatched.

Specified by:

handle in interface EventDispatchHandler<E extends Event>

Specified by:

handle in interface EventHandler<E extends Event>

Parameters:

inEvent - - The dispatched event.

ex - - An exception to pass to the handler

startTaskEvent

public final void startTaskEvent()

startTaskEvent

public final void startTaskEvent(EventDispatcher inDispatch)

startTaskEvent

public final void startTaskEvent(EventDispatcher inDispatch,
                                 long milliTimeout)

onCancelHandler

public final void onCancelHandler()

Description copied from interface: EventDispatchHandler

Called when this handler is unregistered with the dispatcher.

Specified by:

onCancelHandler in interface EventDispatchHandler<E extends Event>

cancel

public final void cancel()

Overrides:

cancel in class Task<T>