Class QueryParameters

java.lang.Object

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

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

org.springframework.restdocs.operation.QueryParameters

All Implemented Interfaces:

Serializable, Cloneable, Map<String, List<String>>, MultiValueMap<String,String>

public final class QueryParameters
extends LinkedMultiValueMap<String,String>

A request's query parameters, derived from its URI's query string.

Since:

3.0.0

Author:

Andy Wilkinson

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method	Description
static QueryParameters	from(OperationRequest request)	Extracts the query parameters from the query string of the given request.

Methods inherited from class LinkedMultiValueMap

clone, deepCopy

Methods inherited from class MultiValueMapAdapter

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

Methods inherited from class Object

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

Methods inherited from interface Map

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

Methods inherited from interface MultiValueMap

addIfAbsent, asSingleValueMap

Method Details

from

public static QueryParameters from(OperationRequest request)

Extracts the query parameters from the query string of the given request. If the request has no query string, an empty QueryParameters is returned, rather than null.

Parameters:

request - the request

Returns:

the query parameters extracted from the request's query string