uk.co.strangeskies.collection.multimap

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

Type Parameters:

K - key type

V - element value type

C - element collection type

All Superinterfaces:

java.util.Map<K,C>

All Known Implementing Classes:

MultiHashMap, MultiTreeMap

public interface MultiMap<K,V,C extends java.util.Collection<V>>
extends java.util.Map<K,C>

TODO system for returning proxy collections that automatically add/remove the entry from the map when they become non-empty/empty.

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
default boolean	add(K key, V value)
default boolean	addAll(K key, java.util.Collection<? extends V> values)
default boolean	addAll(K key, V... values)
default boolean	addAll(java.util.Map<? extends K,? extends V> values)
default boolean	addAll(MultiMap<? extends K,? extends V,?> values)
default boolean	addAllToAll(java.util.Collection<? extends K> keys, java.util.Collection<? extends V> values)
default boolean	addAllToAll(java.util.Collection<? extends V> values)
default boolean	addAllToAll(V... values)
default boolean	addToAll(java.util.Collection<? extends K> keys, V value)
default boolean	addToAll(V value)
default boolean	contains(K key, V value)
C	createCollection()
default C	getAll()
default C	getAll(java.util.Collection<? extends K> keys)
default C	getAll(K... keys)
default C	getCollection(K key)
default boolean	removeAll(K key, java.util.Collection<? extends V> values)
default boolean	removeAll(K key, V... values)
default boolean	removeAll(java.util.Map<K,V> values)
default boolean	removeAll(MultiMap<K,V,?> values)
default boolean	removeAllFromAll(java.util.Collection<? extends K> keys, java.util.Collection<? extends V> values)
default boolean	removeAllFromAll(java.util.Collection<? extends V> values)
default boolean	removeAllFromAll(V... values)
default boolean	removeFromAll(java.util.Collection<? extends K> keys, V value)
default boolean	removeFromAll(V value)
default boolean	removeValue(K key, V value)

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, remove, replace, replace, replaceAll, size, values

Method Detail

createCollection

C createCollection()

getCollection

default C getCollection(K key)

add

default boolean add(K key,
                    V value)

addAll

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

addAll

default boolean addAll(java.util.Map<? extends K,? extends V> values)

addAll

default boolean addAll(MultiMap<? extends K,? extends V,?> values)

addAll

default boolean addAll(K key,
                       V... values)

addToAll

default boolean addToAll(V value)

addAllToAll

default boolean addAllToAll(java.util.Collection<? extends V> values)

addAllToAll

default boolean addAllToAll(V... values)

addToAll

default boolean addToAll(java.util.Collection<? extends K> keys,
                         V value)

addAllToAll

default boolean addAllToAll(java.util.Collection<? extends K> keys,
                            java.util.Collection<? extends V> values)

removeValue

default boolean removeValue(K key,
                            V value)

removeAll

default boolean removeAll(K key,
                          java.util.Collection<? extends V> values)

removeAll

default boolean removeAll(K key,
                          V... values)

removeAll

default boolean removeAll(java.util.Map<K,V> values)

removeAll

default boolean removeAll(MultiMap<K,V,?> values)

removeFromAll

default boolean removeFromAll(V value)

removeAllFromAll

default boolean removeAllFromAll(java.util.Collection<? extends V> values)

removeAllFromAll

default boolean removeAllFromAll(V... values)

removeFromAll

default boolean removeFromAll(java.util.Collection<? extends K> keys,
                              V value)

removeAllFromAll

default boolean removeAllFromAll(java.util.Collection<? extends K> keys,
                                 java.util.Collection<? extends V> values)

contains

default boolean contains(K key,
                         V value)

getAll

default C getAll()

getAll

default C getAll(java.util.Collection<? extends K> keys)

getAll

default C getAll(K... keys)