org.openqa.selenium.support.ui

Class WebDriverWait

java.lang.Object

org.openqa.selenium.support.ui.FluentWait<org.openqa.selenium.WebDriver>

org.openqa.selenium.support.ui.WebDriverWait

All Implemented Interfaces:

Wait<org.openqa.selenium.WebDriver>

public class WebDriverWait
extends FluentWait<org.openqa.selenium.WebDriver>

A specialization of FluentWait that uses WebDriver instances.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_SLEEP_TIMEOUT
private org.openqa.selenium.WebDriver	driver

Fields inherited from class org.openqa.selenium.support.ui.FluentWait

FIVE_HUNDRED_MILLIS

Constructor Summary

Constructors

Constructor and Description
WebDriverWait(org.openqa.selenium.WebDriver driver, Clock clock, Sleeper sleeper, long timeOutInSeconds, long sleepTimeOut)
WebDriverWait(org.openqa.selenium.WebDriver driver, long timeOutInSeconds) Wait will ignore instances of NotFoundException that are encountered (thrown) by default in the 'until' condition, and immediately propagate all others.
WebDriverWait(org.openqa.selenium.WebDriver driver, long timeOutInSeconds, long sleepInMillis) Wait will ignore instances of NotFoundException that are encountered (thrown) by default in the 'until' condition, and immediately propagate all others.

Method Summary

Modifier and Type	Method and Description
protected java.lang.RuntimeException	timeoutException(java.lang.String message, java.lang.Throwable lastException) Throws a timeout exception.

Methods inherited from class org.openqa.selenium.support.ui.FluentWait

ignoreAll, ignoring, ignoring, pollingEvery, until, until, withMessage, withMessage, withTimeout

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

driver

private final org.openqa.selenium.WebDriver driver

Constructor Detail

WebDriverWait

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

Wait will ignore instances of NotFoundException that are encountered (thrown) by default in the 'until' condition, and immediately propagate all others. You can add more to the ignore list by calling ignoring(exceptions to add).

Parameters:

driver - The WebDriver instance to pass to the expected conditions

timeOutInSeconds - The timeout in seconds when an expectation is called

See Also:

FluentWait.ignoring(java.lang.Class)

WebDriverWait

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

Wait will ignore instances of NotFoundException that are encountered (thrown) by default in the 'until' condition, and immediately propagate all others. You can add more to the ignore list by calling ignoring(exceptions to add).

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.

See Also:

FluentWait.ignoring(java.lang.Class)

WebDriverWait

public WebDriverWait(org.openqa.selenium.WebDriver driver,
                     Clock clock,
                     Sleeper sleeper,
                     long timeOutInSeconds,
                     long sleepTimeOut)

Parameters:

driver - The WebDriver instance to pass to the expected conditions

clock - The clock to use when measuring the timeout

sleeper - Object used to make the current thread go to sleep.

timeOutInSeconds - The timeout in seconds when an expectation is

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

Method Detail

timeoutException

protected java.lang.RuntimeException timeoutException(java.lang.String message,
                                                      java.lang.Throwable lastException)

Description copied from class: FluentWait

Throws a timeout exception. This method may be overridden to throw an exception that is idiomatic for a particular test infrastructure, such as an AssertionError in JUnit4.

Overrides:

timeoutException in class FluentWait<org.openqa.selenium.WebDriver>

Parameters:

message - The timeout message.

lastException - The last exception to be thrown and subsequently suppressed while waiting on a function.

Returns:

Nothing will ever be returned; this return type is only specified as a convenience.