org.safs.selenium.webdriver

Class SeleniumPlus.WDTimeOut

java.lang.Object

org.safs.selenium.webdriver.SeleniumPlus.WDTimeOut

Enclosing class:

SeleniumPlus

public static class SeleniumPlus.WDTimeOut
extends java.lang.Object

 This class provides some static methods to set Selenium WebDriver's timeout thread-safely.
 

History:

Jul 8, 2014 (Lei Wang) Initial release.
Jun 5, 2014 (Lei Wang) Add some non-thread safe method to set timeout for implicit-wait, page-load, and script.

Constructor Summary

Constructors

Constructor and Description
WDTimeOut()

Method Summary

Modifier and Type	Method and Description
static org.openqa.selenium.WebDriver.Timeouts	implicitlyWait(long time, java.util.concurrent.TimeUnit unit) Set the Web Driver's ImplicitlyWait timeout, the amount of time the driver should wait when searching for an element if it is not immediately present. Note:This method is not thread-safe.
static org.openqa.selenium.WebDriver.Timeouts	pageLoadTimeout(long time, java.util.concurrent.TimeUnit unit) Set the Web Driver's pageLoad timeout, the amount of time to wait for a page load to complete before throwing an error.
static boolean	resetImplicitlyWait(long timeout, java.util.concurrent.TimeUnit unit) Reset the 'Web Driver's ImplicitlyWait timeout' and unlock the 'timeout setting'.
static boolean	resetPageLoadTimeout(long timeout, java.util.concurrent.TimeUnit unit) Reset the 'Web Driver's PageLoad timeout' and unlock the 'timeout setting'.
static boolean	resetScriptTimeout(long timeout, java.util.concurrent.TimeUnit unit) Reset the 'Web Driver's JavaScript Execution timeout' and unlock the 'timeout setting'.
static org.openqa.selenium.WebDriver.Timeouts	scriptTimeout(long time, java.util.concurrent.TimeUnit unit) Set the Web Driver's Script timeout, the amount of time to wait for an asynchronous script to finish execution before throwing an error.
static boolean	setImplicitlyWait(long timeout, java.util.concurrent.TimeUnit unit) Set the 'Web Driver's ImplicitlyWait timeout' and lock the 'timeout setting'.
static boolean	setImplicitlyWait(long timeout, java.util.concurrent.TimeUnit unit, long waitLockTimeout) Set the 'Web Driver's ImplicitlyWait timeout' This method is thread-safe.
static boolean	setPageLoadTimeout(long timeout, java.util.concurrent.TimeUnit unit) Set the 'Web Driver's PageLoad timeout' and lock the 'timeout setting'.
static boolean	setPageLoadTimeout(long timeout, java.util.concurrent.TimeUnit unit, long waitLockTimeout) Set the 'Web Driver's PageLoad timeout' This method is thread-safe.
static boolean	setScriptTimeout(long timeout, java.util.concurrent.TimeUnit unit) Set the 'Web Driver's JavaScript Execution timeout' and lock the 'timeout setting'.
static boolean	setScriptTimeout(long timeout, java.util.concurrent.TimeUnit unit, long waitLockTimeout) Set the 'Web Driver's JavaScript Execution timeout' This method is thread-safe.

Methods inherited from class java.lang.Object

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

Constructor Detail

WDTimeOut

public WDTimeOut()

Method Detail

implicitlyWait

public static org.openqa.selenium.WebDriver.Timeouts implicitlyWait(long time,
                                                                    java.util.concurrent.TimeUnit unit)

Set the Web Driver's ImplicitlyWait timeout, the amount of time the driver should wait when searching for an element if it is not immediately present.
Note:This method is not thread-safe. If multiple threads call this method, the change of 'implicitlyWait' in one thread will affect the other thread.

Parameters:

timeout - long, the timeout to set

unit - TimeUnit, the timeout's unit, seconds or milliseconds etc.

Returns:

Timeouts

See Also:

setImplicitlyWait(long, TimeUnit), setImplicitlyWait(long, TimeUnit, long)

pageLoadTimeout

