org.fluentlenium.core.wait

Class FluentWait

java.lang.Object

org.fluentlenium.core.wait.FluentWait

All Implemented Interfaces:

FluentWaitConditions<FluentWait>, FluentWaitConfiguration<FluentWait>, FluentWaitFunctional<FluentControl>, org.openqa.selenium.support.ui.Wait<FluentControl>

public class FluentWait
extends java.lang.Object
implements FluentWaitFunctional<FluentControl>, FluentWaitConditions<FluentWait>, FluentWaitConfiguration<FluentWait>

A wait object wrapping default selenium FluentWait object into a more complete API, allowing to wait for any condition to be verified.

Constructor Summary

Constructors

Constructor and Description
FluentWait(FluentControl control) Creates a new fluent wait.

Method Summary

Modifier and Type	Method and Description
FluentWait	atMost(java.time.Duration duration) Configure timeout for this wait object.
FluentWait	atMost(long duration) Configure wait timeout for this wait object.
FluentWait	atMost(long duration, java.util.concurrent.TimeUnit unit) Configure timeout for this wait object.
FluentWait	explicitlyFor(long amount) Waits unconditionally for an explicit amount of time.
FluentWait	explicitlyFor(long amount, java.util.concurrent.TimeUnit timeUnit) Waits unconditionally for an explicit amount of time.
org.openqa.selenium.support.ui.FluentWait	getWait() Get the underlying selenium wait object
boolean	hasMessageDefined() Check if a message is defined.
FluentWait	ignoreAll(java.util.Collection<java.lang.Class<? extends java.lang.Throwable>> types) Add given exceptions to ignore list to avoid breaking the wait when they occurs in the underlying condition evaluation.
FluentWait	ignoring(java.lang.Class<? extends java.lang.RuntimeException> exceptionType) Add given exception to ignore list to avoid breaking the wait when they occurs in the underlying condition evaluation.
FluentWait	ignoring(java.lang.Class<? extends java.lang.RuntimeException> firstType, java.lang.Class<? extends java.lang.RuntimeException> secondType) Add given exceptions to ignore list to avoid breaking the wait when they occurs in the underlying condition evaluation.
FluentWait	pollingEvery(java.time.Duration duration) Configure polling time for this wait object.
FluentWait	pollingEvery(long duration) Configure polling time for this wait object.
FluentWait	pollingEvery(long duration, java.util.concurrent.TimeUnit unit) Configure polling time for this wait object.
FluentConditions	until(FluentWebElement element) Get a conditions object used to wait for condition on given element.
<T> T	until(java.util.function.Function<? super FluentControl,T> function) Wait until the function returns a non-null and non-false object.
FluentListConditions	until(java.util.List<? extends FluentWebElement> elements) Get a conditions object used to wait for a condition on given elements.
void	until(java.util.function.Supplier<java.lang.Boolean> booleanSupplier) Wait until the supplier returns true.
FluentListConditions	untilEach(java.util.List<? extends FluentWebElement> elements) Get a conditions object used to wait for a condition on given elements.
FluentListConditions	untilEachElements(java.util.function.Supplier<? extends java.util.List<? extends FluentWebElement>> elements) Get a conditions object used to wait for a condition on given elements.
FluentConditions	untilElement(java.util.function.Supplier<? extends FluentWebElement> element) Get a conditions object used to wait for a condition on given element.
FluentListConditions	untilElements(java.util.function.Supplier<? extends java.util.List<? extends FluentWebElement>> elements) Get a conditions object used to wait for a condition on given elements.
FluentWaitPageConditions	untilPage() Get a condition object used to wait for a page condition.
FluentWaitPageConditions	untilPage(FluentPage page) Get a condition object used to wait for a page condition.
void	untilPredicate(java.util.function.Predicate<FluentControl> predicate) Wait until the predicate returns true.
FluentWaitWindowConditions	untilWindow(java.lang.String windowName) Get a condition object used to wait for a window condition.
FluentWait	withMessage(java.lang.String message) Configures a custom message to be used if the condition fails during the timeout duration.
FluentWait	withMessage(java.util.function.Supplier<java.lang.String> message) Configures a custom message supplier to be used if the condition fails during the timeout duration.
FluentWait	withNoDefaultsException() Removes default exceptions from exceptions ignore list.

Methods inherited from class java.lang.Object

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

Constructor Detail

FluentWait

public FluentWait(FluentControl control)

Creates a new fluent wait.

Parameters:

control - control interface

Method Detail

getWait

public org.openqa.selenium.support.ui.FluentWait getWait()

Description copied from interface: FluentWaitConfiguration

Get the underlying selenium wait object

Specified by:

getWait in interface FluentWaitConfiguration<FluentWait>

Returns:

selenium wait

atMost

public FluentWait atMost(java.time.Duration duration)

