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

Field Summary

Fields

Modifier and Type	Field and Description
private XpathExpectationsHelper	xpathHelper

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.
private java.lang.String	getDefinedEncoding(MockHttpServletResponse response) Get the response encoding if explicitly defined in the response, {code null} otherwise.
ResultMatcher	node(<any> matcher) Evaluate the XPath and assert the Node content found with the given Hamcrest Matcher.
ResultMatcher	nodeCount(<any> matcher) Evaluate the XPath and assert the number of nodes found with the given Hamcrest Matcher.
ResultMatcher	number(<any> matcher) Evaluate the XPath and assert the Double value found with the given Hamcrest Matcher.
ResultMatcher	string(<any> matcher) Apply the XPath and assert the String value found with the given Hamcrest Matcher.

Methods inherited from class java.lang.Object

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

Field Detail

xpathHelper

private final XpathExpectationsHelper xpathHelper

Constructor Detail

XpathResultMatchers

protected XpathResultMatchers(java.lang.String expression,
                              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(<any> matcher)

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

getDefinedEncoding

private java.lang.String getDefinedEncoding(MockHttpServletResponse response)

Get the response encoding if explicitly defined in the response, {code null} otherwise.

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(<any> matcher)

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

string

public ResultMatcher string(<any> matcher)

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

number

public ResultMatcher number(<any> matcher)

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

booleanValue

public ResultMatcher booleanValue(java.lang.Boolean value)

Evaluate the XPath and assert the Boolean value found.