public static org.openqa.selenium.WebDriver.Timeouts pageLoadTimeout(long time,
                                                                     java.util.concurrent.TimeUnit unit)

Set the Web Driver's pageLoad timeout, the amount of time to wait for a page load to complete before throwing an error. If the timeout is negative, page loads can be indefinite.
Note:This method is not thread-safe. If multiple threads call this method, the change of 'implicitlyWait' in one thread will affect the other thread.

Parameters:

timeout - long, the timeout to set

unit - TimeUnit, the timeout's unit, seconds or milliseconds etc.

Returns:

Timeouts

See Also:

setPageLoadTimeout(long, TimeUnit), setPageLoadTimeout(long, TimeUnit, long)

scriptTimeout

public static org.openqa.selenium.WebDriver.Timeouts scriptTimeout(long time,
                                                                   java.util.concurrent.TimeUnit unit)

Set the Web Driver's Script timeout, the amount of time to wait for an asynchronous script to finish execution before throwing an error. If the timeout is negative, then the script will be allowed to run indefinitely.
Note:This method is not thread-safe. If multiple threads call this method, the change of 'implicitlyWait' in one thread will affect the other thread.

Parameters:

timeout - long, the timeout to set

unit - TimeUnit, the timeout's unit, seconds or milliseconds etc.

Returns:

Timeouts

See Also:

setScriptTimeout(long, TimeUnit), setScriptTimeout(long, TimeUnit, long)

setImplicitlyWait

public static boolean setImplicitlyWait(long timeout,
                                        java.util.concurrent.TimeUnit unit)

 Set the 'Web Driver's ImplicitlyWait timeout' and lock the 'timeout setting'.
 This method is thread-safe. If one thread has called this method,
 it will set a lock and the other threads will have to wait until the first thread
 unlock by calling resetImplicitlyWait(long, TimeUnit).
 The lock range is within the caller method.
 See the following example:
 
 try{
   setImplicitlyWait(timeout, unit);
   //doSomething();
 }catch(Exception e){
 }finally{
   resetImplicitlyWait(originalTimeout, originalUnit);
 }
 
 

Parameters:

timeout - long, the timeout to set

unit - TimeUnit, the timeout's unit, seconds or milliseconds etc.

Returns:

boolean, true if the timeout has been set successfully.

See Also:

resetImplicitlyWait(long, TimeUnit)

setImplicitlyWait

public static boolean setImplicitlyWait(long timeout,
                                        java.util.concurrent.TimeUnit unit,
                                        long waitLockTimeout)

Set the 'Web Driver's ImplicitlyWait timeout'
This method is thread-safe. To set 'timeout', thread needs to possess a lock. But if the lock is possessed by an other
thread, this thread must wait. If this thread doesn't want to wait for the lock for a too
time, this method provides a 'waitLockTimeout', after that timeout, this thread will quit.
The lock range is within the caller method.

Parameters:

timeout - long, the timeout to set

unit - TimeUnit, the timeout's unit, seconds or milliseconds etc.

waitLockTimeout - long, the timeout to wait for obtaining the lock, in milliseconds

Returns:

boolean, true if the timeout has been set successfully.

See Also:

setImplicitlyWait(long, TimeUnit), resetImplicitlyWait(long, TimeUnit)

resetImplicitlyWait

public static boolean resetImplicitlyWait(long timeout,
                                          java.util.concurrent.TimeUnit unit)

Reset the 'Web Driver's ImplicitlyWait timeout' and unlock the 'timeout setting'.

Parameters:

timeout - long, the timeout to set

unit - TimeUnit, the timeout's unit, seconds or milliseconds etc.

Returns:

boolean, true if the timeout has been reset successfully.

See Also:

setImplicitlyWait(long, TimeUnit)

setScriptTimeout

public static boolean setScriptTimeout(long timeout,
                                       java.util.concurrent.TimeUnit unit)

 Set the 'Web Driver's JavaScript Execution timeout' and lock the 'timeout setting'.
 This method is thread-safe. If one thread has called this method,
 it will set a lock and the other threads will have to wait until the first thread
 unlock by calling resetScriptTimeout(long, TimeUnit).
 The lock range is within the caller method.
 See the following example:
 
 try{
   setScriptTimeout(timeout, unit);
   //doSomething();
 }catch(Exception e){
 }finally{
   resetScriptTimeout(originalTimeout, originalUnit);
 }
 
 

