javax.realtime

Class PeriodicTimer

java.lang.Object

javax.realtime.AsyncBaseEvent

javax.realtime.AsyncEvent

javax.realtime.Timer

javax.realtime.PeriodicTimer

All Implemented Interfaces:

ActiveEvent<Timer,TimeDispatcher>, Releasable<Timer,TimeDispatcher>

public class PeriodicTimer
extends Timer

Jamaica Real-Time Specification for Java class PeriodicTimer.

This timer event fires periodically.

Constructor Summary

Constructors

Constructor and Description
PeriodicTimer(HighResolutionTime<?> start, RelativeTime interval, AsyncBaseEventHandler handler) Constructor to create an instance with given time, interval and handler.
PeriodicTimer(HighResolutionTime<?> start, RelativeTime interval, AsyncEventHandler handler) Constructor to create an instance with given time, interval and handler.
PeriodicTimer(HighResolutionTime<?> start, RelativeTime interval, AsyncEventHandler handler, TimeDispatcher dispatcher) Creates a timer that executes its fire method periodically.
PeriodicTimer(HighResolutionTime<?> start, RelativeTime interval, Clock clock, AsyncBaseEventHandler handler) Constructor to create an instance with given time, interval, clock and handler.
PeriodicTimer(HighResolutionTime<?> start, RelativeTime interval, Clock clock, AsyncEventHandler handler) Constructor to create an instance with given time, interval, clock and handler.

Method Summary

Modifier and Type	Method and Description
ReleaseParameters<?>	createReleaseParameters() createReleaseParameters creates the default release parameters for this event.
AbsoluteTime	getFireTime() getFireTime returns the time at which this timer is expected to fire or skip firing (because it is disabled) next.
RelativeTime	getInterval() getInterval returns the interval of this periodic timer.
PeriodicTimer	setInterval(RelativeTime newinterval) setInterval changes the interval for this periodic timer.

Methods inherited from class javax.realtime.Timer

bindTo, destroy, finalize, fire, getClock, getDispatcher, getEffectiveStartTime, getEffectiveStartTime, getFireTime, getStart, isActive, isRunning, reschedule, setDispatcher, setStartTime, start, start, start, start, stop

Methods inherited from class javax.realtime.AsyncEvent

addHandler, handledBy, removeHandler, setHandler, unbindTo

Methods inherited from class javax.realtime.AsyncBaseEvent

addHandler, disable, enable, handledBy, hasHandlers, removeHandler, setHandler

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.realtime.ActiveEvent

disable, enable

Constructor Detail

PeriodicTimer

public PeriodicTimer(HighResolutionTime<?> start,
                     RelativeTime interval,
                     AsyncBaseEventHandler handler)

Constructor to create an instance with given time, interval and handler.

Throws:

StaticIllegalArgumentException - if time or interval is a negative RelativeTime.

Parameters:

start - The time when this timer should fire first. May be null, in this case this is equal to new RelativeTime(0, 0) and the firing will occur immediately after a call to start().

interval - The interval or null to get a behavior like OneShotTimer.

handler - The handler that will be released when this timer fires. May be null to have no handler until one will be added via addHandler.

Since:

RTSJ 2.0

PeriodicTimer

public PeriodicTimer(HighResolutionTime<?> start,
                     RelativeTime interval,
                     AsyncEventHandler handler)

Constructor to create an instance with given time, interval and handler.

This method has been replaced in RTSJ 2.0 to support the more generic AsyncBaseEventHandler and is kept for binary compatibility.

See Also:

PeriodicTimer(HighResolutionTime, RelativeTime, AsyncBaseEventHandler)

PeriodicTimer

public PeriodicTimer(HighResolutionTime<?> start,
                     RelativeTime interval,
                     Clock clock,
                     AsyncBaseEventHandler handler)

Constructor to create an instance with given time, interval, clock and handler.

Throws:

StaticIllegalArgumentException - if time or interval is a negative RelativeTime.

Parameters:

start - The time when this timer should fire first. May be null, in this case this is equal to new RelativeTime(0, 0) and the firing will occur immediately after a call to start().

interval - The interval or null to get a behavior like OneShotTimer.

clock - the clock this timer should be based upon. May be null to use the default System.getRealtimeClock().

handler - The handler that will be released when this timer fires. May be null to have no handler until one will be added via addHandler.

PeriodicTimer

public PeriodicTimer(HighResolutionTime<?> start,
                     RelativeTime interval,
                     Clock clock,
                     AsyncEventHandler handler)

Constructor to create an instance with given time, interval, clock and handler.

This method has been replaced in RTSJ 2.0 to support the more generic AsyncBaseEventHandler and is kept for binary compatibility.

See Also:

PeriodicTimer(HighResolutionTime, RelativeTime, Clock, AsyncBaseEventHandler)

PeriodicTimer

public PeriodicTimer(HighResolutionTime<?> start,
                     RelativeTime interval,
                     AsyncEventHandler handler,
                     TimeDispatcher dispatcher)
              throws StaticIllegalArgumentException,
                     IllegalAssignmentError,
                     StaticUnsupportedOperationException

Creates a timer that executes its fire method periodically.

Throws:

StaticIllegalArgumentException - when start or interval is a RelativeTime instance with a value less than zero; or the clocks associated with start and interval are not the identical.

IllegalAssignmentError - when this PeriodicTimer cannot hold references to handler, clock and interval.

StaticUnsupportedOperationException - when the Chronograph associated with time is not a Clock.

Parameters:

start - The time that specifies when the first interval begins, based on the clock associated with it. The first firing of the timer is modified according to the PhasingPolicy when the timer is started.

A start value of null is equivalent to a RelativeTime of 0.

interval - The period of the timer. Its usage is based on the clock specified by the clock parameter. When interval is zero or null, the period is ignored and the firing behavior of the PeriodicTimer is that of a OneShotTimer.

handler - The default handler to use for this event. When null, no handler is associated with the timer and nothing will happen when this event fires unless a handler is subsequently associated with the timer using the addHandler() or setHandler() method.

dispatcher - The dispatcher to use for triggering this event.

Since:

RTSJ 2.0

Method Detail

createReleaseParameters

public ReleaseParameters<?> createReleaseParameters()

createReleaseParameters creates the default release parameters for this event. This implementation creates ReleaseParameters using the interval specified for this without cost/ deadline and without overrun or miss handler.

Overrides:

createReleaseParameters in class Timer

Throws:

StaticIllegalStateException - if this timer is destroyed.

Returns:

An instance of ReleaseParameters appropriate for handlers for this event.

getFireTime

public AbsoluteTime getFireTime()

getFireTime returns the time at which this timer is expected to fire or skip firing (because it is disabled) next.

Overrides:

getFireTime in class Timer

Throws:

StaticIllegalStateException - if this timer has been destroyed.

Returns:

a new instance of AbsoluteTime that holds the next firing time.

getInterval

public RelativeTime getInterval()

getInterval returns the interval of this periodic timer.

Throws:

StaticIllegalStateException - if this timer has been destroyed.

Returns:

the interval.

setInterval

public PeriodicTimer setInterval(RelativeTime newinterval)

setInterval changes the interval for this periodic timer.

Throws:

StaticIllegalArgumentException - if time or interval is a negative RelativeTime.

Parameters:

newinterval - the new interval.

Since:

RTSJ 2.0 returns itself