Class FormParameters

java.lang.Object

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

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

org.springframework.restdocs.operation.FormParameters

All Implemented Interfaces:

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

public final class FormParameters
extends LinkedMultiValueMap<String,String>

A request's form parameters, derived from its form URL encoded body content.

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 FormParameters	from(OperationRequest request)	Extracts the form parameters from the body 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 FormParameters from(OperationRequest request)

Extracts the form parameters from the body of the given request. If the request has no body content, an empty FormParameters is returned, rather than null.

Parameters:

request - the request

Returns:

the form parameters extracted from the body content