fr.vergne.collection

Interface MultiMap<Key,Value>

Type Parameters:

Key -

Value -

All Superinterfaces:

Iterable<Map.Entry<Key,Value>>, Map<Key,Collection<Value>>

All Known Implementing Classes:

AbstractMultiMap, HashMultiMap, ListMultiMap

public interface MultiMap<Key,Value>
extends Map<Key,Collection<Value>>, Iterable<Map.Entry<Key,Value>>

A MultiMap allows to map a key to several values. This class is similar to the Apache MultiMap, but assumes that it is a proper Map between a key and a set of values rather than a special Map between a key and each of its single values. Thus, where the Apache one appears as a common Map but with the need to make casting and other tricky things to use it fully, this MultiMap implements as much as possible the concept to provide a user-friendly class.

Author:

Matthieu Vergne

Nested Class Summary

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

Map.Entry<K,V>

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 depopulate(Object, Collection).
boolean	populate(Key key, Collection<Value> values) Map a key to all the provided values.
boolean	populate(Key key, Value... values) Same as populate(Object, Collection).

Methods inherited from interface java.util.Map

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

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

populate

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

Same as populate(Object, Collection).

populate

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

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).

Returns:

true if some values have been added

depopulate

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

Same as depopulate(Object, Collection).

depopulate

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

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

Parameters:

key - the key to remove values from

values - the values to remove

Returns:

true if some values have been removed

containsCouple

boolean containsCouple(Key key,
                     Value 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