org.richfaces.wait
Class Wait

java.lang.Object
  org.richfaces.wait.Wait

Type Parameters:

T - the end implementation of DefaultWaiting as the return type for setter methods

All Implemented Interfaces:

Cloneable

public class Wait
extends Object
implements Cloneable

Implementation of immutable class with purpose of waiting with customizable timeout, interval, and failure behaviour and delay on start of waiting.

Version:

$Revision$

Author:

Lukas Fryc

Field Summary

static long	DEFAULT_INTERVAL
static long	DEFAULT_TIMEOUT Default waiting timeout

Constructor Summary

Wait()

Method Summary

Wait	dontFail() Sets no failure after waiting timeout.
protected void	fail() Tries to fail by throwing 'failure' throwable.
Wait	failWith(CharSequence failureMessage, Object... arguments) Returns preset instance of waiting with given failure message parametrized by given objects.
Wait	failWith(Exception exception) Returns Waiting object initialized with given exception.
protected long	getInterval() Returns the interval set for this object.
protected long	getTimeout() Returns the timeout set for this object.
Wait	interval(long interval) Returns instance of waiting with same properties like this object and interval set to given interval.
protected boolean	isDelayed() Returns if this waiting's start is delayed.
Wait	noDelay() Sets no delay between start of waiting and first test for conditions.
Wait	timeout(long timeout) Returns instance of waiting with same properties like this object and timeout set to given timeout.
void	until(Condition condition) Stars loop waiting to satisfy condition.
Wait	withDelay(boolean isDelayed) Set if testing condition should be delayed of one interval after the start of waiting.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_INTERVAL

public static final long DEFAULT_INTERVAL

See Also:

Constant Field Values

DEFAULT_TIMEOUT

public static final long DEFAULT_TIMEOUT

Default waiting timeout

See Also:

Constant Field Values

Constructor Detail

Wait

public Wait()

Method Detail

getInterval

protected long getInterval()

Returns the interval set for this object.

Returns:

the set interval

getTimeout

protected long getTimeout()

Returns the timeout set for this object.

Returns:

the timeout set for this object

isDelayed

protected boolean isDelayed()

Returns if this waiting's start is delayed.

Returns:

if this waiting's start is delayed

interval

public Wait interval(long interval)

Returns instance of waiting with same properties like this object and interval set to given interval.

Parameters:

interval - in milliseconds that will be preset to returned instance of Waiting

Returns:

Waiting instance configured with given interval

timeout

public Wait timeout(long timeout)

Returns instance of waiting with same properties like this object and timeout set to given timeout.

Parameters:

timeout - in milliseconds that will be preset to returned instance of Waiting

Returns:

Waiting instance configured with given timeout

failWith

public Wait failWith(Exception exception)

Returns Waiting object initialized with given exception.

If the exception is instance of RuntimeException, it will be thrown in case of waiting timed out.

If the exception isn't instance of RuntimeException, the WaitingTimeoutException will be thrown with cause preset to the given Throwable.

If failure is set to null, timeout will not result to failure!

Parameters:

exception - the instance of RuntimeException to be thrown or any other Exception when the WaitTimeoutException should be thrown with this exception as cause

Returns:

Waiting instance configured with given exception as cause of waiting timeout

failWith

public Wait failWith(CharSequence failureMessage,
                     Object... arguments)

Returns preset instance of waiting with given failure message parametrized by given objects.

To parametrize failure message, the org.jboss.arquillian.ajocado.format.SimplifiedFormat#format(String, Object...) will be used.

If failure is set to null, timeout will not result to failure!

Parameters:

failureMessage - character sequence that will be used as message of exception thrown in case of waiting timeout or null if waiting timeout shouldn't result to failure

arguments - arguments to failureMessage which will be use in parametrization of failureMessage

Returns:

Waiting instance initialized with given failureMessage and arguments

dontFail

public Wait dontFail()

Sets no failure after waiting timeout. Waiting timeout with this preset don't result to failure!

Returns:

Waiting instance initialized with no failure

noDelay

public Wait noDelay()

Sets no delay between start of waiting and first test for conditions.

Returns:

Waiting instance initialized with no delay

withDelay

public Wait withDelay(boolean isDelayed)

Set if testing condition should be delayed of one interval after the start of waiting.

The length of delay is one interval (see interval(long)).

Parameters:

isDelayed - true if start of condition testing should be delayed; false otherwise

Returns:

Waiting instance initialized with the delay before start of testing conditions if isDelayed is set to true; with no delay otherwise

until

public void until(Condition condition)

Stars loop waiting to satisfy condition.

Parameters:

condition - what wait for to be satisfied

fail

protected void fail()

Tries to fail by throwing 'failure' throwable. If failure is instance of RuntimeException, will be directly thrown. Otherwise will be failure clothe to RuntimeException. If failure is null, method wont fail.