javax.realtime
Class PeriodicTimer
java.lang.Object
|
+--javax.realtime.AsyncEvent
|
+--javax.realtime.Timer
|
+--javax.realtime.PeriodicTimer
- public class PeriodicTimer
- extends Timer
An AsyncEvent whose fire method is executed periodically according to the
given parameters. If a clock is given, calculation of the period uses the
increments of the clock. If an interval is given or set the system
guarantees that the fire method will execute interval time units after the
last execution or its given start time as appropriate. If one of the
HighResolutionTime argument types is RationalTime then the system guarantees
that the fire method will be executed exactly frequency times every unit
time (see RationalTime constructors) by adjusting the interval between
executions of fire(). This is similar to a thread with PeriodicParameters
except that it is lighter weight.
If a PeriodicTimer is disabled, it still counts, and if enabled at some later
time, it will fire at its next scheduled fire time.
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PeriodicTimer
public PeriodicTimer(HighResolutionTime start,
RelativeTime interval,
AsyncEventHandler handler)
- Create an instance of AsyncEvent that executes its fire method periodiacally
- Parameters:
start
- The time when the first interval beginsinterval
- The time between successive executions of the fire methodhandler
- The instance of AsyncEventHandler that will be scheduled each
time the fire method is exceuted
PeriodicTimer
public PeriodicTimer(HighResolutionTime start,
RelativeTime interval,
Clock clock,
AsyncEventHandler handler)
- Create an instance of AsyncEvent that executes its fire method periodically
- Parameters:
start
- The time when the first interval beginsinterval
- The time between successive executions of the fire methodclock
- The clock whose increments are used to calculate the intervalhandler
- The instance of AsyncEventHandler that will be scheduled each
time the fire method is executed
createReleaseParameters
public ReleaseParameters createReleaseParameters()
- Create a
ReleaseParameters
object with the next fire time as the
start time and the interval of this
as the period.
- Overrides:
createReleaseParameters
in class Timer
- Returns:
- an instance of ReleaseParameters object
fire
public void fire()
- Causes the instance of the superclass
AsyncEvent
to occur now.
- Overrides:
fire
in class AsyncEvent
getFireTime
public AbsoluteTime getFireTime()
- Return the next time at which this will fire.
- Overrides:
getFireTime
in class Timer
- Following copied from class:
javax.realtime.Timer
- Returns:
- an AbsoluteTime object representing the absolute time at which this will fire.
getInterval
public RelativeTime getInterval()
- Return the interval of this Timer
- Returns:
- a RelativeTime object which is the current interval of this
setInterval
public void setInterval(RelativeTime interval)
- Reset the interval of this Timer
- Parameters:
interval
- A RelativeTime object which is the interval to reset this Timer