Package org.jboss.arquillian.graphene.wait

Interface WebDriverWait<FLUENT>

All Superinterfaces:

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

public interface WebDriverWait<FLUENT>
extends FluentWait<org.openqa.selenium.WebDriver,FLUENT>

Author:

Jan Papousek

Method Summary

Modifier and Type	Method	Description
<ACTION> FLUENT	commit(ACTION action)	Closes the fluent definition and indicates that it can be applied.
<K extends Throwable> FluentWait<org.openqa.selenium.WebDriver,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<org.openqa.selenium.WebDriver,FLUENT>	ignoring(Class<? extends Throwable> exceptionType)
<K extends Throwable> FluentWait<org.openqa.selenium.WebDriver,FLUENT>	ignoring(Class<? extends Throwable> firstType, Class<? extends Throwable> secondType)
FluentWait<org.openqa.selenium.WebDriver,FLUENT>	pollingEvery(long duration, TimeUnit unit)	Sets how often the condition should be evaluated.
FluentWait<org.openqa.selenium.WebDriver,FLUENT>	pollingEvery(Duration duration)	Sets how often the condition should be evaluated.
FluentBuilder<FLUENT>	until()	Returns the fluent condition builder.
FluentBuilder<FLUENT>	until(String failMessage)	Returns the fluent condition builder.
<T> T	until(Function<? super org.openqa.selenium.WebDriver,T> isTrue)
FluentWait<org.openqa.selenium.WebDriver,FLUENT>	withMessage(String message)	Sets the message to be displayed when time expires.
FluentWait<org.openqa.selenium.WebDriver,FLUENT>	withTimeout(long duration, TimeUnit unit)	Sets how long to wait for the evaluated condition to be true.
FluentWait<org.openqa.selenium.WebDriver,FLUENT>	withTimeout(Duration duration)	Sets how long to wait for the evaluated condition to be true.

Method Details

withMessage

FluentWait<org.openqa.selenium.WebDriver,FLUENT> withMessage(String message)

Description copied from interface: FluentWait

Sets the message to be displayed when time expires.

Specified by:

withMessage in interface FluentWait<org.openqa.selenium.WebDriver,FLUENT>

Parameters:

message - to be appended to default.

Returns:

A self reference.

withTimeout

FluentWait<org.openqa.selenium.WebDriver,FLUENT> withTimeout(long duration,
 TimeUnit unit)

Description copied from interface: FluentWait

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

Specified by:

withTimeout in interface FluentWait<org.openqa.selenium.WebDriver,FLUENT>

Parameters:

duration - The timeout duration.

unit - The unit of time.

Returns:

A self reference.

withTimeout

FluentWait<org.openqa.selenium.WebDriver,FLUENT> withTimeout(Duration duration)

Description copied from interface: FluentWait

Sets how long to wait for the evaluated condition to be true. The default timeout is 500ms. It is an alternative for FluentWait.withTimeout(long, TimeUnit)

Specified by:

withTimeout in interface FluentWait<org.openqa.selenium.WebDriver,FLUENT>

pollingEvery

FluentWait<org.openqa.selenium.WebDriver,FLUENT> pollingEvery(long duration,
 TimeUnit unit)

Description copied from interface: FluentWait

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.

Specified by:

pollingEvery in interface FluentWait<org.openqa.selenium.WebDriver,FLUENT>

Parameters:

duration - The timeout duration.

unit - The unit of time.

Returns:

A self reference.

pollingEvery

FluentWait<org.openqa.selenium.WebDriver,FLUENT> pollingEvery(Duration duration)

Description copied from interface: FluentWait

Sets how often the condition should be evaluated. It is an alternative for FluentWait.pollingEvery(long, TimeUnit)

Specified by:

pollingEvery in interface FluentWait<org.openqa.selenium.WebDriver,FLUENT>

ignoreAll

<K extends Throwable>
FluentWait<org.openqa.selenium.WebDriver,FLUENT> ignoreAll(Collection<Class<? extends K>> types)

Description copied from interface: FluentWait

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.

Specified by:

ignoreAll in interface FluentWait<org.openqa.selenium.WebDriver,FLUENT>

Parameters:

types - The types of exceptions to ignore.

Returns:

A self reference.

ignoring

<K extends Throwable>
FluentWait<org.openqa.selenium.WebDriver,FLUENT> ignoring(Class<? extends Throwable> exceptionType)

Specified by:

ignoring in interface FluentWait<org.openqa.selenium.WebDriver,FLUENT>

See Also:

• FluentWait.ignoreAll(Collection)

ignoring

<K extends Throwable>
FluentWait<org.openqa.selenium.WebDriver,FLUENT> ignoring(Class<? extends Throwable> firstType,
 Class<? extends Throwable> secondType)

Specified by:

ignoring in interface FluentWait<org.openqa.selenium.WebDriver,FLUENT>

See Also:

• FluentWait.ignoreAll(Collection)

until

FluentBuilder<FLUENT> until()

Description copied from interface: FluentWait

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

Specified by:

until in interface FluentWait<org.openqa.selenium.WebDriver,FLUENT>

until

FluentBuilder<FLUENT> until(String failMessage)

Description copied from interface: FluentWait

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

Specified by:

until in interface FluentWait<org.openqa.selenium.WebDriver,FLUENT>

Parameters:

failMessage - message used when the waiting fails

until

<T> T until(Function<? super org.openqa.selenium.WebDriver,T> isTrue)

Specified by:

until in interface org.openqa.selenium.support.ui.Wait<FLUENT>

commit

<ACTION> FLUENT commit(ACTION action)

Description copied from interface: FluentBase

Closes the fluent definition and indicates that it can be applied.

Specified by:

commit in interface FluentBase<FLUENT>

Returns:

the committed fluent definition