javax.realtime

Class OneShotTimer

java.lang.Object

javax.realtime.AsyncBaseEvent

javax.realtime.AsyncEvent

javax.realtime.Timer

javax.realtime.OneShotTimer

All Implemented Interfaces:

Releasable<Timable,TimeDispatcher>, Timable

public class OneShotTimer
extends Timer

Jamaica Real-Time Specification for Java class OneShotTimer.

This event will fire once at a specified time.

Constructor Summary

Constructors

Constructor and Description
OneShotTimer(HighResolutionTime<?> time, AsyncBaseEventHandler handler) Constructor to create an instance with given time and handler.
OneShotTimer(HighResolutionTime<?> time, AsyncEventHandler handler) Constructor to create an instance with given time and handler.
OneShotTimer(HighResolutionTime<?> start, Clock clock, AsyncBaseEventHandler handler) Constructor to create an instance with given time, clock and handler.
OneShotTimer(HighResolutionTime<?> start, Clock clock, AsyncEventHandler handler) Constructor to create an instance with given time, clock and handler.

Method Summary

Methods inherited from class javax.realtime.Timer

bindTo, createReleaseParameters, destroy, disable, enable, fire, getClock, getDispatcher, getFireTime, getFireTime, isRunning, reschedule, start, start, stop

Methods inherited from class javax.realtime.AsyncEvent

addHandler, addHandler, handledBy, handledBy, removeHandler, removeHandler, setHandler, setHandler, unbindTo

Methods inherited from class javax.realtime.AsyncBaseEvent

hasHandlers

Methods inherited from class java.lang.Object

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

Constructor Detail

OneShotTimer

public OneShotTimer(HighResolutionTime<?> time,
                    AsyncBaseEventHandler handler)

Constructor to create an instance with given time and handler.

Throws:

StaticIllegalArgumentException - if time is a negative RelativeTime.

Parameters:

time - The time when this timer should fire. 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().

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.

OneShotTimer

public OneShotTimer(HighResolutionTime<?> time,
                    AsyncEventHandler handler)

Constructor to create an instance with given time 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:

OneShotTimer(HighResolutionTime, AsyncBaseEventHandler)

OneShotTimer

public OneShotTimer(HighResolutionTime<?> start,
                    Clock clock,
                    AsyncBaseEventHandler handler)

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

Throws:

StaticIllegalArgumentException - if time is a negative RelativeTime.

Parameters:

start - The time when this timer should fire. 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().

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.

OneShotTimer

public OneShotTimer(HighResolutionTime<?> start,
                    Clock clock,
                    AsyncEventHandler handler)

Constructor to create an instance with given time, 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:

OneShotTimer(HighResolutionTime, Clock, AsyncBaseEventHandler)