com.gluonhq.charm.connect.data

Class MultiValuedMap<K,V>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,java.util.List<V>>

com.gluonhq.charm.connect.data.MultiValuedMap<K,V>

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<K,java.util.List<V>>

public class MultiValuedMap<K,V>
extends java.util.HashMap<K,java.util.List<V>>

Utility class for storing a Map where a specific key can hold more than one value. In HTTP Rest requests, query and form parameters are allowed to have more than one value for a specific key, in which case this class can be used.

Since:

2.1.0

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
MultiValuedMap()

Method Summary

Modifier and Type	Method and Description
java.util.List<V>	optPut(K key, V value) Convenience method.
void	putMap(java.util.Map<K,V> map) Copies all of the mappings from the specified map into this map.
java.util.List<V>	putSingle(K key, V value) Add the provided value to the list of values associated with this key

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

MultiValuedMap

public MultiValuedMap()

Method Detail

optPut

public java.util.List<V> optPut(K key,
                                V value)

Convenience method. Only add the value to the values already belonging to this key in case value is not NULL. This saves client-checks on null values. // TODO not sure we really want this.

Parameters:

key - the key of which the values need to be updated

value - the value to be added when not NULL

Returns:

the new list of values mapped to the specified key

putSingle

public java.util.List<V> putSingle(K key,
                                   V value)

Add the provided value to the list of values associated with this key

Parameters:

key - the key

value - the new (additional) value belonging to this key.

Returns:

the list associated with this key

putMap

public void putMap(java.util.Map<K,V> map)

Copies all of the mappings from the specified map into this map.

Parameters:

map - mappings to be stored in this map