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 JSON path expressions.

Based on the JsonPath project: requiring version 0.9+, with 1.1+ strongly recommended.

Since:

3.2

Author:

Rossen Stoyanchev, Juergen Hoeller, Craig Andrews, Sam Brannen

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.reflect.Method	compileMethod
private static java.lang.Object	emptyFilters
private java.lang.String	expression
private JsonPath	jsonPath

Constructor Summary

Constructors

Constructor and Description
JsonPathExpectationsHelper(java.lang.String expression, java.lang.Object... args) Construct a new JsonPathExpectationsHelper.

Method Summary

Modifier and Type	Method and Description
private java.lang.Object	assertExistsAndReturn(java.lang.String content)
<T> void	assertValue(java.lang.String content, <any> matcher) Evaluate the JSON path expression against the supplied content and assert the resulting value with the given Matcher.
void	assertValue(java.lang.String content, java.lang.Object expectedValue) Evaluate the JSON path expression against the supplied content and assert that the result is equal to the expected value.
void	assertValueIsArray(java.lang.String content) Evaluate the JSON path expression against the supplied content and assert that the resulting value is an array.
void	assertValueIsBoolean(java.lang.String content) Evaluate the JSON path expression against the supplied content and assert that the resulting value is a Boolean.
void	assertValueIsEmpty(java.lang.String content) Evaluate the JSON path expression against the supplied content and assert that an empty value exists at the given path.
void	assertValueIsMap(java.lang.String content) Evaluate the JSON path expression against the supplied content and assert that the resulting value is a Map.
void	assertValueIsNotEmpty(java.lang.String content) Evaluate the JSON path expression against the supplied content and assert that a non-empty value exists at the given path.
void	assertValueIsNumber(java.lang.String content) Evaluate the JSON path expression against the supplied content and assert that the resulting value is a Number.
void	assertValueIsString(java.lang.String content) Evaluate the JSON path expression against the supplied content and assert that the resulting value is a String.
void	doesNotExist(java.lang.String content) Evaluate the JSON path expression against the supplied content and assert that a value does not exist at the given path.
private java.lang.Object	evaluateJsonPath(java.lang.String content)
void	exists(java.lang.String content) Evaluate the JSON path expression against the supplied content and assert that a non-null value exists at the given path.
private java.lang.String	failureReason(java.lang.String expectedDescription, java.lang.Object value)
private boolean	pathIsIndefinite()

Methods inherited from class java.lang.Object

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

Field Detail

compileMethod

private static java.lang.reflect.Method compileMethod

emptyFilters

private static java.lang.Object emptyFilters

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)

Construct a new JsonPathExpectationsHelper.

Parameters:

expression - the JsonPath expression; never null or empty

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

Method Detail

assertValue

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

Evaluate the JSON path expression against the supplied content and assert the resulting value with the given Matcher.

Parameters:

content - the JSON content

matcher - the matcher with which to assert the result

Throws:

java.text.ParseException

assertValue

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

Evaluate the JSON path expression against the supplied content and assert that the result is equal to the expected value.

Parameters:

content - the JSON content

expectedValue - the expected value

Throws:

java.text.ParseException

assertValueIsString

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

Evaluate the JSON path expression against the supplied content and assert that the resulting value is a String.

Parameters:

content - the JSON content

Throws:

java.text.ParseException

Since:

4.2.1

assertValueIsBoolean

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

Evaluate the JSON path expression against the supplied content and assert that the resulting value is a Boolean.

Parameters:

content - the JSON content

Throws:

java.text.ParseException

Since:

4.2.1

assertValueIsNumber

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

Evaluate the JSON path expression against the supplied content and assert that the resulting value is a Number.

Parameters:

content - the JSON content

Throws:

java.text.ParseException

Since:

4.2.1

assertValueIsArray

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

Evaluate the JSON path expression against the supplied content and assert that the resulting value is an array.

Parameters:

content - the JSON content

Throws:

java.text.ParseException

assertValueIsMap

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

Evaluate the JSON path expression against the supplied content and assert that the resulting value is a Map.

Parameters:

content - the JSON content

Throws:

java.text.ParseException

Since:

4.2.1

exists

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

Evaluate the JSON path expression against the supplied content and assert that a non-null value exists at the given path.

If the JSON path expression is not definite, this method asserts that the value at the given path is not empty.

Parameters:

content - the JSON content

Throws:

java.text.ParseException

doesNotExist

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

Evaluate the JSON path expression against the supplied content and assert that a value does not exist at the given path.

If the JSON path expression is not definite, this method asserts that the value at the given path is empty.

Parameters:

content - the JSON content

Throws:

java.text.ParseException

assertValueIsEmpty

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

Evaluate the JSON path expression against the supplied content and assert that an empty value exists at the given path.

For the semantics of empty, consult the Javadoc for ObjectUtils.isEmpty(Object).

Parameters:

content - the JSON content

Throws:

java.text.ParseException

assertValueIsNotEmpty

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

Evaluate the JSON path expression against the supplied content and assert that a non-empty value exists at the given path.

For the semantics of empty, consult the Javadoc for ObjectUtils.isEmpty(Object).

Parameters:

content - the JSON content

Throws:

java.text.ParseException

failureReason

private java.lang.String failureReason(java.lang.String expectedDescription,
                                       java.lang.Object value)

evaluateJsonPath

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

Throws:

java.text.ParseException

assertExistsAndReturn

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

Throws:

java.text.ParseException

pathIsIndefinite

private boolean pathIsIndefinite()