org.alfresco.po.common.util

Class Utils

java.lang.Object

org.alfresco.po.common.util.Utils

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@Component
public final class Utils
extends Object
implements org.springframework.context.ApplicationContextAware

Utility class containing helpful methods.

Since:

2.2

Version:

1.0

Author:

Tuna Aksoy

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_RETRY default retry 5 times

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
static void	checkMandatoryParam(String paramName, Object object) Checks that the provided parameter satisfies all mandatory preconditions.
static <T extends org.openqa.selenium.internal.WrapsElement> T	clear(T field) Clear control and enter text
static <T extends org.openqa.selenium.WebElement> T	clear(T field) Clear control
static <T extends org.openqa.selenium.internal.WrapsElement> T	clearAndType(T field, String text) Clear control and enter text
static <T extends org.openqa.selenium.WebElement> T	clearAndType(T field, String text) Clear control and enter text
static <T extends org.openqa.selenium.WebElement> T	clearAndTypeInvalidValues(T field, String text) Clear control and enter text without checking its value
static File	createTempFile(String name) Create temp file TODO ..
static boolean	elementExists(org.openqa.selenium.By selector) Helper method to see if element exists on page
static boolean	elementExists(org.openqa.selenium.By selector, long duration, TimeUnit unit) Helper method to see if element exists on page
static boolean	elementExists(org.openqa.selenium.WebElement webElement, org.openqa.selenium.By selector) Helper method to see if element exists within element
static org.springframework.context.ApplicationContext	getApplicationContext() Helper to provide application context
static org.openqa.selenium.WebElement	getVisibleElement(org.openqa.selenium.By selector) Get the visible element from the list of elements that can be retrieved with the same selector
static org.openqa.selenium.WebDriver	getWebDriver() Helper to get web driver
static <T extends org.openqa.selenium.internal.WrapsElement> T	mouseOver(T wrapsElement) Helper method to mouse over element
static <T extends org.openqa.selenium.WebElement> T	mouseOver(T webElement) Helper to mouse over element
static <T> T	retry(Retry<T> retry, int count) Helper method to retry the provided code block, ignoring any Exceptions until either the code block completes successfully or the maximum number of retries has been reached.
static <T> T	retry(Retry<T> retry, int count, Class<? extends Exception>... retryExceptions) Helper method to retry the provided code block, ignoring the specified exception types until either the code block completes successfully or the maximum number of retries has been reached.
static <T> T	retryUntil(Retry<T> retry, Supplier<Boolean> predicate, int count) Helper method to retry the provided code block until the predicate block returns true or the maximum number of retries has been reached.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
static <T> void	waitFor(org.openqa.selenium.support.ui.ExpectedCondition<T> condition)
static org.openqa.selenium.WebElement	waitForFind(org.openqa.selenium.By selector) Waits for a web element to be found.
static org.openqa.selenium.WebElement	waitForFind(org.openqa.selenium.WebElement webElement, org.openqa.selenium.By selector) Waits for a web element to be found in the scope of another element.
static void	waitForInvisibilityOf(org.openqa.selenium.By locator) Helper method to wait for the invisibility of an element located by selector
static void	waitForInvisibilityOf(org.openqa.selenium.WebElement webElement) Helper method to wait for the invisibility of an element
static void	waitForStalenessOf(ru.yandex.qatools.htmlelements.element.TypifiedElement webElement)
static void	waitForStalenessOf(org.openqa.selenium.WebElement webElement) Helper method to wait for the staleness of an element
static org.openqa.selenium.WebElement	waitForVisibilityOf(org.openqa.selenium.By locator) Helper method to wait for the visibility of element located by selector
static void	waitForVisibilityOf(ru.yandex.qatools.htmlelements.element.TypifiedElement webElement)
static void	waitForVisibilityOf(org.openqa.selenium.WebElement webElement) Helper method to wait for the visibility of an element
static org.openqa.selenium.support.ui.WebDriverWait	webDriverWait() Helper to get web driver wait object
static org.openqa.selenium.support.ui.WebDriverWait	webDriverWait(long waitSeconds) Helper to get web driver wait object

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RETRY

public static final int DEFAULT_RETRY

default retry 5 times

See Also:

Constant Field Values

Constructor Detail

Utils

public Utils()

Method Detail

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

See Also:

ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)

getApplicationContext

public static org.springframework.context.ApplicationContext getApplicationContext()

Helper to provide application context

getWebDriver

public static org.openqa.selenium.WebDriver getWebDriver()

Helper to get web driver

Returns:

webDriverWait

public static org.openqa.selenium.support.ui.WebDriverWait webDriverWait(long waitSeconds)

Helper to get web driver wait object

Returns:

webDriverWait

public static org.openqa.selenium.support.ui.WebDriverWait webDriverWait()

Helper to get web driver wait object

Returns:

elementExists

public static boolean elementExists(org.openqa.selenium.By selector)

Helper method to see if element exists on page

elementExists

public static boolean elementExists(org.openqa.selenium.By selector,
                                    long duration,
                                    TimeUnit unit)

Helper method to see if element exists on page

elementExists

public static boolean elementExists(org.openqa.selenium.WebElement webElement,
                                    org.openqa.selenium.By selector)

