Class MultiMap<K,V>

java.lang.Object

aQute.lib.collections.MultiMap<K,V>

All Implemented Interfaces:

Map<K,List<V>>

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

Nested Class Summary

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Constructor Summary

Constructors

Modifier	Constructor	Description
	MultiMap()
	MultiMap(boolean noduplicates)
<S extends K, T extends V>	MultiMap(MultiMap<S,T> other)
	MultiMap(Class<? extends K> keyClass, Class<? extends V> valueClass, boolean noduplicates)
	MultiMap(Map<? extends K, ? extends Collection<? extends V>> other)

Method Summary

Modifier and Type	Method	Description
boolean	add(K key, V value)
boolean	addAll(Map<? extends K, ? extends Collection<? extends V>> other)
boolean	addAll(K key, Collection<? extends V> value)
Iterator<V>	all()
List<V>	allValues()	Return a collection with all values
void	clear()
List<V>	compute(K key, BiFunction<? super K, ? super List<V>, ? extends List<V>> remappingFunction)
List<V>	computeIfAbsent(K key, Function<? super K, ? extends List<V>> mappingFunction)
List<V>	computeIfPresent(K key, BiFunction<? super K, ? super List<V>, ? extends List<V>> remappingFunction)
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<K,List<V>>>	entrySet()
boolean	equals(Object obj)
Map<K,V>	flatten()
void	forEach(BiConsumer<? super K, ? super List<V>> action)
static <T extends Comparable<? super T>> String	format(Map<T, ? extends Collection<?>> map)
List<V>	get(Object key)
List<V>	getOrDefault(Object key, List<V> defaultValue)
MultiMap<K,V>	groupBy(Collection<? extends V> collection, Function<? super V, ? extends K> classifier)	Index a collection.
int	hashCode()
boolean	isEmpty()
Iterator<V>	iterate(K key)
Set<K>	keySet()
List<V>	merge(K key, List<V> value, BiFunction<? super List<V>, ? super List<V>, ? extends List<V>> remappingFunction)
List<V>	put(K key, List<V> value)
void	putAll(Map<? extends K, ? extends List<V>> m)
List<V>	putIfAbsent(K key, List<V> value)
List<V>	remove(Object key)
boolean	remove(Object key, Object value)
boolean	removeAll(K key, Collection<? extends V> value)
boolean	removeValue(K key, V value)
List<V>	replace(K key, List<V> value)
boolean	replace(K key, List<V> oldValue, List<V> newValue)
void	replaceAll(BiFunction<? super K, ? super List<V>, ? extends List<V>> function)
int	size()
String	toString()
MultiMap<V,K>	transpose()
MultiMap<V,K>	transpose(boolean noduplicates)
Collection<List<V>>	values()

Methods inherited from class Object

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

Constructor Details

MultiMap

public MultiMap()

MultiMap

public MultiMap(boolean noduplicates)

MultiMap

public MultiMap(Class<? extends K> keyClass,
 Class<? extends V> valueClass,
 boolean noduplicates)

MultiMap

public MultiMap(Map<? extends K, ? extends Collection<? extends V>> other)

MultiMap

public <S extends K, T extends V> MultiMap(MultiMap<S,T> other)

Method Details

add

public boolean add(K key,
 V value)

addAll

public boolean addAll(K key,
 Collection<? extends V> value)

addAll

public boolean addAll(Map<? extends K, ? extends Collection<? extends V>> other)

removeValue

public boolean removeValue(K key,
 V value)

removeAll

public boolean removeAll(K key,
 Collection<? extends V> value)

iterate

public Iterator<V> iterate(K key)

all

public Iterator<V> all()

flatten

public Map<K,V> flatten()

transpose

public MultiMap<V,K> transpose()

transpose

public MultiMap<V,K> transpose(boolean noduplicates)

allValues

public List<V> allValues()

Return a collection with all values

Returns:

all values

format

public static <T extends Comparable<? super T>>
String format(Map<T, ? extends Collection<?>> map)

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 List<V> get(Object key)

Specified by:

get in interface Map<K,V>

put

public List<V> put(K key,
 List<V> value)

Specified by:

put in interface Map<K,V>

remove

public List<V> remove(Object key)

Specified by:

remove in interface Map<K,V>

putAll

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

Specified by:

putAll in interface Map<K,V>

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<List<V>> values()

Specified by:

values in interface Map<K,V>

entrySet

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

Specified by:

entrySet in interface Map<K,V>

getOrDefault

public List<V> getOrDefault(Object key,
 List<V> defaultValue)

Specified by:

getOrDefault in interface Map<K,V>

forEach

public void forEach(BiConsumer<? super K, ? super List<V>> action)

Specified by:

forEach in interface Map<K,V>

replaceAll

public void replaceAll(BiFunction<? super K, ? super List<V>, ? extends List<V>> function)

Specified by:

replaceAll in interface Map<K,V>

putIfAbsent

public List<V> putIfAbsent(K key,
 List<V> value)

Specified by:

putIfAbsent in interface Map<K,V>

remove

public boolean remove(Object key,
 Object value)

Specified by:

remove in interface Map<K,V>

replace

public boolean replace(K key,
 List<V> oldValue,
 List<V> newValue)

Specified by:

replace in interface Map<K,V>

replace

public List<V> replace(K key,
 List<V> value)

Specified by:

replace in interface Map<K,V>

computeIfAbsent

public List<V> computeIfAbsent(K key,
 Function<? super K, ? extends List<V>> mappingFunction)

Specified by:

computeIfAbsent in interface Map<K,V>

computeIfPresent

public List<V> computeIfPresent(K key,
 BiFunction<? super K, ? super List<V>, ? extends List<V>> remappingFunction)

Specified by:

computeIfPresent in interface Map<K,V>

compute

public List<V> compute(K key,
 BiFunction<? super K, ? super List<V>, ? extends List<V>> remappingFunction)

Specified by:

compute in interface Map<K,V>

merge

public List<V> merge(K key,
 List<V> value,
 BiFunction<? super List<V>, ? super List<V>, ? extends List<V>> remappingFunction)

Specified by:

merge in interface Map<K,V>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

groupBy

public MultiMap<K,V> groupBy(Collection<? extends V> collection,
 Function<? super V, ? extends K> classifier)

Index a collection.

Parameters:

collection - the collection to index

classifier - the function to map a value in the collection to the key

Returns:

the current map