org.springframework.test.web.client.match

Class JsonPathRequestMatchers

java.lang.Object

org.springframework.test.web.client.match.JsonPathRequestMatchers

public class JsonPathRequestMatchers
extends java.lang.Object

Factory methods for request content RequestMatcher's using a JSONPath expression. An instance of this class is typically accessed via RequestMatchers.jsonPath(..).

Since:

3.2

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	JsonPathRequestMatchers.AbstractJsonPathRequestMatcher Abstract base class for JSONPath RequestMatcher's.

Field Summary

Fields

Modifier and Type	Field and Description
private JsonPathExpectationsHelper	jsonPathHelper

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsonPathRequestMatchers(java.lang.String expression, java.lang.Object... args) Class constructor, not for direct instantiation.

Method Summary

Modifier and Type	Method and Description
RequestMatcher	doesNotExist() Evaluate the JSON path and assert the resulting content exists.
RequestMatcher	exists() Apply the JSONPath and assert the resulting value.
RequestMatcher	isArray() Assert the content at the given JSONPath is an array.
<T> RequestMatcher	value(<any> matcher) Evaluate the JSONPath and assert the resulting value with the given Matcher.
RequestMatcher	value(java.lang.Object expectedValue) Apply the JSONPath and assert the resulting value.

Methods inherited from class java.lang.Object

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

Field Detail

jsonPathHelper

private JsonPathExpectationsHelper jsonPathHelper

Constructor Detail

JsonPathRequestMatchers

protected JsonPathRequestMatchers(java.lang.String expression,
                                  java.lang.Object... args)

Class constructor, not for direct instantiation. Use MockRestRequestMatchers#jsonPath(String, Matcher) or MockRestRequestMatchers.jsonPath(String, Object...).

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

value

public <T> RequestMatcher value(<any> matcher)

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

value

public RequestMatcher value(java.lang.Object expectedValue)

Apply the JSONPath and assert the resulting value.

exists

public RequestMatcher exists()

Apply the JSONPath and assert the resulting value.

doesNotExist

public RequestMatcher doesNotExist()

Evaluate the JSON path and assert the resulting content exists.

isArray

public RequestMatcher isArray()

Assert the content at the given JSONPath is an array.