org.springframework.test.util

Class XpathExpectationsHelper

java.lang.Object

org.springframework.test.util.XpathExpectationsHelper

public class XpathExpectationsHelper
extends java.lang.Object

A helper class for applying assertions via XPath expressions.

Since:

3.2

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	expression
private boolean	hasNamespaces
private javax.xml.xpath.XPathExpression	xpathExpression

Constructor Summary

Constructors

Constructor and Description
XpathExpectationsHelper(java.lang.String expression, java.util.Map<java.lang.String,java.lang.String> namespaces, java.lang.Object... args) XpathExpectationsHelper constructor.

Method Summary

Modifier and Type	Method and Description
void	assertBoolean(byte[] content, java.lang.String encoding, boolean expectedValue) Apply the XPath expression and assert the resulting content as a Boolean.
void	assertNode(byte[] content, java.lang.String encoding, <any> matcher) Parse the content, evaluate the XPath expression as a Node, and assert it with the given Matcher<Node>.
void	assertNodeCount(byte[] content, java.lang.String encoding, <any> matcher) Apply the XPath expression and assert the resulting content with the given Hamcrest matcher.
void	assertNumber(byte[] content, java.lang.String encoding, <any> matcher) Apply the XPath expression and assert the resulting content with the given Hamcrest matcher.
void	assertString(byte[] content, java.lang.String encoding, <any> matcher) Apply the XPath expression and assert the resulting content with the given Hamcrest matcher.
private javax.xml.xpath.XPathExpression	compileXpathExpression(java.lang.String expression, java.util.Map<java.lang.String,java.lang.String> namespaces)
void	doesNotExist(byte[] content, java.lang.String encoding) Apply the XPath expression and assert the resulting content does not exist.
protected <T> T	evaluateXpath(org.w3c.dom.Document document, javax.xml.namespace.QName evaluationType, java.lang.Class<T> expectedClass) Apply the XPath expression to given document.
void	exists(byte[] content, java.lang.String encoding) Apply the XPath expression and assert the resulting content exists.
protected javax.xml.xpath.XPathExpression	getXpathExpression() Return the compiled XPath expression.
protected org.w3c.dom.Document	parseXmlByteArray(byte[] xml, java.lang.String encoding) Parse the given XML content to a Document.

Methods inherited from class java.lang.Object

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

Field Detail

expression

private final java.lang.String expression

xpathExpression

private final javax.xml.xpath.XPathExpression xpathExpression

hasNamespaces

private final boolean hasNamespaces

Constructor Detail

XpathExpectationsHelper

public XpathExpectationsHelper(java.lang.String expression,
                               java.util.Map<java.lang.String,java.lang.String> namespaces,
                               java.lang.Object... args)
                        throws javax.xml.xpath.XPathExpressionException

XpathExpectationsHelper constructor.

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

compileXpathExpression

private javax.xml.xpath.XPathExpression compileXpathExpression(java.lang.String expression,
                                                               java.util.Map<java.lang.String,java.lang.String> namespaces)
                                                        throws javax.xml.xpath.XPathExpressionException

Throws:

javax.xml.xpath.XPathExpressionException

getXpathExpression

protected javax.xml.xpath.XPathExpression getXpathExpression()

Return the compiled XPath expression.

assertNode

public void assertNode(byte[] content,
                       java.lang.String encoding,
                       <any> matcher)
                throws java.lang.Exception

Parse the content, evaluate the XPath expression as a Node, and assert it with the given Matcher<Node>.

Throws:

java.lang.Exception

parseXmlByteArray

protected org.w3c.dom.Document parseXmlByteArray(byte[] xml,
                                                 java.lang.String encoding)
                                          throws java.lang.Exception

Parse the given XML content to a Document.

Parameters:

xml - the content to parse

encoding - optional content encoding, if provided as metadata (e.g. in HTTP headers)

Returns:

the parsed document

Throws:

java.lang.Exception

evaluateXpath

protected <T> T evaluateXpath(org.w3c.dom.Document document,
                              javax.xml.namespace.QName evaluationType,
                              java.lang.Class<T> expectedClass)
                       throws javax.xml.xpath.XPathExpressionException

Apply the XPath expression to given document.

Throws:

javax.xml.xpath.XPathExpressionException

exists

public void exists(byte[] content,
                   java.lang.String encoding)
            throws java.lang.Exception

Apply the XPath expression and assert the resulting content exists.

Throws:

java.lang.Exception - if content parsing or expression evaluation fails

doesNotExist

public void doesNotExist(byte[] content,
                         java.lang.String encoding)
                  throws java.lang.Exception

Apply the XPath expression and assert the resulting content does not exist.

Throws:

java.lang.Exception - if content parsing or expression evaluation fails

assertNodeCount

public void assertNodeCount(byte[] content,
                            java.lang.String encoding,
                            <any> matcher)
                     throws java.lang.Exception

Apply the XPath expression and assert the resulting content with the given Hamcrest matcher.

Throws:

java.lang.Exception - if content parsing or expression evaluation fails

assertString

public void assertString(byte[] content,
                         java.lang.String encoding,
                         <any> matcher)
                  throws java.lang.Exception

Apply the XPath expression and assert the resulting content with the given Hamcrest matcher.

Throws:

java.lang.Exception - if content parsing or expression evaluation fails

assertNumber

public void assertNumber(byte[] content,
                         java.lang.String encoding,
                         <any> matcher)
                  throws java.lang.Exception

Apply the XPath expression and assert the resulting content with the given Hamcrest matcher.

Throws:

java.lang.Exception - if content parsing or expression evaluation fails

assertBoolean

public void assertBoolean(byte[] content,
                          java.lang.String encoding,
                          boolean expectedValue)
                   throws java.lang.Exception

Apply the XPath expression and assert the resulting content as a Boolean.

Throws:

java.lang.Exception - if content parsing or expression evaluation fails