org.jboss.util
Class TimerTask

java.lang.Object
  org.jboss.util.TimerTask

All Implemented Interfaces:

java.lang.Comparable, Executable (src)

public abstract class TimerTask

extends java.lang.Object

implements Executable (src) , java.lang.Comparable

A class that represent a task that can be scheduled for one-shot or repeated execution by a TimerQueue (src) .

A similar class is present in java.util package of jdk version >= 1.3; for compatibility with jdk 1.2 we reimplemented it.

See Also:

TimerQueue (src)

TimerTask

protected TimerTask()

Creates a TimerTask object that will be executed once.

TimerTask

protected TimerTask(long period)

Creates a TimerTask object that will be executed every period milliseconds.

Parameters:

period - the execution period; if zero, will be executed only once.

cancel

public boolean cancel()

Cancels the next execution of this TimerTask (if any).
If the TimerTask is executing it will prevent the next execution (if any).

execute

public abstract void execute()
                      throws java.lang.Exception

The task to be executed, to be implemented in subclasses.

Specified by:

execute in interface Executable (src)

Throws:

java.lang.Exception

compareTo

public int compareTo(java.lang.Object other)

A TimerTask is less than another if it will be scheduled before.

Specified by:

compareTo in interface java.lang.Comparable

Throws:

java.lang.ClassCastException - if other is not a TimerTask, according to the Comparable contract

getPeriod

protected long getPeriod()

Returns the period of this TimerTask