Interface WebTestClient.Bodyspec<B, s extends WebTestClient.Bodyspec<B,s>>

Type Parameters:

B - the body type

s - a self reference to the spec type

All Known subinterfaces:

WebTestClient.ListBodyspec<E>

Enclosing interface:

WebTestClient

public static interface WebTestClient.Bodyspec<B, s extends WebTestClient.Bodyspec<B,s>>

spec for expectations on the response body decoded to a single Object.

since:

5.0

Author:

Rossen stoyanchev, Brian Clozel, sam Brannen, Michał Rowicki

Method summary

Modifier and Type	Method	Description
<T extends s> T	consumeWith(Consumer<EntityExchangeResult<B>>&nbsp;consumer)	Assert the exchange result with the given Consumer.
<T extends s> T	isEqualTo(@Nullable B&nbsp;expected)	Assert the extracted body is equal to the given value.
EntityExchangeResult<B>	returnResult()	Exit the chained API and return an ExchangeResult with the decoded response content.
<T extends s, R> T	value(@NonNull Function<@Nullable B, @Nullable R>&nbsp;bodyMapper, Consumer<? super R>&nbsp;consumer)	Transform the extracted the body with a function, for example, extracting a property, and assert the mapped value with a Consumer.
<T extends s, R> T	value(@NonNull Function<@Nullable B, @Nullable R>&nbsp;bodyMapper, Matcher<? super R>&nbsp;matcher)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of Consumer-based variants, and AssertJ support via WebTestClientResponse
<T extends s> T	value(Consumer<@Nullable B>&nbsp;consumer)	Assert the extracted body with a Consumer.
<T extends s> T	value(Matcher<? super B>&nbsp;matcher)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of Consumer-based variants, and AssertJ support via WebTestClientResponse

Method Details

isEqualTo

<T extends s>&nbsp;T&nbsp;isEqualTo(@Nullable B&nbsp;expected)

Assert the extracted body is equal to the given value.

value

@Deprecated(since="7.0",
            forRemoval=true)
@NullUnmarked
<T extends s>&nbsp;T&nbsp;value(Matcher<? super B>&nbsp;matcher)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of Consumer-based variants, and AssertJ support via WebTestClientResponse

Assert the extracted body with a Matcher.

since:

5.1

value

@Deprecated(since="7.0",
            forRemoval=true)
@NullUnmarked
<T extends s, R>&nbsp;T&nbsp;value(@NonNull Function<@Nullable B, @Nullable R>&nbsp;bodyMapper,
 Matcher<? super R>&nbsp;matcher)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of Consumer-based variants, and AssertJ support via WebTestClientResponse

Transform the extracted the body with a function, for example, extracting a property, and assert the mapped value with a Matcher.

since:

5.1

value

<T extends s>&nbsp;T&nbsp;value(Consumer<@Nullable B>&nbsp;consumer)

Assert the extracted body with a Consumer.

since:

5.1

value

<T extends s, R>&nbsp;T&nbsp;value(@NonNull Function<@Nullable B, @Nullable R>&nbsp;bodyMapper,
 Consumer<? super R>&nbsp;consumer)

Transform the extracted the body with a function, for example, extracting a property, and assert the mapped value with a Consumer.

since:

7.0

consumeWith

<T extends s>&nbsp;T&nbsp;consumeWith(Consumer<EntityExchangeResult<B>>&nbsp;consumer)

Assert the exchange result with the given Consumer.

returnResult

EntityExchangeResult<B>&nbsp;returnResult()

Exit the chained API and return an ExchangeResult with the decoded response content.