com.codeborne.selenide

Class CollectionCondition

java.lang.Object

com.codeborne.selenide.CollectionCondition

All Implemented Interfaces:

java.util.function.Predicate<java.util.List<org.openqa.selenium.WebElement>>

Direct Known Subclasses:

ContainExactTextsCaseSensitive, ExactTexts, ItemWithText, ListSize, PredicateCollectionCondition, SizeGreaterThan, SizeGreaterThanOrEqual, SizeLessThan, SizeLessThanOrEqual, SizeNotEqual

@ParametersAreNonnullByDefault
public abstract class CollectionCondition
extends java.lang.Object
implements java.util.function.Predicate<java.util.List<org.openqa.selenium.WebElement>>

Field Summary

Fields

Modifier and Type	Field and Description
static CollectionCondition	empty
protected java.lang.String	explanation

Constructor Summary

Constructors

Constructor and Description
CollectionCondition()

Method Summary

Modifier and Type	Method and Description
static CollectionCondition	allMatch(java.lang.String description, java.util.function.Predicate<org.openqa.selenium.WebElement> predicate) Checks if ALL elements of this collection match the provided predicate
static CollectionCondition	anyMatch(java.lang.String description, java.util.function.Predicate<org.openqa.selenium.WebElement> predicate) Checks if ANY elements of this collection match the provided predicate
CollectionCondition	because(java.lang.String explanation) Should be used for explaining the reason of condition
static CollectionCondition	containExactTextsCaseSensitive(java.util.List<java.lang.String> expectedTexts) Check that the given collection contains all elements with given texts.
static CollectionCondition	containExactTextsCaseSensitive(java.lang.String... expectedTexts) Check that the given collection contains all elements with given texts.
static CollectionCondition	exactTexts(java.util.List<java.lang.String> expectedTexts) Checks that given collection has given texts (each collection element EQUALS TO corresponding text)
static CollectionCondition	exactTexts(java.lang.String... expectedTexts) Checks that given collection has given texts (each collection element EQUALS TO corresponding text)
static CollectionCondition	exactTextsCaseSensitiveInAnyOrder(java.util.List<java.lang.String> expectedTexts) Checks that given collection has given texts in any order (each collection element EQUALS TO corresponding text)
static CollectionCondition	exactTextsCaseSensitiveInAnyOrder(java.lang.String... expectedTexts) Checks that given collection has given texts in any order (each collection element EQUALS TO corresponding text)
abstract void	fail(CollectionSource collection, java.util.List<org.openqa.selenium.WebElement> elements, java.lang.Exception lastError, long timeoutMs)
static CollectionCondition	itemWithText(java.lang.String expectedText) Checks if given collection has an element with given text.
abstract boolean	missingElementSatisfiesCondition()
static CollectionCondition	noneMatch(java.lang.String description, java.util.function.Predicate<org.openqa.selenium.WebElement> predicate) Checks if NONE elements of this collection match the provided predicate
static CollectionCondition	size(int expectedSize) Checks that collection has the given size
static CollectionCondition	sizeGreaterThan(int expectedSize)
static CollectionCondition	sizeGreaterThanOrEqual(int expectedSize)
static CollectionCondition	sizeLessThan(int expectedSize)
static CollectionCondition	sizeLessThanOrEqual(int size)
static CollectionCondition	sizeNotEqual(int expectedSize)
static CollectionCondition	texts(java.util.List<java.lang.String> expectedTexts) Checks that given collection has given texts (each collection element CONTAINS corresponding text)
static CollectionCondition	texts(java.lang.String... expectedTexts) Checks that given collection has given texts (each collection element CONTAINS corresponding text)
static CollectionCondition	textsInAnyOrder(java.util.List<java.lang.String> expectedTexts) Checks that given collection has given texts in any order (each collection element CONTAINS corresponding text)
static CollectionCondition	textsInAnyOrder(java.lang.String... expectedTexts) Checks that given collection has given texts in any order (each collection element CONTAINS corresponding text)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or, test

Field Detail

explanation

protected java.lang.String explanation

empty

public static CollectionCondition empty

Constructor Detail

CollectionCondition

public CollectionCondition()

Method Detail

fail

public abstract void fail(CollectionSource collection,
                          @Nullable
                          java.util.List<org.openqa.selenium.WebElement> elements,
                          @Nullable
                          java.lang.Exception lastError,
                          long timeoutMs)

size

@CheckReturnValue
public static CollectionCondition size(int expectedSize)

Checks that collection has the given size

sizeGreaterThan

@CheckReturnValue
public static CollectionCondition sizeGreaterThan(int expectedSize)

sizeGreaterThanOrEqual

@CheckReturnValue
public static CollectionCondition sizeGreaterThanOrEqual(int expectedSize)

sizeLessThan

@CheckReturnValue
public static CollectionCondition sizeLessThan(int expectedSize)

sizeLessThanOrEqual

@CheckReturnValue
public static CollectionCondition sizeLessThanOrEqual(int size)

sizeNotEqual

@CheckReturnValue
public static CollectionCondition sizeNotEqual(int expectedSize)

texts

@CheckReturnValue
public static CollectionCondition texts(java.lang.String... expectedTexts)

Checks that given collection has given texts (each collection element CONTAINS corresponding text)

NB! Ignores multiple whitespaces between words

texts

@CheckReturnValue
public static CollectionCondition texts(java.util.List<java.lang.String> expectedTexts)

