eve.sys

Class Handle.WaitOnChange

java.lang.Object

eve.sys.Handle.WaitOnChange

Enclosing class:

Handle

public class Handle.WaitOnChange
extends Object

This class allows you to monitor the state of the Handle without having to maintain the state values yourself. It is NOT thread-safe and is meant to be used by a single Thread.

Constructor Summary

Constructors

Constructor and Description
WaitOnChange()

Method Summary

Modifier and Type	Method and Description
boolean	hasStopped() Return if the Handle has stopped.
boolean	waitForChange() Wait indefinitely for any change in the Handle's state and accept the change when received.
boolean	waitForChange(TimeOut howLong) Wait for any change in the Handle's state and accept the change when received.
boolean	waitInterruptable(TimeOut howLong) Wait for any change in the Handle's state and accept the change when received.

Methods inherited from class java.lang.Object

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

Constructor Detail

WaitOnChange

public WaitOnChange()

Method Detail

hasStopped

public final boolean hasStopped()

Return if the Handle has stopped.

Returns:

waitForChange

public boolean waitForChange(TimeOut howLong)

Wait for any change in the Handle's state and accept the change when received. Note that this method will always return true the first time it is called to allow it to get in sync with the Handle state. Thereafter it will only return true if changed() was called on the Handle or if the Handle stopped.

Parameters:

howLong - the length of time to wait.

Returns:

true if a change was detected OR if the Handle has stopped, in which case the "hasStopped()" method will return true;

waitInterruptable

public boolean waitInterruptable(TimeOut howLong)
                          throws InterruptedException

Wait for any change in the Handle's state and accept the change when received. Note that this method will always return true the first time it is called to allow it to get in sync with the Handle state. Thereafter it will only return true if changed() was called on the Handle or if the Handle stopped.

Parameters:

howLong - the length of time to wait.

Returns:

true if a change was detected OR if the Handle has stopped, in which case the "hasStopped()" method will return true;

Throws:

InterruptedException - if the Thread was interrupted.

waitForChange

public boolean waitForChange()

Wait indefinitely for any change in the Handle's state and accept the change when received. Note that this method will always return true the first time it is called to allow it to get in sync with the Handle state. Thereafter it will only return true if changed() was called on the Handle or if the Handle stopped.

Parameters:

howLong - the length of time to wait.

Returns:

true if a change was detected OR if the Handle has stopped, in which case the "hasStopped()" method will return true;

Throws:

InterruptedException - if the Thread was interrupted.