com.empyr.api

Class Request<T>

java.lang.Object

com.empyr.api.HttpRequest

com.empyr.api.Request<T>

Type Parameters:

T - The type of the requested response which would be serialized out of the API call.

public class Request<T>
extends HttpRequest

Builder class for building API requests to the Empyr backend.

Author:

jarrodcuzens

See Also:

for examples.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Request(MethodType t, String endPoint, boolean requiresToken)

Method Summary

Modifier and Type	Method and Description
Request<T>	addParams(Map<String,Object> params)
Request<T>	addParams(Object... params)
static <F> Request<F>	createRequest(MethodType get, String endpoint)
static <F> Request<F>	createRequest(MethodType get, String endpoint, boolean requiresToken)
static <F> Request<F>	createRequest(MethodType get, String endpoint, boolean requiresToken, String userToken)
Request<T>	expects(String returnKey, Class<?> response)
<F> Request<T>	expects(String returnKey, TypeReference<F> type)
Map<String,Object>	getExpected()
RestResponse<T>	getResponse()
boolean	isRequiresToken()
void	setResponse(RestResponse<T> response)

Methods inherited from class com.empyr.api.HttpRequest

createHttpRequest, getEndPoint, getMethod, getRequestParams

Methods inherited from class java.lang.Object

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

Constructor Detail

Request

protected Request(MethodType t,
                  String endPoint,
                  boolean requiresToken)

Method Detail

createRequest

public static <F> Request<F> createRequest(MethodType get,
                                           String endpoint)

createRequest

public static <F> Request<F> createRequest(MethodType get,
                                           String endpoint,
                                           boolean requiresToken)

createRequest

public static <F> Request<F> createRequest(MethodType get,
                                           String endpoint,
                                           boolean requiresToken,
                                           String userToken)

addParams

public Request<T> addParams(Map<String,Object> params)

Overrides:

addParams in class HttpRequest

addParams

public Request<T> addParams(Object... params)

Overrides:

addParams in class HttpRequest

getExpected

public Map<String,Object> getExpected()

Returns:

the expected

expects

public Request<T> expects(String returnKey,
                          Class<?> response)

expects

public <F> Request<T> expects(String returnKey,
                              TypeReference<F> type)

getResponse

public RestResponse<T> getResponse()

setResponse

public void setResponse(RestResponse<T> response)

isRequiresToken

public boolean isRequiresToken()

Returns:

the requiresToken