org.imaginea.test.automation.framework.util

Class PageObjectUtils

java.lang.Object

org.imaginea.test.automation.framework.util.Utilities

org.imaginea.test.automation.framework.util.PageObjectUtils

Direct Known Subclasses:

AbstractPageClass, Browser, TestClass

public abstract class PageObjectUtils
extends Utilities

Utility class containing mainly the util methods for the Page Class and Locator class. Not meant to be used by other classes.

Author:

Varun Menon

Field Summary

Fields

Modifier and Type	Field and Description
protected Browser	browser
protected DefaultConfig	config

Constructor Summary

Constructors

Constructor and Description
PageObjectUtils()

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	at(Class<?> pageClass) Utility to verify that the driver is at said page or not.
<T> T	at(Class<?> pageClass, File file) Utility to verify that the driver is at said page or not.
<T> T	at(Class<?> pageClass, String filePath) Utility to verify that the driver is at said page or not.
<T> T	at(T page) Utility to verify that the driver is at said page or not.
<T> T	at(T page, File file) Utility to verify that the driver is at said page or not.
<T> T	at(T page, String filePath) Utility to verify that the driver is at said page or not.
<T> T	getPageObject(Class<?> pageClass) Utility to create and get the said page class object.
<T> T	getPageObject(Class<?> pageClass, File customLocatorFile) Utility to create and get the said page class object.
<T> T	getPageObject(Class<? extends PageClass> pageClass, String filePath) Utility to create and get the said page class object.
String	getUrl(PageClass page)
<T> boolean	isAt(Class<?> pageClass) Similar to at(Class) method, instead it return true or false based on the at verification done.
<T> boolean	isAt(Class<?> pageClass, File file) Similar to at(Class,java.io.File) method, instead it return true or false based on the at verification done.
<T> boolean	isAt(Class<?> pageClass, String filePath) Similar to at(Class,java.lang.String) method, instead it return true or false based on the at verification done.
<T> boolean	isAt(T page) Similar to at(Class) method, instead it return true or false based on the at verification done.
<T> boolean	isAt(T page, File file) Similar to #at(T,java.io.File) method, instead it return true or false based on the at verification done.
<T> boolean	isAt(T page, String filePath) Similar to at(Class) method, instead it return true or false based on the at verification done.
void	setBrowser(Browser browser)
<T> T	to(Class<?> pageClass) Navigates to said page after appending the base url to Page url.
<T> T	to(Class<?> pageClass, File file) Navigates to said page after appending the base url to Page url and initializes any PageFactory based WebElements in the said class using the provided locator file.
<T> T	to(Class<?> pageClass, String filePath) Navigates to said page after appending the base url to Page url.
<T> T	to(T page) Navigates to said page after appending the base url to Page url.
<T> T	to(T page, File file) Navigates to said page after appending the base url to Page url and initializes any PageFactory based WebElements in the said class using the provided locator file.
<T> T	to(T page, String filePath) Navigates to said page after appending the base url to Page url.
<T> T	to(org.openqa.selenium.WebDriver driver, T page)

Methods inherited from class org.imaginea.test.automation.framework.util.Utilities

evaluateFileFromResourceDirectory, waitForElementPresent, waitForElementPresent, waitForElementPresent, waitForElementPresent, waitForElementToBeVisible, waitForElementToBeVisible, waitForPage, waitForPage

Methods inherited from class java.lang.Object

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

Field Detail

config

protected DefaultConfig config

browser

protected Browser browser

Constructor Detail

PageObjectUtils

public PageObjectUtils()

Method Detail

setBrowser

public void setBrowser(Browser browser)

getPageObject

public <T> T getPageObject(Class<?> pageClass,
                  File customLocatorFile)

Utility to create and get the said page class object. This utility directly creates the said page class object and returns it. No navigation or verification is done for the said page.

This method initializes any PageFactory based WebElements present in the said class using the provided locator file.

Parameters:

pageClass - Page class extending PageClass for which the object has to be created and returned.

customLocatorFile - - File object of the file containing the key/value pair of the locators.

Returns:

The said page class object

getPageObject

public <T> T getPageObject(Class<? extends PageClass> pageClass,
                  String filePath)

Utility to create and get the said page class object. This utility directly creates the said page class object and returns it. No navigation or verification is done for the said page.

This method initializes any PageFactory based WebElements present in the said class using the provided locator file path.

Parameters:

pageClass - Page class extending PageClass for which the object has to be created and returned.

filePath - - File path of the file containing the key/value pair of the locators.

Returns:

The said page class object

getPageObject

public <T> T getPageObject(Class<?> pageClass)

Utility to create and get the said page class object. This utility directly creates the said page class object and returns it. No navigation or verification is done for the said page.

Parameters:

pageClass - Page class extending PageClass for which the object has to be created and returned.

Returns:

The said page class object

getUrl

public String getUrl(PageClass page)

to

public <T> T to(org.openqa.selenium.WebDriver driver,
       T page)

to

public <T> T to(Class<?> pageClass)

Navigates to said page after appending the base url to Page url. This utility also verifies whether the driver is at the said Page by using "at" method of the Page after navigation.

Parameters:

pageClass - - Page class extending PageClass to where the driver have to be navigated.

Returns:

The said page class object once verification is successful.

at

public <T> T at(Class<?> pageClass)

Utility to verify that the driver is at said page or not.

Parameters:

pageClass - Page class extending PageClass which have to verified to be on.

Returns:

The said page class object once verification is successful.

to

public <T> T to(Class<?> pageClass,
       File file)

