cz.etnetera.seleniumbrowser.browser

Interface BrowserContext

All Superinterfaces:

DataSource, PropertySource, org.openqa.selenium.SearchContext, org.openqa.selenium.internal.WrapsDriver

All Known Implementing Classes:

Browser, BrowserElement, Logic, Module, Page

public interface BrowserContext
extends org.openqa.selenium.SearchContext, PropertySource, DataSource, org.openqa.selenium.internal.WrapsDriver

This is common interface for objects holding Browser and adds Browser specific methods directly in scope of Page, BrowserElement and Logic.

Method Summary

Modifier and Type	Method and Description
default void	assertAt(Class<?> page) Asserts that actual page is a given class.
default void	checkIfPresent(org.openqa.selenium.WebElement element) Checks if element exists on actual page.
default <T extends BrowserElement> T	constructBrowserElement(Class<T> element, org.openqa.selenium.WebElement webElement, boolean optional) Construct element defined by class.
default <T extends BrowserEvent> T	constructEvent(Class<T> eventCls) Construct event defined by class.
default <T extends Logic> T	constructLogic(Class<T> logic) Construct logic defined by class.
default <T extends Page> T	constructPage(Class<T> page) Construct page defined by class.
default org.openqa.selenium.support.pagefactory.ElementLocator	createElementLocator(org.openqa.selenium.By by) Creates ElementLocator used to locate element.
default org.openqa.selenium.support.pagefactory.ElementLocator	createElementLocator(org.openqa.selenium.By by, boolean lookupCached) Creates ElementLocator used to locate element.
default org.openqa.selenium.support.pagefactory.ElementLocator	createElementLocator(Field field) Creates ElementLocator used to locate element.
default List<BrowserElement>	find(BrowserContext context, org.openqa.selenium.By by) Find all elements within the given context using the given mechanism.
default <T extends BrowserElement> List<T>	find(BrowserContext context, org.openqa.selenium.By by, Class<T> elementCls) Find all elements within the given context using the given mechanism as instances of the given BrowserElement or its subclass.
default List<BrowserElement>	find(org.openqa.selenium.By by) Find all elements within the current context using the given mechanism.
default <T extends BrowserElement> List<T>	find(org.openqa.selenium.By by, Class<T> elementCls) Find all elements within the current context using the given mechanism as instances of the given BrowserElement or its subclass.
default BrowserElement	findOne(BrowserContext context, org.openqa.selenium.By by) Find the first element within the given context using the given mechanism.
default <T extends BrowserElement> T	findOne(BrowserContext context, org.openqa.selenium.By by, Class<T> elementCls) Find the first element within the given context using the given mechanism as instance of the given BrowserElement or its subclass.
default <T extends BrowserElement> T	findOne(BrowserContext context, org.openqa.selenium.By by, Class<T> elementCls, boolean optional) Find the first element within the given context using the given mechanism as instance of the given BrowserElement or its subclass.
default BrowserElement	findOne(org.openqa.selenium.By by) Find the first element within the current context using the given mechanism.
default <T extends BrowserElement> T	findOne(org.openqa.selenium.By by, Class<T> elementCls) Find the first element within the current context using the given mechanism as instance of the given BrowserElement or its subclass.
default BrowserElement	findOneOptional(BrowserContext context, org.openqa.selenium.By by) Find the first element within the given context using the given mechanism.
default <T extends BrowserElement> T	findOneOptional(BrowserContext context, org.openqa.selenium.By by, Class<T> elementCls) Find the first element within the given context using the given mechanism as instance of the given BrowserElement or its subclass.
default BrowserElement	findOneOptional(org.openqa.selenium.By by) Find the first element within the current context using the given mechanism.
default <T extends BrowserElement> T	findOneOptional(org.openqa.selenium.By by, Class<T> elementCls) Find the first element within the current context using the given mechanism as instance of the given BrowserElement or its subclass.
Browser	getBrowser() Returns Browser instance.
default <T> T	getBrowser(Class<T> browser) Returns Browser instance casted to specific type.
default BrowserConfiguration	getConfiguration() Returns BrowserConfiguration instance.
default <T> T	getConfiguration(Class<T> configuration) Returns BrowserConfiguration instance casted to specific type.
BrowserContext	getContext() Returns parent BrowserContext instance.
default <T> T	getContext(Class<T> context) Returns parent BrowserContext instance casted to specific type.
default Map<String,Object>	getDataHolder() Returns map which holds data.
default org.openqa.selenium.WebDriver	getDriver() Returns wrapped WebDriver instance.
default <T> T	getDriver(Class<T> driver) Returns wrapped WebDriver instance casted to specific type.
default Page	getPage() Returns actual page or null if browser has no page initiated.
default <T> T	getPage(Class<T> page) Returns actual page casted to given type or null if browser has no page initiated.
default String	getProperty(String key) Returns property as String.
default BrowserUtils	getUtils() Returns browser utilities instance.
default double	getWaitRetryInterval() Returns default wait retry interval.
default double	getWaitTimeout() Returns default wait timeout.
default org.openqa.selenium.WebDriver	getWrappedDriver()
default <T extends Page> T	goTo(Class<T> page) Go to page defined by class.
default <T extends Page> T	goTo(T page) Go to already constructed page.
default <T extends Page> T	goToSafely(Class<T> page) Safely go to page defined by class.
default <T extends Page> T	goToSafely(T page) Safely go to already constructed page.
default void	goToUrl(String url) Go to specific URL.
default <T extends BrowserElement> T	initBrowserElement(Class<T> element, org.openqa.selenium.WebElement webElement, boolean optional) Initialize element defined by class.
default <T extends BrowserElement> T	initBrowserElement(T element) Initialize already constructed element.
default void	initElements() Initialize elements annotated with FindBy and similar annotations.
default <T extends Logic> T	initLogic(Class<T> logic) Initialize logic defined by class.
default <T extends Logic> T	initLogic(T logic) Initialize logic defined by class.
default Page	initOnePage(Object... pages) Initialize first of matching page.
default Page	initOnePageSafely(Object... pages) Safely initialize first of matching page.
default <T extends Page> T	initPage(Class<T> page) Initialize page defined by class.
default <T extends Page> T	initPage(T page) Initialize already constructed page.
default <T extends Page> T	initPageSafely(Class<T> page) Safely initialize page defined by class.
default <T extends Page> T	initPageSafely(T page) Safely initialize already constructed page.
default boolean	isAt(Class<?> page) Check if actual page is a given class.
default boolean	isNotPresent(org.openqa.selenium.WebElement element) Returns true if element does not exists on actual page.
default boolean	isPresent(org.openqa.selenium.WebElement element) Returns true if element exists on actual page.
default void	report(String label) Triggers OnReportEvent with given label.
default void	saveFile(byte[] bytes, String name, String extension) Saves bytes into named file with extension.
default void	saveFile(File file, String name, String extension) Saves file into named file with extension.
default void	saveFile(String content, String name, String extension) Saves string into named file with extension.
default void	setPage(Page page) Sets actual browser page.
default void	triggerEvent(BrowserEvent event) Triggers BrowserEvent.
default BrowserContextWait	waiting() Constructs new wait instance using default waiting settings.
default BrowserContextWait	waiting(org.openqa.selenium.support.ui.Clock clock, org.openqa.selenium.support.ui.Sleeper sleeper, double timeout, double retryInterval) Constructs new wait instance using default waiting settings with specific clock to use when measuring the timeout, specific sleeper to use to put the thread to sleep between evaluation loops, specific timeout in seconds and retry interval in seconds.
default BrowserContextWait	waiting(double timeout) Constructs new wait instance using default waiting settings with specific timeout in seconds.
default BrowserContextWait	waiting(double timeout, double retryInterval) Constructs new wait instance using default waiting settings with specific timeout in seconds and retry interval in seconds.

