Package br.com.moip.api.request

Class RequestPropertiesBuilder

java.lang.Object

br.com.moip.api.request.RequestProperties

br.com.moip.api.request.RequestPropertiesBuilder

public class RequestPropertiesBuilder
extends RequestProperties

Field Summary

Fields inherited from class br.com.moip.api.request.RequestProperties

accept, body, contentType, endpoint, method, type

Constructor Summary

Constructors

Constructor	Description
RequestPropertiesBuilder()

Method Summary

Modifier and Type	Method	Description
RequestPropertiesBuilder	accept(java.lang.String acceptVersion)	This method is used to set the JSON version, if it takes.
RequestPropertiesBuilder	body(java.util.Map<java.lang.String,java.lang.Object> body)	This method is used to set the request object into super class.
RequestProperties	build()	This method is used to parse the object to RequestProperties type and complete the build.
RequestPropertiesBuilder	contentType(org.apache.http.entity.ContentType contentType)	This method is used to set the request content type.
RequestPropertiesBuilder	endpoint(java.lang.String endpoint)	This method is used to set the request endpoint into super class.
RequestPropertiesBuilder	method(java.lang.String method)	This method is used to set the request method into super class.
RequestPropertiesBuilder	type(java.lang.Class type)	This method is used to set the model class type.

Methods inherited from class java.lang.Object

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

Methods inherited from class br.com.moip.api.request.RequestProperties

getAccept, getContentType, getEndpoint, getMethod, getObject, getType, hasAccept

Constructor Detail

RequestPropertiesBuilder

public RequestPropertiesBuilder()

Method Detail

method

public RequestPropertiesBuilder method(java.lang.String method)

This method is used to set the request method into super class. The possible values are POST, GET, PUT and DELETE.

Parameters:

method - String request method

Returns:

this (RequestPropertiesBuilder)

endpoint

public RequestPropertiesBuilder endpoint(java.lang.String endpoint)

This method is used to set the request endpoint into super class. This is the endpoint that will be requested. Ex: /v2/customers, /v2/accounts, /v2/transfers.

Parameters:

endpoint - String request endpoint.

Returns:

this (RequestPropertiesBuilder)

body

public RequestPropertiesBuilder body(java.util.Map<java.lang.String,java.lang.Object> body)

This method is used to set the request object into super class. The object is the body of the request.

Parameters:

body - Object request object

Returns:

this (RequestPropertiesBuilder)

See Also:

Object

type

public RequestPropertiesBuilder type(java.lang.Class type)

This method is used to set the model class type. If the request is successful, the class attributes will be filled with the response.

Parameters:

type - Class request class type

Returns:

this (RequestPropertiesBuilder)

See Also:

Class

contentType

public RequestPropertiesBuilder contentType(org.apache.http.entity.ContentType contentType)

This method is used to set the request content type. Actually, the only content type accept by Moip API is the APPLICATION_JSON.

Parameters:

contentType - ContentType request content type

Returns:

this (RequestPropertiesBuilder)

See Also:

ContentType

accept

public RequestPropertiesBuilder accept(java.lang.String acceptVersion)

This method is used to set the JSON version, if it takes. Actually, only some endpoints accept a different JSON version. Accept application/json;version=2.1 Possible value: "2.1"

Parameters:

acceptVersion - String accept JSON version

Returns:

this (RequestPropertiesBuilder)

See Also:

Saldo Moip, Lançamentos

build

public RequestProperties build()

This method is used to parse the object to RequestProperties type and complete the build.

Returns:

this (RequestProperties)