org.mbari.siam.core
Class SiamTimerTask

java.lang.Object
  extended by org.mbari.siam.core.SiamTimerTask
All Implemented Interfaces:
java.lang.Runnable
Direct Known Subclasses:
ScheduleTimerTask, ShoreMessagingService.ShutdownTask

public abstract class SiamTimerTask
extends java.lang.Object
implements java.lang.Runnable

A task that can be scheduled for one-time or repeated execution by a Timer.

Since:
1.3

Modified for SIAM by Bob Herlien, 7/1/2003. No changes to this module except to rename to SiamTimerTask (from java.utils.TimerTask) and to include it in package org.mbari.siam.core

Version:
1.6, 02/02/00
Author:
Josh Bloch
See Also:
Timer

Constructor Summary
protected SiamTimerTask()
          Creates a new timer task.
 
Method Summary
 boolean cancel()
          Cancels this timer task.
abstract  void run()
          The action to be performed by this timer task.
 long scheduledExecutionTime()
          Returns the scheduled execution time of the most recent actual execution of this task.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SiamTimerTask

protected SiamTimerTask()
Creates a new timer task.

Method Detail

run

public abstract void run()
The action to be performed by this timer task.

Specified by:
run in interface java.lang.Runnable

cancel

public boolean cancel()
Cancels this timer task. If the task has been scheduled for one-time execution and has not yet run, or has not yet been scheduled, it will never run. If the task has been scheduled for repeated execution, it will never run again. (If the task is running when this call occurs, the task will run to completion, but will never run again.)

Note that calling this method from within the run method of a repeating timer task absolutely guarantees that the timer task will not run again.

This method may be called repeatedly; the second and subsequent calls have no effect.

Returns:
true if this task is scheduled for one-time execution and has not yet run, or this task is scheduled for repeated execution. Returns false if the task was scheduled for one-time execution and has already run, or if the task was never scheduled, or if the task was already cancelled. (Loosely speaking, this method returns true if it prevents one or more scheduled executions from taking place.)

scheduledExecutionTime

public long scheduledExecutionTime()
Returns the scheduled execution time of the most recent actual execution of this task. (If this method is invoked while task execution is in progress, the return value is the scheduled execution time of the ongoing task execution.)

This method is typically invoked from within a task's run method, to determine whether the current execution of the task is sufficiently timely to warrant performing the scheduled activity:

   public void run() {
       if (System.currentTimeMillis() - scheduledExecutionTime() >=
           MAX_TARDINESS)
               return;  // Too late; skip this execution.
       // Perform the task
   }
 
This method is typically not used in conjunction with fixed-delay execution repeating tasks, as their scheduled execution times are allowed to drift over time, and so are not terribly significant.

Returns:
the time at which the most recent execution of this task was scheduled to occur, in the format returned by Date.getTime(). The return value is undefined if the task has yet to commence its first execution.
See Also:
Date.getTime()


Copyright © 2003 MBARI.

The Monterey Bay Aquarium Research Institute (MBARI) provides this documentation and code "as is", with no warranty, express or implied, of its quality or consistency. It is provided without support and without obligation on the part of MBARI to assist in its use, correction, modification, or enhancement.