javax.realtime

Class OneShotTimer

java.lang.Object

javax.realtime.AsyncBaseEvent

javax.realtime.AsyncEvent

javax.realtime.Timer

javax.realtime.OneShotTimer

All Implemented Interfaces:

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

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<?> time, AsyncEventHandler handler, TimeDispatcher dispatcher) Creates an instance of OneShotTimer, based on the given clock, that will execute its fire method according to the given time.
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, finalize, fire, getClock, getDispatcher, getEffectiveStartTime, getEffectiveStartTime, getFireTime, 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

OneShotTimer

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

Constructor to create an instance with given time and handler.

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.

Throws:

StaticIllegalArgumentException - if time is a negative RelativeTime.

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.

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.

Throws:

StaticIllegalArgumentException - if time is a negative RelativeTime.

OneShotTimer

public OneShotTimer(HighResolutionTime<?> time,
                    AsyncEventHandler handler,
                    TimeDispatcher dispatcher)
             throws StaticIllegalArgumentException,
                    StaticUnsupportedOperationException,
                    IllegalAssignmentError

Creates an instance of OneShotTimer, based on the given clock, that will execute its fire method according to the given time. The Clock association of the parameter time is ignored.

Parameters:

time - The time used to determine when to fire the event. A time value of null is equivalent to a RelativeTime of 0, and in this case the Timer fires immediately upon a call to start().

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 used to interface between this timer and its associated clock. When null, the system default dispatcher is used.

Throws:

StaticIllegalArgumentException - when time is a RelativeTime instance less than zero.

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

IllegalAssignmentError - when this OneShotTimer cannot hold references to time, handler, or clock.

Since:

RTSJ 2.0

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)