Condition (selenide 4.7 API)

java.lang.Object
- com.codeborne.selenide.Condition

All Implemented Interfaces:

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

Direct Known Subclasses:

Text
```
public abstract class Condition
extends java.lang.Object
implements com.google.common.base.Predicate<org.openqa.selenium.WebElement>
```
Conditions to match web elements: checks for visibility, text etc.

Field Summary

Fields
Modifier and Type	Field and Description
`static Condition`	`appear` Synonym for `visible` - may be used for better readability
`static Condition`	`appears` Synonym for `visible` - may be used for better readability
`static Condition`	`checked` Checks that checkbox is checked
`static Condition`	`disabled` Checks that element is disabled
`static Condition`	`disappear` Synonym for `hidden` - may be used for better readability:
`static Condition`	`disappears` Synonym for `hidden` - may be used for better readability:
`static Condition`	`empty` 1) For input element, check that value is missing or empty
`static Condition`	`enabled` Checks that element is not disabled
`static Condition`	`exist` Check if element exist.
`static Condition`	`focused` Check if browser focus is currently in given element.
`static Condition`	`hidden` Checks that element is not visible or does not exists.
`protected java.lang.String`	`name`
`protected boolean`	`nullIsAllowed`
`static Condition`	`present` Deprecated. please use `exist` instead, "present" is ambiguous Synonym for `exist`. Sample: `$("input").shouldBe(present);`
`static Condition`	`readonly` Check if element has "readonly" attribute (with any value)
`static Condition`	`selected` Checks that element is selected
`static Condition`	`visible` Checks if element is visible

Constructor Summary

Constructors
Constructor and Description

Condition(java.lang.String name)

Condition(java.lang.String name, boolean absentElementMatchesCondition)

