com.programix.thread
Class Waiter.Condition

java.lang.Object
  com.programix.thread.Waiter.Condition

Enclosing class:

Waiter

public class Waiter.Condition
extends Object

Used to associate additional conditions on an existing Waiter.

Author:

Paul Hyde

Method Summary

Waiter	getOwner() Returns the Waiter that owns this condition.
boolean	isFalse() Returns true if the expression specified at construction currently evaluates to false.
boolean	isTrue() Returns true if the expression specified at construction currently evaluates to true.
void	waitUntilTrue() Waits (for an unlimited amount of time) for the supplied expression to evaluate to true.
boolean	waitUntilTrue(long msTimeout) Waits (up to a maximum amount of time) for the supplied expression to evaluate to true.
void	waitUntilTrueWithTimedOutException(long msTimeout) Waits (up to a maximum amount of time) for the supplied expression to evaluate to true.
void	waitWhileTrue() Waits (for an unlimited amount of time) for the supplied expression to evaluate to false.
boolean	waitWhileTrue(long msTimeout) Waits (up to a maximum amount of time) for the supplied expression to evaluate to false.
void	waitWhileTrueWithTimedOutException(long msTimeout) Waits (up to a maximum amount of time) for the supplied expression to evaluate to false.

Methods inherited from class java.lang.Object

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

Method Detail

isTrue

public boolean isTrue()
               throws ShutdownException

Returns true if the expression specified at construction currently evaluates to true.

Throws:

ShutdownException - if already shutdown.

isFalse

public boolean isFalse()
                throws ShutdownException

Returns true if the expression specified at construction currently evaluates to false.

Throws:

ShutdownException - if already shutdown.

waitUntilTrue

public boolean waitUntilTrue(long msTimeout)
                      throws InterruptException,
                             ShutdownException

Waits (up to a maximum amount of time) for the supplied expression to evaluate to true. Uses a return value to signal whether or not a timeout occurred. See the Universal Behavior section in the class-level documentation of Waiter for details about the timeouts, return values, exceptions potentially thrown, and other general behavior.

Throws:

InterruptException

ShutdownException

waitUntilTrue

public void waitUntilTrue()
                   throws InterruptException,
                          ShutdownException

Waits (for an unlimited amount of time) for the supplied expression to evaluate to true. See the Universal Behavior section in the class-level documentation of Waiter for details about the timeouts, return values, exceptions potentially thrown, and other general behavior.

Throws:

InterruptException

ShutdownException

waitUntilTrueWithTimedOutException

public void waitUntilTrueWithTimedOutException(long msTimeout)
                                        throws InterruptException,
                                               TimedOutException,
                                               ShutdownException

Waits (up to a maximum amount of time) for the supplied expression to evaluate to true. Throws TimedOutException to signal that a timeout occurred. See the Universal Behavior section in the class-level documentation of Waiter for details about the timeouts, return values, exceptions potentially thrown, and other general behavior.

Throws:

InterruptException

TimedOutException

ShutdownException

waitWhileTrue

public boolean waitWhileTrue(long msTimeout)
                      throws InterruptException,
                             ShutdownException

Waits (up to a maximum amount of time) for the supplied expression to evaluate to false. Uses a return value to signal whether or not a timeout occurred. See the Universal Behavior section in the class-level documentation of Waiter for details about the timeouts, return values, exceptions potentially thrown, and other general behavior.

Throws:

InterruptException

ShutdownException

waitWhileTrue

public void waitWhileTrue()
                   throws InterruptException,
                          ShutdownException

Waits (for an unlimited amount of time) for the supplied expression to evaluate to false. See the Universal Behavior section in the class-level documentation of Waiter for details about the timeouts, return values, exceptions potentially thrown, and other general behavior.

Throws:

InterruptException

ShutdownException

waitWhileTrueWithTimedOutException

public void waitWhileTrueWithTimedOutException(long msTimeout)
                                        throws InterruptException,
                                               TimedOutException,
                                               ShutdownException

Waits (up to a maximum amount of time) for the supplied expression to evaluate to false. Throws TimedOutException to signal that a timeout occurred. See the Universal Behavior section in the class-level documentation of Waiter for details about the timeouts, return values, exceptions potentially thrown, and other general behavior.

Throws:

InterruptException

TimedOutException

ShutdownException

getOwner

public Waiter getOwner()

Returns the Waiter that owns this condition.