mx4j.timer

Class TimeTask

Implemented Interfaces:
Comparable, Runnable
Known Direct Subclasses:
TimerTask

public abstract class TimeTask
extends java.lang.Object
implements Comparable, Runnable

A task that is executed at a specified time.

Subclasses implement the periodicity, if needed. Two TimeTasks are compared with their neext execution time.

Version:
$Revision: 1.3 $

Constructor Summary

TimeTask()
Constructor for subclasses

Method Summary

int
compareTo(Object obj)
Compares 2 TimeTasks by comparing their next execution times
boolean
getFixedRate()
Returns whether this task is a fixed rate or fixed delay task.
protected long
getNextExecutionTime()
Returns the next time at which the task will be executed, ie the run() method is called.
protected long
getPeriod()
Returns the period of this task.
protected boolean
isFinished()
Returns whethere this task is finished.
protected boolean
isPeriodic()
Returns whether this task is periodic.
abstract void
run()
The method to implement to have this TimeTask to do something.
protected void
setFinished(boolean value)
Marks this task as finished or not.
protected void
setNextExecutionTime(long time)
Sets the next execution time.

Constructor Details

TimeTask

protected TimeTask()
Constructor for subclasses

Method Details

compareTo

public int compareTo(Object obj)
Compares 2 TimeTasks by comparing their next execution times

getFixedRate

public boolean getFixedRate()
Returns whether this task is a fixed rate or fixed delay task. By default return false

getNextExecutionTime

protected long getNextExecutionTime()

getPeriod

protected long getPeriod()
Returns the period of this task. By default returns 0.

isFinished

protected boolean isFinished()
Returns whethere this task is finished.

isPeriodic

protected boolean isPeriodic()
Returns whether this task is periodic. By default return false.

run

public abstract void run()
The method to implement to have this TimeTask to do something.

setFinished

protected void setFinished(boolean value)
See Also:
isFinished()

setNextExecutionTime

protected void setNextExecutionTime(long time)
Sets the next execution time.

Copyright © 2001-2005 The MX4J Contributors. All Rights Reserved.