Parameters:

timeout - long, the timeout to set

unit - TimeUnit, the timeout's unit, seconds or milliseconds etc.

Returns:

boolean, true if the timeout has been set successfully.

See Also:

resetScriptTimeout(long, TimeUnit)

setScriptTimeout

public static boolean setScriptTimeout(long timeout,
                                       java.util.concurrent.TimeUnit unit,
                                       long waitLockTimeout)

Set the 'Web Driver's JavaScript Execution timeout'
This method is thread-safe. To set 'timeout', thread needs to possess a lock. But if the lock is possessed by an other
thread, this thread must wait. If this thread doesn't want to wait for the lock for a too
time, this method provides a 'waitLockTimeout', after that timeout, this thread will quit.
The lock range is within the caller method.

Parameters:

timeout - long, the timeout to set

unit - TimeUnit, the timeout's unit, seconds or milliseconds etc.

waitLockTimeout - long, the timeout to wait for obtaining the lock, in milliseconds

Returns:

boolean, true if the timeout has been set successfully.

See Also:

setScriptTimeout(long, TimeUnit), resetScriptTimeout(long, TimeUnit)

resetScriptTimeout

public static boolean resetScriptTimeout(long timeout,
                                         java.util.concurrent.TimeUnit unit)

Reset the 'Web Driver's JavaScript Execution timeout' and unlock the 'timeout setting'.

Parameters:

timeout - long, the timeout to set

unit - TimeUnit, the timeout's unit, seconds or milliseconds etc.

Returns:

boolean, true if the timeout has been reset successfully.

See Also:

setScriptTimeout(long, TimeUnit)

setPageLoadTimeout

public static boolean setPageLoadTimeout(long timeout,
                                         java.util.concurrent.TimeUnit unit)

 Set the 'Web Driver's PageLoad timeout' and lock the 'timeout setting'.
 This method is thread-safe. If one thread has called this method,
 it will set a lock and the other threads will have to wait until the first thread
 unlock by calling resetPageLoadTimeout(long, TimeUnit).
 The lock range is within the caller method.
 See the following example:
 
 try{
   setPageLoadTimeout(timeout, unit);
   //doSomething();
 }catch(Exception e){
 }finally{
   resetPageLoadTimeout(originalTimeout, originalUnit);
 }
 
 

Parameters:

timeout - long, the timeout to set

unit - TimeUnit, the timeout's unit, seconds or milliseconds etc.

Returns:

boolean, true if the timeout has been set successfully.

See Also:

resetPageLoadTimeout(long, TimeUnit)

setPageLoadTimeout

public static boolean setPageLoadTimeout(long timeout,
                                         java.util.concurrent.TimeUnit unit,
                                         long waitLockTimeout)

Set the 'Web Driver's PageLoad timeout'
This method is thread-safe. To set 'timeout', thread needs to possess a lock. But if the lock is possessed by an other
thread, this thread must wait. If this thread doesn't want to wait for the lock for a too
time, this method provides a 'waitLockTimeout', after that timeout, this thread will quit.
The lock range is within the caller method.

Parameters:

timeout - long, the timeout to set

unit - TimeUnit, the timeout's unit, seconds or milliseconds etc.

waitLockTimeout - long, the timeout to wait for obtaining the lock, in milliseconds

Returns:

boolean, true if the timeout has been set successfully.

See Also:

setPageLoadTimeout(long, TimeUnit), resetPageLoadTimeout(long, TimeUnit)

resetPageLoadTimeout

public static boolean resetPageLoadTimeout(long timeout,
                                           java.util.concurrent.TimeUnit unit)

Reset the 'Web Driver's PageLoad timeout' and unlock the 'timeout setting'.

Parameters:

timeout - long, the timeout to set

unit - TimeUnit, the timeout's unit, seconds or milliseconds etc.

Returns:

boolean, true if the timeout has been reset successfully.

See Also:

setPageLoadTimeout(long, TimeUnit)