org.springframework.test.web.client.match

Class XpathRequestMatchers

java.lang.Object

org.springframework.test.web.client.match.XpathRequestMatchers

public class XpathRequestMatchers
extends Object

Factory methods for request content RequestMatcher implementations that use an XPath expression.

An instance of this class is typically accessed via MockRestRequestMatchers.xpath(String, Object...) or MockRestRequestMatchers.xpath(String, Map, Object...).

Since:

3.2

Author:

Rossen Stoyanchev, Sam Brannen

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XpathRequestMatchers(String expression, Map<String,String> namespaces, Object... args) Class constructor, not for direct instantiation.

Method Summary

Modifier and Type	Method and Description
RequestMatcher	booleanValue(Boolean value) Apply the XPath and assert the boolean value found.
RequestMatcher	doesNotExist() Assert that content does not exist at the given XPath.
RequestMatcher	exists() Assert that content exists at the given XPath.
RequestMatcher	node(Matcher<? super Node> matcher) Apply the XPath and assert it with the given Matcher<Node>.
RequestMatcher	nodeCount(int expectedCount) Apply the XPath and assert the number of nodes found.
RequestMatcher	nodeCount(Matcher<? super Integer> matcher) Apply the XPath and assert the number of nodes found with the given Matcher<Integer>.
RequestMatcher	number(Double value) Apply the XPath and assert the number value found.
RequestMatcher	number(Matcher<? super Double> matcher) Apply the XPath and assert the number found with the given matcher.
RequestMatcher	string(Matcher<? super String> matcher) Apply the XPath and assert the String content found with the given matcher.
RequestMatcher	string(String content) Apply the XPath and assert the String content found.

Methods inherited from class java.lang.Object

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

Constructor Detail

XpathRequestMatchers

protected XpathRequestMatchers(String expression,
                               @Nullable
                               Map<String,String> namespaces,
                               Object... args)
                        throws XPathExpressionException

Class constructor, not for direct instantiation.

Use MockRestRequestMatchers.xpath(String, Object...) or MockRestRequestMatchers.xpath(String, Map, Object...).

Parameters:

expression - the XPath expression

namespaces - the XML namespaces referenced in the XPath expression, or null

args - arguments to parameterize the XPath expression with, using the formatting specifiers defined in String.format(String, Object...)

Throws:

XPathExpressionException - if expression compilation failed

Method Detail

node

public RequestMatcher node(Matcher<? super Node> matcher)

Apply the XPath and assert it with the given Matcher<Node>.

exists

public RequestMatcher exists()

Assert that content exists at the given XPath.

doesNotExist

public RequestMatcher doesNotExist()

Assert that content does not exist at the given XPath.

nodeCount

public RequestMatcher nodeCount(Matcher<? super Integer> matcher)

Apply the XPath and assert the number of nodes found with the given Matcher<Integer>.

nodeCount

public RequestMatcher nodeCount(int expectedCount)

Apply the XPath and assert the number of nodes found.

string

public RequestMatcher string(Matcher<? super String> matcher)

Apply the XPath and assert the String content found with the given matcher.

string

public RequestMatcher string(String content)

Apply the XPath and assert the String content found.

number

public RequestMatcher number(Matcher<? super Double> matcher)

Apply the XPath and assert the number found with the given matcher.

number

public RequestMatcher number(Double value)

Apply the XPath and assert the number value found.

booleanValue

public RequestMatcher booleanValue(Boolean value)

Apply the XPath and assert the boolean value found.