Summary: Methods | Inherited Methods | [Expand All]

# DomMatchers

`public final class DomMatchers`
`extends Object` ``

java.lang.Object
↳ | android.support.test.espresso.web.matcher.DomMatchers

A collection of hamcrest matchers for objects in the org.w3c.dom package (such as `Document` and `Element`).

## Summary

### Public methods
`static Matcher<Document>` | `containingTextInBody(String text)` Returns a matcher that matches Documents that have a body containing the given test.
`static Matcher<Document>` | `elementById(String id, Matcher<Element> elementMatcher)` Matches `Document`s that have an `Element` with the given id that matches the given element matcher.
`static Matcher<Document>` | `elementByXPath(String xpath, Matcher<Element> elementMatcher)` Matches a XPath and validates it against the first `Element` that it finds in the `NodeList`.
`static Matcher<Document>` | `hasElementWithId(String id)` Returns a matcher that matches `Document`s that have at least one element with the given id.
`static Matcher<Document>` | `hasElementWithXpath(String xpath)` Returns a matcher that matches `Document`s that have at least one element with the given xpath.
`static Matcher<Document>` | `withBody(Matcher<Element> bodyMatcher)` Returns a matcher that matches `Document`s with body that matches the given matcher.
`static Matcher<Element>` | `withTextContent(String textContent)` Returns a matcher that matches `Element`s with the given textContent.
`static Matcher<Element>` | `withTextContent(Matcher<String> textContentMatcher)` Returns a matcher that matches `Element`s that have textContent matching the given matcher.

### Inherited methods
From class `java.lang.Object`
`Object` | `clone()`
`boolean` | `equals(Object arg0)`
`void` | `finalize()`
`final Class<?>` | `getClass()`
`int` | `hashCode()`
`final void` | `notify()`
`final void` | `notifyAll()`
`String` | `toString()`
`final void` | `wait(long arg0, int arg1)`
`final void` | `wait(long arg0)`
`final void` | `wait()`

## Public methods

### containingTextInBody

    Matcher<Document> containingTextInBody (String text)

Returns a matcher that matches Documents that have a body containing the given test.

Parameters
`text` | `String`

Returns
`Matcher<Document>` |

### elementById

    Matcher<Document> elementById (String id,
                    Matcher<Element> elementMatcher)

Matches `Document`s that have an `Element` with the given id that matches the given element matcher.

Parameters
`id` | `String`
`elementMatcher` | `Matcher`

Returns
`Matcher<Document>` |

### elementByXPath

    Matcher<Document> elementByXPath (String xpath,
                    Matcher<Element> elementMatcher)

Matches a XPath and validates it against the first `Element` that it finds in the `NodeList`.

Parameters
`xpath` | `String`
`elementMatcher` | `Matcher`

Returns
`Matcher<Document>` |

### hasElementWithId

    Matcher<Document> hasElementWithId (String id)

Returns a matcher that matches `Document`s that have at least one element with the given id.

Parameters
`id` | `String`

Returns
`Matcher<Document>` |

### hasElementWithXpath

    Matcher<Document> hasElementWithXpath (String xpath)

Returns a matcher that matches `Document`s that have at least one element with the given xpath.

Parameters
`xpath` | `String`

Returns
`Matcher<Document>` |

### withBody

    Matcher<Document> withBody (Matcher<Element> bodyMatcher)

Returns a matcher that matches `Document`s with body that matches the given matcher.

Parameters
`bodyMatcher` | `Matcher`

Returns
`Matcher<Document>` |

### withTextContent

    Matcher<Element> withTextContent (String textContent)

Returns a matcher that matches `Element`s with the given textContent. Equivalent of withTextContent(is(textContent)).

Parameters
`textContent` | `String`

Returns
`Matcher<Element>` |

### withTextContent

    Matcher<Element> withTextContent (Matcher<String> textContentMatcher)

Returns a matcher that matches `Element`s that have textContent matching the given matcher.

Parameters
`textContentMatcher` | `Matcher`

Returns
`Matcher<Element>` |

- ## Classes

  - DomMatchers

- ## Exceptions

  - AmbiguousElementMatcherException