Methods inherited from interface org.openqa.selenium.SearchContext

findElement, findElements

Methods inherited from interface cz.etnetera.seleniumbrowser.source.PropertySource

castString, getProperty, getProperty, getProperty

Methods inherited from interface cz.etnetera.seleniumbrowser.source.DataSource

addData, getData, removeData

Method Detail

getContext

BrowserContext getContext()

Returns parent BrowserContext instance.

Returns:

The parent browser context.

getContext

default <T> T getContext(Class<T> context)

Returns parent BrowserContext instance casted to specific type.

Returns:

The parent browser context.

getBrowser

Browser getBrowser()

Returns Browser instance.

Returns:

The browser

getBrowser

default <T> T getBrowser(Class<T> browser)

Returns Browser instance casted to specific type.

Returns:

The browser

getConfiguration

default BrowserConfiguration getConfiguration()

Returns BrowserConfiguration instance.

Returns:

The browser configuration

getConfiguration

default <T> T getConfiguration(Class<T> configuration)

Returns BrowserConfiguration instance casted to specific type.

Returns:

The browser configuration

getDriver

default org.openqa.selenium.WebDriver getDriver()

Returns wrapped WebDriver instance.

Returns:

The driver

getDriver

default <T> T getDriver(Class<T> driver)

Returns wrapped WebDriver instance casted to specific type.

