Class RequestBuilder<T>

java.lang.Object

de.chojo.universalis.rest.requests.RequestBuilder<T>

Type Parameters:

T - type of response

All Implemented Interfaces:

Request<T>

Direct Known Subclasses:

ContentRequestImpl, DataCentersRequestImpl, HistoryRequestImpl, LeastRecentlyUpdatedRequestImpl, MarketableRequestImpl, MarketBoardRequestImpl, MostRecentlyUpdatedRequestImpl, TaxRatesRequestImpl, UploaderUploadCountsRequestImpl, UploadHistoryRequestImpl, WorldsRequestImpl, WorldUploadCountsRequestImpl

public class RequestBuilder<T>
extends Object
implements Request<T>

A request builder used to build, execute requests and parse the response

Field Summary

Fields

Modifier and Type	Field	Description
protected final UniversalisRestImpl	rest

Constructor Summary

Constructors

Constructor	Description
RequestBuilder(UniversalisRestImpl rest, Class<T> result)	Create a new request builder
RequestBuilder(UniversalisRestImpl rest, Class<T> result, Consumer<T> postRetrievalHook)	Creates a new request builder

Method Summary

Modifier and Type	Method	Description
T	complete()	Sends the request and handles the response on the current thread
void	markScope(String name)	Records that a top-level scope (world/dataCenter/region) has been chosen.
void	parameter(String key, Object object)	Adds a parameter to the uri
void	path(Object... path)	Adds an element to the path.
void	path(String... path)	Adds an element to the path.
CompletableFuture<T>	queue()	Queue the request asynchronous.
String	toString()

Methods inherited from class Object

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

Field Details

rest

protected final UniversalisRestImpl rest

Constructor Details

RequestBuilder

public RequestBuilder(UniversalisRestImpl rest,
 Class<T> result)

Create a new request builder

Parameters:

rest - rest client

result - result of the request

RequestBuilder

public RequestBuilder(UniversalisRestImpl rest,
 Class<T> result,
 Consumer<T> postRetrievalHook)

Creates a new request builder

Parameters:

rest - rest client

result - result of the request

postRetrievalHook - modification of the result

Method Details

markScope

public void markScope(String name)

Records that a top-level scope (world/dataCenter/region) has been chosen. Throws if a scope is already set — request scopes are mutually exclusive.

parameter

public void parameter(String key,
 Object object)

Adds a parameter to the uri

Parameters:

key - parameter key

object - parameter value

path

public void path(String... path)

Adds an element to the path.

Parameters:

path - path

path

public void path(Object... path)

Adds an element to the path.

Parameters:

path - path

queue

public CompletableFuture<T> queue()

Description copied from interface: Request

Queue the request asynchronous.

Specified by:

queue in interface Request<T>

Returns:

completable future providing the response

complete

public T complete()

Description copied from interface: Request

Sends the request and handles the response on the current thread

Specified by:

complete in interface Request<T>

Returns:

response

toString

public String toString()

Overrides:

toString in class Object