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>>, org.springframework.util.MultiValueMap<String,String>
public final class FormParameters extends org.springframework.util.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:

  • Nested Class Summary

    Nested classes/interfaces inherited from interface java.util.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 org.springframework.util.LinkedMultiValueMap

    clone, deepCopy

    Methods inherited from class org.springframework.util.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 java.lang.Object

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

    Methods inherited from interface java.util.Map

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

    Methods inherited from interface org.springframework.util.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