org.jboss.arquillian.graphene.wait

Interface FluentWait<ARG,FLUENT>

Type Parameters:

ARG - The input type for each condition used with this instance.

FLUENT - The type of value returned in the end of fluent chain.

All Superinterfaces:

FluentBase<FLUENT>, org.openqa.selenium.support.ui.Wait<ARG>

All Known Subinterfaces:

WebDriverWait<FLUENT>

public interface FluentWait<ARG,FLUENT>
extends org.openqa.selenium.support.ui.Wait<ARG>, FluentBase<FLUENT>

This interface is a replication of FluentWait. It's here because of a fluent API in Graphene.

Author:

Jan Papousek

Method Summary

Methods

Modifier and Type	Method and Description
<K extends Throwable> FluentWait<ARG,FLUENT>	ignoreAll(Collection<Class<? extends K>> types) Configures this instance to ignore specific types of exceptions while waiting for a condition.
<K extends Throwable> FluentWait<ARG,FLUENT>	ignoring(Class<? extends Throwable> exceptionType)
<K extends Throwable> FluentWait<ARG,FLUENT>	ignoring(Class<? extends Throwable> firstType, Class<? extends Throwable> secondType)
FluentWait<ARG,FLUENT>	pollingEvery(long duration, TimeUnit unit) Sets how often the condition should be evaluated.
FluentBuilder<FLUENT>	until() Returns the fluent condition builder.
void	until(com.google.common.base.Predicate<ARG> isTrue) Repeatedly applies this instance's input value to the given predicate until the timeout expires or the predicate evaluates to true.
FluentBuilder<FLUENT>	until(String failMessage) Returns the fluent condition builder.
FluentWait<ARG,FLUENT>	withMessage(String message) Sets the message to be displayed when time expires.
FluentWait<ARG,FLUENT>	withTimeout(long duration, TimeUnit unit) Sets how long to wait for the evaluated condition to be true.

Methods inherited from interface org.openqa.selenium.support.ui.Wait

until

Methods inherited from interface org.jboss.arquillian.graphene.fluent.FluentBase

commit

Method Detail

withMessage

FluentWait<ARG,FLUENT> withMessage(String message)

Sets the message to be displayed when time expires.

Parameters:

message - to be appended to default.

Returns:

A self reference.

withTimeout

FluentWait<ARG,FLUENT> withTimeout(long duration,
                                 TimeUnit unit)

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

Parameters:

duration - The timeout duration.

unit - The unit of time.

Returns:

A self reference.

pollingEvery

FluentWait<ARG,FLUENT> pollingEvery(long duration,
                                  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 500ms.

Parameters:

duration - The timeout duration.

unit - The unit of time.

Returns:

A self reference.

ignoreAll

<K extends Throwable> FluentWait<ARG,FLUENT> ignoreAll(Collection<Class<? extends K>> 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.

Parameters:

types - The types of exceptions to ignore.

Returns:

A self reference.

ignoring

<K extends Throwable> FluentWait<ARG,FLUENT> ignoring(Class<? extends Throwable> exceptionType)

See Also:

ignoreAll(Collection)

ignoring

<K extends Throwable> FluentWait<ARG,FLUENT> ignoring(Class<? extends Throwable> firstType,
                                                    Class<? extends Throwable> secondType)

See Also:

ignoreAll(Collection)

until

void until(com.google.common.base.Predicate<ARG> 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

FluentBuilder<FLUENT> until()

Returns the fluent condition builder. The builder automatically calls FluentBase.commit(java.lang.Object) which calls until(com.google.common.base.Predicate).

until

FluentBuilder<FLUENT> until(String failMessage)

Returns the fluent condition builder. The builder automatically calls FluentBase.commit(java.lang.Object) which calls until(com.google.common.base.Predicate).

Parameters:

failMessage - message used when the waiting fails