uk.co.visalia.brightpearl.apiclient.request

Class ServiceReadRequestSetBuilder<T>

java.lang.Object

uk.co.visalia.brightpearl.apiclient.request.ServiceReadRequestSetBuilder<T>

Type Parameters:

T - placeholder for the response type, used to avoid casting of responses. This is not linked to the Type set on each request so a ClassCastException is possible if the type is set incorrectly.

public class ServiceReadRequestSetBuilder<T>
extends Object

A factory for immutable ServiceReadRequestSet instances. These requests are used to load large sets of data easily, by creating individual ServiceReadRequests to the same API each with a subset of a large ID set.

This class is returned from static request builder methods in the services package, and provides a simple method for setting parameters on all the requests before they are built.

This builder does not attempt to check that all requests added are to the same API.

Constructor Summary

Constructors

Constructor and Description
ServiceReadRequestSetBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
ServiceReadRequestSet<T>	build() Builds an immutable request set instance from values provided to this builder.
static <T> ServiceReadRequestSetBuilder<T>	newReadRequestSet() Creates a new paged GET request builder configured with the URL to call and expected response type.
static <T> ServiceReadRequestSetBuilder<T>	newReadRequestSet(Class<T> responseType) Creates a new paged GET request builder configured with the URL to call and expected response type.
ServiceReadRequestSetBuilder<T>	withAddedParam(String name, String value) Add an additional unencoded querystring parameter to be added to every request, preserving the existing set but overwriting any param with the same name.
ServiceReadRequestSetBuilder<T>	withAddedParams(Map<String,String> params) Add additional unencoded querystring parameters to be added to every request, preserving the existing set but overwriting any param with the same names.
ServiceReadRequestSetBuilder<T>	withAddedRequest(ServiceReadRequest<T> request) Adds a request to the batch.
ServiceReadRequestSetBuilder<T>	withAddedRequest(ServiceReadRequestBuilder<T> requestBuilder) Adds a request to the batch.
ServiceReadRequestSetBuilder<T>	withAddedRequests(Set<ServiceReadRequest<T>> requests) Adds a set of requests to the batch.
ServiceReadRequestSetBuilder<T>	withParams(Map<String,String> params) Add querystring parameters to every request, replacing any previously set.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceReadRequestSetBuilder

public ServiceReadRequestSetBuilder()

Method Detail

newReadRequestSet

public static <T> ServiceReadRequestSetBuilder<T> newReadRequestSet(Class<T> responseType)

Creates a new paged GET request builder configured with the URL to call and expected response type. This method does not support extraction of generic types but is able to infer the type parameter <T>.

Type Parameters:

T - placeholder for the response type, used to avoid casting of responses.

Parameters:

responseType - type of result expected in the 'response' element of the JSON response body. This argument is not used for parsing, only to provide

Returns:

an OPTIONS request builder instance.

newReadRequestSet

public static <T> ServiceReadRequestSetBuilder<T> newReadRequestSet()

Creates a new paged GET request builder configured with the URL to call and expected response type. This method supports extraction of generic types (e.g. typed lists or maps) from the response element.

Type Parameters:

T - placeholder for the response type, used to avoid casting of responses.

Returns:

A GET request builder instance.

withAddedParam

public ServiceReadRequestSetBuilder<T> withAddedParam(String name,
                                             String value)

Add an additional unencoded querystring parameter to be added to every request, preserving the existing set but overwriting any param with the same name. The parameter is applied to every request when build() is called, so includes those not yet added.

Parameters:

name - parameter name.

value - parameter value.

Returns:

builder instance for method chaining.

withAddedParams

public ServiceReadRequestSetBuilder<T> withAddedParams(Map<String,String> params)

Add additional unencoded querystring parameters to be added to every request, preserving the existing set but overwriting any param with the same names. The parameters are applied to every request when build() is called, so includes those not yet added.

Parameters:

params - map of querystring params.

Returns:

builder instance for method chaining.

withParams

public ServiceReadRequestSetBuilder<T> withParams(Map<String,String> params)

Add querystring parameters to every request, replacing any previously set. The parameters are applied to every request when build() is called, so includes those not yet added.

Parameters:

params - map of querystring params.

Returns:

builder instance for method chaining.

withAddedRequest

public ServiceReadRequestSetBuilder<T> withAddedRequest(ServiceReadRequestBuilder<T> requestBuilder)

Adds a request to the batch. This is a convenience method that accepts a builder so you can skip calling its ServiceReadRequestBuilder.build() method.

Parameters:

requestBuilder - A request to be added to the batch.

Returns:

builder instance for method chaining.

withAddedRequest

public ServiceReadRequestSetBuilder<T> withAddedRequest(ServiceReadRequest<T> request)

Adds a request to the batch.

Parameters:

request - A request to be added to the batch.

Returns:

builder instance for method chaining.

withAddedRequests

public ServiceReadRequestSetBuilder<T> withAddedRequests(Set<ServiceReadRequest<T>> requests)

Adds a set of requests to the batch.

Parameters:

requests - Requests to be added to the batch.

Returns:

builder instance for method chaining.

build

public ServiceReadRequestSet<T> build()

Builds an immutable request set instance from values provided to this builder.

Returns:

immutable request set instance.