org.springframework.test.util

Class JsonPathExpectationsHelper

java.lang.Object

org.springframework.test.util.JsonPathExpectationsHelper

public class JsonPathExpectationsHelper
extends java.lang.Object

A helper class for applying assertions via JSONPath expressions.

Since:

3.2

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	expression
private JsonPath	jsonPath

Constructor Summary

Constructors

Constructor and Description
JsonPathExpectationsHelper(java.lang.String expression, java.lang.Object... args) Class constructor.

Method Summary

Methods

Modifier and Type	Method and Description
<T> void	assertValue(java.lang.String content, matcher) Evaluate the JSONPath and assert the resulting value with the given Matcher.
void	assertValue(java.lang.String responseContent, java.lang.Object expectedValue) Apply the JSONPath and assert the resulting value.
void	assertValueIsArray(java.lang.String responseContent) Apply the JSONPath and assert the resulting value is an array.
void	doesNotExist(java.lang.String content) Evaluate the JSON path and assert it doesn't point to any content.
private java.lang.Object	evaluateJsonPath(java.lang.String content)
void	exists(java.lang.String content) Evaluate the JSON path and assert the resulting content exists.

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

jsonPath

private final JsonPath jsonPath

Constructor Detail

JsonPathExpectationsHelper

public JsonPathExpectationsHelper(java.lang.String expression,
                          java.lang.Object... args)

Class constructor.

Parameters:

expression - the JSONPath expression

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

Method Detail

assertValue

public <T> void assertValue(java.lang.String content,
                    matcher)
                 throws java.text.ParseException

Evaluate the JSONPath and assert the resulting value with the given Matcher.

Parameters:

content - the response content

matcher - the matcher to assert on the resulting json path

Throws:

java.text.ParseException

evaluateJsonPath

private java.lang.Object evaluateJsonPath(java.lang.String content)
                                   throws java.text.ParseException

Throws:

java.text.ParseException

assertValue

public void assertValue(java.lang.String responseContent,
               java.lang.Object expectedValue)
                 throws java.text.ParseException

Apply the JSONPath and assert the resulting value.

Throws:

java.text.ParseException

assertValueIsArray

public void assertValueIsArray(java.lang.String responseContent)
                        throws java.text.ParseException

Apply the JSONPath and assert the resulting value is an array.

Throws:

java.text.ParseException

exists

public void exists(java.lang.String content)
            throws java.text.ParseException

Evaluate the JSON path and assert the resulting content exists.

Throws:

java.text.ParseException

doesNotExist

public void doesNotExist(java.lang.String content)
                  throws java.text.ParseException

Evaluate the JSON path and assert it doesn't point to any content.

Throws:

java.text.ParseException