com.helger.commons.collection.multimap

Class AbstractMultiTreeMap<KEYTYPE,VALUETYPE,COLLTYPE extends Collection<VALUETYPE>>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.TreeMap<KEYTYPE,COLLTYPE>

com.helger.commons.collection.multimap.AbstractMultiTreeMap<KEYTYPE,VALUETYPE,COLLTYPE>

Type Parameters:

KEYTYPE - key type

VALUETYPE - value type

COLLTYPE - contained collection type

All Implemented Interfaces:

IMultiMap<KEYTYPE,VALUETYPE,COLLTYPE>, Serializable, Cloneable, Map<KEYTYPE,COLLTYPE>, NavigableMap<KEYTYPE,COLLTYPE>, SortedMap<KEYTYPE,COLLTYPE>

Direct Known Subclasses:

AbstractMultiTreeMapListBased, AbstractMultiTreeMapSetBased

@NotThreadSafe
public abstract class AbstractMultiTreeMap<KEYTYPE,VALUETYPE,COLLTYPE extends Collection<VALUETYPE>>
extends TreeMap<KEYTYPE,COLLTYPE>
implements IMultiMap<KEYTYPE,VALUETYPE,COLLTYPE>

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
AbstractMultiTreeMap()
AbstractMultiTreeMap(Comparator<? super KEYTYPE> aComparator)
AbstractMultiTreeMap(KEYTYPE aKey, COLLTYPE aCollection)
AbstractMultiTreeMap(KEYTYPE aKey, VALUETYPE aValue)
AbstractMultiTreeMap(Map<? extends KEYTYPE,? extends COLLTYPE> aCont)

Method Summary

Methods

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.
protected abstract COLLTYPE	createNewCollection()
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 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

AbstractMultiTreeMap

public AbstractMultiTreeMap()

AbstractMultiTreeMap

public AbstractMultiTreeMap(@Nullable
                    Comparator<? super KEYTYPE> aComparator)

AbstractMultiTreeMap

public AbstractMultiTreeMap(@Nullable
                    KEYTYPE aKey,
                    @Nullable
                    VALUETYPE aValue)

AbstractMultiTreeMap

public AbstractMultiTreeMap(@Nullable
                    KEYTYPE aKey,
                    @Nullable
                    COLLTYPE aCollection)

AbstractMultiTreeMap

public AbstractMultiTreeMap(@Nullable
                    Map<? extends KEYTYPE,? extends COLLTYPE> aCont)

Method Detail

createNewCollection

@Nonnull
@ReturnsMutableCopy
protected abstract COLLTYPE createNewCollection()

getOrCreate

@Nonnull
public COLLTYPE getOrCreate(@Nullable
                           KEYTYPE aKey)

Description copied from interface: IMultiMap

Get or create the collection of the specified key.

Specified by:

getOrCreate in interface IMultiMap<KEYTYPE,VALUETYPE,COLLTYPE extends Collection<VALUETYPE>>

Parameters:

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

Returns:

The mutable collection to be used. Never null.

putSingle

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

Description copied from interface: IMultiMap

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

Specified by:

putSingle in interface IMultiMap<KEYTYPE,VALUETYPE,COLLTYPE extends Collection<VALUETYPE>>

Parameters:

aKey - The key 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 KEYTYPE,? extends VALUETYPE> aMap)

Description copied from interface: IMultiMap

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

Specified by:

putAllIn in interface IMultiMap<KEYTYPE,VALUETYPE,COLLTYPE extends Collection<VALUETYPE>>

Parameters:

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

Returns:

EChange

removeSingle

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

Description copied from interface: IMultiMap

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

Specified by:

removeSingle in interface IMultiMap<KEYTYPE,VALUETYPE,COLLTYPE extends Collection<VALUETYPE>>

Parameters:

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

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

Returns:

EChange

containsSingle

public final boolean containsSingle(@Nullable
                     KEYTYPE aKey,
                     @Nullable
                     VALUETYPE aValue)

Description copied from interface: IMultiMap

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

Specified by:

containsSingle in interface IMultiMap<KEYTYPE,VALUETYPE,COLLTYPE extends Collection<VALUETYPE>>

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

Specified by:

getTotalValueCount in interface IMultiMap<KEYTYPE,VALUETYPE,COLLTYPE extends Collection<VALUETYPE>>

Returns:

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