Package net.sf.eBus.util

Class TimerTask

java.lang.Object

java.util.TimerTask

net.sf.eBus.util.TimerTask

All Implemented Interfaces:

Runnable

public final class TimerTask
extends TimerTask

An eBus.util.TimerTask associates a timer task with a TimerTaskListener. When the timer expires, TimerTaskListener.handleTimeout(TimerEvent) where EventObject.getSource() returns the value passed to the TimerTask(TimerTaskListener, Object) constructor.

In eBus v. 4.2.0, TimerTaskListener is marked as a @FunctionalInterface. This allows the listener to be defined using a lambda expression.

If TimerTaskListener.handleTimeout(TimerEvent) throws an exception, the exception stack trace is logged at the warning level.

Author:

Charles Rapp

Constructor Summary

Constructors

Constructor	Description
TimerTask(TimerTaskListener listener)	Creates a new TimerTask.
TimerTask(TimerTaskListener listener, Object value)	Creates a new TimerTask.

Method Summary

Modifier and Type	Method	Description
boolean	cancel()	Cancels this timer task.
void	run()	Tells the listener that this timer has expired.

Methods inherited from class java.util.TimerTask

scheduledExecutionTime

Methods inherited from class java.lang.Object

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

Constructor Detail

TimerTask

public TimerTask(TimerTaskListener listener)

Creates a new TimerTask. This task is sent to the TimerTaskListener when the timer expires. The associated value is null.

Parameters:

listener - Inform this listener of the timeout.

Throws:

NullPointerException - if listener is null.

TimerTask

public TimerTask(TimerTaskListener listener,
                 Object value)

Creates a new TimerTask. This task is sent to TimerTaskListener.handleTimeout(TimerEvent) when the timer expires. The associated value is value.

Parameters:

listener - Inform this listener of the timeout.

value - The associated value passed to the listener. May be null.

Throws:

NullPointerException - if listener is null.

Method Detail

cancel

public boolean cancel()

Cancels this timer task. See java.util.TimerTask.cancel for a detailed description of cancel.

Overrides:

cancel in class TimerTask

Returns:

true if this timer task is scheduled to run once and never ran or is scheduled for repeated execution. Returns false if this task was scheduled to run once and was executed, if this task was never scheduled or if this task is already canceled.

run

public void run()

Tells the listener that this timer has expired.

Note: Do not call this method! This method is part of java.util.TimerTask and should be called by java.util.Timer only.

Specified by:

run in interface Runnable

Specified by:

run in class TimerTask