Package org.springframework.restdocs.operation

Class QueryParameters

java.lang.Object

org.springframework.util.MultiValueMapAdapter<K,V>

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

org.springframework.restdocs.operation.QueryParameters

All Implemented Interfaces:

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

public final class QueryParameters
extends org.springframework.util.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 java.util.Map

Map.Entry<K extends Object,V extends Object>

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 org.springframework.util.LinkedMultiValueMap

clone, deepCopy

Methods inherited from class org.springframework.util.MultiValueMapAdapter

add, addAll, addAll, clear, containsKey, containsValue, 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

Methods inherited from interface org.springframework.util.MultiValueMap

addIfAbsent

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