com.hp.util.concurrent

Class AsyncWaiter

java.lang.Object

com.hp.util.concurrent.AsyncWaiter

public final class AsyncWaiter
extends Object

A task that waits for a condition or predicate to hold. This task is asynchronous.

Waiter should be the preferred method if possible.

Author:

Fabiel Zuniga

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AsyncWaiter.ConditionListener Condition listener.

Method Summary

Methods

Modifier and Type	Method and Description
static Cancelable	wait(Condition condition, AsyncWaiter.ConditionListener conditionListener, int retries, javax.measure.Measurable<javax.measure.quantity.Duration> period, ThreadExecutor threadExecutor) Asynchronously waits for the condition to become true.
static Cancelable	wait(Condition condition, AsyncWaiter.ConditionListener conditionListener, javax.measure.Measurable<javax.measure.quantity.Duration> period, ThreadExecutor threadExecutor) Asynchronously waits for the condition to become true.

Methods inherited from class java.lang.Object

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

Method Detail

wait

public static Cancelable wait(Condition condition,
              AsyncWaiter.ConditionListener conditionListener,
              int retries,
              javax.measure.Measurable<javax.measure.quantity.Duration> period,
              ThreadExecutor threadExecutor)
                       throws NullPointerException,
                              IllegalArgumentException

Asynchronously waits for the condition to become true. This method does not block.

Parameters:

condition - condition to evaluate

conditionListener - listener to notify when the condition is met or missed if no more evaluations will be performed because the maximum number of retries is reached

retries - maximum number of retries

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

threadExecutor - thread executor used to wait asynchronously

Returns:

a Cancelable used to cancel the process

Throws:

NullPointerException - if eithercondition, conditionListener, delay or threadExecutor is null

IllegalArgumentException - if retries is less or equals to zero

wait

public static Cancelable wait(Condition condition,
              AsyncWaiter.ConditionListener conditionListener,
              javax.measure.Measurable<javax.measure.quantity.Duration> period,
              ThreadExecutor threadExecutor)
                       throws NullPointerException

Asynchronously waits for the condition to become true. This method does not block.

Parameters:

condition - condition to evaluate

conditionListener - listener to notify when the condition is met

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

threadExecutor - thread executor used to wait asynchronously

Returns:

a Cancelable used to cancel the process

Throws:

NullPointerException - if eithercondition, conditionListener, delay or threadExecutor is null