Class AbstractJsonPathAssertions<B>

java.lang.Object

org.springframework.test.web.support.AbstractJsonPathAssertions<B>

Type Parameters:

B - the type of body spec (RestTestClient vs WebTestClient specific)

Direct Known Subclasses:

JsonPathAssertions, JsonPathAssertions

public abstract class AbstractJsonPathAssertions<B>
extends Object

Base class for applying JsonPath assertions in RestTestClient and WebTestClient.

Since:

7.0

Author:

Rob Worsnop, Rossen Stoyanchev

See Also:

• https://github.com/jayway/JsonPath
• JsonPathExpectationsHelper

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractJsonPathAssertions(B spec, String content, String expression, @Nullable com.jayway.jsonpath.Configuration configuration)

Method Summary

Modifier and Type	Method	Description
B	doesNotExist()	Applies JsonPathExpectationsHelper.doesNotExist(String).
B	doesNotHaveJsonPath()	Applies JsonPathExpectationsHelper.doesNotHaveJsonPath(String).
boolean	equals(@Nullable Object obj)
B	exists()	Applies JsonPathExpectationsHelper.exists(String).
int	hashCode()
B	hasJsonPath()	Applies JsonPathExpectationsHelper.hasJsonPath(String).
B	isArray()	Applies JsonPathExpectationsHelper.assertValueIsArray(String).
B	isBoolean()	Applies JsonPathExpectationsHelper.assertValueIsBoolean(String).
B	isEmpty()	Applies JsonPathExpectationsHelper.assertValueIsEmpty(String).
B	isEqualTo(@Nullable Object expectedValue)	Applies JsonPathExpectationsHelper.assertValue(String, Object).
B	isMap()	Applies JsonPathExpectationsHelper.assertValueIsMap(String).
B	isNotEmpty()	Applies JsonPathExpectationsHelper.assertValueIsNotEmpty(String).
B	isNumber()	Applies JsonPathExpectationsHelper.assertValueIsNumber(String).
<T> B	value(Class<T> targetType, Consumer<T> consumer)	Consume the result of the JSONPath evaluation and provide a target class.
<T> B	value(Class<T> targetType, Matcher<? super T> matcher)	Delegates to JsonPathExpectationsHelper.assertValue(String, Matcher, Class).
<T> B	value(Consumer<T> consumer)	Consume the result of the JSONPath evaluation.
<T> B	value(Matcher<? super T> matcher)	Delegates to JsonPathExpectationsHelper.assertValue(String, Matcher).
<T> B	value(ParameterizedTypeReference<T> targetType, Consumer<T> consumer)	Consume the result of the JSONPath evaluation and provide a parameterized type.
<T> B	value(ParameterizedTypeReference<T> targetType, Matcher<? super T> matcher)	Delegates to JsonPathExpectationsHelper.assertValue(String, Matcher, ParameterizedTypeReference).

Methods inherited from class Object

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

Constructor Details

AbstractJsonPathAssertions

protected AbstractJsonPathAssertions(B spec,
 String content,
 String expression,
 @Nullable com.jayway.jsonpath.Configuration configuration)

Method Details

isEqualTo

public B isEqualTo(@Nullable Object expectedValue)

Applies JsonPathExpectationsHelper.assertValue(String, Object).

exists

public B exists()

Applies JsonPathExpectationsHelper.exists(String).

doesNotExist

public B doesNotExist()

Applies JsonPathExpectationsHelper.doesNotExist(String).

isEmpty

public B isEmpty()

Applies JsonPathExpectationsHelper.assertValueIsEmpty(String).

isNotEmpty

public B isNotEmpty()

Applies JsonPathExpectationsHelper.assertValueIsNotEmpty(String).

hasJsonPath

public B hasJsonPath()

Applies JsonPathExpectationsHelper.hasJsonPath(String).

doesNotHaveJsonPath

public B doesNotHaveJsonPath()

Applies JsonPathExpectationsHelper.doesNotHaveJsonPath(String).

isBoolean

public B isBoolean()

Applies JsonPathExpectationsHelper.assertValueIsBoolean(String).

isNumber

public B isNumber()

Applies JsonPathExpectationsHelper.assertValueIsNumber(String).

isArray

public B isArray()

Applies JsonPathExpectationsHelper.assertValueIsArray(String).

isMap

public B isMap()

Applies JsonPathExpectationsHelper.assertValueIsMap(String).

value

public <T> B value(Matcher<? super T> matcher)

Delegates to JsonPathExpectationsHelper.assertValue(String, Matcher).

value

public <T> B value(Class<T> targetType,
 Matcher<? super T> matcher)

Delegates to JsonPathExpectationsHelper.assertValue(String, Matcher, Class).

value

public <T> B value(ParameterizedTypeReference<T> targetType,
 Matcher<? super T> matcher)

Delegates to JsonPathExpectationsHelper.assertValue(String, Matcher, ParameterizedTypeReference).

value

public <T> B value(Consumer<T> consumer)

Consume the result of the JSONPath evaluation.

value

public <T> B value(Class<T> targetType,
 Consumer<T> consumer)

Consume the result of the JSONPath evaluation and provide a target class.

value

public <T> B value(ParameterizedTypeReference<T> targetType,
 Consumer<T> consumer)

Consume the result of the JSONPath evaluation and provide a parameterized type.

equals

public boolean equals(@Nullable Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object