Description copied from interface: FluentWaitConfiguration

Configure timeout for this wait object.

Specified by:

atMost in interface FluentWaitConfiguration<FluentWait>

Parameters:

duration - duration

Returns:

this object to chain method calls

atMost

public FluentWait atMost(long duration,
                         java.util.concurrent.TimeUnit unit)

Description copied from interface: FluentWaitConfiguration

Configure timeout for this wait object.

Specified by:

atMost in interface FluentWaitConfiguration<FluentWait>

Parameters:

duration - duration

unit - time unit

Returns:

this object to chain method calls

atMost

public FluentWait atMost(long duration)

Description copied from interface: FluentWaitConfiguration

Configure wait timeout for this wait object.

Specified by:

atMost in interface FluentWaitConfiguration<FluentWait>

Parameters:

duration - duration in millisecond

Returns:

this object to chain method calls

pollingEvery

public FluentWait pollingEvery(java.time.Duration duration)

Description copied from interface: FluentWaitConfiguration

Configure polling time for this wait object.

Specified by:

pollingEvery in interface FluentWaitConfiguration<FluentWait>

Parameters:

duration - duration between each condition invocation

Returns:

this object to chain method calls

pollingEvery

public FluentWait pollingEvery(long duration,
                               java.util.concurrent.TimeUnit unit)

Description copied from interface: FluentWaitConfiguration

Configure polling time for this wait object.

Specified by:

pollingEvery in interface FluentWaitConfiguration<FluentWait>

Parameters:

duration - duration between each condition invocation

unit - time unit

Returns:

this object to chain method calls

pollingEvery

public FluentWait pollingEvery(long duration)

Description copied from interface: FluentWaitConfiguration

Configure polling time for this wait object.

Specified by:

pollingEvery in interface FluentWaitConfiguration<FluentWait>

Parameters:

duration - duration in millisecond between each condition invocation

Returns:

this object to chain method calls

ignoreAll

public FluentWait ignoreAll(java.util.Collection<java.lang.Class<? extends java.lang.Throwable>> types)

Description copied from interface: FluentWaitConfiguration

Add given exceptions to ignore list to avoid breaking the wait when they occurs in the underlying condition evaluation.

Specified by:

ignoreAll in interface FluentWaitConfiguration<FluentWait>

Parameters:

types - collection of exception type to ignore

Returns:

this object to chain method calls

ignoring

public FluentWait ignoring(java.lang.Class<? extends java.lang.RuntimeException> exceptionType)

Description copied from interface: FluentWaitConfiguration

Add given exception to ignore list to avoid breaking the wait when they occurs in the underlying condition evaluation.

Specified by:

ignoring in interface FluentWaitConfiguration<FluentWait>

Parameters:

exceptionType - exception type to ignore

Returns:

this object to chain method calls

ignoring

public FluentWait ignoring(java.lang.Class<? extends java.lang.RuntimeException> firstType,
                           java.lang.Class<? extends java.lang.RuntimeException> secondType)

Description copied from interface: FluentWaitConfiguration

Add given exceptions to ignore list to avoid breaking the wait when they occurs in the underlying condition evaluation.

Specified by:

ignoring in interface FluentWaitConfiguration<FluentWait>

Parameters:

firstType - exception type to ignore

secondType - exception type to ignore

Returns:

this object to chain method calls

withMessage

public FluentWait withMessage(java.lang.String message)

Description copied from interface: FluentWaitConfiguration

Configures a custom message to be used if the condition fails during the timeout duration.

Specified by:

withMessage in interface FluentWaitConfiguration<FluentWait>

Parameters:

message - failing message

Returns:

this object to chain method calls

withMessage

public FluentWait withMessage(java.util.function.Supplier<java.lang.String> message)

Description copied from interface: FluentWaitConfiguration

Configures a custom message supplier to be used if the condition fails during the timeout duration.

Specified by:

withMessage in interface FluentWaitConfiguration<FluentWait>

Parameters:

message - failing message

Returns:

this object to chain method calls

withNoDefaultsException

public FluentWait withNoDefaultsException()

Description copied from interface: FluentWaitConfiguration

Removes default exceptions from exceptions ignore list.

Specified by:

withNoDefaultsException in interface FluentWaitConfiguration<FluentWait>

Returns:

this object to chain method calls

hasMessageDefined

public boolean hasMessageDefined()

Check if a message is defined.

Specified by:

hasMessageDefined in interface FluentWaitConfiguration<FluentWait>

Returns:

true if this fluent wait use a custom message, false otherwise

untilPredicate

public void untilPredicate(java.util.function.Predicate<FluentControl> predicate)

Description copied from interface: FluentWaitFunctional

Wait until the predicate returns true.

Specified by:

untilPredicate in interface FluentWaitFunctional<FluentControl>

