org.mule.runtime.api.util

Class MultiMap<K,V>

java.lang.Object

org.mule.runtime.api.util.MultiMap<K,V>

Type Parameters:

K - the type of keys maintained by this map

V - the type of mapped values

All Implemented Interfaces:

Serializable, Map<K,V>

Direct Known Subclasses:

CaseInsensitiveMultiMap

public class MultiMap<K,V>
extends Object
implements Map<K,V>, Serializable

Implementation of a multi-map that allows the aggregation of keys and access to the aggregated list or a single value (the first).

Since:

1.0

See Also:

Serialized Form

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<K,LinkedList<V>>	paramsMap

Constructor Summary

Constructors

Constructor and Description
MultiMap()
MultiMap(Map<K,V> parametersMap)
MultiMap(MultiMap<K,V> multiMap)

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
static <K,V> MultiMap<K,V>	emptyMultiMap() Returns an empty multi-map (immutable).
List<Map.Entry<K,V>>	entryList() Returns a List view of the mappings contained in this map, including an entry for each value associated to the same key.
Set<Map.Entry<K,V>>	entrySet()
boolean	equals(Object o)
V	get(Object key)
List<V>	getAll(Object key) Returns the values to which the specified key is mapped.
int	hashCode()
boolean	isEmpty()
Set<K>	keySet()
void	put(K key, Collection<V> values) Associates the specified value with the specified key in this map (optional operation).
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> aMap)
void	putAll(MultiMap<? extends K,? extends V> aMultiMap) Similar to putAll(Map), but instead of putting only the first value of each key, all the values are copied for each key.
V	remove(Object key)
int	size()
MultiMap<K,V>	toImmutableMultiMap()
Map<K,? extends List<V>>	toListValuesMap()
String	toString()
Collection<V>	values()

Methods inherited from class java.lang.Object

clone, 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

Field Detail

paramsMap

protected Map<K,LinkedList<V>> paramsMap

Constructor Detail

MultiMap

public MultiMap(MultiMap<K,V> multiMap)

MultiMap

public MultiMap(Map<K,V> parametersMap)

MultiMap

public MultiMap()

Method Detail

emptyMultiMap

public static <K,V> MultiMap<K,V> emptyMultiMap()

Returns an empty multi-map (immutable). This map is serializable.

This example illustrates the type-safe way to obtain an empty map:

 MultiMap<String, Stirng> s = MultiMap.emptyMultiMap();
 

Type Parameters:

K - the class of the map keys

V - the class of the map values

Returns:

an empty multi-map

Since:

1.1.1

toImmutableMultiMap

public MultiMap<K,V> toImmutableMultiMap()

size

public int size()

Specified by:

size in interface Map<K,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

get

public V get(Object key)

Specified by:

get in interface Map<K,V>

getAll

public List<V> getAll(Object key)

Returns the values to which the specified key is mapped.

Parameters:

key - the key whose associated values are to be returned

Returns:

a list of values to which the specified key is mapped, or an empty list if this map contains no mappings for the key

put

public V put(K key,
             V value)

Specified by:

put in interface Map<K,V>

put

public void put(K key,
                Collection<V> values)

Associates the specified value with the specified key in this map (optional operation). If the map previously contained mappings for the key, the new values are aggregated to the old.

Parameters:

key - key with which the specified values are to be associated

values - collection of values to be associated with the specified key

remove

public V remove(Object key)

Specified by:

remove in interface Map<K,V>

putAll

public void putAll(Map<? extends K,? extends V> aMap)

Specified by:

putAll in interface Map<K,V>

putAll

public void putAll(MultiMap<? extends K,? extends V> aMultiMap)

Similar to putAll(Map), but instead of putting only the first value of each key, all the values are copied for each key.

Parameters:

aMultiMap - mappings to be stored in this map

Throws:

ClassCastException - if the class of a key or value in the specified map prevents it from being stored in this map

NullPointerException - if the specified map is null, or if this map does not permit null keys or values, and the specified map contains null keys or values

IllegalArgumentException - if some property of a key or value in the specified map prevents it from being stored in this map

Since:

1.1.1

clear

public void clear()

Specified by:

clear in interface Map<K,V>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

values

public Collection<V> values()

Specified by:

values in interface Map<K,V>

entrySet

public Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

entryList

public List<Map.Entry<K,V>> entryList()

Returns a List view of the mappings contained in this map, including an entry for each value associated to the same key.

Returns:

a list view of the mappings contained in this map

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class Object

toListValuesMap

public Map<K,? extends List<V>> toListValuesMap()

toString

public String toString()

Overrides:

toString in class Object