Returns:

The driver

getPage

default Page getPage()

Returns actual page or null if browser has no page initiated.

Returns:

The actual page or null

getPage

default <T> T getPage(Class<T> page)

Returns actual page casted to given type or null if browser has no page initiated.

Parameters:

page - The class to cast the page to

Returns:

The actual page or null

setPage

default void setPage(Page page)

Sets actual browser page.

Parameters:

page - The page to set

goToUrl

default void goToUrl(String url)

Go to specific URL.

Parameters:

url - The URL to go to

getWaitTimeout

default double getWaitTimeout()

Returns default wait timeout.

Returns:

The default wait timeout.

getWaitRetryInterval

default double getWaitRetryInterval()

Returns default wait retry interval.

Returns:

The default wait retry interval.

waiting

default BrowserContextWait waiting(org.openqa.selenium.support.ui.Clock clock,
                                   org.openqa.selenium.support.ui.Sleeper sleeper,
                                   double timeout,
                                   double retryInterval)

Constructs new wait instance using default waiting settings with specific clock to use when measuring the timeout, specific sleeper to use to put the thread to sleep between evaluation loops, specific timeout in seconds and retry interval in seconds.

Parameters:

clock - The clock to use when measuring the timeout.

sleeper - Used to put the thread to sleep between evaluation loops.

timeout - The timeout before waiting ends.

retryInterval - The retry interval for delays between condition check.

Returns:

The wait instance

waiting

default BrowserContextWait waiting(double timeout,
                                   double retryInterval)

Constructs new wait instance using default waiting settings with specific timeout in seconds and retry interval in seconds.

Returns:

The wait instance

waiting

default BrowserContextWait waiting(double timeout)

Constructs new wait instance using default waiting settings with specific timeout in seconds.

Returns:

The wait instance

waiting

default BrowserContextWait waiting()

Constructs new wait instance using default waiting settings.

Returns:

The wait instance

isAt

default boolean isAt(Class<?> page)

Check if actual page is a given class. It performs no other redirection or verification.

Parameters:

page - The class to check the page against

Returns:

true if actual page is instance of given class

assertAt

default void assertAt(Class<?> page)

Asserts that actual page is a given class. It performs no other redirection or verification. Throws AssertionError if condition did not pass.

Parameters:

page - The class to check the page against

goToSafely

default <T extends Page> T goToSafely(Class<T> page)

Safely go to page defined by class. Page is automatically verified against its conditions. If verification fails null is returned.

Parameters:

page - The page class to go to

Returns:

The page instance or null if page is not verified

goToSafely

default <T extends Page> T goToSafely(T page)

Safely go to already constructed page. Page is automatically verified against its conditions. If verification fails null is returned.

Parameters:

page - The page instance to go to

Returns:

The same page instance or null if page is not verified

initPageSafely

default <T extends Page> T initPageSafely(Class<T> page)

Safely initialize page defined by class. It stays on same URL and tries to initialize the page. Page is automatically verified against its conditions. If verification fails null is returned.

Parameters:

page - The page class to initialize

Returns:

The page instance or null if page is not verified

initPageSafely

default <T extends Page> T initPageSafely(T page)