Parameters:

predicate - predicate condition to wait for

until

public void until(java.util.function.Supplier<java.lang.Boolean> booleanSupplier)

Description copied from interface: FluentWaitFunctional

Wait until the supplier returns true.

Specified by:

until in interface FluentWaitFunctional<FluentControl>

Parameters:

booleanSupplier - supplier condition to wait for.

until

public <T> T until(java.util.function.Function<? super FluentControl,T> function)

Description copied from interface: FluentWaitFunctional

Wait until the function returns a non-null and non-false object.

Specified by:

until in interface FluentWaitFunctional<FluentControl>

Specified by:

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

Type Parameters:

T - type of returned object

Parameters:

function - function returning a non-null and non-false object when condition is verified.

Returns:

object returned by function

until

public FluentConditions until(FluentWebElement element)

Description copied from interface: FluentWaitConditions

Get a conditions object used to wait for condition on given element.

Specified by:

until in interface FluentWaitConditions<FluentWait>

Parameters:

element - element to wait for

Returns:

conditions object

until

public FluentListConditions until(java.util.List<? extends FluentWebElement> elements)

Description copied from interface: FluentWaitConditions

Get a conditions object used to wait for a condition on given elements.

At least one element must verify the condition to be verified.

Specified by:

until in interface FluentWaitConditions<FluentWait>

Parameters:

elements - elements to wait for

Returns:

conditions object

untilEach

public FluentListConditions untilEach(java.util.List<? extends FluentWebElement> elements)

Description copied from interface: FluentWaitConditions

Get a conditions object used to wait for a condition on given elements.

Each element must verify the condition to be verified.

Specified by:

untilEach in interface FluentWaitConditions<FluentWait>

Parameters:

elements - elements to wait for

Returns:

conditions object

untilElement

public FluentConditions untilElement(java.util.function.Supplier<? extends FluentWebElement> element)

Description copied from interface: FluentWaitConditions

Get a conditions object used to wait for a condition on given element.

Specified by:

untilElement in interface FluentWaitConditions<FluentWait>

Parameters:

element - element to wait for

Returns:

conditions object

untilElements

public FluentListConditions untilElements(java.util.function.Supplier<? extends java.util.List<? extends FluentWebElement>> elements)

Description copied from interface: FluentWaitConditions

Get a conditions object used to wait for a condition on given elements.

At least one element must verify the condition to be verified.

Specified by:

untilElements in interface FluentWaitConditions<FluentWait>

Parameters:

elements - elements to wait for

Returns:

conditions object

untilEachElements

public FluentListConditions untilEachElements(java.util.function.Supplier<? extends java.util.List<? extends FluentWebElement>> elements)

Description copied from interface: FluentWaitConditions

Get a conditions object used to wait for a condition on given elements.

Each element must verify the condition to be verified.

Specified by:

untilEachElements in interface FluentWaitConditions<FluentWait>

Parameters:

elements - elements to wait for

Returns:

conditions object

untilWindow

public FluentWaitWindowConditions untilWindow(java.lang.String windowName)

Description copied from interface: FluentWaitConditions

Get a condition object used to wait for a window condition.

Specified by:

untilWindow in interface FluentWaitConditions<FluentWait>

Parameters:

windowName - name of the window to wait for

Returns:

window conditions object

untilPage

public FluentWaitPageConditions untilPage()

Description copied from interface: FluentWaitConditions

Get a condition object used to wait for a page condition.

Specified by:

untilPage in interface FluentWaitConditions<FluentWait>

Returns:

page conditions object

untilPage

public FluentWaitPageConditions untilPage(FluentPage page)

Description copied from interface: FluentWaitConditions

Get a condition object used to wait for a page condition.

Specified by:

untilPage in interface FluentWaitConditions<FluentWait>

Parameters:

page - page to wait for

Returns:

page conditions object

explicitlyFor

public FluentWait explicitlyFor(long amount,
                                java.util.concurrent.TimeUnit timeUnit)

Description copied from interface: FluentWaitConditions

Waits unconditionally for an explicit amount of time.

The method should be used only as a last resort.

In most cases you should wait for some condition, e.g. visibility of particular element on the page.

Specified by:

explicitlyFor in interface FluentWaitConditions<FluentWait>

Parameters:

amount - amount of time

timeUnit - unit of time

Returns:

this object to chain method calls

explicitlyFor

public FluentWait explicitlyFor(long amount)

Description copied from interface: FluentWaitConditions

Waits unconditionally for an explicit amount of time.

The method should be used only as a last resort.

In most cases you should wait for some condition, e.g. visibility of particular element on the page.

Specified by:

explicitlyFor in interface FluentWaitConditions<FluentWait>

Parameters:

amount - amount of time to wait in milliseconds

Returns:

this object to chain method calls