com.mulesoft.connectivity.rest.commons.api.operation.queryparam

Class RequestParameterFormatter

java.lang.Object

com.mulesoft.connectivity.rest.commons.api.operation.queryparam.RequestParameterFormatter

Direct Known Subclasses:

CommaRequestParameterFormatter, MultimapRequestParameterFormatter

public abstract class RequestParameterFormatter
extends Object

Formats the parameters of a request, so that they are sent using the desired format.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
RequestParameterFormatter()

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.api.util.MultiMap<String,String>	format(Map<String,Object> parameters) Formats the parameters of a request, so that they are sent using the desired format.
abstract org.mule.runtime.api.util.MultiMap<String,String>	format(Map<String,Object> parameters, boolean caseSensitive) Formats the parameters of a request, so that they are sent using the desired format.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestParameterFormatter

public RequestParameterFormatter()

Method Detail

format

public org.mule.runtime.api.util.MultiMap<String,String> format(Map<String,Object> parameters)

Formats the parameters of a request, so that they are sent using the desired format. For the input multimap every key/value query parameter will have an entry in the multimap. Each value of the @return multimap will be sent as a key/value in the http request.

Parameters:

parameters - A MultiMap of query parameters that must be sent in a http request

Returns:

A multimap where the query parameters are formatted.

format

public abstract org.mule.runtime.api.util.MultiMap<String,String> format(Map<String,Object> parameters,
                                                                         boolean caseSensitive)

Formats the parameters of a request, so that they are sent using the desired format. For the input multimap every key/value query parameter will have an entry in the multimap. Each value of the @return multimap will be sent as a key/value in the http request.

Parameters:

parameters - A MultiMap of query parameters that must be sent in a http request

Returns:

A multimap where the query parameters are formatted.