Safely initialize already constructed page. It stays on same URL and tries to initialize the page. Page is automatically verified against its conditions. If verification fails null is returned.

Parameters:

page - The page instance to initialize

Returns:

The same page instance or null if page is not verified

initOnePageSafely

default Page initOnePageSafely(Object... pages)

Safely initialize first of matching page. Pages can be defined as class or as Page instances. It iterates over all pages and tries to initialize and verify them. First verified page is returned. If none of the pages is verified null is returned.

Parameters:

pages - The page classes or pages to initialize

Returns:

The same page instance or null if none of pages is verified

goTo

default <T extends Page> T goTo(Class<T> page)

Go to page defined by class. Page is automatically verified against its conditions.

Parameters:

page - The page class to go to

Returns:

The page instance

Throws:

VerificationException - if page verification did not pass after initialization

goTo

default <T extends Page> T goTo(T page)

Go to already constructed page. Page is automatically verified against its conditions.

Parameters:

page - The page instance to go to

Returns:

The same page instance

Throws:

VerificationException - if page verification did not pass after initialization

initPage

default <T extends Page> T initPage(Class<T> page)

Initialize page defined by class. It stays on same URL and tries to initialize the page. Page is automatically verified against its conditions.

Parameters:

page - The page class to initialize

Returns:

The page instance

Throws:

VerificationException - if page verification did not pass after initialization

initPage

default <T extends Page> T initPage(T page)

Initialize already constructed page. It stays on same URL and tries to initialize the page. Page is automatically verified against its conditions.

Parameters:

page - The page instance to initialize

Returns:

The same page instance

Throws:

VerificationException - if page verification did not pass after initialization

initOnePage

default Page initOnePage(Object... pages)

Initialize first of matching page. Pages can be defined as class or as Page instances. It iterates over all pages and tries to initialize and verify them. First verified page is returned. If none of the pages is verified VerificationException is thrown.

Parameters:

pages - The page classes or pages to initialize

Returns:

The same page instance

Throws:

VerificationException - if none of pages did not pass verification after initialization

constructPage

default <T extends Page> T constructPage(Class<T> page)

Construct page defined by class.

Parameters:

page - The page class to construct

Returns:

The page instance

initBrowserElement

default <T extends BrowserElement> T initBrowserElement(T element)

Initialize already constructed element.

Parameters:

element - The element instance to initialize

Returns:

The same element instance

initBrowserElement

default <T extends BrowserElement> T initBrowserElement(Class<T> element,
                                                        org.openqa.selenium.WebElement webElement,
                                                        boolean optional)

Initialize element defined by class. It injects this instance as context into element.

Parameters:

element - The element class to initialize

webElement - The web element to wrap

optional - Is element optional

Returns:

The element instance.

constructBrowserElement

default <T extends BrowserElement> T constructBrowserElement(Class<T> element,
                                                             org.openqa.selenium.WebElement webElement,
                                                             boolean optional)

Construct element defined by class. It injects this instance as context into element.

Parameters:

element - The element class to construct

webElement - The web element to wrap

optional - Is element optional

Returns:

The element instance.

initLogic

default <T extends Logic> T initLogic(T logic)

Initialize logic defined by class.

Parameters:

logic - The logic instance to initialize

Returns:

The same logic instance

initLogic

default <T extends Logic> T initLogic(Class<T> logic)

Initialize logic defined by class.

Parameters:

logic - The logic class to initialize

Returns:

The logic instance

constructLogic

default <T extends Logic> T constructLogic(Class<T> logic)

Construct logic defined by class.

Parameters:

logic - The logic class to construct

Returns:

The logic instance

initElements

default void initElements()

Initialize elements annotated with FindBy and similar annotations.

checkIfPresent

default void checkIfPresent(org.openqa.selenium.WebElement element)
                     throws org.openqa.selenium.NoSuchElementException

Checks if element exists on actual page. If is present it does nothing. Otherwise throws NoSuchElementException.

Parameters:

element - The element to test

Throws:

org.openqa.selenium.NoSuchElementException - if element is not present

isPresent

default boolean isPresent(org.openqa.selenium.WebElement element)

