com.helger.commons.collection.multimap

Interface IMultiMap<KEYTYPE,VALUETYPE,COLLTYPE extends ICommonsCollection<VALUETYPE>>

Type Parameters:

KEYTYPE - Key type

VALUETYPE - Element type

COLLTYPE - Container type containing value types

All Superinterfaces:

ICloneable<ICommonsMap<KEYTYPE,COLLTYPE>>, ICommonsMap<KEYTYPE,COLLTYPE>, Map<KEYTYPE,COLLTYPE>, Serializable

All Known Subinterfaces:

IMultiMapListBased<KEYTYPE,VALUETYPE>, IMultiMapSetBased<KEYTYPE,VALUETYPE,COLLTYPE>

All Known Implementing Classes:

AbstractMultiConcurrentHashMap, AbstractMultiConcurrentHashMapListBased, AbstractMultiConcurrentHashMapSetBased, AbstractMultiHashMap, AbstractMultiHashMapListBased, AbstractMultiHashMapSetBased, AbstractMultiLinkedHashMap, AbstractMultiLinkedHashMapListBased, AbstractMultiLinkedHashMapSetBased, AbstractMultiTreeMap, AbstractMultiTreeMapListBased, AbstractMultiTreeMapSetBased, AbstractMultiWeakHashMap, AbstractMultiWeakHashMapListBased, AbstractMultiWeakHashMapSetBased, MultiConcurrentHashMapArrayListBased, MultiConcurrentHashMapHashSetBased, MultiConcurrentHashMapLinkedHashSetBased, MultiConcurrentHashMapTreeSetBased, MultiConcurrentHashMapVectorBased, MultiHashMapArrayListBased, MultiHashMapHashSetBased, MultiHashMapLinkedHashSetBased, MultiHashMapTreeSetBased, MultiHashMapVectorBased, MultiLinkedHashMapArrayListBased, MultiLinkedHashMapHashSetBased, MultiLinkedHashMapLinkedHashSetBased, MultiLinkedHashMapTreeSetBased, MultiLinkedHashMapVectorBased, MultiTreeMapArrayListBased, MultiTreeMapHashSetBased, MultiTreeMapLinkedHashSetBased, MultiTreeMapTreeSetBased, MultiTreeMapVectorBased, MultiWeakHashMapArrayListBased, MultiWeakHashMapHashSetBased, MultiWeakHashMapLinkedHashSetBased, MultiWeakHashMapTreeSetBased, MultiWeakHashMapVectorBased

public interface IMultiMap<KEYTYPE,VALUETYPE,COLLTYPE extends ICommonsCollection<VALUETYPE>>
extends ICommonsMap<KEYTYPE,COLLTYPE>

Base interface for a multi map (one key with several values).

Author:

Philip Helger

Nested Class Summary

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

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
default boolean	containsSingle(KEYTYPE aKey, VALUETYPE aValue) Check a single element from the container identified by the passed key is present.
default void	forEachSingle(BiConsumer<? super KEYTYPE,? super VALUETYPE> aConsumer)
default void	forEachSingleValue(Consumer<? super VALUETYPE> aConsumer)
COLLTYPE	getOrCreate(KEYTYPE aKey) Get or create the collection of the specified key.
default long	getTotalValueCount()
default EChange	putAllIn(Map<? extends KEYTYPE,? extends VALUETYPE> aMap) Add all values into the container identified by the passed key-value-map.
default EChange	putSingle(KEYTYPE aKey, VALUETYPE aValue) Add a single value into the container identified by the passed key.
default EChange	removeSingle(KEYTYPE aKey, VALUETYPE aValue) Remove a single element from the container identified by the passed key.

Methods inherited from interface com.helger.commons.collection.ext.ICommonsMap

addAll, containsAnyEntry, containsAnyKey, containsAnyValue, copyOfEntrySet, copyOfKeySet, copyOfKeySet, copyOfValues, copyOfValues, copyOfValuesMapped, copyOfValuesMapped, createInstance, findFirstEntry, findFirstKey, findFirstValue, forEach, forEachKey, forEachKey, forEachValue, forEachValue, getAsUnmodifiable, getFirstEntry, getFirstEntry, getFirstKey, getFirstKey, getFirstValue, getFirstValue, getSortedByKey, getSortedByValue, getSwappedKeyValues, isNotEmpty, putAll, putAll, putAllMapped, putAllMapped, putAllMapped, putIf, putIfNotNull, removeAll, removeObject, setAll

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

Methods inherited from interface com.helger.commons.lang.ICloneable

getClone

Method Detail

getOrCreate

@Nonnull
 @ReturnsMutableObject(value="design")
COLLTYPE getOrCreate(@Nonnull
                                                                       KEYTYPE aKey)

Get or create the collection of the specified key.

Parameters:

aKey - The key to use. May not be null.

Returns:

The mutable collection to be used. Never null.

putSingle

@Nonnull
default EChange putSingle(@Nonnull
                                    KEYTYPE aKey,
                                    @Nullable
                                    VALUETYPE aValue)

Add a single value into the container identified by the passed key.

Parameters:

aKey - The key to use. May not be null.

aValue - The value to be added. May be null.

Returns:

EChange

putAllIn

@Nonnull
default EChange putAllIn(@Nonnull
                                   Map<? extends KEYTYPE,? extends VALUETYPE> aMap)

Add all values into the container identified by the passed key-value-map.

Parameters:

aMap - The key-value-map to use. May not be null.

Returns:

EChange

removeSingle

@Nonnull
default EChange removeSingle(@Nonnull
                                       KEYTYPE aKey,
                                       @Nullable
                                       VALUETYPE aValue)

Remove a single element from the container identified by the passed key.

Parameters:

aKey - The key to use. May not be null.

aValue - The value to be removed. May be null.

Returns:

EChange

containsSingle

default boolean containsSingle(@Nonnull
                               KEYTYPE aKey,
                               @Nullable
                               VALUETYPE aValue)

Check a single element from the container identified by the passed key is present.

Parameters:

aKey - The key to use. May not be null.

aValue - The value to be checked. May be null.

Returns:

true if the value is contained, false otherwise

getTotalValueCount

@Nonnegative
default long getTotalValueCount()

Returns:

The total number of contained values recursively over all contained maps. Always ≥ 0.

forEachSingle

default void forEachSingle(@Nonnull
                           BiConsumer<? super KEYTYPE,? super VALUETYPE> aConsumer)

forEachSingleValue

default void forEachSingleValue(@Nonnull
                                Consumer<? super VALUETYPE> aConsumer)