org.springframework.util

Interface MultiValueMap<K,V>

  • Type Parameters:
    K - the key type
    V - the value element type
    All Superinterfaces:
    java.util.Map<K,java.util.List<V>>
    All Known Implementing Classes:
    HttpHeaders, LinkedMultiValueMap, StompHeaders, WebSocketHttpHeaders


    public interface MultiValueMap<K,V>
    extends java.util.Map<K,java.util.List<V>>
    Extension of the Map interface that stores multiple values.
    Since:
    3.0
    Author:
    Arjen Poutsma
    • Nested Class Summary

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

        java.util.Map.Entry<K,V>
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      void add(K key, V value)
      Add the given single value to the current list of values for the given key.
      void addAll(K key, java.util.List<? extends V> values)
      Add all the values of the given list to the current list of values for the given key.
      void addAll(MultiValueMap<K,V> values)
      Add all the values of the given MultiValueMap to the current values.
      V getFirst(K key)
      Return the first value for the given key.
      void set(K key, V value)
      Set the given single value under the given key.
      void setAll(java.util.Map<K,V> values)
      Set the given values under.
      java.util.Map<K,V> toSingleValueMap()
      Returns the first values contained in this MultiValueMap.
      • Methods inherited from interface java.util.Map

        clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
    • Method Detail

      • getFirst

        @Nullable
        V getFirst(K key)
        Return the first value for the given key.
        Parameters:
        key - the key
        Returns:
        the first value for the specified key, or null if none
      • add

        void add(K key,
                 @Nullable
                 V value)
        Add the given single value to the current list of values for the given key.
        Parameters:
        key - the key
        value - the value to be added
      • addAll

        void addAll(K key,
                    java.util.List<? extends V> values)
        Add all the values of the given list to the current list of values for the given key.
        Parameters:
        key - they key
        values - the values to be added
        Since:
        5.0
      • addAll

        void addAll(MultiValueMap<K,V> values)
        Add all the values of the given MultiValueMap to the current values.
        Parameters:
        values - the values to be added
        Since:
        5.0
      • set

        void set(K key,
                 @Nullable
                 V value)
        Set the given single value under the given key.
        Parameters:
        key - the key
        value - the value to set
      • setAll

        void setAll(java.util.Map<K,V> values)
        Set the given values under.
        Parameters:
        values - the values.
      • toSingleValueMap

        java.util.Map<K,V> toSingleValueMap()
        Returns the first values contained in this MultiValueMap.
        Returns:
        a single value representation of this map