com.hp.util.concurrent

Class Blocker

java.lang.Object

com.hp.util.concurrent.Blocker

public final class Blocker
extends Object

A class that blocks the current thread until some condition is met.

This class should be used when the condition has to be evaluated and a notification is not possible; if it is possible to get a notification when the condition may change Object.wait() and Object.notify()/ Object.notifyAll() should be used instead (See Waiter which should be the preferred method if possible).

If the thread does not need to be blocked, but a condition change notification is still not possible, use AsyncWaiter instead.

Author:

Fabiel Zuniga

Method Summary

Methods

Modifier and Type	Method and Description
static void	wait(Condition condition, int retries, javax.measure.Measurable<javax.measure.quantity.Duration> period) Blocks the current thread if the condition isn't true until it becomes true or the maximum number of retries has been reached.
static void	wait(Condition condition, javax.measure.Measurable<javax.measure.quantity.Duration> period) Blocks the current thread if the condition isn't true until it becomes true.

Methods inherited from class java.lang.Object

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

Method Detail

wait

public static void wait(Condition condition,
        int retries,
        javax.measure.Measurable<javax.measure.quantity.Duration> period)
                 throws NullPointerException,
                        IllegalArgumentException,
                        InterruptedException

Blocks the current thread if the condition isn't true until it becomes true or the maximum number of retries has been reached.

The Blocker may unblock even if the condition has not been met if the maximum number of retries is reached, thus it is recommended to evaluate the condition after the Blocker unblocks.

Parameters:

condition - condition to evaluate

retries - maximum number of retries

period - duration of one cycle in a repeating event; condition evaluation period or delay between retries (time the thread will be in sleep mode until a new evaluation is performed)

Throws:

NullPointerException - if eithercondition or delay is null

InterruptedException - if any thread has interrupted the current thread

IllegalArgumentException - if retries is less or equals to zero

wait

public static void wait(Condition condition,
        javax.measure.Measurable<javax.measure.quantity.Duration> period)
                 throws NullPointerException,
                        InterruptedException

Blocks the current thread if the condition isn't true until it becomes true.

Parameters:

condition - condition to evaluate

period - duration of one cycle in a repeating event; condition evaluation period

Throws:

NullPointerException - if eithercondition or delay is null

InterruptedException - if any thread has interrupted the current thread