Returns true if element exists on actual page. It is opposite to isNotPresent(WebElement).

Parameters:

element - The element to test

Returns:

true if element is present

isNotPresent

default boolean isNotPresent(org.openqa.selenium.WebElement element)

Returns true if element does not exists on actual page. It is opposite to isPresent(WebElement).

Parameters:

element - The element to test

Returns:

true if element is not present

report

default void report(String label)

Triggers OnReportEvent with given label.

Parameters:

label - The report label

triggerEvent

default void triggerEvent(BrowserEvent event)

Triggers BrowserEvent.

Parameters:

event - The triggered event

constructEvent

default <T extends BrowserEvent> T constructEvent(Class<T> eventCls)

Construct event defined by class.

Parameters:

eventCls - The event class to construct

Returns:

The event instance

saveFile

default void saveFile(String content,
                      String name,
                      String extension)

Saves string into named file with extension. It uses Browser.getFilePath(String, String). If Browser.isReported() is false no file is saved.

Parameters:

content - The string content to save.

name - The file name without extension.

extension - The file extension.

saveFile

default void saveFile(byte[] bytes,
                      String name,
                      String extension)

Saves bytes into named file with extension. It uses Browser.getFilePath(String, String). If Browser.isReported() is false no file is saved.

Parameters:

bytes - The bytes to save.

name - The file name without extension.

extension - The file extension.

saveFile

default void saveFile(File file,
                      String name,
                      String extension)

Saves file into named file with extension. It uses Browser.getFilePath(String, String). If Browser.isReported() is false no file is saved.

Parameters:

file - The file to save.

name - The file name without extension.

extension - The file extension.

getUtils

default BrowserUtils getUtils()

Returns browser utilities instance.

Returns:

The browser utilities.

find

default List<BrowserElement> find(org.openqa.selenium.By by)

Find all elements within the current context using the given mechanism.

Parameters:

by - The locating mechanism to use

Returns:

A list of all BrowserElements, or an empty list if nothing matches

find

default List<BrowserElement> find(BrowserContext context,
                                  org.openqa.selenium.By by)

Find all elements within the given context using the given mechanism.

Parameters:

context - The browser context to search in

by - The locating mechanism to use

Returns:

A list of all BrowserElements, or an empty list if nothing matches

find

default <T extends BrowserElement> List<T> find(org.openqa.selenium.By by,
                                                Class<T> elementCls)

Find all elements within the current context using the given mechanism as instances of the given BrowserElement or its subclass.

Parameters:

by - The locating mechanism to use

elementCls - The element class

Returns:

A list of all BrowserElements as instances of the given BrowserElement or its subclass, or an empty list if nothing matches

find

default <T extends BrowserElement> List<T> find(BrowserContext context,
                                                org.openqa.selenium.By by,
                                                Class<T> elementCls)

Find all elements within the given context using the given mechanism as instances of the given BrowserElement or its subclass.

Parameters:

context - The browser context to search in

by - The locating mechanism to use

elementCls - The element class

Returns:

A list of all BrowserElements as instances of the given BrowserElement or its subclass, or an empty list if nothing matches

findOne

default BrowserElement findOne(org.openqa.selenium.By by)

Find the first element within the current context using the given mechanism.

Parameters:

by - The locating mechanism

Returns:

The first matching element on the current context

Throws:

org.openqa.selenium.NoSuchElementException - If no matching elements are found

findOne

default BrowserElement findOne(BrowserContext context,
                               org.openqa.selenium.By by)

Find the first element within the given context using the given mechanism.

Parameters:

context - The browser context to search in

by - The locating mechanism

Returns:

The first matching element on the given context

Throws:

org.openqa.selenium.NoSuchElementException - If no matching elements are found

findOne

default <T extends BrowserElement> T findOne(org.openqa.selenium.By by,
                                             Class<T> elementCls)

Find the first element within the current context using the given mechanism as instance of the given BrowserElement or its subclass.

Parameters:

by - The locating mechanism

elementCls - The element class

Returns:

The first matching element on the current context as instance of the given BrowserElement or its subclass

Throws:

org.openqa.selenium.NoSuchElementException - If no matching elements are found

findOne

