Package zombie.core.Collections
Class ZomboidHashMap<K,V>
java.lang.Object
zombie.core.Collections.ZomboidAbstractMap<K,V>
zombie.core.Collections.ZomboidHashMap<K,V>
- All Implemented Interfaces:
Serializable
,Cloneable
,Map<K,
V>
public class ZomboidHashMap<K,V>
extends ZomboidAbstractMap<K,V>
implements Map<K,V>, Cloneable, Serializable
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class zombie.core.Collections.ZomboidAbstractMap
ZomboidAbstractMap.SimpleEntry<K,
V>, ZomboidAbstractMap.SimpleImmutableEntry<K, V> -
Constructor Summary
ConstructorDescriptionConstructs an empty ZomboidHashMap with the default initial capacity (16) and the default load factor (0.75).ZomboidHashMap
(int initialCapacity) Constructs an empty ZomboidHashMap with the specified initial capacity and the default load factor (0.75).ZomboidHashMap
(int initialCapacity, float loadFactor) Constructs an empty ZomboidHashMap with the specified initial capacity and load factor.ZomboidHashMap
(Map<? extends K, ? extends V> m) Constructs a new ZomboidHashMap with the same mappings as the specified Map. -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Removes all of the mappings from this map.clone()
Returns a shallow copy of this ZomboidHashMap instance: the keys and values themselves are not cloned.boolean
containsKey
(Object key) Returns true if this map contains a mapping for the specified key.boolean
containsValue
(Object value) Returns true if this map maps one or more keys to the specified value.entrySet()
Returns aSet
view of the mappings contained in this map.Returns the value to which the specified key is mapped, ornull
if this map contains no mapping for the key.boolean
isEmpty()
Returns true if this map contains no key-value mappings.keySet()
Returns aSet
view of the keys contained in this map.Associates the specified value with the specified key in this map.void
Copies all of the mappings from the specified map to this map.Removes the mapping for the specified key from this map if present.int
size()
Returns the number of key-value mappings in this map.values()
Returns aCollection
view of the values contained in this map.Methods inherited from class zombie.core.Collections.ZomboidAbstractMap
equals, hashCode, toString
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll
-
Constructor Details
-
ZomboidHashMap
public ZomboidHashMap(int initialCapacity, float loadFactor) Constructs an empty ZomboidHashMap with the specified initial capacity and load factor.- Parameters:
initialCapacity
- the initial capacityloadFactor
- the load factor- Throws:
IllegalArgumentException
- if the initial capacity is negative or the load factor is nonpositive
-
ZomboidHashMap
public ZomboidHashMap(int initialCapacity) Constructs an empty ZomboidHashMap with the specified initial capacity and the default load factor (0.75).- Parameters:
initialCapacity
- the initial capacity.- Throws:
IllegalArgumentException
- if the initial capacity is negative.
-
ZomboidHashMap
public ZomboidHashMap()Constructs an empty ZomboidHashMap with the default initial capacity (16) and the default load factor (0.75). -
ZomboidHashMap
Constructs a new ZomboidHashMap with the same mappings as the specified Map. The ZomboidHashMap is created with default load factor (0.75) and an initial capacity sufficient to hold the mappings in the specified Map.- Parameters:
m
- the map whose mappings are to be placed in this map- Throws:
NullPointerException
- if the specified map is null
-
-
Method Details
-
size
public int size()Returns the number of key-value mappings in this map. -
isEmpty
public boolean isEmpty()Returns true if this map contains no key-value mappings. -
get
Returns the value to which the specified key is mapped, ornull
if this map contains no mapping for the key.More formally, if this map contains a mapping from a key
k
to a valuev
such that(key==null ? k==null : key.equals(k))
, then this method returnsv
; otherwise it returnsnull
. (There can be at most one such mapping.)A return value of
null
does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key tonull
. ThecontainsKey
operation may be used to distinguish these two cases. -
containsKey
Returns true if this map contains a mapping for the specified key.- Specified by:
containsKey
in interfaceMap<K,
V> - Overrides:
containsKey
in classZomboidAbstractMap<K,
V> - Parameters:
key
- The key whose presence in this map is to be tested- Returns:
- true if this map contains a mapping for the specified key.
-
put
Associates the specified value with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced.- Specified by:
put
in interfaceMap<K,
V> - Overrides:
put
in classZomboidAbstractMap<K,
V> - Parameters:
key
- key with which the specified value is to be associatedvalue
- value to be associated with the specified key- Returns:
- the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key.)
-
putAll
Copies all of the mappings from the specified map to this map. These mappings will replace any mappings that this map had for any of the keys currently in the specified map.- Specified by:
putAll
in interfaceMap<K,
V> - Overrides:
putAll
in classZomboidAbstractMap<K,
V> - Parameters:
m
- mappings to be stored in this map- Throws:
NullPointerException
- if the specified map is null
-
remove
Removes the mapping for the specified key from this map if present.- Specified by:
remove
in interfaceMap<K,
V> - Overrides:
remove
in classZomboidAbstractMap<K,
V> - Parameters:
key
- key whose mapping is to be removed from the map- Returns:
- the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key.)
-
clear
public void clear()Removes all of the mappings from this map. The map will be empty after this call returns. -
containsValue
Returns true if this map maps one or more keys to the specified value.- Specified by:
containsValue
in interfaceMap<K,
V> - Overrides:
containsValue
in classZomboidAbstractMap<K,
V> - Parameters:
value
- value whose presence in this map is to be tested- Returns:
- true if this map maps one or more keys to the specified value
-
clone
Returns a shallow copy of this ZomboidHashMap instance: the keys and values themselves are not cloned.- Returns:
- a shallow copy of this map
-
keySet
Returns aSet
view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations. -
values
Returns aCollection
view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations. -
entrySet
Returns aSet
view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.
-