fr.vergne.collection.impl

Class AbstractMultiMap<Key,Value>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<Key,Collection<Value>>

fr.vergne.collection.impl.AbstractMultiMap<Key,Value>

Type Parameters:

Key -

Value -

All Implemented Interfaces:

MultiMap<Key,Value>, Serializable, Cloneable, Iterable<Map.Entry<Key,Value>>, Map<Key,Collection<Value>>

Direct Known Subclasses:

HashMultiMap, ListMultiMap

public abstract class AbstractMultiMap<Key,Value>
extends HashMap<Key,Collection<Value>>
implements MultiMap<Key,Value>

An AbstractMultiMap is a MultiMap which implements most of the features. It is basically a HashMap, so a given key appears only once. However, the type of collection used for values is not provided, which leads to a method to implement in the classes which extend this AbstractMultiMap.

Author:

Matthieu Vergne

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AbstractMultiMap()
AbstractMultiMap(MultiMap<Key,Value> map)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsCouple(Key key, Value value)
boolean	depopulate(Key key, Collection<Value> values) Remove some values from a key.
boolean	depopulate(Key key, Value... values) Same as MultiMap.depopulate(Object, Collection).
protected abstract Collection<Value>	generateInnerCollection(Key key)
Iterator<Map.Entry<Key,Value>>	iterator()
boolean	populate(Key key, Collection<Value> values) Map a key to all the provided values.
boolean	populate(Key key, Value... values) Same as MultiMap.populate(Object, Collection).

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

AbstractMultiMap

public AbstractMultiMap(MultiMap<Key,Value> map)

AbstractMultiMap

public AbstractMultiMap()

Method Detail

populate

public final boolean populate(Key key,
               Value... values)

Description copied from interface: MultiMap

Same as MultiMap.populate(Object, Collection).

Specified by:

populate in interface MultiMap<Key,Value>

populate

public final boolean populate(Key key,
               Collection<Value> values)

Description copied from interface: MultiMap

Map a key to all the provided values. If there is already values mapped to this key, the new values are added (the old ones are kept, not replaced).

Specified by:

populate in interface MultiMap<Key,Value>

Returns:

true if some values have been added

depopulate

public final boolean depopulate(Key key,
                 Value... values)

Description copied from interface: MultiMap

Same as MultiMap.depopulate(Object, Collection).

Specified by:

depopulate in interface MultiMap<Key,Value>

depopulate

public final boolean depopulate(Key key,
                 Collection<Value> values)

Description copied from interface: MultiMap

Remove some values from a key. Values which are not mapped to this key does not generate any exception.

Specified by:

depopulate in interface MultiMap<Key,Value>

Parameters:

key - the key to remove values from

values - the values to remove

Returns:

true if some values have been removed

generateInnerCollection

protected abstract Collection<Value> generateInnerCollection(Key key)

containsCouple

public boolean containsCouple(Key key,
                     Value value)

Specified by:

containsCouple in interface MultiMap<Key,Value>

Parameters:

key - the key to check

value - the value to check

Returns:

true if the key is known and the value is actually mapped to it

iterator

public Iterator<Map.Entry<Key,Value>> iterator()

Specified by:

iterator in interface Iterable<Map.Entry<Key,Value>>