com.aicas.jamaica.lang

Class Wait

java.lang.Object

com.aicas.jamaica.lang.Wait

public class Wait
extends Object

Convenience methods for waiting for monitors, sleeping and joining threads.

These methods do not throw InterruptedException. Their implementation is based on methods in Object or Thread, but have their own handling of InterruptedExeptions. They may be used as drop-in replacements for the corresponding methods in Object and Thread.

If the underlying methods throws an AsynchronouslyInterruptedException or an instance of a subclass, an AsynchronouslyInterruptedError is thrown. This can be used to avoid an endless loop when performing wait(), sleep() or join() in a loop with a catch clause to ignore InterruptedException. In this case, a pending AsynchronouslyInterruptedException would be thrown immediately on the call to wait/sleep/join, causing a live lock.

Constructor Summary

Constructors

Constructor and Description
Wait()

Method Summary

Modifier and Type	Method and Description
static void	checkForAsynchronouslyInterruptedException(InterruptedException exception) Check if given InterruptedException is an AsynchronouslyInterruptedException.
static void	checkPendingAsynchronouslyInterruptedException() In case there is a javax.realtime.control.AsynchronouslyInterruptedException pending for the current thread, this pending exception is thrown.
static void	join(Thread thread) Wait for termination of a given thread.
static InterruptedException	newInterruptedException() Create a new InterruptedException.
static void	sleep(long ms) Convenience method.
static void	sleep(long ms, int ns) Sleep for a given amount of time and ignore all interrupts() or ThreadDeath exceptions.
static void	throwInterruptedException() throws a InterruptedException.
static void	wait(Object obj) Convenience method.
static void	wait(Object obj, long ms) Convenience method.
static void	wait(Object obj, long ms, int ns) Wait for a notify on a given object using Object.wait(long, int) and ignore all interrupts() or ThreadDeath exceptions.

Methods inherited from class java.lang.Object

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

Constructor Detail

Wait

public Wait()

Method Detail

wait

public static void wait(Object obj,
                        long ms,
                        int ns)

Wait for a notify on a given object using Object.wait(long, int) and ignore all interrupts() or ThreadDeath exceptions. Remember the interrupted() state in the current thread. This routine only returns after a notify occurred or the timeout has expired. Any interrupt() that occurred will be recored in the isInterrupted() state of the current thread.

Throws:

IllegalMonitorStateException - if the current thread did not enter obj's monitor.

AsynchronouslyInterruptedError - if the wait was interrupted by an AsynchronouslyInterruptedException.

Parameters:

obj - the object to wait for.

ms - the timeout in milliseconds, 0 for none.

ns - the timeout in nanoseconds, 0 for none.

wait

public static void wait(Object obj,
                        long ms)

Convenience method. wait(obj, ms) is equivalent to wait(obj, ms, 0).

Parameters:

obj - the object to wait for.

ms - the timeout in milliseconds, 0 for none.

wait

public static void wait(Object obj)

Convenience method. wait(obj) is equivalent to wait(obj, 0).

Parameters:

obj - the object to wait for.

sleep

public static void sleep(long ms,
                         int ns)

Sleep for a given amount of time and ignore all interrupts() or ThreadDeath exceptions. Remember the interrupted() state in the current thread.

Throws:

IllegalArgumentException - if millis or nanos is negative or nanos is larger than 999999.

AsynchronouslyInterruptedError - if the wait was interrupted by an AsynchronouslyInterruptedException.

Parameters:

ms - the timeout in milliseconds.

ns - the timeout in nanoseconds.

sleep

public static void sleep(long ms)

Convenience method. Wait.sleep(ms) is equivalent to sleep(ms, 0).

Parameters:

ms - the timeout in milliseconds.

join

public static void join(Thread thread)

Wait for termination of a given thread. This routine only returns after the thread has terminated. Any interrupt() that occurred will be recored in the isInterrupted() state of the current thread.

Throws:

AsynchronouslyInterruptedError - if the wait was interrupted by an AsynchronouslyInterruptedException.

Parameters:

thread - the thread whose termination we are waiting for.

newInterruptedException

public static InterruptedException newInterruptedException()
                                                    throws AsynchronouslyInterruptedException

Create a new InterruptedException. In case there is a pending javax.realtime.control.AsynchronouslyInterruptedException, this pending exception is thrown. Otherwise, a new InterruptedExcpetion is created and returned.

Throws:

AsynchronouslyInterruptedException - in case of a pending javax.realtime.control.AsynchronouslyInterruptedException.

Returns:

a new instance of InterruptedExcpetion.

throwInterruptedException

public static void throwInterruptedException()
                                      throws InterruptedException

throws a InterruptedException. In case there is a pending javax.realtime.control.AsynchronouslyInterruptedException, this pending exception is thrown. Otherwise, a new InterruptedExcpetion is created and thrown instead.

Throws:

InterruptedExcpetion - in any case.

InterruptedException

checkForAsynchronouslyInterruptedException

public static void checkForAsynchronouslyInterruptedException(InterruptedException exception)
                                                       throws AsynchronouslyInterruptedError

Check if given InterruptedException is an AsynchronouslyInterruptedException. If so, throw an AsynchronouslyInterruptedError with cause exception.

Throws:

AsynchronouslyInterruptedError

Parameters:

exception - an InterruptedException

checkPendingAsynchronouslyInterruptedException

public static void checkPendingAsynchronouslyInterruptedException()
                                                           throws AsynchronouslyInterruptedError

In case there is a javax.realtime.control.AsynchronouslyInterruptedException pending for the current thread, this pending exception is thrown. Otherwise, this returns normally.

Throws:

AsynchronouslyInterruptedError - in case an AsynchronouslyInterruptedException was pending