uk.co.visalia.brightpearl.apiclient.multimessage

Class ServiceResponseBuilder<T>

java.lang.Object

uk.co.visalia.brightpearl.apiclient.multimessage.ServiceResponseBuilder<T>

public class ServiceResponseBuilder<T>
extends Object

A builder used to create immutable instances of ServiceResponse. Intended for internal use only.

Method Summary

Methods

Modifier and Type	Method and Description
ServiceResponse<T>	build() Constructs the immutable MultiResponse instance.
static <T> ServiceResponseBuilder<T>	newServiceResponse() Returns a new builder instance used to create immutable MultiResponse instances
ServiceResponseBuilder<T>	withException(RuntimeException exception) Set the exception thrown based on service errors in the response or an error parsing the JSON.
ServiceResponseBuilder<T>	withResponse(T response) Sets the entity received in the response element of the JSON response body.
ServiceResponseBuilder<T>	withRuid(String ruid) Set the unique ID of the request this is a response to.
ServiceResponseBuilder<T>	withStatus(int status) Set the HTTP status code returned for this individual response.

Methods inherited from class java.lang.Object

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

Method Detail

newServiceResponse

public static <T> ServiceResponseBuilder<T> newServiceResponse()

Returns a new builder instance used to create immutable MultiResponse instances

Returns:

new builder instance.

build

public ServiceResponse<T> build()

Constructs the immutable MultiResponse instance.

Returns:

a MultiResponse instance.

withRuid

public ServiceResponseBuilder<T> withRuid(String ruid)

Set the unique ID of the request this is a response to.

Parameters:

ruid - unique ID of a request.

Returns:

builder instance for method chaining.

withStatus

public ServiceResponseBuilder<T> withStatus(int status)

Set the HTTP status code returned for this individual response.

Parameters:

status - HTTP status code of the individual request.

Returns:

builder instance for method chaining.

withResponse

public ServiceResponseBuilder<T> withResponse(T response)

Sets the entity received in the response element of the JSON response body.

Parameters:

response - response entity.

Returns:

builder instance for method chaining.

withException

public ServiceResponseBuilder<T> withException(RuntimeException exception)

Set the exception thrown based on service errors in the response or an error parsing the JSON.

Parameters:

exception - exception thrown processing the response.

Returns:

builder instance for method chaining.