Package com.codeborne.selenide

Class ElementsCollection

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<SelenideElement>

com.codeborne.selenide.ElementsCollection

All Implemented Interfaces:

Iterable<SelenideElement>, Collection<SelenideElement>, List<SelenideElement>

@ParametersAreNonnullByDefault
public class ElementsCollection
extends AbstractList<SelenideElement>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ElementsCollection.SelenideElementIterable

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
ElementsCollection(Driver driver, String cssSelector)
ElementsCollection(Driver driver, Collection<? extends org.openqa.selenium.WebElement> elements)
ElementsCollection(Driver driver, org.openqa.selenium.By seleniumSelector)
ElementsCollection(CollectionSource collection)

Method Summary

Modifier and Type	Method	Description
ElementsCollection	as(String alias)	Give this collection a human-readable name
ElementsCollection.SelenideElementIterable	asDynamicIterable()	Returns a "dynamic" Iterable which reloads web elements during iteration.
ElementsCollection.SelenideElementIterable	asFixedIterable()	Returns a "static" Iterable which doesn't reload web elements during iteration.
static String	elementsToString(Driver driver, Collection<org.openqa.selenium.WebElement> elements)	Outputs string presentation of the element's collection
ElementsCollection	exclude(Condition condition)	Filters elements excluding those which met the given condition (lazy evaluation)
ElementsCollection	excludeWith(Condition condition)	Filters elements excluding those which met the given condition (lazy evaluation)
ElementsCollection	filter(Condition condition)	Filters collection elements based on the given condition (lazy evaluation)
ElementsCollection	filterBy(Condition condition)	Filters collection elements based on the given condition (lazy evaluation)
SelenideElement	find(Condition condition)	Find the first element which met the given condition (lazy evaluation)
SelenideElement	findBy(Condition condition)	Find the first element which met the given condition (lazy evaluation)
SelenideElement	first()	returns the first element of the collection (lazy evaluation)
ElementsCollection	first(int elements)	returns the first n elements of the collection (lazy evaluation)
void	forEach(Consumer<? super SelenideElement> action)	Deprecated. Use either asFixedIterable() or asDynamicIterable() instead.
SelenideElement	get(int index)	Gets the n-th element of collection (lazy evaluation)
Iterator<SelenideElement>	iterator()	Deprecated. use method asFixedIterable() or asDynamicIterable() instead.
SelenideElement	last()	returns the last element of the collection (lazy evaluation)
ElementsCollection	last(int elements)	returns the last n elements of the collection (lazy evaluation)
ListIterator<SelenideElement>	listIterator(int index)	Deprecated. use method asFixedIterable() or asDynamicIterable() instead.
Stream<SelenideElement>	parallelStream()	Deprecated. Use either asFixedIterable() or asDynamicIterable() instead.
ElementsCollection	should(CollectionCondition... conditions)	Check if a collection matches given condition(s).
ElementsCollection	should(CollectionCondition condition, Duration timeout)	Check if a collection matches a given condition within the given time period.
protected ElementsCollection	should(String prefix, Duration timeout, CollectionCondition... conditions)
ElementsCollection	shouldBe(CollectionCondition... conditions)	For example: $$(".error").shouldBe(empty)
ElementsCollection	shouldBe(CollectionCondition condition, Duration timeout)
ElementsCollection	shouldHave(CollectionCondition... conditions)	For example: $$(".error").shouldHave(size(3)) $$(".error").shouldHave(texts("Error1", "Error2"))
ElementsCollection	shouldHave(CollectionCondition condition, Duration timeout)	Check if a collection matches given condition within given period
int	size()	return actual size of the collection, doesn't wait on collection to be loaded.
ElementsCollection	snapshot()	Takes the snapshot of current state of this collection.
Stream<SelenideElement>	stream()	Deprecated. Use either asFixedIterable() or asDynamicIterable() instead.
List<String>	texts()	Gets all the texts in elements collection
static List<String>	texts(Collection<org.openqa.selenium.WebElement> elements)	Fail-safe method for retrieving texts of given elements.
Object[]	toArray()	Deprecated. use method asFixedIterable() or asDynamicIterable() instead.
String	toString()
protected void	waitUntil(CollectionCondition condition, Duration timeout)

Methods inherited from class java.util.AbstractList

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

Methods inherited from class java.util.AbstractCollection

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

removeIf, toArray

Methods inherited from interface java.util.List

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

Constructor Details

ElementsCollection

public ElementsCollection(CollectionSource collection)

ElementsCollection

public ElementsCollection(Driver driver,
 Collection<? extends org.openqa.selenium.WebElement> elements)

ElementsCollection

public ElementsCollection(Driver driver,
 String cssSelector)

ElementsCollection

public ElementsCollection(Driver driver,
 org.openqa.selenium.By seleniumSelector)

