net.sf.eBus.util

Class TimerEvent

java.lang.Object

java.util.EventObject

net.sf.eBus.util.TimerEvent

All Implemented Interfaces:

Serializable

public final class TimerEvent
extends EventObject

A TimerEvent event is sent to those TimerTaskListener objects registered with an expired TimerTask.

Note: The event's source is a TimerTask.

Author:

Charles Rapp

See Also:

TimerTask, TimerTaskListener, Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
TimerEvent(TimerTask timerTask, Object value) Creates a timer event for the specified timer task.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancels the underlying timer task.
Object	value() Returns the timer task associated value.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TimerEvent

public TimerEvent(TimerTask timerTask,
                  Object value)

Creates a timer event for the specified timer task. The timer task is the event source. The value is the one passed to TimerTask.TimerTask(net.sf.eBus.util.TimerTaskListener, java.lang.Object).

Parameters:

timerTask - The event source.

value - The timer's associated value. May be null.

See Also:

TimerTask

Method Detail

value

public Object value()

Returns the timer task associated value. May return null.

Returns:

the timer task associated value.

cancel

public void cancel()

Cancels the underlying timer task.

See Also:

TimerTask