com.helger.commons.collection.multimap

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

Type Parameters:

KEYTYPE - Key type

VALUETYPE - Element type

COLLTYPE - Container type containing value types

All Superinterfaces:

Map<KEYTYPE,COLLTYPE>

All Known Subinterfaces:

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

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 Collection<VALUETYPE>>
extends Map<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
boolean	containsSingle(KEYTYPE aKey, VALUETYPE aValue) Check a single element from the container identified by the passed key is present.
COLLTYPE	getOrCreate(KEYTYPE aKey) Get or create the collection of the specified key.
long	getTotalValueCount()
EChange	putAllIn(Map<? extends KEYTYPE,? extends VALUETYPE> aMap) Add all values into the container identified by the passed key-value-map.
EChange	putSingle(KEYTYPE aKey, VALUETYPE aValue) Add a single value into the container identified by the passed key.
EChange	removeSingle(KEYTYPE aKey, VALUETYPE aValue) Remove a single element from the container identified by the passed key.

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

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

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
long getTotalValueCount()

Returns:

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