Package org.hamcrest.xml

Class HasXPath

java.lang.Object

org.hamcrest.BaseMatcher<Node>

org.hamcrest.TypeSafeDiagnosingMatcher<Node>

org.hamcrest.xml.HasXPath

All Implemented Interfaces:

Matcher<Node>, SelfDescribing

public class HasXPath
extends TypeSafeDiagnosingMatcher<Node>

Applies a Matcher to a given XML Node in an existing XML Node tree, specified by an XPath expression.

Field Summary

Fields

Modifier and Type	Field	Description
private final XPathExpression	compiledXPath
private final QName	evaluationMode
static final NamespaceContext	NO_NAMESPACE_CONTEXT
private static final Condition.Step<Object,String>	NODE_EXISTS
private final Matcher<String>	valueMatcher
private static final IsAnything<String>	WITH_ANY_CONTENT
private final String	xpathString

Constructor Summary

Constructors

Modifier	Constructor	Description
	HasXPath(String xPathExpression, NamespaceContext namespaceContext, Matcher<String> valueMatcher)
private	HasXPath(String xPathExpression, NamespaceContext namespaceContext, Matcher<String> valueMatcher, QName mode)
	HasXPath(String xPathExpression, Matcher<String> valueMatcher)

Method Summary

Modifier and Type	Method	Description
private static XPathExpression	compiledXPath(String xPathExpression, NamespaceContext namespaceContext)
void	describeTo(Description description)	Generates a description of the object.
private Condition<Object>	evaluated(Node item, Description mismatch)
static Matcher<Node>	hasXPath(String xPath)	Creates a matcher of Nodes that matches when the examined node contains a node at the specified xPath, with any content.
static Matcher<Node>	hasXPath(String xPath, NamespaceContext namespaceContext)	Creates a matcher of Nodes that matches when the examined node contains a node at the specified xPath within the specified namespace context, with any content.
static Matcher<Node>	hasXPath(String xPath, NamespaceContext namespaceContext, Matcher<String> valueMatcher)	Creates a matcher of Nodes that matches when the examined node has a value at the specified xPath, within the specified namespaceContext, that satisfies the specified valueMatcher.
static Matcher<Node>	hasXPath(String xPath, Matcher<String> valueMatcher)	Creates a matcher of Nodes that matches when the examined node has a value at the specified xPath that satisfies the specified valueMatcher.
boolean	matchesSafely(Node item, Description mismatch)	Subclasses should implement this.
private static Condition.Step<Object,String>	nodeExists()

Methods inherited from class org.hamcrest.TypeSafeDiagnosingMatcher

describeMismatch, matches

Methods inherited from class org.hamcrest.BaseMatcher

_dont_implement_Matcher___instead_extend_BaseMatcher_, isNotNull, toString

Methods inherited from class java.lang.Object

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

Field Details

NO_NAMESPACE_CONTEXT

public static final NamespaceContext NO_NAMESPACE_CONTEXT

WITH_ANY_CONTENT

private static final IsAnything<String> WITH_ANY_CONTENT

NODE_EXISTS

private static final Condition.Step<Object,String> NODE_EXISTS

valueMatcher

private final Matcher<String> valueMatcher

compiledXPath

private final XPathExpression compiledXPath

xpathString

private final String xpathString

evaluationMode

private final QName evaluationMode

Constructor Details

HasXPath

public HasXPath(String xPathExpression,
 Matcher<String> valueMatcher)

Parameters:

xPathExpression - XPath expression.

valueMatcher - Matcher to use at given XPath. May be null to specify that the XPath must exist but the value is irrelevant.

HasXPath

public HasXPath(String xPathExpression,
 NamespaceContext namespaceContext,
 Matcher<String> valueMatcher)

Parameters:

xPathExpression - XPath expression.

namespaceContext - Resolves XML namespace prefixes in the XPath expression

valueMatcher - Matcher to use at given XPath. May be null to specify that the XPath must exist but the value is irrelevant.

HasXPath

private HasXPath(String xPathExpression,
 NamespaceContext namespaceContext,
 Matcher<String> valueMatcher,
 QName mode)

Method Details

matchesSafely

public boolean matchesSafely(Node item,
 Description mismatch)

Description copied from class: TypeSafeDiagnosingMatcher

Subclasses should implement this. The item will already have been checked for the specific type and will never be null.

Specified by:

matchesSafely in class TypeSafeDiagnosingMatcher<Node>

describeTo

public void describeTo(Description description)

Description copied from interface: SelfDescribing

Generates a description of the object. The description may be part of a a description of a larger object of which this is just a component, so it should be worded appropriately.

Parameters:

description - The description to be built or appended to.

evaluated

private Condition<Object> evaluated(Node item,
 Description mismatch)

nodeExists

private static Condition.Step<Object,String> nodeExists()

compiledXPath

private static XPathExpression compiledXPath(String xPathExpression,
 NamespaceContext namespaceContext)

hasXPath

public static Matcher<Node> hasXPath(String xPath,
 Matcher<String> valueMatcher)

Creates a matcher of Nodes that matches when the examined node has a value at the specified xPath that satisfies the specified valueMatcher. For example:

assertThat(xml, hasXPath("/root/something[2]/cheese", equalTo("Cheddar")))

Parameters:

xPath - the target xpath

valueMatcher - matcher for the value at the specified xpath

hasXPath

public static Matcher<Node> hasXPath(String xPath,
 NamespaceContext namespaceContext,
 Matcher<String> valueMatcher)

Creates a matcher of Nodes that matches when the examined node has a value at the specified xPath, within the specified namespaceContext, that satisfies the specified valueMatcher. For example:

assertThat(xml, hasXPath("/root/something[2]/cheese", myNs, equalTo("Cheddar")))

Parameters:

xPath - the target xpath

namespaceContext - the namespace for matching nodes

valueMatcher - matcher for the value at the specified xpath

hasXPath

public static Matcher<Node> hasXPath(String xPath)

Creates a matcher of Nodes that matches when the examined node contains a node at the specified xPath, with any content. For example:

assertThat(xml, hasXPath("/root/something[2]/cheese"))

Parameters:

xPath - the target xpath

hasXPath

public static Matcher<Node> hasXPath(String xPath,
 NamespaceContext namespaceContext)

Creates a matcher of Nodes that matches when the examined node contains a node at the specified xPath within the specified namespace context, with any content. For example:

assertThat(xml, hasXPath("/root/something[2]/cheese", myNs))

Parameters:

xPath - the target xpath

namespaceContext - the namespace for matching nodes