org.mule.module.http.api

Interface HttpParameters

All Superinterfaces:

Map<String,String>

All Known Implementing Classes:

CaseInsensitiveParameterMap, ParameterMap

public interface HttpParameters
extends Map<String,String>

HTTP parameters map. Usually used to hold query parameters, form parameters or uri parameters. Implementations of this class are immutable.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
String	get(Object key)
List<String>	getAll(String key) Utility method to retrieve all the values for a certain parameter.
Map<String,? extends List<String>>	toListValuesMap()

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

getAll

List<String> getAll(String key)

Utility method to retrieve all the values for a certain parameter.

Parameters:

key - the name of the parameter.

Returns:

a list with all the values for that parameter name. If there's no value then an empty collection is returned.

get

String get(Object key)

Specified by:

get in interface Map<String,String>

Parameters:

key - parameter name

Returns:

the parameter value. If there wsa a collection of values for the parameter then only the first one is returned.

toListValuesMap

Map<String,? extends List<String>> toListValuesMap()

Returns:

Immutable map with all the parameters which values are collections with all the values.