Package org.apache.juneau.rest.client.assertion

Class ResponseBodyAssertion

java.lang.Object

org.apache.juneau.rest.client.assertion.ResponseBodyAssertion

public final class ResponseBodyAssertion
extends Object

A fluent assertion class for HTTP response bodies.

Obtain instances via ResponseAssertion.body().

See Also:

• Next-Generation REST Client

Since:

9.2.1

Method Summary

Modifier and Type	Method	Description
ResponseAssertion	and()	Returns the parent ResponseAssertion to continue assertion chaining.
ResponseBodyAssertion	contains(String substring)	Asserts that the response body (as a UTF-8 string) contains the given substring.
ResponseBodyAssertion	equals(String expected)	Asserts that the response body (as a UTF-8 string) equals the expected value.
ResponseBodyAssertion	isEmpty()	Asserts that the response body is empty (null or zero-length).
ResponseBodyAssertion	isNotEmpty()	Asserts that the response body is present and non-empty.
ResponseBodyAssertion	startsWith(String prefix)	Asserts that the response body starts with the given prefix.

Methods inherited from class java.lang.Object

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

Method Details

equals

public ResponseBodyAssertion equals(String expected)

Asserts that the response body (as a UTF-8 string) equals the expected value.

Parameters:

expected - The expected body string. May be null to assert an empty/absent body.

Returns:

This object (for chaining).

Throws:

AssertionError - If the body does not match.

UncheckedIOException - If reading the body throws IOException.

contains

public ResponseBodyAssertion contains(String substring)

Asserts that the response body (as a UTF-8 string) contains the given substring.

Parameters:

substring - The substring to look for. Must not be null.

Returns:

This object (for chaining).

Throws:

AssertionError - If the body is absent or does not contain the substring.

UncheckedIOException - If reading the body throws IOException.

isEmpty

public ResponseBodyAssertion isEmpty()

Asserts that the response body is empty (null or zero-length).

Returns:

This object (for chaining).

Throws:

AssertionError - If the body is non-empty.

UncheckedIOException - If reading the body throws IOException.

isNotEmpty

public ResponseBodyAssertion isNotEmpty()

Asserts that the response body is present and non-empty.

Returns:

This object (for chaining).

Throws:

AssertionError - If the body is null or empty.

UncheckedIOException - If reading the body throws IOException.

startsWith

public ResponseBodyAssertion startsWith(String prefix)

Asserts that the response body starts with the given prefix.

Parameters:

prefix - The expected prefix. Must not be null.

Returns:

This object (for chaining).

Throws:

AssertionError - If the body is absent or does not start with the prefix.

UncheckedIOException - If reading the body throws IOException.

and

public ResponseAssertion and()

Returns the parent ResponseAssertion to continue assertion chaining.

Returns:

The parent assertion. Never null.