com.workfusion.rpa.helpers

Class UiElementCollection

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<UiElement>

com.workfusion.rpa.helpers.UiElementCollection

All Implemented Interfaces:

Iterable<UiElement>, Collection<UiElement>, List<UiElement>

public class UiElementCollection
extends AbstractList<UiElement>

This class wraps a list of UiElement and provides a new functionality.

Samples

$$(".errorMessage").first()shouldBe(visible, enabled);

$$("td").shouldHaveSize(5);

$$(".edit").getTexts();

See Also:

List

Method Summary

Modifier and Type	Method and Description
static String	elementsToString(List<? extends org.openqa.selenium.WebElement> elements) Outputs string presentation of the element's collection
UiElementCollection	exclude(UiCondition condition) Filters elements excluding those which met the given condition
UiElementCollection	excludeWith(UiCondition condition) Filters elements excluding those which met the given condition
UiElementCollection	filter(UiCondition condition) Filters collection elements based on the given condition
UiElementCollection	filterBy(UiCondition condition) Filters collection elements based on the given condition
UiElement	find(UiCondition condition) Find the first element which met the given condition
UiElement	findBy(UiCondition condition) Find the first element which met the given condition
UiElement	first()
UiElement	get(int index)
String[]	getTexts() Gets all the texts in elements collection
static String[]	getTexts(Collection<? extends org.openqa.selenium.WebElement> elements) Fail-safe method for retrieving texts of given elements.
Iterator<UiElement>	iterator()
UiElement	last()
ListIterator<UiElement>	listIterator()
ListIterator<UiElement>	listIterator(int index)
UiElementCollection	shouldBe(UiCollectionCondition... conditions) $$(".error").shouldBe(empty)
UiElementCollection	shouldHave(UiCollectionCondition... conditions) $$(".error").shouldHave(size(3))
UiElementCollection	shouldHaveSize(int expectedSize) Checks is the collection is of given size
int	size()
String	toString()
UiElementCollection	waitUntil(UiCollectionCondition condition) Wait until given collection meets given conditions.
UiElementCollection	waitUntil(UiCollectionCondition condition, long timeoutMilliseconds) Wait until given collection meets given conditions.
UiElementCollection	waitUntil(UiCollectionCondition condition, long timeoutMilliseconds, long pollingIntervalMilliseconds) Wait until given collection meets given conditions.
UiElementCollection	waitWhile(UiCollectionCondition condition) Wait while given collection meets given conditions.
UiElementCollection	waitWhile(UiCollectionCondition condition, long timeoutMilliseconds) Wait while given collection meets given conditions.
UiElementCollection	waitWhile(UiCollectionCondition condition, long timeoutMilliseconds, long pollingIntervalMilliseconds) Wait while given collection meets given conditions.

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, equals, hashCode, indexOf, lastIndexOf, remove, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

get

public UiElement get(int index)

Specified by:

get in interface List<UiElement>

Specified by:

get in class AbstractList<UiElement>

first

public UiElement first()

Returns:

the first element of the collection

last

public UiElement last()

Returns:

the last element of the collection

size

public int size()

Specified by:

size in interface Collection<UiElement>

Specified by:

size in interface List<UiElement>

Specified by:

size in class AbstractCollection<UiElement>

shouldHaveSize

public UiElementCollection shouldHaveSize(int expectedSize)

Checks is the collection is of given size

Parameters:

expectedSize - expected size of the collection

Returns:

UiElementCollection

shouldBe

public UiElementCollection shouldBe(UiCollectionCondition... conditions)

$$(".error").shouldBe(empty)

shouldHave

public UiElementCollection shouldHave(UiCollectionCondition... conditions)

$$(".error").shouldHave(size(3))

waitUntil

public UiElementCollection waitUntil(UiCollectionCondition condition)

Wait until given collection meets given conditions.

Throws:

IllegalStateException - if collection still is not matched to condition after the timeout

waitUntil

