com.squareup.square.http.request

Class HttpRequest

java.lang.Object

com.squareup.square.http.request.HttpRequest

Direct Known Subclasses:

HttpBodyRequest

public class HttpRequest
extends Object

Class for creating and managing HTTP Requests.

Constructor Summary

Constructors

Constructor and Description
HttpRequest(HttpMethod method, StringBuilder queryUrlBuilder, Headers headers, Map<String,Object> queryParameters, List<AbstractMap.SimpleEntry<String,Object>> parameters) Initializes a simple http request.

Method Summary

Modifier and Type	Method and Description
void	addQueryParameter(String key, Object value) Add Query parameter in http request.
Headers	getHeaders() Headers for the http request.
HttpMethod	getHttpMethod() HttpMethod for the http request.
List<AbstractMap.SimpleEntry<String,Object>>	getParameters() Parameters for the http request.
Map<String,Object>	getQueryParameters() Query parameters for the http request.
String	getQueryUrl() Query url for the http request.
String	toString() Converts this HttpRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpRequest

public HttpRequest(HttpMethod method,
                   StringBuilder queryUrlBuilder,
                   Headers headers,
                   Map<String,Object> queryParameters,
                   List<AbstractMap.SimpleEntry<String,Object>> parameters)

Initializes a simple http request.

Parameters:

method - The HTTP method to use. Can be GET, HEAD, PUT, POST, DELETE and PATCH

queryUrlBuilder - The fully qualified absolute http url to create the HTTP Request.

headers - The key-value map of all http headers to be sent

queryParameters - The query parameters in a key-value map

parameters - The form data values in a key-value map

Method Detail

getHttpMethod

public HttpMethod getHttpMethod()

HttpMethod for the http request.

Returns:

HttpMethod

getHeaders

public Headers getHeaders()

Headers for the http request.

Returns:

Headers

getQueryUrl

public String getQueryUrl()

Query url for the http request.

Returns:

String query url

getParameters

public List<AbstractMap.SimpleEntry<String,Object>> getParameters()

Parameters for the http request.

Returns:

List of simple entries for form parameters

getQueryParameters

public Map<String,Object> getQueryParameters()

Query parameters for the http request.

Returns:

Map of queryParameters

addQueryParameter

public void addQueryParameter(String key,
                              Object value)

Add Query parameter in http request.

Parameters:

key - The key of query parameter to be added

value - The value for respective query parameter

toString

public String toString()

Converts this HttpRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class