com.helger.commons.collection.multimap

Interface IMultiMapMapBased<KEYTYPE1,KEYTYPE2,VALUETYPE>

Type Parameters:

KEYTYPE1 - Key type of outer map

KEYTYPE2 - Key type of inner map

VALUETYPE - Element type

All Superinterfaces:

Map<KEYTYPE1,Map<KEYTYPE2,VALUETYPE>>

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>
extends Map<KEYTYPE1,Map<KEYTYPE2,VALUETYPE>>

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

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

Returns:

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