randoop.util

Class MultiMap<K,V>

java.lang.Object

randoop.util.MultiMap<K,V>

All Implemented Interfaces:

IMultiMap<K,V>

Direct Known Subclasses:

MultiMap.EmptyMultiMap

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

Implements an IMultiMap with a java.util.LinkedHashMap.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	MultiMap.EmptyMultiMap<K,V> An immutable, empty multimap.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<K,java.util.Set<V>>	map The backing map.

Constructor Summary

Constructors

Constructor and Description
MultiMap() Creates a new, empyt MultiMap.
MultiMap(int initialCapacity)

Method Summary

Modifier and Type	Method and Description
boolean	add(K key, V value) Precondition: the mapping key→value is not already in the map.
void	addAll(K key, java.util.Collection<? extends V> values)
void	addAll(java.util.Map<? extends K,? extends V> m)
void	addAll(MultiMap<K,V> mmap)
void	clear()
boolean	contains(K obj)
static <K,V> MultiMap<K,V>	empty() Returns an immutable, empty multimap.
java.util.Set<V>	getValues(K key) Returns the values that the given key maps to.
boolean	isEmpty()
java.util.Set<K>	keySet() Returns the set of keys in this map (the domain).
void	put(K key, java.util.Collection<? extends V> values) Adds a key-values mapping to this multimap.
boolean	remove(K key)
boolean	remove(K key, V value) Precondition: the mapping key→value is in the map.
int	size() Returns the size of this map: the number of mappings.
java.lang.String	toString() Returns a String representation of this map.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

map

private final java.util.Map<K,java.util.Set<V>> map

The backing map.

Constructor Detail

MultiMap

public MultiMap()

Creates a new, empyt MultiMap.

MultiMap

public MultiMap(int initialCapacity)

Method Detail

empty

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

Returns an immutable, empty multimap.

Type Parameters:

K - the type of the keys

V - the type of the values

Returns:

an immutable, empty multimap

put

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

Adds a key-values mapping to this multimap.

Parameters:

key - the key

values - the values

addAll

public void addAll(java.util.Map<? extends K,? extends V> m)

addAll

public void addAll(K key,
                   java.util.Collection<? extends V> values)

addAll

public void addAll(MultiMap<K,V> mmap)

add

public boolean add(K key,
                   V value)

Description copied from interface: IMultiMap

Precondition: the mapping key→value is not already in the map.

Specified by:

add in interface IMultiMap<K,V>

Parameters:

key - cannot be null

value - cannot be null

Returns:

true if the call modifies this object

remove

public boolean remove(K key,
                      V value)

Description copied from interface: IMultiMap

Precondition: the mapping key→value is in the map.

Specified by:

remove in interface IMultiMap<K,V>

Parameters:

key - cannot be null

value - cannot be null

Returns:

true if the call modifies this object

remove

public boolean remove(K key)

getValues

public java.util.Set<V> getValues(K key)

Description copied from interface: IMultiMap

Returns the values that the given key maps to.

Specified by:

getValues in interface IMultiMap<K,V>

Parameters:

key - cannot be null

Returns:

the set of values for the given key

keySet

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

Description copied from interface: IMultiMap

Returns the set of keys in this map (the domain).

Specified by:

keySet in interface IMultiMap<K,V>

Returns:

the set of keys in this map

contains

public boolean contains(K obj)

clear

public void clear()

size

public int size()

Description copied from interface: IMultiMap

Returns the size of this map: the number of mappings.

Specified by:

size in interface IMultiMap<K,V>

Returns:

the number of entries in this map

isEmpty

public boolean isEmpty()

toString

public java.lang.String toString()

Description copied from interface: IMultiMap

Returns a String representation of this map.

Specified by:

toString in interface IMultiMap<K,V>

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this map