com.helger.commons.collection.multimap

Interface IMultiMapMapBased<KEYTYPE1,KEYTYPE2,VALUETYPE,MAPTYPE extends ICommonsMap<KEYTYPE2,VALUETYPE>>

Type Parameters:

KEYTYPE1 - Key type of outer map

KEYTYPE2 - Key type of inner map

VALUETYPE - Element type

MAPTYPE - Inner map type

All Superinterfaces:

ICloneable<ICommonsMap<KEYTYPE1,MAPTYPE>>, ICommonsMap<KEYTYPE1,MAPTYPE>, Map<KEYTYPE1,MAPTYPE>, Serializable

All Known Implementing Classes:

AbstractMultiHashMapMapBased, AbstractMultiLinkedHashMapMapBased, AbstractMultiTreeMapMapBased, MultiHashMapHashMapBased, MultiHashMapLinkedHashMapBased, MultiHashMapTreeMapBased, MultiHashMapWeakHashMapBased, MultiLinkedHashMapHashMapBased, MultiLinkedHashMapLinkedHashMapBased, MultiLinkedHashMapTreeMapBased, MultiLinkedHashMapWeakHashMapBased, MultiTreeMapHashMapBased, MultiTreeMapLinkedHashMapBased, MultiTreeMapTreeMapBased, MultiTreeMapWeakHashMapBased

public interface IMultiMapMapBased<KEYTYPE1,KEYTYPE2,VALUETYPE,MAPTYPE extends ICommonsMap<KEYTYPE2,VALUETYPE>>
extends ICommonsMap<KEYTYPE1,MAPTYPE>

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(KEYTYPE1 aKey, KEYTYPE2 aInnerKey) Check a single element from the container identified by the passed keys is present.
default void	forEachSingle(ITriConsumer<KEYTYPE1,KEYTYPE2,VALUETYPE> aConsumer)
MAPTYPE	getOrCreate(KEYTYPE1 aKey) Get or create the collection of the specified key.
default VALUETYPE	getSingle(KEYTYPE1 aKey, KEYTYPE2 aInnerKey) Get a single value from the container identified by the passed keys.
default long	getTotalValueCount()
default EChange	putAllIn(Map<? extends KEYTYPE1,? extends Map<KEYTYPE2,VALUETYPE>> aMap) Add all values into the container identified by the passed key-value-map.
default EChange	putSingle(KEYTYPE1 aKey, KEYTYPE2 aInnerKey, VALUETYPE aValue) Add a single value into the container identified by the passed key.
default EChange	removeSingle(KEYTYPE1 aKey, KEYTYPE2 aInnerKey) 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")
MAPTYPE getOrCreate(@Nonnull
                                                                      KEYTYPE1 aKey)

Get or create the collection of the specified key.

Parameters:

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

Returns:

The mutable map that can be modified later on. Never null.

putSingle

@Nonnull
default EChange putSingle(@Nonnull
                                    KEYTYPE1 aKey,
                                    @Nonnull
                                    KEYTYPE2 aInnerKey,
                                    @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.

aInnerKey - The key for the inner map 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 KEYTYPE1,? extends Map<KEYTYPE2,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
                                       KEYTYPE1 aKey,
                                       @Nonnull
                                       KEYTYPE2 aInnerKey)

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

Parameters:

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

aInnerKey - The key for the inner map to be removed. May be null.

Returns:

EChange

getSingle

@Nullable
default VALUETYPE getSingle(@Nonnull
                                       KEYTYPE1 aKey,
                                       @Nonnull
                                       KEYTYPE2 aInnerKey)

Get a single value from the container identified by the passed keys.

Parameters:

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

aInnerKey - The key for the inner map to use. May not be null.

Returns:

null if no such value exists.

containsSingle

default boolean containsSingle(@Nonnull
                               KEYTYPE1 aKey,
                               @Nonnull
                               KEYTYPE2 aInnerKey)

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

Parameters:

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

aInnerKey - The key of the inner map to be checked. May be null.

Returns:

true if 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
                           ITriConsumer<KEYTYPE1,KEYTYPE2,VALUETYPE> aConsumer)