org.n52.iceland.util.collections

Interface MultiMap<K,V,C extends java.util.Collection<V>>

Type Parameters:

K - the key type

V - the value type

C - the collection type

All Superinterfaces:

java.util.Map<K,C>, java.io.Serializable

All Known Subinterfaces:

ListMultiMap<K,V>, SetMultiMap<K,V>

All Known Implementing Classes:

AbstractDelegatingMultiMap, AbstractMultiHashMap, AbstractSynchronizedMultiMap, EnumSetMultiMap, HashSetMultiMap, LinkedListMultiMap, SynchronizedListMultiMap, SynchronizedSetMultiMap

Deprecated.

use either guava or a plain java collection

@Deprecated
public interface MultiMap<K,V,C extends java.util.Collection<V>>
extends java.util.Map<K,C>, java.io.Serializable

Map that encapsulates access to multiple values per key.

Since:

1.0.0

Nested Class Summary

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

java.util.Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
C	add(K key, V value) Deprecated. Adds the specified value to the key.
C	addAll(K key, java.util.Collection<? extends V> values) Deprecated. Adds the specified values to the key.
C	allValues() Deprecated.
boolean	containsCollectionValue(V v) Deprecated. Checks if any collection of any key contains v.
boolean	hasValues(K key) Deprecated. Checks if the specified key is contained in this map and if the associated collection is not empty.
boolean	remove(K key, java.lang.Iterable<V> value) Deprecated. Removes the values of the collection for the specified key (if it exists).
boolean	remove(java.lang.Object key, java.lang.Object value) Deprecated. Removes the value of the collection for the specified key (if it exists).
boolean	removeWithKey(K key, java.lang.Iterable<V> value) Deprecated. Removes the specified values of the collection for the specified key (if it exists).
boolean	removeWithKey(K key, V value) Deprecated. Removes the specified value of the collection for the specified key (if it exists).

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, replace, replace, replaceAll, size, values

Method Detail

containsCollectionValue

boolean containsCollectionValue(V v)

Deprecated.

Checks if any collection of any key contains v.

Parameters:

v - the element to check

Returns:

if it is contained

add

C add(K key,
      V value)

Deprecated.

Adds the specified value to the key. If the collection for the key was null it will be created.

Parameters:

key - the key

value - the value

Returns:

the collection the value was added to

addAll

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

Deprecated.

Adds the specified values to the key. If the collection for the key was null it will be created.

Parameters:

key - the key

values - the values

Returns:

the collection the values were added to

remove

boolean remove(java.lang.Object key,
               java.lang.Object value)

Deprecated.

Removes the value of the collection for the specified key (if it exists).

Specified by:

remove in interface java.util.Map<K,C extends java.util.Collection<V>>

Parameters:

key - the key

value - the value to remove

Returns:

if the map was altered

remove

boolean remove(K key,
               java.lang.Iterable<V> value)

Deprecated.

Removes the values of the collection for the specified key (if it exists).

Parameters:

key - the key

value - the values to remove

Returns:

if the map was altered

removeWithKey

boolean removeWithKey(K key,
                      V value)

Deprecated.

Removes the specified value of the collection for the specified key (if it exists). If the collection for the key is empty after the removal the key is removed from the map.

Parameters:

key - the key

value - the value

Returns:

if the map was altered

removeWithKey

boolean removeWithKey(K key,
                      java.lang.Iterable<V> value)

Deprecated.

Removes the specified values of the collection for the specified key (if it exists). If the collection for the key is empty after the removal the key is removed from the map.

Parameters:

key - the key

value - the value

Returns:

if the map was altered

hasValues

boolean hasValues(K key)

Deprecated.

Checks if the specified key is contained in this map and if the associated collection is not empty.

Parameters:

key - the key

Returns:

if the key has at least one value

allValues

C allValues()

Deprecated.

Returns:

the values of all keys