Package org.kquiet.browser

Class ActionComposerBuilder.ActionSequenceBuilder.WaitUntilBuilder<V>

java.lang.Object

org.kquiet.browser.ActionComposerBuilder.ActionSequenceBuilder.WaitUntilBuilder<V>

Type Parameters:

V - the expected return type of condition function

Enclosing class:

ActionComposerBuilder.ActionSequenceBuilder

public class ActionComposerBuilder.ActionSequenceBuilder.WaitUntilBuilder<V>
extends Object

A builder to build WaitUntil in a fluent way.

Constructor Summary

Constructors

Constructor	Description
WaitUntilBuilder(ActionComposerBuilder.ActionSequenceBuilder parentActionSequenceBuilder, Function<org.openqa.selenium.WebDriver,V> conditionFunc, int totalTimeout)	Create a new ActionComposerBuilder.ActionSequenceBuilder.WaitUntilBuilder with specified ActionComposerBuilder.ActionSequenceBuilder as parent builder.

Method Summary

Modifier and Type	Method	Description
ActionComposerBuilder.ActionSequenceBuilder	done()	Finish building WaitUntil and add it to parent builder.
ActionComposerBuilder.ActionSequenceBuilder.WaitUntilBuilder<V>	withIgnoredException(Set<Class<? extends Throwable>> ignoreExceptions)	Set the types of exceptions to ignore when evaluating condition function.
ActionComposerBuilder.ActionSequenceBuilder.WaitUntilBuilder<V>	withPhaseTimeout(int phaseTimeout)	Set the maximum amount of time to wait for each execution phase.
ActionComposerBuilder.ActionSequenceBuilder.WaitUntilBuilder<V>	withPollInterval(int pollInterval)	Set how often the condition function should be evaluated.
ActionComposerBuilder.ActionSequenceBuilder.WaitUntilBuilder<V>	withTimeoutCallback(Consumer<ActionComposer> timeoutCallback)	Set the callback function to be called when total timeout expires.

Methods inherited from class java.lang.Object

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

Constructor Details

WaitUntilBuilder

public WaitUntilBuilder(ActionComposerBuilder.ActionSequenceBuilder parentActionSequenceBuilder,
 Function<org.openqa.selenium.WebDriver,V> conditionFunc,
 int totalTimeout)

Create a new ActionComposerBuilder.ActionSequenceBuilder.WaitUntilBuilder with specified ActionComposerBuilder.ActionSequenceBuilder as parent builder.

Parameters:

parentActionSequenceBuilder - parent builder(ActionComposerBuilder.ActionSequenceBuilder)

conditionFunc - the condition function for evaluation by phases

totalTimeout - the maximum amount of time to wait totally

Method Details

withPhaseTimeout

public ActionComposerBuilder.ActionSequenceBuilder.WaitUntilBuilder<V> withPhaseTimeout(int phaseTimeout)

Set the maximum amount of time to wait for each execution phase.

Parameters:

phaseTimeout - phase timeout

Returns:

self reference

withPollInterval

public ActionComposerBuilder.ActionSequenceBuilder.WaitUntilBuilder<V> withPollInterval(int pollInterval)

Set how often the condition function should be evaluated.

Parameters:

pollInterval - evaluation interval

Returns:

self reference

withIgnoredException

public ActionComposerBuilder.ActionSequenceBuilder.WaitUntilBuilder<V> withIgnoredException(Set<Class<? extends Throwable>> ignoreExceptions)

Set the types of exceptions to ignore when evaluating condition function.

Parameters:

ignoreExceptions - exception list

Returns:

self reference

withTimeoutCallback

public ActionComposerBuilder.ActionSequenceBuilder.WaitUntilBuilder<V> withTimeoutCallback(Consumer<ActionComposer> timeoutCallback)

Set the callback function to be called when total timeout expires.

Parameters:

timeoutCallback - timeout callback function

Returns:

self reference

done

public ActionComposerBuilder.ActionSequenceBuilder done()

Finish building WaitUntil and add it to parent builder.

Returns:

parent builder(ActionComposerBuilder.ActionSequenceBuilder)