org.jboss.arquillian.ajocado.waiting
Interface Waiting<T extends Waiting<T>>

Type Parameters:

T - the end implementation of Waiting to return by methods on Waiting

All Known Subinterfaces:

AjaxWaiting, SeleniumWaiting

All Known Implementing Classes:

DefaultAjaxWaiting, DefaultSeleniumWaiting, DefaultWaiting

public interface Waiting<T extends Waiting<T>>

Interface for implementations of waiting for satisfaction of condition.

Implementations should keep contract of immutability.

Version:

$Revision$

Author:

Lukas Fryc

Method Summary

T	dontFail() Sets no failure after waiting timeout.
T	failWith(CharSequence failureMessage, Object... arguments) Returns preset instance of waiting with given failure message parametrized by given objects.
T	failWith(Exception exception) Returns Waiting object initialized with given exception.
T	interval(long interval) Returns instance of waiting with same properties like this object and interval set to given interval.
T	noDelay() Sets no delay between start of waiting and first test for conditions.
T	timeout(long timeout) Returns instance of waiting with same properties like this object and timeout set to given timeout.
void	waitForTimeout() Waits for predefined amount of time (see timeout(long)).
T	withDelay(boolean isDelayed) Set if testing condition should be delayed of one interval after the start of waiting.

Method Detail

interval

T 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

T 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

T 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

T failWith(CharSequence failureMessage,
           Object... arguments)

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

To parametrize failure message, the 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

T 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

T noDelay()

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

Returns:

Waiting instance initialized with no delay

withDelay

T 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

waitForTimeout

void waitForTimeout()

Waits for predefined amount of time (see timeout(long)).