org.openqa.selenium.support.ui
Class WebDriverWait

java.lang.Object
  org.openqa.selenium.support.ui.WebDriverWait

All Implemented Interfaces:

Wait<WebDriver>

public class WebDriverWait
extends java.lang.Object
implements Wait<WebDriver>

An implementation of the Wait interface that makes use of WebDriver. The expected usage is in conjunction with the ExpectedCondition interface.

Because waiting for elements to appear on a page is such a common use-case, this class will silently swallow NotFoundException whilst waiting.

Field Summary

static long

DEFAULT_SLEEP_TIMEOUT

Constructor Summary

protected	WebDriverWait(Clock clock, WebDriver driver, long timeOutInSeconds, long sleepTimeOut)
	WebDriverWait(WebDriver driver, long timeOutInSeconds)
	WebDriverWait(WebDriver driver, long timeOutInSeconds, long sleepInMillis)

Method Summary

protected void	throwTimeoutException(java.lang.String message, java.lang.Exception lastException) Override this method to throw an exception that is idiomatic for a given test infrastructure.
<T> T	until(com.google.common.base.Function<WebDriver,T> isTrue) Implementations should wait until the condition evaluates to a value that is neither null nor false.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SLEEP_TIMEOUT

public static final long DEFAULT_SLEEP_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

WebDriverWait

public WebDriverWait(WebDriver driver,
                     long timeOutInSeconds)

Parameters:

driver - The WebDriver instance to pass to the expected conditions

timeOutInSeconds - The timeout in seconds when an expectation is called

WebDriverWait

public WebDriverWait(WebDriver driver,
                     long timeOutInSeconds,
                     long sleepInMillis)

Parameters:

driver - The WebDriver instance to pass to the expected conditions

timeOutInSeconds - The timeout in seconds when an expectation is called

sleepInMillis - The duration in milliseconds to sleep between polls.

WebDriverWait

protected WebDriverWait(Clock clock,
                        WebDriver driver,
                        long timeOutInSeconds,
                        long sleepTimeOut)

Parameters:

clock - The clock to use when measuring the timeout

driver - The WebDriver instance to pass to the expected conditions

timeOutInSeconds - The timeout in seconds when an expectation is

sleepTimeOut - The timeout used whilst sleeping. Defaults to 500ms called

Method Detail

until

public <T> T until(com.google.common.base.Function<WebDriver,T> isTrue)

Implementations should wait until the condition evaluates to a value that is neither null nor false. Because of this contract, the return type must not be Void.

If the condition does not become true within a certain time (as defined by the implementing class), this method will throw a non-specified Throwable. This is so that an implementor may throw whatever is idiomatic for a given test infrastructure (e.g. JUnit4 would throw AssertionError.

Specified by:

until in interface Wait<WebDriver>

Type Parameters:

T - the return type of the method, which must not be Void

Parameters:

isTrue - the parameter to pass to the ExpectedCondition

throwTimeoutException

protected void throwTimeoutException(java.lang.String message,
                                     java.lang.Exception lastException)

Override this method to throw an exception that is idiomatic for a given test infrastructure. E.g. JUnit4 should throw an AssertionError