at.willhaben.willtest.config

Class TimeoutsConfigurationParticipant<D extends org.openqa.selenium.WebDriver>

java.lang.Object

at.willhaben.willtest.config.TimeoutsConfigurationParticipant<D>

All Implemented Interfaces:

WebDriverConfigurationParticipant<D>

public class TimeoutsConfigurationParticipant<D extends org.openqa.selenium.WebDriver>
extends Object
implements WebDriverConfigurationParticipant<D>

Adjusts timeouts available by using webDriver.manage().timeouts(). Please note, that if some of the 3 timeouts are not defined, then it will use the defaults settings of the given WebDriver implementation.

If all timeouts are set through this class, then there is a possibility to get the current timeout settings of the WebDriver, which is not possible out of the box in Selenium.

Constructor Summary

Constructors

Constructor and Description
TimeoutsConfigurationParticipant()

Method Summary

Modifier and Type	Method and Description
<T extends SeleniumProvider<T,D>> T	addTo(T seleniumProvider) Adds this configurator to the given SeleniumProvider
Optional<Duration>	getImplicitWait() Returns the current implicit wait in milliseconds.
Optional<Duration>	getPageLoadTimeout() Returns the current page load timeout in milliseconds.
Optional<Duration>	getScriptTimeout() Returns the current script timeout in milliseconds.
void	postConstruct(D webDriver) Can make some changes on a newly created WebDriver before it gets used.
org.openqa.selenium.support.ui.Wait<org.openqa.selenium.WebDriver>	waitOverridingImplicitWait(org.openqa.selenium.WebDriver webDriver, int seconds) If there is an implicit wait set, then you might need to wait for a shorter period.
TimeoutsConfigurationParticipant<D>	withImplicitWait(Duration implicitWait) See WebDriver.Timeouts.implicitlyWait(long, TimeUnit)
TimeoutsConfigurationParticipant<D>	withoutImplicitWait() This will reset implicit wait to the WebDriver implementation default
TimeoutsConfigurationParticipant<D>	withoutPageLoadTimeout() This will reset page load timeout to the WebDriver implementation default
TimeoutsConfigurationParticipant<D>	withoutScriptTimeout() This will reset script timeout to the WebDriver implementation default
TimeoutsConfigurationParticipant<D>	withPageLoadTimeout(Duration pageLoadTimeout) See WebDriver.Timeouts.pageLoadTimeout(long, TimeUnit)
TimeoutsConfigurationParticipant<D>	withScriptTimeout(Duration scriptTimeout) See WebDriver.Timeouts.setScriptTimeout(long, TimeUnit)

Methods inherited from class java.lang.Object

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

Methods inherited from interface at.willhaben.willtest.config.WebDriverConfigurationParticipant

addDesiredCapabilities

Constructor Detail

TimeoutsConfigurationParticipant

public TimeoutsConfigurationParticipant()

Method Detail

postConstruct

public void postConstruct(D webDriver)

Description copied from interface: WebDriverConfigurationParticipant

Can make some changes on a newly created WebDriver before it gets used.

Specified by:

postConstruct in interface WebDriverConfigurationParticipant<D extends org.openqa.selenium.WebDriver>

Parameters:

webDriver - webdriver to be changed

getImplicitWait

public Optional<Duration> getImplicitWait()

Returns the current implicit wait in milliseconds. If some code changes the timeout directly, this value can be incorrect. Always set timeouts using this class.

Returns:

implicit wait if any defined

getScriptTimeout

public Optional<Duration> getScriptTimeout()

Returns the current script timeout in milliseconds. If some code changes the timeout directly, this value can be incorrect. Always set timeouts using this class.

Returns:

script timeout if any defined

getPageLoadTimeout

public Optional<Duration> getPageLoadTimeout()

Returns the current page load timeout in milliseconds. If some code changes the timeout directly, this value can be incorrect. Always set timeouts using this class.

Returns:

page load timeout if any defined

waitOverridingImplicitWait

public org.openqa.selenium.support.ui.Wait<org.openqa.selenium.WebDriver> waitOverridingImplicitWait(org.openqa.selenium.WebDriver webDriver,
                                                                                                     int seconds)

If there is an implicit wait set, then you might need to wait for a shorter period. This method makes it possible with setting the implicit wait temporarily to 0.

Parameters:

webDriver - webdriver to be used

seconds - timeout in seconds

Returns:

a Wait instance, which set the implicit wait temporarily to 0.

addTo

public <T extends SeleniumProvider<T,D>> T addTo(T seleniumProvider)

Adds this configurator to the given SeleniumProvider

Type Parameters:

T - type of the selenium provider

Parameters:

seleniumProvider - "this" will be added as configuration participant to the given provider

Returns:

seleniumProvider to enable method chaining

withImplicitWait

public TimeoutsConfigurationParticipant<D> withImplicitWait(Duration implicitWait)

See WebDriver.Timeouts.implicitlyWait(long, TimeUnit)

Parameters:

implicitWait - duration

Returns:

this to enable method chaining

withScriptTimeout

public TimeoutsConfigurationParticipant<D> withScriptTimeout(Duration scriptTimeout)

See WebDriver.Timeouts.setScriptTimeout(long, TimeUnit)

Parameters:

scriptTimeout - duration

Returns:

this to enable method chaining

withPageLoadTimeout

public TimeoutsConfigurationParticipant<D> withPageLoadTimeout(Duration pageLoadTimeout)

See WebDriver.Timeouts.pageLoadTimeout(long, TimeUnit)

Parameters:

pageLoadTimeout - duration

Returns:

this to enable method chaining

withoutImplicitWait

public TimeoutsConfigurationParticipant<D> withoutImplicitWait()

This will reset implicit wait to the WebDriver implementation default

Returns:

this to enable method chaining

withoutPageLoadTimeout

public TimeoutsConfigurationParticipant<D> withoutPageLoadTimeout()

This will reset page load timeout to the WebDriver implementation default

Returns:

this to enable method chaining

withoutScriptTimeout

public TimeoutsConfigurationParticipant<D> withoutScriptTimeout()

This will reset script timeout to the WebDriver implementation default

Returns:

this to enable method chaining