Checks that given collection has given texts (each collection element CONTAINS corresponding text)

NB! Ignores multiple whitespaces between words

textsInAnyOrder

@CheckReturnValue
public static CollectionCondition textsInAnyOrder(java.lang.String... expectedTexts)

Checks that given collection has given texts in any order (each collection element CONTAINS corresponding text)

NB! Ignores multiple whitespaces between words

textsInAnyOrder

@CheckReturnValue
public static CollectionCondition textsInAnyOrder(java.util.List<java.lang.String> expectedTexts)

Checks that given collection has given texts in any order (each collection element CONTAINS corresponding text)

NB! Ignores multiple whitespaces between words

exactTexts

@CheckReturnValue
public static CollectionCondition exactTexts(java.lang.String... expectedTexts)

Checks that given collection has given texts (each collection element EQUALS TO corresponding text)

NB! Ignores multiple whitespaces between words

exactTexts

@CheckReturnValue
public static CollectionCondition exactTexts(java.util.List<java.lang.String> expectedTexts)

Checks that given collection has given texts (each collection element EQUALS TO corresponding text)

NB! Ignores multiple whitespaces between words

anyMatch

@CheckReturnValue
public static CollectionCondition anyMatch(java.lang.String description,
                                                             java.util.function.Predicate<org.openqa.selenium.WebElement> predicate)

Checks if ANY elements of this collection match the provided predicate

Parameters:

description - The description of the given predicate

predicate - the Predicate to match

allMatch

@CheckReturnValue
public static CollectionCondition allMatch(java.lang.String description,
                                                             java.util.function.Predicate<org.openqa.selenium.WebElement> predicate)

Checks if ALL elements of this collection match the provided predicate

Parameters:

description - The description of the given predicate

predicate - the Predicate to match

noneMatch

@CheckReturnValue
public static CollectionCondition noneMatch(java.lang.String description,
                                                              java.util.function.Predicate<org.openqa.selenium.WebElement> predicate)

Checks if NONE elements of this collection match the provided predicate

Parameters:

description - The description of the given predicate

predicate - the Predicate to match

itemWithText

@CheckReturnValue
public static CollectionCondition itemWithText(java.lang.String expectedText)

Checks if given collection has an element with given text. The condition is satisfied if one or more elements in this collection have exactly the given text.

Parameters:

expectedText - The expected text in the collection

containExactTextsCaseSensitive

@CheckReturnValue
public static CollectionCondition containExactTextsCaseSensitive(java.lang.String... expectedTexts)

Check that the given collection contains all elements with given texts.

NB! This condition is case-sensitive and checks for exact matches!

Examples:

 // collection 1: [Tom, Dick, Harry]
 $$("li.odd").should(containExactTextsCaseSensitive("Tom", "Dick", "Harry")); // success
 // collection 2: [Tom, John, Dick, Harry]
 $$("li.even").should(containExactTextsCaseSensitive("Tom", "Dick", "Harry")); // success
 // collection 3: [John, Dick, Tom, Paul]
 $$("li.first").should(containExactTextsCaseSensitive("Tom", "Dick", "Harry")); // fail ("Harry" is missing)
 // collection 4: [Tom, Dick, hArRy]
 $$("li.last").should(containExactTextsCaseSensitive("Tom", "Dick", "Harry")); // fail ("Harry" is missing)
 

Parameters:

expectedTexts - the expected texts that the collection should contain

containExactTextsCaseSensitive

@CheckReturnValue
public static CollectionCondition containExactTextsCaseSensitive(java.util.List<java.lang.String> expectedTexts)

Check that the given collection contains all elements with given texts.

NB! This condition is case-sensitive and checks for exact matches!

Examples:

 // collection 1: [Tom, Dick, Harry]
 $$("li.odd").should(containExactTextsCaseSensitive("Tom", "Dick", "Harry")); // success
 // collection 2: [Tom, John, Dick, Harry]
 $$("li.even").should(containExactTextsCaseSensitive("Tom", "Dick", "Harry")); // success
 // collection 3: [John, Dick, Tom, Paul]
 $$("li.first").should(containExactTextsCaseSensitive("Tom", "Dick", "Harry")); // fail ("Harry" is missing)
 // collection 4: [Tom, Dick, hArRy]
 $$("li.last").should(containExactTextsCaseSensitive("Tom", "Dick", "Harry")); // fail ("Harry" is missing)
 

Parameters:

expectedTexts - the expected texts that the collection should contain

exactTextsCaseSensitiveInAnyOrder

@CheckReturnValue
public static CollectionCondition exactTextsCaseSensitiveInAnyOrder(java.util.List<java.lang.String> expectedTexts)

Checks that given collection has given texts in any order (each collection element EQUALS TO corresponding text)

NB! Case sensitive

Parameters:

expectedTexts - Expected texts in any order in the collection

exactTextsCaseSensitiveInAnyOrder

@CheckReturnValue
public static CollectionCondition exactTextsCaseSensitiveInAnyOrder(java.lang.String... expectedTexts)

Checks that given collection has given texts in any order (each collection element EQUALS TO corresponding text)

NB! Case sensitive

Parameters:

expectedTexts - Expected texts in any order in the collection

because

public CollectionCondition because(java.lang.String explanation)

Should be used for explaining the reason of condition

missingElementSatisfiesCondition

public abstract boolean missingElementSatisfiesCondition()