com.opera.core.systems.internal

Class CallbackWait

java.lang.Object

com.opera.core.systems.internal.CallbackWait

Direct Known Subclasses:

ImplicitWait

public abstract class CallbackWait
extends Object

A variation of Selenium's Wait that uses Callable and that may have its timeout and polling interval configured on the fly. Each CallbackWait 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 NoSuchElementException when searching for an element on the page.

Constructor Summary

Constructors

Constructor and Description
CallbackWait() Callback with a fresh clock and a the system's default thread sleeper.
CallbackWait(org.openqa.selenium.support.ui.Clock clock, org.openqa.selenium.support.ui.Sleeper sleeper) Callback with a specified clock and sleeper.

Method Summary

Methods

Modifier and Type	Method and Description
CallbackWait	ignoreAll(Collection<Class<? extends RuntimeException>> types) Configures this instance to ignore specific types of exceptions while waiting for a condition.
CallbackWait	ignoring(Class<? extends RuntimeException> exceptionType)
CallbackWait	ignoring(Class<? extends RuntimeException> firstType, Class<? extends RuntimeException> secondType)
CallbackWait	pollingEvery(org.openqa.selenium.support.ui.Duration interval) Sets how often the condition should be evaluated.
protected RuntimeException	timeoutException(String message, Exception lastException) Throws a timeout exception.
<X> X	until(Callable<X> condition) Repeatedly applies this instance's input value to the given callable 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.
CallbackWait	withMessage(String message) Sets the message to be displayed when time expires.
CallbackWait	withTimeout(org.openqa.selenium.support.ui.Duration timeout) 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

CallbackWait

public CallbackWait()

Callback with a fresh clock and a the system's default thread sleeper.

CallbackWait

public CallbackWait(org.openqa.selenium.support.ui.Clock clock,
            org.openqa.selenium.support.ui.Sleeper sleeper)

Callback with a specified clock and sleeper.

Parameters:

clock - the clock to use when measuring the timeout

sleeper - used to put the thread to sleep between evaluation loops

Method Detail

withTimeout

public CallbackWait withTimeout(org.openqa.selenium.support.ui.Duration timeout)

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

Parameters:

timeout - the timeout duration

Returns:

self reference

withMessage

public CallbackWait withMessage(String message)

Sets the message to be displayed when time expires.

Parameters:

message - to be appended to default

Returns:

self reference

pollingEvery

public CallbackWait pollingEvery(org.openqa.selenium.support.ui.Duration interval)

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

Parameters:

interval - the interval duration

Returns:

self reference

ignoreAll

public CallbackWait ignoreAll(Collection<Class<? extends RuntimeException>> 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.

Parameters:

types - the types of exceptions to ignore

Returns:

self reference

ignoring

public CallbackWait ignoring(Class<? extends RuntimeException> exceptionType)

See Also:

ignoreAll(java.util.Collection)

ignoring

public CallbackWait ignoring(Class<? extends RuntimeException> firstType,
                    Class<? extends RuntimeException> secondType)

See Also:

ignoreAll(java.util.Collection)

until

public <X> X until(Callable<X> condition)

Repeatedly applies this instance's input value to the given callable 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.
4. the current thread is interrupted.

Parameters:

condition - the Callable to evaluate

Returns:

the callable's return value

timeoutException

protected RuntimeException timeoutException(String message,
                                Exception lastException)

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.

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