Helper method to see if element exists within element

waitFor

public static <T> void waitFor(org.openqa.selenium.support.ui.ExpectedCondition<T> condition)

waitForFind

public static org.openqa.selenium.WebElement waitForFind(org.openqa.selenium.By selector)

Waits for a web element to be found.

Throws TimeoutException if element is not found.

Parameters:

selector - selector

Returns:

WebElement web element

waitForFind

public static org.openqa.selenium.WebElement waitForFind(org.openqa.selenium.WebElement webElement,
                                                         org.openqa.selenium.By selector)

Waits for a web element to be found in the scope of another element.

Throws TimeoutException if element is not found.

Parameters:

webElement - web element to scope find

selector - web selector

Returns:

WebElement found web element

waitForStalenessOf

public static void waitForStalenessOf(org.openqa.selenium.WebElement webElement)

Helper method to wait for the staleness of an element

waitForStalenessOf

public static void waitForStalenessOf(ru.yandex.qatools.htmlelements.element.TypifiedElement webElement)

See Also:

waitForStalenessOf(WebElement)

waitForVisibilityOf

public static void waitForVisibilityOf(org.openqa.selenium.WebElement webElement)

Helper method to wait for the visibility of an element

waitForVisibilityOf

public static void waitForVisibilityOf(ru.yandex.qatools.htmlelements.element.TypifiedElement webElement)

See Also:

waitForVisibilityOf(WebElement)

waitForVisibilityOf

public static org.openqa.selenium.WebElement waitForVisibilityOf(org.openqa.selenium.By locator)

Helper method to wait for the visibility of element located by selector

waitForInvisibilityOf

public static void waitForInvisibilityOf(org.openqa.selenium.WebElement webElement)

Helper method to wait for the invisibility of an element

waitForInvisibilityOf

public static void waitForInvisibilityOf(org.openqa.selenium.By locator)

Helper method to wait for the invisibility of an element located by selector

mouseOver

public static <T extends org.openqa.selenium.WebElement> T mouseOver(T webElement)

Helper to mouse over element

Parameters:

webElement -

Returns:

mouseOver

public static <T extends org.openqa.selenium.internal.WrapsElement> T mouseOver(T wrapsElement)

Helper method to mouse over element

Parameters:

wrapsElement -

Returns:

clear

public static <T extends org.openqa.selenium.WebElement> T clear(T field)

Clear control

clearAndType

public static <T extends org.openqa.selenium.WebElement> T clearAndType(T field,
                                                                        String text)

Clear control and enter text

clearAndTypeInvalidValues

public static <T extends org.openqa.selenium.WebElement> T clearAndTypeInvalidValues(T field,
                                                                                     String text)

Clear control and enter text without checking its value

clear

public static <T extends org.openqa.selenium.internal.WrapsElement> T clear(T field)

Clear control and enter text

clearAndType

public static <T extends org.openqa.selenium.internal.WrapsElement> T clearAndType(T field,
                                                                                   String text)

Clear control and enter text

checkMandatoryParam

public static void checkMandatoryParam(String paramName,
                                       Object object)

Checks that the provided parameter satisfies all mandatory preconditions. These include:

• paramName should be non-null and not blank.
• object should be non-null.
• String objects should not be blank.
• Collection objects should not be empty.

Parameters:

paramName - parameter name

object - object value

Throws:

IllegalArgumentException - if any violations have occurred.

createTempFile

public static File createTempFile(String name)

Create temp file TODO .. support multiple mimetypes .. build files with real size content

Parameters:

name - file name

Returns:

File file

retry

public static final <T> T retry(Retry<T> retry,
                                int count)

Helper method to retry the provided code block, ignoring any Exceptions until either the code block completes successfully or the maximum number of retries has been reached.

Type Parameters:

T - the return type from the code block.

Parameters:

retry - a code block to execute.

count - maximum number of retries.

Returns:

result of the code block.

retry

public static final <T> T retry(Retry<T> retry,
                                int count,
                                Class<? extends Exception>... retryExceptions)

Helper method to retry the provided code block, ignoring the specified exception types until either the code block completes successfully or the maximum number of retries has been reached.

Type Parameters:

T - the return type from the code block.

Parameters:

retry - a code block to execute.

count - maximum number of retries.

retryExceptions - a sequence of exception types any one of which will start a retry.

Returns:

result of the code block.

retryUntil

public static final <T> T retryUntil(Retry<T> retry,
                                     Supplier<Boolean> predicate,
                                     int count)

Helper method to retry the provided code block until the predicate block returns true or the maximum number of retries has been reached. Note that any exceptions thrown within the Retry will not be caught internally and will be thrown immediately.

Type Parameters:

T - the return type of the Retry block.

Parameters:

retry - the code block to retry.

predicate - a predicate code block which determines when the Retry is successfully completed.

count - the maximum number of retries.

Returns:

the value returned by the Retry block.

getVisibleElement

public static org.openqa.selenium.WebElement getVisibleElement(org.openqa.selenium.By selector)

Get the visible element from the list of elements that can be retrieved with the same selector

Parameters:

selector - used to find elements

Returns:

the visible element