uk.co.visalia.brightpearl.apiclient.http

Class ResponseBuilder

java.lang.Object

uk.co.visalia.brightpearl.apiclient.http.ResponseBuilder

public class ResponseBuilder
extends Object

A builder used to create immutable Response instances.

Method Summary

Methods

Modifier and Type	Method and Description
Response	build() Builds and returns an immutable Response instance.
static ResponseBuilder	newResponse() Creates a new builder instance.
ResponseBuilder	withBody(String body) Set the JSON body received.
ResponseBuilder	withHeaders(Map<String,String> headers) Set the response headers received.
ResponseBuilder	withStatus(int status) Set the HTTP response status.

Methods inherited from class java.lang.Object

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

Method Detail

newResponse

public static ResponseBuilder newResponse()

Creates a new builder instance.

Returns:

new builder instance.

build

public Response build()

Builds and returns an immutable Response instance.

Returns:

new response instance.

withStatus

public ResponseBuilder withStatus(int status)

Set the HTTP response status.

Parameters:

status - HTTP status.

Returns:

builder instance for method chaining.

withHeaders

public ResponseBuilder withHeaders(Map<String,String> headers)

Set the response headers received. All headers should be included.

Parameters:

headers - Response headers received.

Returns:

builder instance for method chaining.

withBody

public ResponseBuilder withBody(String body)

Set the JSON body received.

Parameters:

body - JSON received in the response body.

Returns:

builder instance for method chaining.