org.openqa.selenium.support.ui

类 FluentWait<T>

java.lang.Object

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

类型参数:

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

所有已实现的接口:

Wait<T>

直接已知子类:

WebDriverWait

public class FluentWait<T>
extends Object
implements Wait<T>

An implementation of the Wait interface that may have its timeout and polling interval configured on the fly.

Each FluentWait instance defines the maximum amount of time to wait for a condition, as well as the frequency with which to check the condition. Furthermore, the user may configure the wait to ignore specific types of exceptions whilst waiting, such as NoSuchElementExceptions when searching for an element on the page.

Sample usage:

   // Waiting 30 seconds for an element to be present on the page, checking
   // for its presence once every 5 seconds.
   Wait wait = new FluentWait(driver)
       .withTimeout(30, SECONDS)
       .pollingEvery(5, SECONDS)
       .ignoring(NoSuchElementException.class);

   WebElement foo = wait.until(new Function() {
     public WebElement apply(WebDriver driver) {
       return driver.findElement(By.id("foo"));
     }
   });
 

This class makes no thread safety guarantees.

字段概要

字段

限定符和类型	字段和说明
static Duration	FIVE_HUNDRED_MILLIS

构造器概要

构造器

构造器和说明
FluentWait(T input)
FluentWait(T input, Clock clock, Sleeper sleeper)

方法概要

限定符和类型	方法和说明
<K extends Throwable> FluentWait<T>	ignoreAll(Collection<Class<? extends K>> types) Configures this instance to ignore specific types of exceptions while waiting for a condition.
FluentWait<T>	ignoring(Class<? extends Throwable> exceptionType)
FluentWait<T>	ignoring(Class<? extends Throwable> firstType, Class<? extends Throwable> secondType)
FluentWait<T>	pollingEvery(long duration, TimeUnit unit) Sets how often the condition should be evaluated.
<V> V	until(com.google.common.base.Function<? super T,V> isTrue) Repeatedly applies this instance's input value to the given function until one of the following occurs: the function returns neither null nor false, the function throws an unignored exception, the timeout expires, the current thread is interrupted
void	until(com.google.common.base.Predicate<T> isTrue) Repeatedly applies this instance's input value to the given predicate until the timeout expires or the predicate evaluates to true.
FluentWait<T>	withMessage(String message) Sets the message to be displayed when time expires.
FluentWait<T>	withMessage(com.google.common.base.Supplier<String> messageSupplier) Sets the message to be evaluated and displayed when time expires.
FluentWait<T>	withTimeout(long duration, TimeUnit unit) Sets how long to wait for the evaluated condition to be true.

从类继承的方法 java.lang.Object

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

字段详细资料

FIVE_HUNDRED_MILLIS

public static final Duration FIVE_HUNDRED_MILLIS

构造器详细资料

FluentWait

public FluentWait(T input)

参数:

input - The input value to pass to the evaluated conditions.

FluentWait

public FluentWait(T input,
                  Clock clock,
                  Sleeper sleeper)

参数:

input - The input value to pass to the evaluated conditions.

clock - The clock to use when measuring the timeout.

sleeper - Used to put the thread to sleep between evaluation loops.

方法详细资料

withTimeout

public FluentWait<T> withTimeout(long duration,
                                 TimeUnit unit)

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

参数:

duration - The timeout duration.

unit - The unit of time.

返回:

A self reference.

withMessage

public FluentWait<T> withMessage(String message)

Sets the message to be displayed when time expires.

参数:

message - to be appended to default.

返回:

A self reference.

withMessage

public FluentWait<T> withMessage(com.google.common.base.Supplier<String> messageSupplier)

Sets the message to be evaluated and displayed when time expires.

参数:

messageSupplier - to be evaluated on failure and appended to default.

返回:

A self reference.

pollingEvery

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

参数:

duration - The timeout duration.

unit - The unit of time.

返回:

A self reference.

ignoreAll

public <K extends Throwable> FluentWait<T> 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.

类型参数:

K - an Exception that extends Throwable

参数:

types - The types of exceptions to ignore.

返回:

A self reference.

ignoring

public FluentWait<T> ignoring(Class<? extends Throwable> exceptionType)

参数:

exceptionType - exception to ignore

返回:

a self reference

另请参阅:

ignoreAll(Collection)

ignoring

public FluentWait<T> ignoring(Class<? extends Throwable> firstType,
                              Class<? extends Throwable> secondType)

参数:

firstType - exception to ignore

secondType - another exception to ignore

返回:

a self reference

另请参阅:

ignoreAll(Collection)

until

public void until(com.google.common.base.Predicate<T> isTrue)

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

参数:

isTrue - The predicate to wait on.

抛出:

TimeoutException - If the timeout expires.

until

public <V> V until(com.google.common.base.Function<? super T,V> isTrue)

Repeatedly applies this instance's input value to the given function until one of the following occurs:

1. the function returns neither null nor false,
2. the function throws an unignored exception,
3. the timeout expires,
5. the current thread is interrupted

指定者:

until 在接口中 Wait<T>

类型参数:

V - The function's expected return type.

参数:

isTrue - the parameter to pass to the ExpectedCondition

返回:

The functions' return value if the function returned something different from null or false before the timeout expired.

抛出:

TimeoutException - If the timeout expires.