Navigates to said page after appending the base url to Page url and initializes any PageFactory based WebElements in the said class using the provided locator file. This utility also verifies whether the driver is at the said Page by using "at" method of the Page after navigation.

Parameters:

pageClass - - Page class extending PageClass to where the driver have to be navigated.

file - - File object of the file containing the key/value pair of the locators.

Returns:

The said page class object once verification is successful.

to

public <T> T to(Class<?> pageClass,
       String filePath)

Navigates to said page after appending the base url to Page url. This method initializes any PageFactory based WebElements in the said class using the provided locator file path. This utility also verifies whether the driver is at the said Page by using "at" method of the Page after navigation.

Parameters:

pageClass - - Page class extending PageClass to where the driver have to be navigated.

filePath - - File path of the file containing the key/value pair of the locators.

Returns:

The said page class object once verification is successful.

at

public <T> T at(Class<?> pageClass,
       String filePath)

Utility to verify that the driver is at said page or not. This method initializes any PageFactory based WebElements in the said class using the provided locator file path.

Parameters:

pageClass - Page class extending PageClass which have to verified to be on.

filePath - - File path of the file containing the key/value pair of the locators.

Returns:

The said page class object once verification is successful.

at

public <T> T at(Class<?> pageClass,
       File file)

Utility to verify that the driver is at said page or not. This method initializes any PageFactory based WebElements in the said class using the provided locator file.

Parameters:

pageClass - Page class extending PageClass which have to verified to be on.

file - - File object of the file containing the key/value pair of the locators.

Returns:

The said page class object once verification is successful.

to

public <T> T to(T page)

Navigates to said page after appending the base url to Page url. This utility also verifies whether the driver is at the said Page by using "at" method of the Page after navigation.

Parameters:

page - - Object of the Page class extending PageClass to where the driver have to be navigated.

Returns:

The said page class object once verification is successful.

at

public <T> T at(T page)

Utility to verify that the driver is at said page or not.

Parameters:

page - Object of the Page class extending PageClass which have to verified to be on.

Returns:

The said page class object once verification is successful.

to

public <T> T to(T page,
       File file)

Navigates to said page after appending the base url to Page url and initializes any PageFactory based WebElements in the said class using the provided locator file. This utility also verifies whether the driver is at the said Page by using "at" method of the Page after navigation.

Parameters:

page - - Object of the Page class extending PageClass to where the driver have to be navigated.

file - - File object of the file containing the key/value pair of the locators.

Returns:

The said page class object once verification is successful.

to

public <T> T to(T page,
       String filePath)

Navigates to said page after appending the base url to Page url. This method initializes any PageFactory based WebElements in the said class using the provided locator file path. This utility also verifies whether the driver is at the said Page by using "at" method of the Page after navigation.

Parameters:

page - - Object of the Page class extending PageClass to where the driver have to be navigated.

filePath - - File path of the file containing the key/value pair of the locators.

Returns:

The said page class object once verification is successful.

at

public <T> T at(T page,
       String filePath)

Utility to verify that the driver is at said page or not. This method initializes any PageFactory based WebElements in the said class using the provided locator file path.

Parameters:

page - Object of the Page class extending PageClass which have to verified to be on.

filePath - - File path of the file containing the key/value pair of the locators.

Returns:

The said page class object once verification is successful.

at

public <T> T at(T page,
       File file)

Utility to verify that the driver is at said page or not. This method initializes any PageFactory based WebElements in the said class using the provided locator file.

Parameters:

page - Object of the Page class extending PageClass which have to verified to be on.

file - - File object of the file containing the key/value pair of the locators.

Returns:

The said page class object once verification is successful.

isAt

public <T> boolean isAt(T page)

Similar to at(Class) method, instead it return true or false based on the at verification done.

Parameters:

page - Object of the Page class extending PageClass which have to verified to be on.

Returns:

true or false

isAt

public <T> boolean isAt(Class<?> pageClass,
               File file)

Similar to at(Class,java.io.File) method, instead it return true or false based on the at verification done. This method initializes any PageFactory based WebElements in the said class using the provided locator file.

Parameters:

pageClass - Page class extending PageClass which have to verified to be on.

file - - File object of the file containing the key/value pair of the locators.

Returns:

true or false

isAt

public <T> boolean isAt(Class<?> pageClass,
               String filePath)

Similar to at(Class,java.lang.String) method, instead it return true or false based on the at verification done. This method initializes any PageFactory based WebElements present in the said class using the provided locator file path.

Parameters:

pageClass - Page class extending PageClass which have to verified to be on.

filePath - - File path of the file containing the key/value pair of the locators.

Returns:

true or false

isAt

public <T> boolean isAt(Class<?> pageClass)

Similar to at(Class) method, instead it return true or false based on the at verification done.

Parameters:

pageClass - Page class extending PageClass which have to verified to be on.

Returns:

true or false

isAt

public <T> boolean isAt(T page,
               File file)

Similar to #at(T,java.io.File) method, instead it return true or false based on the at verification done. This method initializes any PageFactory based WebElements in the said class using the provided locator file.

Parameters:

page - Object of the Page class extending PageClass which have to verified to be on.

file - - File object of the file containing the key/value pair of the locators.

Returns:

true or false

isAt

public <T> boolean isAt(T page,
               String filePath)

Similar to at(Class) method, instead it return true or false based on the at verification done. This method initializes any PageFactory based WebElements present in the said class using the provided locator file path.

Parameters:

page - Page class extending PageClass which have to verified to be on.

filePath - - File path of the file containing the key/value pair of the locators.

Returns:

true or false