Method Details

should

@Nonnull
public ElementsCollection should(CollectionCondition... conditions)

Check if a collection matches given condition(s).

For example:

 
 $$(".text_list").should(containExactTextsCaseSensitive("text1", "text2"));
 $$(".cat_list").should(allMatch("value==cat", el -> el.getAttribute("value").equals("cat")));
 
 

should

@Nonnull
public ElementsCollection should(CollectionCondition condition,
 Duration timeout)

Check if a collection matches a given condition within the given time period.

Parameters:

timeout - maximum waiting time

shouldBe

@Nonnull
public ElementsCollection shouldBe(CollectionCondition... conditions)

For example: $$(".error").shouldBe(empty)

shouldBe

@Nonnull
public ElementsCollection shouldBe(CollectionCondition condition,
 Duration timeout)

shouldHave

@Nonnull
public ElementsCollection shouldHave(CollectionCondition... conditions)

For example: $$(".error").shouldHave(size(3)) $$(".error").shouldHave(texts("Error1", "Error2"))

shouldHave

@Nonnull
public ElementsCollection shouldHave(CollectionCondition condition,
 Duration timeout)

Check if a collection matches given condition within given period

Parameters:

timeout - maximum waiting time

should

@Nonnull
protected ElementsCollection should(String prefix,
 Duration timeout,
 CollectionCondition... conditions)

waitUntil

protected void waitUntil(CollectionCondition condition,
 Duration timeout)

filter

@CheckReturnValue
@Nonnull
public ElementsCollection filter(Condition condition)

Filters collection elements based on the given condition (lazy evaluation)

Parameters:

condition - condition

Returns:

ElementsCollection

See Also:

• Lazy loading

filterBy

@CheckReturnValue
@Nonnull
public ElementsCollection filterBy(Condition condition)

Filters collection elements based on the given condition (lazy evaluation)

Parameters:

condition - condition

Returns:

ElementsCollection

See Also:

• filter(Condition)
• Lazy loading

exclude

@CheckReturnValue
@Nonnull
public ElementsCollection exclude(Condition condition)

Filters elements excluding those which met the given condition (lazy evaluation)

Parameters:

condition - condition

Returns:

ElementsCollection

See Also:

• Lazy loading

excludeWith

@CheckReturnValue
@Nonnull
public ElementsCollection excludeWith(Condition condition)

Filters elements excluding those which met the given condition (lazy evaluation)

Parameters:

condition - condition

Returns:

ElementsCollection

See Also:

• exclude(Condition)
• Lazy loading

find

@CheckReturnValue
@Nonnull
public SelenideElement find(Condition condition)

Find the first element which met the given condition (lazy evaluation)

Parameters:

condition - condition

Returns:

SelenideElement

See Also:

• Lazy loading

findBy

@CheckReturnValue
@Nonnull
public SelenideElement findBy(Condition condition)

Find the first element which met the given condition (lazy evaluation)

Parameters:

condition - condition

Returns:

SelenideElement

See Also:

• find(Condition)
• Lazy loading

texts

@CheckReturnValue
@Nonnull
public List<String> texts()

Gets all the texts in elements collection

See Also:

• NOT RECOMMENDED

texts

@CheckReturnValue
@Nonnull
public static List<String> texts(@Nullable
 Collection<org.openqa.selenium.WebElement> elements)

Fail-safe method for retrieving texts of given elements.

Parameters:

elements - Any collection of WebElements

Returns:

Texts (or exceptions in case of any WebDriverExceptions)

elementsToString

@CheckReturnValue
@Nonnull
public static String elementsToString(Driver driver,
 @Nullable
 Collection<org.openqa.selenium.WebElement> elements)

Outputs string presentation of the element's collection

Parameters:

elements - elements of string

Returns:

e.g. "[<h1>foo</h1>, <h2>bar</h2>]"

See Also:

• NOT RECOMMENDED

get

@CheckReturnValue
@Nonnull
public SelenideElement get(int index)

Gets the n-th element of collection (lazy evaluation)

Specified by:

get in interface List<SelenideElement>

Specified by:

get in class AbstractList<SelenideElement>

Parameters:

index - 0..N

Returns:

the n-th element of collection

See Also:

• Lazy loading

first

@CheckReturnValue
@Nonnull
public SelenideElement first()

returns the first element of the collection (lazy evaluation)

NOTICE: Instead of $$(css).first(), prefer $(css) as it's faster and returns the same result

Returns:

the first element of the collection

See Also:

• Lazy loading

last

@CheckReturnValue
@Nonnull
public SelenideElement last()

returns the last element of the collection (lazy evaluation)

Returns:

the last element of the collection

See Also:

• Lazy loading

first

@CheckReturnValue
@Nonnull
public ElementsCollection first(int elements)

returns the first n elements of the collection (lazy evaluation)

