org.springframework.test.web.servlet.result

Class XpathResultMatchers

java.lang.Object

org.springframework.test.web.servlet.result.XpathResultMatchers

public class XpathResultMatchers
extends java.lang.Object

Factory for assertions on the response content using XPath expressions.

An instance of this class is typically accessed via MockMvcResultMatchers.xpath(java.lang.String, java.lang.Object...).

Since:

3.2

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XpathResultMatchers(java.lang.String expression, java.util.Map<java.lang.String,java.lang.String> namespaces, java.lang.Object... args) Protected constructor, not for direct instantiation.

Method Summary

Modifier and Type	Method and Description
ResultMatcher	booleanValue(java.lang.Boolean value) Evaluate the XPath and assert the Boolean value found.
ResultMatcher	doesNotExist() Evaluate the XPath and assert that content doesn't exist.
ResultMatcher	exists() Evaluate the XPath and assert that content exists.
ResultMatcher	node(Matcher<? super org.w3c.dom.Node> matcher) Evaluate the XPath and assert the Node content found with the given Hamcrest Matcher.
ResultMatcher	nodeCount(int expectedCount) Evaluate the XPath and assert the number of nodes found.
ResultMatcher	nodeCount(Matcher<java.lang.Integer> matcher) Evaluate the XPath and assert the number of nodes found with the given Hamcrest Matcher.
ResultMatcher	number(java.lang.Double expectedValue) Evaluate the XPath and assert the Double value found.
ResultMatcher	number(Matcher<? super java.lang.Double> matcher) Evaluate the XPath and assert the Double value found with the given Hamcrest Matcher.
ResultMatcher	string(Matcher<? super java.lang.String> matcher) Apply the XPath and assert the String value found with the given Hamcrest Matcher.
ResultMatcher	string(java.lang.String expectedValue) Apply the XPath and assert the String value found.

Methods inherited from class java.lang.Object

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

Constructor Detail

XpathResultMatchers

protected XpathResultMatchers(java.lang.String expression,
                              @Nullable
                              java.util.Map<java.lang.String,java.lang.String> namespaces,
                              java.lang.Object... args)
                       throws javax.xml.xpath.XPathExpressionException

Protected constructor, not for direct instantiation. Use MockMvcResultMatchers.xpath(String, Object...) or MockMvcResultMatchers.xpath(String, Map, Object...).

Parameters:

expression - the XPath expression

namespaces - 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:

javax.xml.xpath.XPathExpressionException

Method Detail

node

public ResultMatcher node(Matcher<? super org.w3c.dom.Node> matcher)

Evaluate the XPath and assert the Node content found with the given Hamcrest Matcher.

exists

public ResultMatcher exists()

Evaluate the XPath and assert that content exists.

doesNotExist

public ResultMatcher doesNotExist()

Evaluate the XPath and assert that content doesn't exist.

nodeCount

public ResultMatcher nodeCount(Matcher<java.lang.Integer> matcher)

Evaluate the XPath and assert the number of nodes found with the given Hamcrest Matcher.

nodeCount

public ResultMatcher nodeCount(int expectedCount)

Evaluate the XPath and assert the number of nodes found.

string

public ResultMatcher string(Matcher<? super java.lang.String> matcher)

Apply the XPath and assert the String value found with the given Hamcrest Matcher.

string

public ResultMatcher string(java.lang.String expectedValue)

Apply the XPath and assert the String value found.

number

public ResultMatcher number(Matcher<? super java.lang.Double> matcher)

Evaluate the XPath and assert the Double value found with the given Hamcrest Matcher.

number

public ResultMatcher number(java.lang.Double expectedValue)

Evaluate the XPath and assert the Double value found.

booleanValue

public ResultMatcher booleanValue(java.lang.Boolean value)

Evaluate the XPath and assert the Boolean value found.