com.github.tashoyan.httpspy

Interface ResponseBuilder

All Known Implementing Classes:

DefaultResponseBuilder

@NotThreadSafe
public interface ResponseBuilder

Response builder.

Builds a response object after properties are set.

Concurrency notes. Builder instances are used in a single thread that prepares requests expectations - typically main thread. Implementations are not required to be thread safe.

Method Summary

Modifier and Type	Method and Description
HttpResponse	build() Builds response.
ResponseBuilder	withBody(String body) Specifies response body.
ResponseBuilder	withDelay(TimeUnit timeUnit, long delay) Specifies response delay.
ResponseBuilder	withHeader(String headerName, String headerValue) Specifies response header.
ResponseBuilder	withStatus(int statusCode) Specifies response status code.

Method Detail

build

HttpResponse build()

Builds response.

Returns:

Response object. Should not return null, if none parameters set then should return default response: success, empty body, no headers, without delay.

withStatus

ResponseBuilder withStatus(int statusCode)

Specifies response status code.

Parameters:

statusCode - Response status code.

Returns:

This object.

Throws:

IllegalArgumentException - statusCode is not positive.

withBody

ResponseBuilder withBody(String body)

Specifies response body.

Parameters:

body - Response body.

Returns:

This object.

withHeader

ResponseBuilder withHeader(String headerName,
                           String headerValue)

Specifies response header.

Parameters:

headerName - Header name.

headerValue - Header value.

Returns:

This object.

Throws:

NullPointerException - headerName is null.

IllegalArgumentException - headerName is empty or blank.

NullPointerException - headerValue is null.

withDelay

ResponseBuilder withDelay(TimeUnit timeUnit,
                          long delay)

Specifies response delay.

Parameters:

timeUnit - Time unit for delay.

delay - Delay before sending response.

Returns:

This object.

Throws:

NullPointerException - timeUnit is null.

IllegalArgumentException - delay is negative.