Constructors
Constructor and Description
`Condition(java.lang.String name)`
`Condition(java.lang.String name, boolean absentElementMatchesCondition)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`actualValue(org.openqa.selenium.WebElement element)` If element didn't match the condition, returns the actual value of element.
`static Condition`	`and(java.lang.String name, Condition... condition)` Check if element matches ALL given conditions.
`abstract boolean`	`apply(org.openqa.selenium.WebElement element)` Check if given element matches this condition.
`boolean`	`applyNull()`
`static Condition`	`attribute(java.lang.String attributeName)` Check if element has given attribute (with any value)
`static Condition`	`attribute(java.lang.String attributeName, java.lang.String expectedAttributeValue)` Sample: `$("#mydiv").shouldHave(attribute("fileId", "12345"));`
`static Condition`	`be(Condition delegate)` Used to form human-readable condition expression Example element.should(be(visible),have(text("abc"))
`Condition`	`because(java.lang.String message)` Should be used for explaining the reason of condition
`static Condition`	`cssClass(java.lang.String cssClass)` Sample: `$("input").shouldHave(cssClass("active"));`
`static Condition`	`exactText(java.lang.String text)` Sample: `$("h1").shouldHave(exactText("Hello"))`
`static Condition`	`exactTextCaseSensitive(java.lang.String text)` Sample: `$("h1").shouldHave(exactTextCaseSensitive("Hello"))`
`static Condition`	`exactValue(java.lang.String value)` Sample: `$("#input").shouldHave(exactValue("John"));`
`static Condition`	`hasAttribute(java.lang.String attributeName, java.lang.String attributeValue)` Deprecated. please use `attribute(String, String)` instead Sample: `$("#mydiv").waitUntil(hasAttribute("fileId", "12345"), 7000);`
`static Condition`	`hasClass(java.lang.String cssClass)` Deprecated. please use `cssClass(String)` instead of this method, which is exactly the same
`static boolean`	`hasClass(org.openqa.selenium.WebElement element, java.lang.String cssClass)` Deprecated. don't use this method, it is public by accident, and will be turned to private soon
`static Condition`	`hasText(java.lang.String text)` Deprecated. please use `text(String)` instead Sample: `$("h1").waitUntil(hasText("Hello"), 10000)` Case insensitive NB! Ignores multiple whitespaces between words
`static Condition`	`hasValue(java.lang.String value)` Deprecated. please use `value(String)` instead Sample: `$("#myInput").waitUntil(hasValue("John"), 5000)`
`static Condition`	`have(Condition delegate)` Used to form human-readable condition expression Example element.should(be(visible),have(text("abc"))
`static Condition`	`id(java.lang.String id)` Sample: `$("#input").shouldHave(id("myForm"))`
`static Condition`	`matchesText(java.lang.String text)` Sample: `$(".error_message").waitWhile(matchesText("Exception"), 12000)`
`static Condition`	`matchText(java.lang.String regex)` Assert that given element's text matches given regular expression
`static Condition`	`name(java.lang.String name)` Sample: `$("#input").shouldHave(name("username"))`
`static Condition`	`not(Condition condition)` Negate given condition.
`static Condition`	`or(java.lang.String name, Condition... condition)` Check if element matches ANY of given conditions.
`static Condition`	`text(java.lang.String text)` Sample: `$("h1").shouldHave(text("Hello\s*John"))`
`static Condition`	`textCaseSensitive(java.lang.String text)` Sample: `$("h1").shouldHave(textCaseSensitive("Hello\s*John"))`
`java.lang.String`	`toString()`
`static Condition`	`type(java.lang.String type)` Sample: `$("#input").shouldHave(type("checkbox"))`
`static Condition`	`value(java.lang.String expectedValue)` Assert that element has given "value" attribute as substring NB! Ignores difference in non-visible characters like spaces, non-breakable spaces, tabs, newlines etc.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.common.base.Predicate
equals, test

Methods inherited from interface java.util.function.Predicate
and, isEqual, negate, or

- Field Detail
  - visible
```
public static final Condition visible
```
    Checks if element is visible
    Sample: $("input").shouldBe(visible);
  - exist
```
public static final Condition exist
```
    Check if element exist. It can be visible or hidden.
    Sample: $("input").should(exist);
  - present
```
@Deprecated
public static final Condition present
```
    Deprecated. please use exist instead, "present" is ambiguous Synonym for exist.
    Sample: $("input").shouldBe(present);
  - hidden
```
public static final Condition hidden
```
    Checks that element is not visible or does not exists. Opposite to appear
    Sample: $("input").shouldBe(hidden);
  - appear
```
public static final Condition appear
```
    Synonym for visible - may be used for better readability
    Sample: $("#logoutLink").should(appear);
  - appears
```
public static final Condition appears
```
    Synonym for visible - may be used for better readability
    $("#logoutLink").waitUntil(appears, 10000);
    Though the same can be done in a shorter way:
    waitFor(By.id("logoutLink");
  - disappears
```
public static final Condition disappears
```
    Synonym for hidden - may be used for better readability:
    Sample: $("#loginLink").waitUntil(disappears, 9000);
  - disappear
```
public static final Condition disappear
```
    Synonym for hidden - may be used for better readability:
    $("#loginLink").should(disappear);
  - readonly
```
public static final Condition readonly
```
    Check if element has "readonly" attribute (with any value)
    Sample: $("input").shouldBe(readonly);
  - empty
```
public static final Condition empty
```
    1) For input element, check that value is missing or empty
    Sample: $("#input").shouldBe(empty)
    2) For other elements, check that text is empty
    Sample: $("h2").shouldBe(empty)
  - focused
```
public static final Condition focused
```
    Check if browser focus is currently in given element.
  - enabled
```
public static final Condition enabled
```
    Checks that element is not disabled
    
    See Also:
    
    WebElement.isEnabled()
  - disabled
```
public static final Condition disabled
```
    Checks that element is disabled
    
    See Also:
    
    WebElement.isEnabled()
  - selected
```
public static final Condition selected
```
    Checks that element is selected
    
    See Also:
    
    WebElement.isSelected()
  - checked
```
public static final Condition checked
```
    Checks that checkbox is checked
    
    See Also:
    
    WebElement.isSelected()
  - name
```
protected final java.lang.String name
```
  - nullIsAllowed
```
protected final boolean nullIsAllowed
```
- Constructor Detail
  - Condition
```
public Condition(java.lang.String name)
```
  - Condition
```
public Condition(java.lang.String name,
                 boolean absentElementMatchesCondition)
```
- Method Detail
  - hasAttribute
```
@Deprecated
public static Condition hasAttribute(java.lang.String attributeName,
                                                 java.lang.String attributeValue)
```
    Deprecated. please use attribute(String, String) instead
    Sample: $("#mydiv").waitUntil(hasAttribute("fileId", "12345"), 7000);
    
    Parameters:
    
    attributeName - name of attribute
    
    attributeValue - expected value of attribute
  - attribute
```
public static Condition attribute(java.lang.String attributeName)
```
    Check if element has given attribute (with any value)
    Sample: $("#mydiv").shouldHave(attribute("fileId"));
    
    Parameters:
    
    attributeName - name of attribute, not null
    
    Returns:
    
    true iff attribute exists
  - attribute
```
public static Condition attribute(java.lang.String attributeName,
                                  java.lang.String expectedAttributeValue)
