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

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) Class constructor.

Method Summary

Modifier and Type	Method and Description
void	assertBoolean(java.lang.String content, boolean expectedValue) Apply the XPath expression and assert the resulting content as a Boolean.
void	assertNode(java.lang.String content, org.hamcrest.Matcher<? super org.w3c.dom.Node> matcher) Parse the content, evaluate the XPath expression as a Node, and assert it with the given Matcher<Node>.
void	assertNodeCount(java.lang.String content, int expectedCount) Apply the XPath expression and assert the resulting content as an integer.
void	assertNodeCount(java.lang.String content, org.hamcrest.Matcher<java.lang.Integer> matcher) Apply the XPath expression and assert the resulting content with the given Hamcrest matcher.
void	assertNumber(java.lang.String content, java.lang.Double expectedValue) Apply the XPath expression and assert the resulting content as a Double.
void	assertNumber(java.lang.String content, org.hamcrest.Matcher<? super java.lang.Double> matcher) Apply the XPath expression and assert the resulting content with the given Hamcrest matcher.
void	assertString(java.lang.String content, org.hamcrest.Matcher<? super java.lang.String> matcher) Apply the XPath expression and assert the resulting content with the given Hamcrest matcher.
void	assertString(java.lang.String content, java.lang.String expectedValue) Apply the XPath expression and assert the resulting content as a String.
void	doesNotExist(java.lang.String content) Apply the XPath expression and assert the resulting content does not exist.
protected <T> T	evaluateXpath(org.w3c.dom.Document document, QName evaluationType, java.lang.Class<T> expectedClass) Apply the XPath expression to given document.
void	exists(java.lang.String content) Apply the XPath expression and assert the resulting content exists.
protected javax.xml.xpath.XPathExpression	getXpathExpression()
protected org.w3c.dom.Document	parseXmlString(java.lang.String xml) 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

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

Class 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

getXpathExpression

protected javax.xml.xpath.XPathExpression getXpathExpression()

Returns:

the compiled XPath expression.

assertNode

public void assertNode(java.lang.String content,
                       org.hamcrest.Matcher<? super org.w3c.dom.Node> 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

parseXmlString

protected org.w3c.dom.Document parseXmlString(java.lang.String xml)
                                       throws java.lang.Exception

Parse the given XML content to a Document.

Parameters:

xml - the content to parse

Returns:

the parsed document

Throws:

java.lang.Exception - in case of errors

evaluateXpath

protected <T> T evaluateXpath(org.w3c.dom.Document document,
                              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(java.lang.String content)
            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(java.lang.String content)
                  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(java.lang.String content,
                            org.hamcrest.Matcher<java.lang.Integer> 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

assertNodeCount

public void assertNodeCount(java.lang.String content,
                            int expectedCount)
                     throws java.lang.Exception

Apply the XPath expression and assert the resulting content as an integer.

Throws:

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

assertString

public void assertString(java.lang.String content,
                         org.hamcrest.Matcher<? super java.lang.String> 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(java.lang.String content,
                         java.lang.String expectedValue)
                  throws java.lang.Exception

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

Throws:

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

assertNumber

public void assertNumber(java.lang.String content,
                         org.hamcrest.Matcher<? super java.lang.Double> 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(java.lang.String content,
                         java.lang.Double expectedValue)
                  throws java.lang.Exception

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

Throws:

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

assertBoolean

public void assertBoolean(java.lang.String content,
                          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