lib.easyjava.type

Class ListMultiMap<K,V>

java.lang.Object

lib.easyjava.type.ListMultiMap<K,V>

Type Parameters:

K - the type of the map's keys

V - the type of the map's values

All Implemented Interfaces:

java.io.Serializable, MultiMap<K,V>

public class ListMultiMap<K,V>
extends java.lang.Object
implements MultiMap<K,V>

A multimap back by a list, allowing duplicate values under the same key

Author:

Rob Rua (robrua@alumni.cmu.edu)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListMultiMap()

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all of the mappings from this map (optional operation).
boolean	containsKey(java.lang.Object key) Returns true if this map contains a mapping for the specified key.
boolean	containsValue(java.lang.Object value) Returns true if this map maps one or more keys to the specified value.
java.util.Collection<java.util.Map.Entry<K,V>>	entries() Returns a collection view of the mappings contained in this map.
boolean	equals(java.lang.Object obj)
java.util.List<V>	get(java.lang.Object key) Returns the values to which the specified key is mapped, or null if this map contains no mapping for the key.
java.util.List<V>	getEmptyCollection() Provides an empty collection of the appropriate type to hold values.
int	hashCode()
boolean	isEmpty() Returns true if this map contains no key-value mappings.
java.util.Set<K>	keySet() Returns a set view of the keys contained in this map.
void	put(K key, java.util.Collection<V> values) Associates the specified values with the specified key in this map (optional operation).
void	put(K key, V value) Associates the specified value with the specified key in this map (optional operation).
void	putAll(java.util.Map<? extends K,? extends V> map) Copies all of the mappings from the specified map to this map (optional operation).
void	putAll(MultiMap<? extends K,? extends V> map) Copies all of the mappings from the specified multimap to this map (optional operation).
java.util.List<V>	remove(java.lang.Object key) Removes the mapping for a key from this map if it is present (optional operation).
int	size() Returns the number of key-value mappings in this map.
java.lang.String	toString()
java.util.Collection<V>	values() Returns a collection view of the values contained in this map.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface lib.easyjava.type.MultiMap

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

Constructor Detail

ListMultiMap

public ListMultiMap()

Method Detail

clear

public void clear()

Description copied from interface: MultiMap

Removes all of the mappings from this map (optional operation).

Specified by:

clear in interface MultiMap<K,V>

containsKey

public boolean containsKey(java.lang.Object key)

Description copied from interface: MultiMap

Returns true if this map contains a mapping for the specified key.

Specified by:

containsKey in interface MultiMap<K,V>

Parameters:

key - key whose presence in this map is to be tested

Returns:

true if this map contains a mapping for the specified key

containsValue

public boolean containsValue(java.lang.Object value)

Description copied from interface: MultiMap

Returns true if this map maps one or more keys to the specified value.

Specified by:

containsValue in interface MultiMap<K,V>

Parameters:

value - value whose presence in this map is to be tested

Returns:

true if this map maps one or more keys to the specified value

entries

public java.util.Collection<java.util.Map.Entry<K,V>> entries()

Description copied from interface: MultiMap

Returns a collection view of the mappings contained in this map.

Specified by:

entries in interface MultiMap<K,V>

Returns:

a collection view of the mappings contained in this map

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

get

public java.util.List<V> get(java.lang.Object key)

Description copied from interface: MultiMap

Returns the values to which the specified key is mapped, or null if this map contains no mapping for the key.

Specified by:

get in interface MultiMap<K,V>

Parameters:

key - the key to get values for

Returns:

the values to which the specified key is mapped, or null if this map contains no mapping for the key

getEmptyCollection

public java.util.List<V> getEmptyCollection()

Description copied from interface: MultiMap

Provides an empty collection of the appropriate type to hold values.

Specified by:

getEmptyCollection in interface MultiMap<K,V>

Returns:

an empty collection

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isEmpty

public boolean isEmpty()

Description copied from interface: MultiMap

Returns true if this map contains no key-value mappings.

Specified by:

isEmpty in interface MultiMap<K,V>

Returns:

true if this map contains no key-value mappings

keySet

public java.util.Set<K> keySet()

Description copied from interface: MultiMap

Returns a set view of the keys contained in this map.

Specified by:

keySet in interface MultiMap<K,V>

Returns:

a set view of the keys contained in this map

put

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

Description copied from interface: MultiMap

Associates the specified values with the specified key in this map (optional operation).

Specified by:

put in interface MultiMap<K,V>

Parameters:

key - key with which the specified value is to be associated

values - values to be associated with the specified key

put

public void put(K key,
                V value)

Description copied from interface: MultiMap

Associates the specified value with the specified key in this map (optional operation).

Specified by:

put in interface MultiMap<K,V>

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

putAll

public void putAll(java.util.Map<? extends K,? extends V> map)

Description copied from interface: MultiMap

Copies all of the mappings from the specified map to this map (optional operation).

Specified by:

putAll in interface MultiMap<K,V>

Parameters:

map - mappings to be stored in this map

putAll

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

Description copied from interface: MultiMap

Copies all of the mappings from the specified multimap to this map (optional operation).

Specified by:

putAll in interface MultiMap<K,V>

Parameters:

map - mappings to be stored in this map

remove

public java.util.List<V> remove(java.lang.Object key)

Description copied from interface: MultiMap

Removes the mapping for a key from this map if it is present (optional operation).

Specified by:

remove in interface MultiMap<K,V>

Parameters:

key - key whose mappings are to be removed from the map

Returns:

the previous values associated with key, or null if there was no mapping for key.

size

public int size()

Description copied from interface: MultiMap

Returns the number of key-value mappings in this map.

Specified by:

size in interface MultiMap<K,V>

Returns:

the number of key-value mappings in this map

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

values

public java.util.Collection<V> values()

Description copied from interface: MultiMap

Returns a collection view of the values contained in this map.

Specified by:

values in interface MultiMap<K,V>

Returns:

a collection view of the values contained in this map