Package randoop.util

Class MultiMap.EmptyMultiMap<K extends @Signed Object,V extends @Signed Object>

java.lang.Object

randoop.util.MultiMap<K,V>

randoop.util.MultiMap.EmptyMultiMap<K,V>

All Implemented Interfaces:

IMultiMap<K,V>

Enclosing class:

MultiMap<K extends @Signed Object,V extends @Signed Object>

private static class MultiMap.EmptyMultiMap<K extends @Signed Object,V extends @Signed Object>
extends MultiMap<K,V>

An immutable, empty multimap.

Field Summary

Fields

Modifier and Type	Field	Description
static MultiMap.EmptyMultiMap	instance	The canonical EmptyMultiMap.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	EmptyMultiMap()	Creates an immutable, empty multimap.

Method Summary

Modifier and Type	Method	Description
boolean	add(K key, V value)	Precondition: the mapping key→value is not already in the map.
void	addAll(Map<? extends K,? extends V> m)
void	addAll(K key, Collection<? extends V> values)
void	addAll(MultiMap<K,V> mmap)
void	clear()
boolean	contains(K obj)
Set<V>	getValues(K key)	Returns the values that the given key maps to.
boolean	isEmpty()
Set<K>	keySet()	Returns the set of keys in this map (the domain).
void	put(K key, 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.
String	toString()	Returns a String representation of this map.

Methods inherited from class randoop.util.MultiMap

empty

Methods inherited from class java.lang.Object

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

Field Detail

instance

public static MultiMap.EmptyMultiMap instance

The canonical EmptyMultiMap.

Constructor Detail

EmptyMultiMap

private EmptyMultiMap()

Creates an immutable, empty multimap. Should only be called once, because all EmptyMultiMaps are the same.

Method Detail

put

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

Description copied from class: MultiMap

Adds a key-values mapping to this multimap.

Overrides:

put in class MultiMap<K extends @Signed Object,V extends @Signed Object>

Parameters:

key - the key

values - the values

addAll

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

Overrides:

addAll in class MultiMap<K extends @Signed Object,V extends @Signed Object>

addAll

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

Overrides:

addAll in class MultiMap<K extends @Signed Object,V extends @Signed Object>

addAll

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

Overrides:

addAll in class MultiMap<K extends @Signed Object,V extends @Signed Object>

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 extends @Signed Object,V extends @Signed Object>

Overrides:

add in class MultiMap<K extends @Signed Object,V extends @Signed Object>

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 extends @Signed Object,V extends @Signed Object>

Overrides:

remove in class MultiMap<K extends @Signed Object,V extends @Signed Object>

Parameters:

key - cannot be null

value - cannot be null

Returns:

true if the call modifies this object

remove

public boolean remove(K key)

Overrides:

remove in class MultiMap<K extends @Signed Object,V extends @Signed Object>

getValues

public 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 extends @Signed Object,V extends @Signed Object>

Overrides:

getValues in class MultiMap<K extends @Signed Object,V extends @Signed Object>

Parameters:

key - cannot be null

Returns:

the set of values for the given key

keySet

public 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 extends @Signed Object,V extends @Signed Object>

Overrides:

keySet in class MultiMap<K extends @Signed Object,V extends @Signed Object>

Returns:

the set of keys in this map

contains

public boolean contains(K obj)

Overrides:

contains in class MultiMap<K extends @Signed Object,V extends @Signed Object>

clear

public void clear()

Overrides:

clear in class MultiMap<K extends @Signed Object,V extends @Signed Object>

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 extends @Signed Object,V extends @Signed Object>

Overrides:

size in class MultiMap<K extends @Signed Object,V extends @Signed Object>

Returns:

the number of entries in this map

isEmpty

public boolean isEmpty()

Overrides:

isEmpty in class MultiMap<K extends @Signed Object,V extends @Signed Object>

toString

public String toString()

Description copied from interface: IMultiMap

Returns a String representation of this map.

Specified by:

toString in interface IMultiMap<K extends @Signed Object,V extends @Signed Object>

Overrides:

toString in class MultiMap<K extends @Signed Object,V extends @Signed Object>

Returns:

a String representation of this map