com.helger.commons.collection.multimap

Class AbstractMultiTreeMapMapBased<KEYTYPE1,KEYTYPE2,VALUETYPE>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.TreeMap<KEYTYPE1,Map<KEYTYPE2,VALUETYPE>>

com.helger.commons.collection.multimap.AbstractMultiTreeMapMapBased<KEYTYPE1,KEYTYPE2,VALUETYPE>

Type Parameters:

KEYTYPE1 - outer key type

KEYTYPE2 - inner key type

VALUETYPE - value type

All Implemented Interfaces:

IMultiMapMapBased<KEYTYPE1,KEYTYPE2,VALUETYPE>, Serializable, Cloneable, Map<KEYTYPE1,Map<KEYTYPE2,VALUETYPE>>, NavigableMap<KEYTYPE1,Map<KEYTYPE2,VALUETYPE>>, SortedMap<KEYTYPE1,Map<KEYTYPE2,VALUETYPE>>

Direct Known Subclasses:

MultiTreeMapHashMapBased, MultiTreeMapLinkedHashMapBased, MultiTreeMapTreeMapBased, MultiTreeMapWeakHashMapBased

@NotThreadSafe
public abstract class AbstractMultiTreeMapMapBased<KEYTYPE1,KEYTYPE2,VALUETYPE>
extends TreeMap<KEYTYPE1,Map<KEYTYPE2,VALUETYPE>>
implements IMultiMapMapBased<KEYTYPE1,KEYTYPE2,VALUETYPE>

Abstract multi map based on TreeMap.

Author:

Philip Helger

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AbstractMultiTreeMapMapBased()
AbstractMultiTreeMapMapBased(Comparator<? super KEYTYPE1> aComparator)
AbstractMultiTreeMapMapBased(KEYTYPE1 aKey, KEYTYPE2 aInnerKey, VALUETYPE aValue)
AbstractMultiTreeMapMapBased(KEYTYPE1 aKey, Map<KEYTYPE2,VALUETYPE> aValue)
AbstractMultiTreeMapMapBased(Map<? extends KEYTYPE1,? extends Map<KEYTYPE2,VALUETYPE>> aCont)

Method Summary

Methods

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.
protected abstract Map<KEYTYPE2,VALUETYPE>	createNewInnerMap()
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 class java.util.TreeMap

ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, put, putAll, remove, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

AbstractMultiTreeMapMapBased

public AbstractMultiTreeMapMapBased()

AbstractMultiTreeMapMapBased

public AbstractMultiTreeMapMapBased(@Nullable
                            Comparator<? super KEYTYPE1> aComparator)

AbstractMultiTreeMapMapBased

public AbstractMultiTreeMapMapBased(@Nullable
                            KEYTYPE1 aKey,
                            @Nullable
                            KEYTYPE2 aInnerKey,
                            @Nullable
                            VALUETYPE aValue)

AbstractMultiTreeMapMapBased

public AbstractMultiTreeMapMapBased(@Nullable
                            KEYTYPE1 aKey,
                            @Nullable
                            Map<KEYTYPE2,VALUETYPE> aValue)

AbstractMultiTreeMapMapBased

public AbstractMultiTreeMapMapBased(@Nullable
                            Map<? extends KEYTYPE1,? extends Map<KEYTYPE2,VALUETYPE>> aCont)

Method Detail

createNewInnerMap

@Nonnull
protected abstract Map<KEYTYPE2,VALUETYPE> createNewInnerMap()

getOrCreate

@Nonnull
public Map<KEYTYPE2,VALUETYPE> getOrCreate(@Nullable
                                          KEYTYPE1 aKey)

Description copied from interface: IMultiMapMapBased

Get or create the collection of the specified key.

Specified by:

getOrCreate in interface IMultiMapMapBased<KEYTYPE1,KEYTYPE2,VALUETYPE>

Parameters:

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

Returns:

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

putSingle

@Nonnull
public final EChange putSingle(@Nullable
                        KEYTYPE1 aKey,
                        @Nullable
                        KEYTYPE2 aInnerKey,
                        @Nullable
                        VALUETYPE aValue)

Description copied from interface: IMultiMapMapBased

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

Specified by:

putSingle in interface IMultiMapMapBased<KEYTYPE1,KEYTYPE2,VALUETYPE>

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
public final EChange putAllIn(@Nonnull
                       Map<? extends KEYTYPE1,? extends Map<KEYTYPE2,VALUETYPE>> aMap)

Description copied from interface: IMultiMapMapBased

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

Specified by:

putAllIn in interface IMultiMapMapBased<KEYTYPE1,KEYTYPE2,VALUETYPE>

Parameters:

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

Returns:

EChange

removeSingle

@Nonnull
public final EChange removeSingle(@Nullable
                           KEYTYPE1 aKey,
                           @Nullable
                           KEYTYPE2 aInnerKey)

Description copied from interface: IMultiMapMapBased

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

Specified by:

removeSingle in interface IMultiMapMapBased<KEYTYPE1,KEYTYPE2,VALUETYPE>

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
public final VALUETYPE getSingle(@Nonnull
                           KEYTYPE1 aKey,
                           @Nonnull
                           KEYTYPE2 aInnerKey)

Description copied from interface: IMultiMapMapBased

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

Specified by:

getSingle in interface IMultiMapMapBased<KEYTYPE1,KEYTYPE2,VALUETYPE>

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

public final boolean containsSingle(@Nullable
                     KEYTYPE1 aKey,
                     @Nullable
                     KEYTYPE2 aInnerKey)

Description copied from interface: IMultiMapMapBased

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

Specified by:

containsSingle in interface IMultiMapMapBased<KEYTYPE1,KEYTYPE2,VALUETYPE>

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

Specified by:

getTotalValueCount in interface IMultiMapMapBased<KEYTYPE1,KEYTYPE2,VALUETYPE>

Returns:

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