io.vertx.ext.web.client.predicate

Interface ResponsePredicateResult

public interface ResponsePredicateResult

Represents the outcome of a ResponsePredicate applied to an HttpResponse.

Author:

Thomas Segismont

Method Summary

Modifier and Type	Method and Description
static ResponsePredicateResult	failure(String message) Creates a failed result.
String	message() The failure message.
HttpResponse<Buffer>	response() The HttpResponse which has been tested.
boolean	succeeded() Whether the result is a success or failure.
static ResponsePredicateResult	success()

Method Detail

success

static ResponsePredicateResult success()

Returns:

a successful result

failure

static ResponsePredicateResult failure(String message)

Creates a failed result.

Parameters:

message - the failure description

succeeded

boolean succeeded()

Whether the result is a success or failure.

Returns:

true if the ResponsePredicate was applied successfully, false otherwise

message

String message()

The failure message. May be null.

response

HttpResponse<Buffer> response()

The HttpResponse which has been tested.

Returns:

null after the result has been created, or the tested response for converters created with ErrorConverter.createFullBody(Function)