com.republicate.modality.util

Class HashMultiMap

java.lang.Object

com.republicate.modality.util.HashMultiMap

All Implemented Interfaces:

MultiMap, Serializable

public class HashMultiMap
extends Object
implements MultiMap, Serializable

A MultiMap is a Map allowing multiple occurrences of keys.

Author:

Mark Richters

See Also:

Map, Serialized Form

Constructor Summary

Constructors

Constructor and Description
HashMultiMap() build a new HashMultiMap.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all mappings from this map (optional operation).
boolean	containsKey(Object key) Returns true if this multimap contains a mapping for the specified key.
boolean	containsValue(Object value) Returns true if this multimap maps one or more keys to the specified value.
boolean	equals(Object o) Compares the specified object with this multimap for equality.
List	get(Object key) Returns a list of values to which this multimap maps the specified key.
int	hashCode() Returns the hash code value for this multimap.
boolean	isEmpty() Returns true if this multimap contains no mappings.
Set	keySet() Returns a set view of the keys contained in this multimap.
void	put(Object key, Object value) Adds the specified value with the specified key to this multimap.
void	putAll(MultiMap t) Copies all entries from the specified multimap to this multimap.
void	remove(Object key) Removes all mappings for this key from this multimap if present.
void	remove(Object key, Object value) Removes the specified key/value mapping from this multimap if present.
int	size() Returns the number of values in this multimap.

Methods inherited from class java.lang.Object

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

Constructor Detail

HashMultiMap

public HashMultiMap()

build a new HashMultiMap.

Method Detail

size

public int size()

Returns the number of values in this multimap.

Specified by:

size in interface MultiMap

Returns:

totla number of values

isEmpty

public boolean isEmpty()

Returns true if this multimap contains no mappings.

Specified by:

isEmpty in interface MultiMap

Returns:

empty status

containsKey

public boolean containsKey(Object key)

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

Specified by:

containsKey in interface MultiMap

Parameters:

key -

Returns:

a boolean

containsValue

public boolean containsValue(Object value)

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

Specified by:

containsValue in interface MultiMap

Returns:

a boolean

get

public List get(Object key)

Returns a list of values to which this multimap maps the specified key.

Specified by:

get in interface MultiMap

Returns:

the list of values to which this map maps the specified key, the list may be empty if the multimap contains no mapping for this key.

put

public void put(Object key,
                Object value)

Adds the specified value with the specified key to this multimap.

Specified by:

put in interface MultiMap

Parameters:

key -

value -

putAll

public void putAll(MultiMap t)

Copies all entries from the specified multimap to this multimap.

Specified by:

putAll in interface MultiMap

Parameters:

t - source multimap

remove

public void remove(Object key)

Removes all mappings for this key from this multimap if present.

Specified by:

remove in interface MultiMap

Parameters:

key -

remove

public void remove(Object key,
                   Object value)

Removes the specified key/value mapping from this multimap if present.

Specified by:

remove in interface MultiMap

Parameters:

key -

value -

clear

public void clear()

Removes all mappings from this map (optional operation).

Specified by:

clear in interface MultiMap

keySet

public Set keySet()

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

Specified by:

keySet in interface MultiMap

Returns:

key set

equals

public boolean equals(Object o)

Compares the specified object with this multimap for equality.

Specified by:

equals in interface MultiMap

Overrides:

equals in class Object

Parameters:

o -

Returns:

a boolean

hashCode

public int hashCode()

Returns the hash code value for this multimap.

Specified by:

hashCode in interface MultiMap

Overrides:

hashCode in class Object