org.springframework.restdocs.operation

Class Parameters

java.lang.Object

org.springframework.util.LinkedMultiValueMap<String,String>

org.springframework.restdocs.operation.Parameters

All Implemented Interfaces:

Serializable, Cloneable, Map<String,List<String>>, org.springframework.util.MultiValueMap<String,String>

public class Parameters
extends org.springframework.util.LinkedMultiValueMap<String,String>

The parameters received in a request.

Author:

Andy Wilkinson

See Also:

Serialized Form

Nested Class Summary

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Parameters()

Method Summary

Modifier and Type	Method and Description
Parameters	getUniqueParameters(URI uri) Returns a new Parameters containing only the parameters that do no appear in the query string of the given uri.
String	toQueryString() Converts the parameters to a query string suitable for use in a URI or the body of a form-encoded request.

Methods inherited from class org.springframework.util.LinkedMultiValueMap

add, clear, clone, containsKey, containsValue, deepCopy, entrySet, equals, get, getFirst, hashCode, isEmpty, keySet, put, putAll, remove, set, setAll, size, toSingleValueMap, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Parameters

public Parameters()

Method Detail

toQueryString

public String toQueryString()

Converts the parameters to a query string suitable for use in a URI or the body of a form-encoded request.

Returns:

the query string

getUniqueParameters

public Parameters getUniqueParameters(URI uri)

Returns a new Parameters containing only the parameters that do no appear in the query string of the given uri.

Parameters:

uri - the uri

Returns:

the unique parameters