com.helger.commons.collection.multimap

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

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<KEYTYPE,VALUETYPE>

com.helger.commons.collection.ext.CommonsHashMap<KEYTYPE,COLLTYPE>

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

Type Parameters:

KEYTYPE - key type

VALUETYPE - value type

COLLTYPE - contained collection type

All Implemented Interfaces:

ICommonsMap<KEYTYPE,COLLTYPE>, IMultiMap<KEYTYPE,VALUETYPE,COLLTYPE>, ICloneable<ICommonsMap<KEYTYPE,COLLTYPE>>, Serializable, Cloneable, Map<KEYTYPE,COLLTYPE>

Direct Known Subclasses:

AbstractMultiHashMapListBased, AbstractMultiHashMapSetBased

@NotThreadSafe
public abstract class AbstractMultiHashMap<KEYTYPE,VALUETYPE,COLLTYPE extends Collection<VALUETYPE>>
extends CommonsHashMap<KEYTYPE,COLLTYPE>
implements IMultiMap<KEYTYPE,VALUETYPE,COLLTYPE>

Abstract multi map based on HashMap.

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

Method Summary

Modifier and Type	Method and Description
protected abstract COLLTYPE	createNewCollection()
COLLTYPE	getOrCreate(KEYTYPE aKey) Get or create the collection of the specified key.

Methods inherited from class com.helger.commons.collection.ext.CommonsHashMap

getClone

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.commons.collection.multimap.IMultiMap

containsSingle, forEachSingle, getTotalValueCount, putAllIn, putSingle, removeSingle

Methods inherited from interface com.helger.commons.collection.ext.ICommonsMap

addAll, copyOfEntrySet, copyOfKeySet, copyOfValues, copyOfValues, copyOfValuesMapped, copyOfValuesMapped, findFirstEntry, findFirstKey, findFirstValue, getAsUnmodifiable, getFirstEntry, getFirstKey, getFirstValue, getSortedByKey, getSortedByValue, getSwappedKeyValues, isNotEmpty, putIf, putIfNotNull, removeAll, 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

Constructor Detail

AbstractMultiHashMap

public AbstractMultiHashMap()

AbstractMultiHashMap

public AbstractMultiHashMap(@Nonnull
                            KEYTYPE aKey,
                            @Nullable
                            VALUETYPE aValue)

AbstractMultiHashMap

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

AbstractMultiHashMap

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

Method Detail

createNewCollection

@Nonnull
 @ReturnsMutableCopy
protected abstract COLLTYPE createNewCollection()

getOrCreate

@Nonnull
 @ReturnsMutableObject(value="design")
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.