```
    Sample: $("#mydiv").shouldHave(attribute("fileId", "12345"));
    
    Parameters:
    
    attributeName - name of attribute
    
    expectedAttributeValue - expected value of attribute
  - value
```
public static Condition value(java.lang.String expectedValue)
```
    Assert that element has given "value" attribute as substring NB! Ignores difference in non-visible characters like spaces, non-breakable spaces, tabs, newlines etc.
    Sample: $("input").shouldHave(value("12345 666 77"));
    
    Parameters:
    
    expectedValue - expected value of "value" attribute
  - exactValue
```
public static Condition exactValue(java.lang.String value)
```
    Sample: $("#input").shouldHave(exactValue("John"));
    
    Parameters:
    
    value - expected value of input field
  - hasValue
```
@Deprecated
public static Condition hasValue(java.lang.String value)
```
    Deprecated. please use value(String) instead
    Sample: $("#myInput").waitUntil(hasValue("John"), 5000)
    Parameters: value - expected value of input field
  name public static Condition name(java.lang.String name) Sample: $("#input").shouldHave(name("username")) Parameters: name - expected name of input field type public static Condition type(java.lang.String type) Sample: $("#input").shouldHave(type("checkbox")) Parameters: type - expected type of input field id public static Condition id(java.lang.String id) Sample: $("#input").shouldHave(id("myForm")) Parameters: id - expected id of input field matchesText public static Condition matchesText(java.lang.String text) Sample: $(".error_message").waitWhile(matchesText("Exception"), 12000) See Also: matchText(String) matchText public static Condition matchText(java.lang.String regex) Assert that given element's text matches given regular expression Sample: $("h1").should(matchText("Hello\s*John")) Parameters: regex - e.g. Kicked.*Chuck Norris - in this case ".*" can contain any characters including spaces, tabs, CR etc. hasText @Deprecated public static Condition hasText(java.lang.String text) Deprecated. please use text(String) instead Sample: $("h1").waitUntil(hasText("Hello"), 10000) Case insensitive NB! Ignores multiple whitespaces between words Parameters: text - expected text of HTML element text public static Condition text(java.lang.String text) Sample: $("h1").shouldHave(text("Hello\s*John")) NB! Case insensitive NB! Ignores multiple whitespaces between words Parameters: text - expected text of HTML element textCaseSensitive public static Condition textCaseSensitive(java.lang.String text) Sample: $("h1").shouldHave(textCaseSensitive("Hello\s*John")) NB! Ignores multiple whitespaces between words Parameters: text - expected text of HTML element exactText public static Condition exactText(java.lang.String text) Sample: $("h1").shouldHave(exactText("Hello")) Case insensitive NB! Ignores multiple whitespaces between words Parameters: text - expected text of HTML element exactTextCaseSensitive public static Condition exactTextCaseSensitive(java.lang.String text) Sample: $("h1").shouldHave(exactTextCaseSensitive("Hello")) NB! Ignores multiple whitespaces between words Parameters: text - expected text of HTML element hasClass @Deprecated public static boolean hasClass(org.openqa.selenium.WebElement element, java.lang.String cssClass) Deprecated. don't use this method, it is public by accident, and will be turned to private soon See Also: #cssClass(String)} instead of using it hasClass @Deprecated public static Condition hasClass(java.lang.String cssClass) Deprecated. please use cssClass(String) instead of this method, which is exactly the same See Also: Sample: $("input").waitUntil(hasClass("blocked"), 7000); cssClass public static Condition cssClass(java.lang.String cssClass) Sample: $("input").shouldHave(cssClass("active")); not public static Condition not(Condition condition) Negate given condition. Used for methods like $.shouldNot(exist), $.shouldNotBe(visible) Typically you don't need to use it. and public static Condition and(java.lang.String name, Condition... condition) Check if element matches ALL given conditions. Parameters: name - Name of this condition, like "empty" (meaning e.g. empty text AND empty value). condition - Conditions to match. Returns: logical AND for given conditions. or public static Condition or(java.lang.String name, Condition... condition) Check if element matches ANY of given conditions. Parameters: name - Name of this condition, like "error" (meaning e.g. "error" OR "failed"). condition - Conditions to match. Returns: logical OR for given conditions. be public static Condition be(Condition delegate) Used to form human-readable condition expression Example element.should(be(visible),have(text("abc")) Parameters: delegate - next condition to wrap Returns: Condition have public static Condition have(Condition delegate) Used to form human-readable condition expression Example element.should(be(visible),have(text("abc")) Parameters: delegate - next condition to wrap Returns: Condition apply public abstract boolean apply(org.openqa.selenium.WebElement element) Check if given element matches this condition. Parameters: element - given WebElement Returns: true if element matches condition applyNull public final boolean applyNull() actualValue public java.lang.String actualValue(org.openqa.selenium.WebElement element) If element didn't match the condition, returns the actual value of element. Used in error reporting. Optional. Makes sense only if you need to add some additional important info to error message. Parameters: element - given WebElement Returns: any string that needs to be appended to error message. because public Condition because(java.lang.String message) Should be used for explaining the reason of condition toString public java.lang.String toString() Overrides: toString in class java.lang.Object

Class Condition

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.common.base.Predicate

Methods inherited from interface java.util.function.Predicate

Field Detail

visible

exist

present

hidden

appear

appears

disappears

disappear

readonly

empty

focused

enabled

disabled

selected

checked

name

nullIsAllowed

Constructor Detail

Condition

Condition

Method Detail

hasAttribute

attribute

attribute

value

exactValue

hasValue

name

type

id

matchesText

matchText

hasText

text

textCaseSensitive

exactText

exactTextCaseSensitive

hasClass

hasClass

cssClass

not

and

or

be

have

apply

applyNull

actualValue

because

toString