Parameters:

elements - number of elements 1..N

See Also:

• Lazy loading

last

@CheckReturnValue
@Nonnull
public ElementsCollection last(int elements)

returns the last n elements of the collection (lazy evaluation)

Parameters:

elements - number of elements 1..N

See Also:

• Lazy loading

size

@CheckReturnValue
public int size()

return actual size of the collection, doesn't wait on collection to be loaded.

Specified by:

size in interface Collection<SelenideElement>

Specified by:

size in interface List<SelenideElement>

Specified by:

size in class AbstractCollection<SelenideElement>

Returns:

actual size of the collection

See Also:

• NOT RECOMMENDED

stream

@Deprecated
public Stream<SelenideElement> stream()

Deprecated.

Use either asFixedIterable() or asDynamicIterable() instead.

Not recommended: As a rule, tests should not iterate collection elements. Instead, try to write a CollectionCondition which verifies the whole collection.

See Also:

• NOT RECOMMENDED

parallelStream

@Deprecated
public Stream<SelenideElement> parallelStream()

Deprecated.

Use either asFixedIterable() or asDynamicIterable() instead.

Not recommended: As a rule, tests should not iterate collection elements. Instead, try to write a CollectionCondition which verifies the whole collection.

See Also:

• NOT RECOMMENDED

forEach

@Deprecated
public void forEach(Consumer<? super SelenideElement> action)

Deprecated.

Use either asFixedIterable() or asDynamicIterable() instead.

Not recommended: As a rule, tests should not iterate collection elements. Instead, try to write a CollectionCondition which verifies the whole collection.

See Also:

• NOT RECOMMENDED

iterator

@CheckReturnValue
@Nonnull
@Deprecated
public Iterator<SelenideElement> iterator()

Deprecated.

use method asFixedIterable() or asDynamicIterable() instead.

Does not reload collection elements while iterating it. Not recommended: As a rule, tests should not iterate collection elements. Instead, try to write a CollectionCondition which verifies the whole collection.

Specified by:

iterator in interface Collection<SelenideElement>

Specified by:

iterator in interface Iterable<SelenideElement>

Specified by:

iterator in interface List<SelenideElement>

Overrides:

iterator in class AbstractList<SelenideElement>

See Also:

• NOT RECOMMENDED

listIterator

@CheckReturnValue
@Nonnull
@Deprecated
public ListIterator<SelenideElement> listIterator(int index)

Deprecated.

use method asFixedIterable() or asDynamicIterable() instead.

Does not reload collection elements while iterating it. Not recommended: As a rule, tests should not iterate collection elements. Instead, try to write a CollectionCondition which verifies the whole collection.

Specified by:

listIterator in interface List<SelenideElement>

Overrides:

listIterator in class AbstractList<SelenideElement>

See Also:

• NOT RECOMMENDED

toArray

@CheckReturnValue
@Nonnull
@Deprecated
public Object[] toArray()

Deprecated.

use method asFixedIterable() or asDynamicIterable() instead.

Specified by:

toArray in interface Collection<SelenideElement>

Specified by:

toArray in interface List<SelenideElement>

Overrides:

toArray in class AbstractCollection<SelenideElement>

See Also:

• NOT RECOMMENDED

snapshot

@CheckReturnValue
@Nonnull
public ElementsCollection snapshot()

Takes the snapshot of current state of this collection. Succeeding calls to this object WILL NOT RELOAD collection element from browser.

Use it to speed up your tests - but only if you know that collection will not be changed during the test.

Returns:

current state of this collection

See Also:

• asFixedIterable()

asFixedIterable

@CheckReturnValue
@Nonnull
public ElementsCollection.SelenideElementIterable asFixedIterable()

Returns a "static" Iterable which doesn't reload web elements during iteration. It's faster than asDynamicIterable() ()}, but can sometimes can cause StaleElementReferenceException etc. if elements are re-rendered during the iteration.

Since:

6.2.0

See Also:

• NOT RECOMMENDED

asDynamicIterable

@CheckReturnValue
@Nonnull
public ElementsCollection.SelenideElementIterable asDynamicIterable()

Returns a "dynamic" Iterable which reloads web elements during iteration. It's slower than asFixedIterable(), but helps to avoid StaleElementReferenceException etc.

Since:

6.2.0

See Also:

• NOT RECOMMENDED

as

@CheckReturnValue
@Nonnull
public ElementsCollection as(String alias)

Give this collection a human-readable name

Caution: you probably don't need this method. It's always a good idea to have the actual selector instead of "nice" description (which might be misleading or even lying).

Parameters:

alias - a human-readable name of this collection (null or empty string not allowed)

Returns:

this collection

Since:

5.20.0

toString

@CheckReturnValue
public String toString()

Overrides:

toString in class AbstractCollection<SelenideElement>