public UiElementCollection waitUntil(UiCollectionCondition condition,
                                     long timeoutMilliseconds)

Wait until given collection meets given conditions.

Parameters:

timeoutMilliseconds - timeout in milliseconds.

Throws:

IllegalStateException - if collection still is not matched to condition after the timeout

waitUntil

public UiElementCollection waitUntil(UiCollectionCondition condition,
                                     long timeoutMilliseconds,
                                     long pollingIntervalMilliseconds)

Wait until given collection meets given conditions.

Parameters:

timeoutMilliseconds - timeout in milliseconds.

pollingIntervalMilliseconds - interval in milliseconds, when checking condition

Throws:

IllegalStateException - if collection still is not matched to condition after the timeout

waitWhile

public UiElementCollection waitWhile(UiCollectionCondition condition)

Wait while given collection meets given conditions.

Throws:

IllegalStateException - if collection still is not matched to condition after the timeout

waitWhile

public UiElementCollection waitWhile(UiCollectionCondition condition,
                                     long timeoutMilliseconds)

Wait while given collection meets given conditions.

Parameters:

timeoutMilliseconds - timeout in milliseconds.

Throws:

IllegalStateException - if collection still is not matched to condition after the timeout

waitWhile

public UiElementCollection waitWhile(UiCollectionCondition condition,
                                     long timeoutMilliseconds,
                                     long pollingIntervalMilliseconds)

Wait while given collection meets given conditions.

Parameters:

timeoutMilliseconds - timeout in milliseconds.

pollingIntervalMilliseconds - interval in milliseconds, when checking condition

Throws:

IllegalStateException - if collection still is not matched to condition after the timeout

filter

public UiElementCollection filter(UiCondition condition)

Filters collection elements based on the given condition

Parameters:

condition -

Returns:

UiElementCollection

filterBy

public UiElementCollection filterBy(UiCondition condition)

Filters collection elements based on the given condition

Parameters:

condition -

Returns:

UiElementCollection

See Also:

filter(UiCondition)

exclude

public UiElementCollection exclude(UiCondition condition)

Filters elements excluding those which met the given condition

Parameters:

condition -

Returns:

UiElementCollection

excludeWith

public UiElementCollection excludeWith(UiCondition condition)

Filters elements excluding those which met the given condition

Parameters:

condition -

Returns:

UiElementCollection

See Also:

exclude(UiCondition)

find

public UiElement find(UiCondition condition)

Find the first element which met the given condition

Parameters:

condition -

Returns:

UiElement

findBy

public UiElement findBy(UiCondition condition)

Find the first element which met the given condition

Parameters:

condition -

Returns:

UiElement

See Also:

find(UiCondition)

getTexts

public String[] getTexts()

Gets all the texts in elements collection

Returns:

array of texts

getTexts

public static String[] getTexts(Collection<? extends org.openqa.selenium.WebElement> elements)

Fail-safe method for retrieving texts of given elements.

Parameters:

elements - Any collection of WebElements

Returns:

Array of texts (or exceptions in case of any WebDriverExceptions)

elementsToString

public static String elementsToString(List<? extends org.openqa.selenium.WebElement> elements)

Outputs string presentation of the element's collection

Parameters:

elements -

Returns:

String

iterator

public Iterator<UiElement> iterator()

Specified by:

iterator in interface Iterable<UiElement>

Specified by:

iterator in interface Collection<UiElement>

Specified by:

iterator in interface List<UiElement>

Overrides:

iterator in class AbstractList<UiElement>

listIterator

public ListIterator<UiElement> listIterator()

Specified by:

listIterator in interface List<UiElement>

Overrides:

listIterator in class AbstractList<UiElement>

listIterator

public ListIterator<UiElement> listIterator(int index)

Specified by:

listIterator in interface List<UiElement>

Overrides:

listIterator in class AbstractList<UiElement>

toString

public String toString()

Overrides:

toString in class AbstractCollection<UiElement>