Class IntIntHashMap
java.lang.Object
org.eclipse.collections.impl.primitive.AbstractIntIterable
org.eclipse.collections.impl.map.mutable.primitive.AbstractMutableIntValuesMap
org.eclipse.collections.impl.map.mutable.primitive.IntIntHashMap
- All Implemented Interfaces:
Externalizable
,Serializable
,IntIterable
,IntIntMap
,IntValuesMap
,MutableIntIntMap
,MutableIntValuesMap
,PrimitiveIterable
,MutableIntKeysMap
,IntKeysMap
public class IntIntHashMap
extends AbstractMutableIntValuesMap
implements MutableIntIntMap, Externalizable, MutableIntKeysMap
This file was automatically generated from template file primitivePrimitiveHashMap.stg.
- Since:
- 3.0.
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
addToValue
(int key, int toBeAdded) Increments and updates the value associated with the key, if a value exists, or sets the value to be the specified value if one does not.Returns a synchronized view of this map, delegating all operations to this map but ensuring only one caller has access to the map at a time.Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing anUnsupportedOperationException
for all mutating operations.void
clear()
Removes all entries from this map.void
compact()
Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels.boolean
containsKey
(int key) Returns whether or not the key is present in the map.boolean
Follows the same general contract asMap.equals(Object)
.Return the IntIntMap that is obtained by flipping the direction of this map and making the associations from value to key.void
forEachKey
(IntProcedure procedure) Iterates through each key in the map, invoking the procedure for each.void
forEachKeyValue
(IntIntProcedure procedure) Iterates through each key/value pair in the map, invoking the procedure for each.int
get
(int key) Retrieves the value associated with the key.int
getAndPut
(int key, int putValue, int defaultValue) Retrieves the value associated with the key if one exists; associates a putValue with the key.int
getIfAbsent
(int key, int ifAbsent) Retrieves the value associated with the key, returning the specified default value if no such mapping exists.int
getIfAbsentPut
(int key, int value) Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.int
getIfAbsentPut
(int key, IntFunction0 function) Retrieves the value associated with the key if one exists; if it does not, invokes the supplier and associates the result with the key.<P> int
getIfAbsentPutWith
(int key, IntFunction<? super P> function, P parameter) Retrieves the value associated with the key if one exists; if it does not, invokes the value function with the parameter and associates the result with the key.int
getIfAbsentPutWithKey
(int key, IntToIntFunction function) Retrieves the value associated with the key if one exists; if it does not, associates the result of invoking the value function with the key.int
getOrThrow
(int key) Retrieves the value associated with the key, throwing anIllegalStateException
if no such mapping exists.int
hashCode()
Follows the same general contract asMap.hashCode()
.<V> V
injectInto
(V injectedValue, ObjectIntToObjectFunction<? super V, ? extends V> function) Returns a primitive iterator that can be used to iterate over the IntIterable in an imperative style.keySet()
Returns a set containing all the keys in this map.keysView()
Returns a view of the keys in this map.Returns a view of the key/value pairs in this map.static IntIntHashMap
newWithKeysValues
(int key1, int value1) static IntIntHashMap
newWithKeysValues
(int key1, int value1, int key2, int value2) static IntIntHashMap
newWithKeysValues
(int key1, int value1, int key2, int value2, int key3, int value3) static IntIntHashMap
newWithKeysValues
(int key1, int value1, int key2, int value2, int key3, int value3, int key4, int value4) void
put
(int key, int value) Associates a value with the specified key.void
Puts all of the key/value mappings from the specified map into this map.void
reject
(IntIntPredicate predicate) Return a copy of this map containing only the key/value pairs that do not match the predicate.void
remove
(int key) Removes the mapping associated with the key, if one exists, from the map.void
removeKey
(int key) Removes the mapping associated with the key, if one exists, from the map.int
removeKeyIfAbsent
(int key, int value) Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.select
(IntIntPredicate predicate) Return a copy of this map containing only the key/value pairs that match the predicate.Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.toString()
Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.int
updateValue
(int key, int initialValueIfAbsent, IntToIntFunction function) Updates or sets the value associated with the key by applying the function to the existing value, if one exists, or to the specified initial value if one does not.void
updateValues
(IntIntToIntFunction function) Updates the values in-place.values()
Returns the values in this map as a separate collection.withKeysValues
(int key1, int value1, int key2, int value2) withKeysValues
(int key1, int value1, int key2, int value2, int key3, int value3) withKeysValues
(int key1, int value1, int key2, int value2, int key3, int value3, int key4, int value4) withKeyValue
(int key1, int value1) Associates a value with the specified key.withoutAllKeys
(IntIterable keys) Removes the mappings associated with all the keys, if they exist, from this map.withoutKey
(int key) Removes the mapping associated with the key, if one exists, from this map.void
Methods inherited from class org.eclipse.collections.impl.map.mutable.primitive.AbstractMutableIntValuesMap
allSatisfy, anySatisfy, appendString, chunk, collect, contains, containsAll, containsValue, count, detectIfNone, each, forEachValue, isEmpty, max, min, notEmpty, reject, select, size, sum, toArray, toArray
Methods inherited from class org.eclipse.collections.impl.primitive.AbstractIntIterable
asLazy, average, maxIfEmpty, median, minIfEmpty, toBag, toList, toSet, toSortedArray, toSortedList
Methods inherited from interface org.eclipse.collections.api.map.primitive.IntIntMap
injectIntoKeyValue
Methods inherited from interface org.eclipse.collections.api.IntIterable
allSatisfy, anySatisfy, asLazy, average, averageIfEmpty, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, contains, containsAll, containsAll, containsAny, containsAny, containsNone, containsNone, count, detectIfNone, each, flatCollect, forEach, injectIntoBoolean, injectIntoByte, injectIntoChar, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, injectIntoShort, max, maxIfEmpty, median, medianIfEmpty, min, minIfEmpty, noneSatisfy, reduce, reduceIfEmpty, reject, select, sum, summaryStatistics, toArray, toArray, toBag, toList, toSet, toSortedArray, toSortedList, toSortedList, toSortedListBy, toSortedListBy
Methods inherited from interface org.eclipse.collections.impl.map.primitive.IntKeysMap
isEmpty, notEmpty, size
Methods inherited from interface org.eclipse.collections.api.map.primitive.IntValuesMap
containsValue, forEachValue, tap
Methods inherited from interface org.eclipse.collections.api.map.primitive.MutableIntIntMap
putPair, withAllKeyValues
Methods inherited from interface org.eclipse.collections.api.map.primitive.MutableIntValuesMap
collect, reject, select
Methods inherited from interface org.eclipse.collections.api.PrimitiveIterable
appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size
-
Constructor Details
-
IntIntHashMap
public IntIntHashMap() -
IntIntHashMap
public IntIntHashMap(int initialCapacity) -
IntIntHashMap
-
-
Method Details
-
newWithKeysValues
-
newWithKeysValues
-
newWithKeysValues
public static IntIntHashMap newWithKeysValues(int key1, int value1, int key2, int value2, int key3, int value3) -
newWithKeysValues
public static IntIntHashMap newWithKeysValues(int key1, int value1, int key2, int value2, int key3, int value3, int key4, int value4) -
equals
Description copied from interface:IntIntMap
Follows the same general contract asMap.equals(Object)
. -
hashCode
public int hashCode()Description copied from interface:IntIntMap
Follows the same general contract asMap.hashCode()
. -
toString
Description copied from interface:PrimitiveIterable
Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.Assert.assertEquals("[]", IntLists.mutable.empty().toString()); Assert.assertEquals("[1]", IntLists.mutable.with(1).toString()); Assert.assertEquals("[1, 2, 3]", IntLists.mutable.with(1, 2, 3).toString());
- Specified by:
toString
in interfaceIntIntMap
- Specified by:
toString
in interfacePrimitiveIterable
- Overrides:
toString
in classAbstractIntIterable
- Returns:
- a string representation of this PrimitiveIterable
- See Also:
-
intIterator
Description copied from interface:IntIterable
Returns a primitive iterator that can be used to iterate over the IntIterable in an imperative style.- Specified by:
intIterator
in interfaceIntIterable
- Specified by:
intIterator
in interfaceMutableIntValuesMap
-
injectInto
- Specified by:
injectInto
in interfaceIntIterable
-
clear
public void clear()Description copied from interface:MutableIntValuesMap
Removes all entries from this map.- Specified by:
clear
in interfaceMutableIntKeysMap
- Specified by:
clear
in interfaceMutableIntValuesMap
-
put
public void put(int key, int value) Description copied from interface:MutableIntIntMap
Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced withvalue
.- Specified by:
put
in interfaceMutableIntIntMap
- Parameters:
key
- the keyvalue
- the value to associate withvalue
-
putAll
Description copied from interface:MutableIntIntMap
Puts all of the key/value mappings from the specified map into this map. If this map already has a value associated with one of the keys in the map, it will be replaced with the value inmap
.- Specified by:
putAll
in interfaceMutableIntIntMap
- Parameters:
map
- the map to copy into this map
-
updateValues
Description copied from interface:MutableIntIntMap
Updates the values in-place.- Specified by:
updateValues
in interfaceMutableIntIntMap
- Parameters:
function
- that takes a key and its value and that returns a new value for this key
-
removeKey
public void removeKey(int key) Description copied from interface:MutableIntIntMap
Removes the mapping associated with the key, if one exists, from the map.- Specified by:
removeKey
in interfaceMutableIntIntMap
- Specified by:
removeKey
in interfaceMutableIntKeysMap
- Parameters:
key
- the key to remove- See Also:
-
remove
public void remove(int key) Description copied from interface:MutableIntIntMap
Removes the mapping associated with the key, if one exists, from the map.- Specified by:
remove
in interfaceMutableIntIntMap
- Parameters:
key
- the key to remove- See Also:
-
removeKeyIfAbsent
public int removeKeyIfAbsent(int key, int value) Description copied from interface:MutableIntIntMap
Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key. If no mapping existed for the key, the specified default value is returned.- Specified by:
removeKeyIfAbsent
in interfaceMutableIntIntMap
- Parameters:
key
- the key to removevalue
- the default value to return if no mapping for the key exists- Returns:
- the value previously associated with the key, if one existed,
or
value
if not
-
getIfAbsentPut
public int getIfAbsentPut(int key, int value) Description copied from interface:MutableIntIntMap
Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.- Specified by:
getIfAbsentPut
in interfaceMutableIntIntMap
- Parameters:
key
- the keyvalue
- the value to associate withkey
if no such mapping exists- Returns:
- the value associated with key, if one exists, or
value
if not
-
getAndPut
public int getAndPut(int key, int putValue, int defaultValue) Description copied from interface:MutableIntIntMap
Retrieves the value associated with the key if one exists; associates a putValue with the key.- Specified by:
getAndPut
in interfaceMutableIntIntMap
- Parameters:
key
- the keyputValue
- the value to associate withkey
if no such mapping existsdefaultValue
- the value to return if no mapping associated withkey
exists- Returns:
- the value associated with key, if one exists, or
defaultValue
if not
-
getIfAbsentPut
Description copied from interface:MutableIntIntMap
Retrieves the value associated with the key if one exists; if it does not, invokes the supplier and associates the result with the key.- Specified by:
getIfAbsentPut
in interfaceMutableIntIntMap
- Parameters:
key
- the keyfunction
- the supplier that provides the value if no mapping exists forkey
- Returns:
- the value associated with the key, if one exists, or the result of
invoking
function
if not
-
getIfAbsentPutWith
Description copied from interface:MutableIntIntMap
Retrieves the value associated with the key if one exists; if it does not, invokes the value function with the parameter and associates the result with the key.- Specified by:
getIfAbsentPutWith
in interfaceMutableIntIntMap
- Type Parameters:
P
- the type of the value function'sparameter
- Parameters:
key
- the keyfunction
- the function that provides the value if no mapping exists. The specifiedparameter
will be passed as the argument to the function.parameter
- the parameter to provide tofunction
if no value exists forkey
- Returns:
- the value associated with the key, if one exists, or the result of
invoking
function
withparameter
if not
-
getIfAbsentPutWithKey
Description copied from interface:MutableIntIntMap
Retrieves the value associated with the key if one exists; if it does not, associates the result of invoking the value function with the key.- Specified by:
getIfAbsentPutWithKey
in interfaceMutableIntIntMap
- Parameters:
key
- the keyfunction
- the function that provides the value if no mapping exists. Thekey
will be passed as the argument to the function.- Returns:
- the value associated with the key, if one exists, or the result of
invoking
function
withkey
if not
-
addToValue
public int addToValue(int key, int toBeAdded) Description copied from interface:MutableIntIntMap
Increments and updates the value associated with the key, if a value exists, or sets the value to be the specified value if one does not.- Specified by:
addToValue
in interfaceMutableIntIntMap
- Parameters:
key
- the keytoBeAdded
- the amount to increment the existing value, if one exists, or to use as the initial value if one does not- Returns:
- the value after incrementing
toBeAdded
to the existing value associated withkey
ortoBeAdded
if one does not
-
updateValue
Description copied from interface:MutableIntIntMap
Updates or sets the value associated with the key by applying the function to the existing value, if one exists, or to the specified initial value if one does not.- Specified by:
updateValue
in interfaceMutableIntIntMap
- Parameters:
key
- the keyinitialValueIfAbsent
- the initial value to supply to the function if no mapping exists for the keyfunction
- the function that returns the updated value based on the current value or the initial value, if no value exists- Returns:
- the new value associated with the key, either as a result of applying
function
to the value already associated with the key or as a result of applying it toinitialValueIfAbsent
and associating the result withkey
-
withKeyValue
Description copied from interface:MutableIntIntMap
Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced withvalue
.- Specified by:
withKeyValue
in interfaceMutableIntIntMap
- Parameters:
key1
- the keyvalue1
- the value to associate withvalue
- Returns:
- this map
- See Also:
-
withKeysValues
-
withKeysValues
public IntIntHashMap withKeysValues(int key1, int value1, int key2, int value2, int key3, int value3) -
withKeysValues
public IntIntHashMap withKeysValues(int key1, int value1, int key2, int value2, int key3, int value3, int key4, int value4) -
withoutKey
Description copied from interface:MutableIntIntMap
Removes the mapping associated with the key, if one exists, from this map.- Specified by:
withoutKey
in interfaceMutableIntIntMap
- Parameters:
key
- the key to remove- Returns:
- this map
- See Also:
-
withoutAllKeys
Description copied from interface:MutableIntIntMap
Removes the mappings associated with all the keys, if they exist, from this map.- Specified by:
withoutAllKeys
in interfaceMutableIntIntMap
- Parameters:
keys
- the keys to remove- Returns:
- this map
- See Also:
-
asUnmodifiable
Description copied from interface:MutableIntIntMap
Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing anUnsupportedOperationException
for all mutating operations. This avoids the overhead of copying the map when callingIntIntMap.toImmutable()
while still providing immutability.- Specified by:
asUnmodifiable
in interfaceMutableIntIntMap
- Returns:
- an unmodifiable view of this map
-
asSynchronized
Description copied from interface:MutableIntIntMap
Returns a synchronized view of this map, delegating all operations to this map but ensuring only one caller has access to the map at a time.- Specified by:
asSynchronized
in interfaceMutableIntIntMap
- Returns:
- a synchronized view of this map
-
toImmutable
Description copied from interface:IntIntMap
Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.- Specified by:
toImmutable
in interfaceIntIntMap
- Returns:
- an immutable map that is equivalent to this one
-
get
public int get(int key) Description copied from interface:IntIntMap
Retrieves the value associated with the key. If no mapping exists for the key, the default value (usually0
) is returned. -
getIfAbsent
public int getIfAbsent(int key, int ifAbsent) Description copied from interface:IntIntMap
Retrieves the value associated with the key, returning the specified default value if no such mapping exists.- Specified by:
getIfAbsent
in interfaceIntIntMap
- Parameters:
key
- the keyifAbsent
- the default value to return if no mapping exists forkey
- Returns:
- the value associated with the key, or
ifAbsent
if no such mapping exists.
-
getOrThrow
public int getOrThrow(int key) Description copied from interface:IntIntMap
Retrieves the value associated with the key, throwing anIllegalStateException
if no such mapping exists.- Specified by:
getOrThrow
in interfaceIntIntMap
- Parameters:
key
- the key- Returns:
- the value associated with the key
-
containsKey
public boolean containsKey(int key) Description copied from interface:IntIntMap
Returns whether or not the key is present in the map.- Specified by:
containsKey
in interfaceIntIntMap
- Specified by:
containsKey
in interfaceIntKeysMap
- Parameters:
key
- the key- Returns:
- if a mapping exists in this map for the key
-
forEachKey
Description copied from interface:IntIntMap
Iterates through each key in the map, invoking the procedure for each.- Specified by:
forEachKey
in interfaceIntIntMap
- Specified by:
forEachKey
in interfaceIntKeysMap
- Parameters:
procedure
- the procedure to invoke for each key
-
forEachKeyValue
Description copied from interface:IntIntMap
Iterates through each key/value pair in the map, invoking the procedure for each.- Specified by:
forEachKeyValue
in interfaceIntIntMap
- Parameters:
procedure
- the procedure to invoke for each key/value pair
-
keysView
Description copied from interface:IntIntMap
Returns a view of the keys in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the keys returned by the iterable. -
keyValuesView
Description copied from interface:IntIntMap
Returns a view of the key/value pairs in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the pairs returned by the iterable.- Specified by:
keyValuesView
in interfaceIntIntMap
- Returns:
- a view of the keys in this map
-
flipUniqueValues
Description copied from interface:IntIntMap
Return the IntIntMap that is obtained by flipping the direction of this map and making the associations from value to key.- Specified by:
flipUniqueValues
in interfaceIntIntMap
- Specified by:
flipUniqueValues
in interfaceMutableIntIntMap
-
select
Description copied from interface:IntIntMap
Return a copy of this map containing only the key/value pairs that match the predicate.- Specified by:
select
in interfaceIntIntMap
- Specified by:
select
in interfaceMutableIntIntMap
- Parameters:
predicate
- the predicate to determine which key/value pairs in this map should be included in the returned map- Returns:
- a copy of this map with the matching key/value pairs
-
reject
Description copied from interface:IntIntMap
Return a copy of this map containing only the key/value pairs that do not match the predicate.- Specified by:
reject
in interfaceIntIntMap
- Specified by:
reject
in interfaceMutableIntIntMap
- Parameters:
predicate
- the predicate to determine which key/value pairs in this map should be excluded from the returned map- Returns:
- a copy of this map without the matching key/value pairs
-
writeExternal
- Specified by:
writeExternal
in interfaceExternalizable
- Throws:
IOException
-
readExternal
- Specified by:
readExternal
in interfaceExternalizable
- Throws:
IOException
ClassNotFoundException
-
compact
public void compact()Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels. -
keySet
Description copied from interface:IntIntMap
Returns a set containing all the keys in this map. The set is backed by the map, so any modifications to the returned set will affect this map. -
values
Description copied from interface:IntValuesMap
Returns the values in this map as a separate collection. The returned collection is backed by the map, so any changes made to the returned collection will affect the state of this map.- Specified by:
values
in interfaceIntValuesMap
- Returns:
- the values as a collection backed by this map
-