default <T extends BrowserElement> T findOne(BrowserContext context,
                                             org.openqa.selenium.By by,
                                             Class<T> elementCls)

Find the first element within the given context using the given mechanism as instance of the given BrowserElement or its subclass.

Parameters:

context - The browser context to search in

by - The locating mechanism

elementCls - The element class

Returns:

The first matching element on the given context as instance of the given BrowserElement or its subclass

Throws:

org.openqa.selenium.NoSuchElementException - If no matching elements are found

findOne

default <T extends BrowserElement> T findOne(BrowserContext context,
                                             org.openqa.selenium.By by,
                                             Class<T> elementCls,
                                             boolean optional)

Find the first element within the given context using the given mechanism as instance of the given BrowserElement or its subclass. If optional is true and no matching elements are found null is returned instead of throwing NoSuchElementException.

Parameters:

context - The browser context to search in

by - The locating mechanism

elementCls - The element class

optional - true for returning null instead of throwing NoSuchElementException if no matching elements are found

Returns:

The first matching element on the given context as instance of the given BrowserElement or its subclass

Throws:

org.openqa.selenium.NoSuchElementException - If no matching elements are found and optional is false

findOneOptional

default BrowserElement findOneOptional(org.openqa.selenium.By by)

Find the first element within the current context using the given mechanism. If no matching elements are found null is returned.

Parameters:

by - The locating mechanism

Returns:

The first matching element on the current context or null if no matching elements are found

findOneOptional

default BrowserElement findOneOptional(BrowserContext context,
                                       org.openqa.selenium.By by)

Find the first element within the given context using the given mechanism. If no matching elements are found null is returned.

Parameters:

context - The browser context to search in

by - The locating mechanism

Returns:

The first matching element on the current context or null if no matching elements are found

findOneOptional

default <T extends BrowserElement> T findOneOptional(org.openqa.selenium.By by,
                                                     Class<T> elementCls)

Find the first element within the current context using the given mechanism as instance of the given BrowserElement or its subclass. If no matching elements are found null is returned.

Parameters:

by - The locating mechanism

elementCls - The element class

Returns:

The first matching element on the current context or null if no matching elements are found

findOneOptional

default <T extends BrowserElement> T findOneOptional(BrowserContext context,
                                                     org.openqa.selenium.By by,
                                                     Class<T> elementCls)

Find the first element within the given context using the given mechanism as instance of the given BrowserElement or its subclass. If no matching elements are found null is returned.

Parameters:

context - The browser context to search in

by - The locating mechanism

elementCls - The element class

Returns:

The first matching element on the current context or null if no matching elements are found

createElementLocator

default org.openqa.selenium.support.pagefactory.ElementLocator createElementLocator(Field field)

Creates ElementLocator used to locate element. It uses FindBy and similar annotations assigned to the given field to create By locating mechanism.

Parameters:

field - The field used as locator source

Returns:

The element locator

createElementLocator

default org.openqa.selenium.support.pagefactory.ElementLocator createElementLocator(org.openqa.selenium.By by)

Creates ElementLocator used to locate element. It uses the given By locating mechanism.

Parameters:

by - The locating mechanism

Returns:

The element locator

createElementLocator

default org.openqa.selenium.support.pagefactory.ElementLocator createElementLocator(org.openqa.selenium.By by,
                                                                                    boolean lookupCached)

Creates ElementLocator used to locate element. It uses the given By locating mechanism. Set lookupCached to true return element from cache on further calls.

Parameters:

by - The locating mechanism

lookupCached - if lookup is cached

Returns:

The element locator

getWrappedDriver

default org.openqa.selenium.WebDriver getWrappedDriver()

Specified by:

getWrappedDriver in interface org.openqa.selenium.internal.WrapsDriver

getDataHolder

default Map<String,Object> getDataHolder()

Description copied from interface: DataSource

Returns map which holds data.

Specified by:

getDataHolder in interface DataSource

Returns:

The data holder map

getProperty

default String getProperty(String key)

Description copied from interface: PropertySource

Returns property as String.

Specified by:

getProperty in interface PropertySource

Parameters:

key - The property key.

Returns:

The property value or null.