| org.itsnat.core.event.TimerHandle
All known Subclasses: org.itsnat.impl.core.listener.domext.TimerEventListenerWrapperImpl,
| TimerHandle | | public interface TimerHandle extends ItsNatUserData(Code) | | Represents a scheduled/timer task by an
ItsNatTimer
author:
Jose Maria Arranz Santamaria |
| Method Summary | |
| public boolean | cancel()
Cancels this timer task. | | public long | getFirstTime()
Returns the time, in the format returned by Date.getTime(), at which
the task was (or is going to be) executed by the first time. | | public ItsNatTimer | getItsNatTimer()
Returns the timer manager this scheduled task belongs to. | | public long | getPeriod()
Returns the time in milliseconds between successive task executions.
the period in milliseconds. | | public long | scheduledExecutionTime()
Returns the scheduled execution time of the most recent
actual execution of this task. |
| cancel | | public boolean cancel()(Code) | | 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
EventListener.handleEvent(Event)
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.
Note: documentation copied (and slightly modified) from
java.util.TimerTask.cancel().
true if this task is scheduled for one-time execution and hasnot yet run, or this task is scheduled for repeated execution.Returns false if the task was scheduled for one-time executionand has already run, or if the task was never scheduled, or ifthe task was already cancelled. (Loosely speaking, this methodreturns true if it prevents one or more scheduledexecutions from taking place.) |
| getFirstTime | | public long getFirstTime()(Code) | | Returns the time, in the format returned by Date.getTime(), at which
the task was (or is going to be) executed by the first time.
the time of the first time. |
| getItsNatTimer | | public ItsNatTimer getItsNatTimer()(Code) | | Returns the timer manager this scheduled task belongs to.
the timer manager. |
| getPeriod | | public long getPeriod()(Code) | | Returns the time in milliseconds between successive task executions.
the period in milliseconds. 0 if the task is executed only once. |
| scheduledExecutionTime | | public long scheduledExecutionTime()(Code) | | 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
EventListener.handleEvent(Event)
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.
Note: documentation copied (and slightly modified) from
java.util.TimerTask.scheduledExecutionTime().
the time at which the most recent execution of this task wasscheduled to occur, in the format returned by Date.getTime().The return value is the same as TimerHandle.getFirstTime() if the task has yet to commenceits first execution. |
|
|