org.jboss.arquillian.graphene.wait

Class WebDriverWait<FLUENT>

java.lang.Object

org.jboss.arquillian.graphene.wait.WebDriverWait<FLUENT>

All Implemented Interfaces:

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

public class WebDriverWait<FLUENT>
extends Object
implements FluentWait<org.openqa.selenium.WebDriver,FLUENT>

Author:

Jan Papousek

Constructor Summary

Constructors

Modifier	Constructor and Description
	WebDriverWait(FLUENT fluent, org.openqa.selenium.WebDriver driver, long timeOutInSeconds)
protected	WebDriverWait(org.openqa.selenium.support.ui.WebDriverWait wait, FLUENT fluent)

Method Summary

Methods

Modifier and Type	Method and Description
<ACTION> FLUENT	commit(ACTION action)
<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.
FluentBuilder<FLUENT>	until() Returns the fluent condition builder.
<T> T	until(com.google.common.base.Function<? super org.openqa.selenium.WebDriver,T> isTrue)
void	until(com.google.common.base.Predicate<org.openqa.selenium.WebDriver> 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<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.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebDriverWait

protected WebDriverWait(org.openqa.selenium.support.ui.WebDriverWait wait,
             FLUENT fluent)

WebDriverWait

public WebDriverWait(FLUENT fluent,
             org.openqa.selenium.WebDriver driver,
             long timeOutInSeconds)

Method Detail

withMessage

public 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

public 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 #FIVE_HUNDRED_MILLIS.

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.

pollingEvery

public 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 #FIVE_HUNDRED_MILLIS.

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.

ignoreAll

public <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

public <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

public <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

public void until(com.google.common.base.Predicate<org.openqa.selenium.WebDriver> isTrue)

Description copied from interface: FluentWait

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

Specified by:

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

Parameters:

isTrue - The predicate to wait on.

until

public FluentBuilder<FLUENT> until()

Description copied from interface: FluentWait

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

Specified by:

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

until

public 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 FluentWait.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

public <T> T until(com.google.common.base.Function<? super org.openqa.selenium.WebDriver,T> isTrue)

Specified by:

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

commit

public <ACTION> FLUENT commit(ACTION action)

Specified by:

commit in interface FluentBase<FLUENT>