com.helger.commons.collection.ext

Class CommonsHashMap<KEYTYPE,VALUETYPE>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<KEYTYPE,VALUETYPE>

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

Type Parameters:

KEYTYPE - Map key type

VALUETYPE - Map value type

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractMultiHashMap, AbstractMultiHashMapMapBased

public class CommonsHashMap<KEYTYPE,VALUETYPE>
extends HashMap<KEYTYPE,VALUETYPE>
implements ICommonsMap<KEYTYPE,VALUETYPE>

A special HashMap implementation based on ICommonsMap.

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
CommonsHashMap()
CommonsHashMap(Collection<? extends COLLTYPE> aValues, Function<? super COLLTYPE,? extends KEYTYPE> aKeyMapper, Function<? super COLLTYPE,? extends VALUETYPE> aValueMapper)
CommonsHashMap(int nInitialCapacity)
CommonsHashMap(int nInitialCapacity, float fLoadFactor)
CommonsHashMap(Map<? extends KEYTYPE,? extends VALUETYPE> aMap)

Method Summary

Modifier and Type	Method and Description
<K,V> CommonsHashMap<K,V>	createInstance() Create a new empty map.
CommonsHashMap<KEYTYPE,VALUETYPE>	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.ext.ICommonsMap

addAll, containsAnyEntry, containsAnyKey, containsAnyValue, copyOfEntrySet, copyOfKeySet, copyOfKeySet, copyOfValues, copyOfValues, copyOfValuesMapped, copyOfValuesMapped, 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

Constructor Detail

CommonsHashMap

public CommonsHashMap()

CommonsHashMap

public CommonsHashMap(@Nonnegative
                      int nInitialCapacity)

CommonsHashMap

public CommonsHashMap(@Nonnegative
                      int nInitialCapacity,
                      @Nonnegative
                      float fLoadFactor)

CommonsHashMap

public CommonsHashMap(@Nullable
                      Map<? extends KEYTYPE,? extends VALUETYPE> aMap)

CommonsHashMap

public CommonsHashMap(@Nullable
                      Collection<? extends COLLTYPE> aValues,
                      @Nonnull
                      Function<? super COLLTYPE,? extends KEYTYPE> aKeyMapper,
                      @Nonnull
                      Function<? super COLLTYPE,? extends VALUETYPE> aValueMapper)

Method Detail

createInstance

@Nonnull
 @ReturnsMutableCopy
public <K,V> CommonsHashMap<K,V> createInstance()

Description copied from interface: ICommonsMap

Create a new empty map. Overwrite this if you don't want to use CommonsHashMap.

Specified by:

createInstance in interface ICommonsMap<KEYTYPE,VALUETYPE>

Type Parameters:

K - Map key type

V - Map value type

Returns:

A new empty map. Never null.

getClone

@Nonnull
 @ReturnsMutableCopy
public CommonsHashMap<KEYTYPE,VALUETYPE> getClone()

Specified by:

getClone in interface ICloneable<ICommonsMap<KEYTYPE,VALUETYPE>>

Returns:

A 100% deep-copy of the implementing class.