javax.realtime

Class Timed

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.InterruptedException

javax.realtime.AsynchronouslyInterruptedException

javax.realtime.Timed

All Implemented Interfaces:

Serializable, StaticThrowable<AsynchronouslyInterruptedException>

public class Timed
extends AsynchronouslyInterruptedException

Jamaica Real-Time Specification for Java class Timed.

Timed is a subclass of AsynchronouslyInterruptedException that permit the execution of code provided in an instance of Interruptible with a given time out. After the time out is reached, the code will be interrupted by throwing this instance of AsynchronouslyInterruptedException.

No memory allocation will be performed after the creation of this Timed instance, several invocation of doInterruptible may hence be performed without additional memory allocation.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface javax.realtime.StaticThrowable

StaticThrowable.Hidden

Constructor Summary

Constructors

Constructor and Description
Timed(HighResolutionTime<?> time) Constructor to create a new instance of Timed with the given time out.

Method Summary

Modifier and Type	Method and Description
boolean	doInterruptible(Interruptible logic) doInterruptible executes the run() method of the provided Interruptible logic with the time-out provided to the constructor of this Timed or set via resetTime.
void	resetTime(HighResolutionTime<?> time) resetTime sets the time out for the next invocation of doInterruptible to a new value.

Methods inherited from class javax.realtime.AsynchronouslyInterruptedException

clear, disable, enable, fire, getGeneric, getSingleton, happened, isEnabled, propagate

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.realtime.StaticThrowable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, init, init, init, init, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, writeReplace

Constructor Detail

Timed

public Timed(HighResolutionTime<?> time)
      throws StaticIllegalArgumentException

Constructor to create a new instance of Timed with the given time out.

Throws:

StaticIllegalArgumentException - if time is null.

Parameters:

time - the timeout when the execution the Interruptible logic should be stopped.

Method Detail

doInterruptible

public boolean doInterruptible(Interruptible logic)

doInterruptible executes the run() method of the provided Interruptible logic with the time-out provided to the constructor of this Timed or set via resetTime.

Overrides:

doInterruptible in class AsynchronouslyInterruptedException

Throws:

StaticIllegalArgumentException - iff the provided logic parameter is null.

Parameters:

logic - Contains the run() method that specifies the logic to be executed in an interruptible way.

Returns:

false iff this call failed since this Timed instance is currently running a call to doInterruptible for the current or a different thread.

resetTime

public void resetTime(HighResolutionTime<?> time)

resetTime sets the time out for the next invocation of doInterruptible to a new value.

Parameters:

time - the new time out. It may be null to keep the time out unchanged.