com.qmetry.qaf.automation.ui.util

Class DynamicWait<T>

java.lang.Object

com.qmetry.qaf.automation.ui.util.DynamicWait<T>

Direct Known Subclasses:

QAFWebDriverWait, QAFWebElementWait

public class DynamicWait<T>
extends java.lang.Object

Author:

chirag.jayswal

Constructor Summary

Constructors

Constructor and Description
DynamicWait(T input)

Method Summary

Modifier and Type	Method and Description
static long	duration(long time, java.util.concurrent.TimeUnit unit)
static long	getDefaultInterval()
static long	getDefaultTimeout()
DynamicWait<T>	ignoring(java.lang.Class<? extends java.lang.Throwable>... types) Configures this instance to ignore specific types of exceptions while waiting for a condition.
DynamicWait<T>	pollingEvery(long duration, java.util.concurrent.TimeUnit unit) Sets how often the condition should be evaluated.
<V> V	until(com.google.common.base.Function<? super T,V> isTrue) Repeatedly applies this instance's input value to the given function until one of the following occurs: the function returns neither null nor false, the function throws an unignored exception, the timeout expires, the current thread is interrupted
void	until(com.google.common.base.Predicate<T> isTrue) Repeatedly applies this instance's input value to the given predicate until the timeout expires or the predicate evaluates to true.
DynamicWait<T>	withMessage(java.lang.String message) Sets the message to be displayed when time expires.
DynamicWait<T>	withMessage(com.google.common.base.Supplier<java.lang.String> messageSupplier) Sets the message to be evaluated and displayed when time expires.
DynamicWait<T>	withTimeout(long duration, java.util.concurrent.TimeUnit unit) Sets how long to wait for the evaluated condition to be true.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicWait

public DynamicWait(T input)

Method Detail

withMessage

public DynamicWait<T> withMessage(java.lang.String message)

Sets the message to be displayed when time expires.

Parameters:

message - to be appended to default.

Returns:

A self reference.

withMessage

public DynamicWait<T> withMessage(com.google.common.base.Supplier<java.lang.String> messageSupplier)

Sets the message to be evaluated and displayed when time expires.

Parameters:

messageSupplier - to be evaluated on failure and appended to default.

Returns:

A self reference.

pollingEvery

public DynamicWait<T> pollingEvery(long duration,
                                   java.util.concurrent.TimeUnit unit)

Sets how often the condition should be evaluated.

In reality, the interval may be greater as the cost of actually evaluating a condition function is not factored in. The default polling interval is #FIVE_HUNDRED_MILLIS.

Parameters:

duration - The timeout duration.

unit - The unit of time.

Returns:

A self reference.

until

public void until(com.google.common.base.Predicate<T> isTrue)

Repeatedly applies this instance's input value to the given predicate until the timeout expires or the predicate evaluates to true.

Parameters:

isTrue - The predicate to wait on.

Throws:

org.openqa.selenium.TimeoutException - If the timeout expires.

until

public <V> V until(com.google.common.base.Function<? super T,V> isTrue)

Repeatedly applies this instance's input value to the given function until one of the following occurs:

1. the function returns neither null nor false,
2. the function throws an unignored exception,
3. the timeout expires,
5. the current thread is interrupted

Type Parameters:

V - The function's expected return type.

Parameters:

isTrue - the parameter to pass to the ExpectedCondition

Returns:

The functions' return value if the function returned something different from null or false before the timeout expired.

Throws:

org.openqa.selenium.TimeoutException - If the timeout expires.

withTimeout

public DynamicWait<T> withTimeout(long duration,
                                  java.util.concurrent.TimeUnit unit)

Sets how long to wait for the evaluated condition to be true. The default timeout is #FIVE_HUNDRED_MILLIS.

Parameters:

duration - The timeout duration.

unit - The unit of time.

Returns:

A self reference.

ignoring

@SafeVarargs
public final DynamicWait<T> ignoring(java.lang.Class<? extends java.lang.Throwable>... types)

Configures this instance to ignore specific types of exceptions while waiting for a condition. Any exceptions not whitelisted will be allowed to propagate, terminating the wait.

Type Parameters:

K - an Exception that extends Throwable

Parameters:

types - The types of exceptions to ignore.

Returns:

A self reference.

getDefaultTimeout

public static long getDefaultTimeout()

getDefaultInterval

public static long getDefaultInterval()

duration

public static long duration(long time,
                            java.util.concurrent.TimeUnit unit)