Eclipse Collections 13.0.0 · org.eclipse.collections.api.map.primitive.MutableIntIntMap

Method Summary

Modifier and Type	Method and Description
public int	Returns: the value after incrementing `toBeAdded` to the existing value associated with `key` or `toBeAdded` if one does not addToValue(int the key key, int the amount to increment the existing value, if one exists, or to use as the initial value if one does not 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.
public MutableIntIntMap	Returns: a synchronized view of this map asSynchronized() 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.
public MutableIntIntMap	Returns: an unmodifiable view of this map asUnmodifiable() Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an `UnsupportedOperationException` for all mutating operations.
public MutableIntIntMap	flipUniqueValues() Redeclares org.eclipse.collections.api.map.primitive.IntIntMap.flipUniqueValues. Return the IntIntMap that is obtained by flipping the direction of this map and making the associations from value to key.
public default int	Returns: the value associated with key, if one exists, or `defaultValue` if not getAndPut(int the key key, int the value to associate with `key` if no such mapping exists putValue, int the value to return if no mapping associated with `key` exists defaultValue) Retrieves the value associated with the key if one exists; associates a putValue with the key.
public int	Returns: the value associated with key, if one exists, or `value` if not getIfAbsentPut(int the key key, int the value to associate with `key` if no such mapping exists value) Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.
public int	Returns: the value associated with the key, if one exists, or the result of invoking `function` if not getIfAbsentPut(int the key key, IntFunction0 the supplier that provides the value if no mapping exists for `key` 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.
public < the type of the value function's `parameter` P> int	Returns: the value associated with the key, if one exists, or the result of invoking `function` with `parameter` if not getIfAbsentPutWith(int the key key, IntFunction<? super P> the function that provides the value if no mapping exists. The specified `parameter` will be passed as the argument to the function. function, P the parameter to provide to `function` if no value exists for `key` 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.
public int	Returns: the value associated with the key, if one exists, or the result of invoking `function` with `key` if not getIfAbsentPutWithKey(int the key key, IntToIntFunction the function that provides the value if no mapping exists. The `key` will be passed as the argument to the function. 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.
public void	put(int the key key, int the value to associate with `value` value) Associates a value with the specified key.
public void	putAll(IntIntMap the map to copy into this map map) Puts all of the key/value mappings from the specified map into this map.
public default void	putPair(IntIntPair keyValuePair) This method allows MutableIntIntMap the ability to add an element in the form of IntIntPair.
public MutableIntIntMap	reject(IntIntPredicate predicate) Redeclares org.eclipse.collections.api.map.primitive.IntIntMap.reject. Return a copy of this map containing only the key/value pairs that do not match the predicate.
public void	remove(int the key to remove key) Removes the mapping associated with the key, if one exists, from the map.
public void	removeKey(int the key to remove key) Removes the mapping associated with the key, if one exists, from the map.
public int	Returns: the value previously associated with the key, if one existed, or `value` if not removeKeyIfAbsent(int the key to remove key, int the default value to return if no mapping for the key exists value) Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.
public MutableIntIntMap	select(IntIntPredicate predicate) Redeclares org.eclipse.collections.api.map.primitive.IntIntMap.select. Return a copy of this map containing only the key/value pairs that match the predicate.
public int	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 to `initialValueIfAbsent` and associating the result with `key` updateValue(int the key key, int the initial value to supply to the function if no mapping exists for the key initialValueIfAbsent, IntToIntFunction the function that returns the updated value based on the current value or the initial value, if no value exists 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.
public void	updateValues(IntIntToIntFunction that takes a key and its value and that returns a new value for this key function) Updates the values in-place.
public default MutableIntIntMap	Returns: this map withAllKeyValues(Iterable<IntIntPair> the pairs to put into this map keyValuePairs) Puts all of the key/value mappings from the specified pairs into this map.
public MutableIntIntMap	Returns: this map withKeyValue(int the key key, int the value to associate with `value` value) Associates a value with the specified key.
public MutableIntIntMap	Returns: this map withoutAllKeys(IntIterable the keys to remove keys) Removes the mappings associated with all the keys, if they exist, from this map.
public MutableIntIntMap	Returns: this map withoutKey(int the key to remove key) Removes the mapping associated with the key, if one exists, from this map.

Method Detail

addToValue back to summary

addToValue	back to summary
public int 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. Parameters key:int the key toBeAdded:int the amount to increment the existing value, if one exists, or to use as the initial value if one does not Returns:int the value after incrementing `toBeAdded` to the existing value associated with `key` or `toBeAdded` if one does not

public int 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.

Parameters

key:int: the key
toBeAdded:int: the amount to increment the existing value, if one exists, or to use as the initial value if one does not

Returns:int

the value after incrementing toBeAdded to the existing value associated with key or toBeAdded if one does not

asSynchronized	back to summary
public MutableIntIntMap asSynchronized() 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:MutableIntIntMap a synchronized view of this map

asSynchronized

back to summary

public MutableIntIntMap asSynchronized()

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:MutableIntIntMap: a synchronized view of this map

asUnmodifiable back to summary

asUnmodifiable	back to summary
public MutableIntIntMap asUnmodifiable() Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an `UnsupportedOperationException` for all mutating operations. This avoids the overhead of copying the map when calling `toImmutable()` while still providing immutability. Returns:MutableIntIntMap an unmodifiable view of this map

public MutableIntIntMap asUnmodifiable()

Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an UnsupportedOperationException for all mutating operations. This avoids the overhead of copying the map when calling toImmutable() while still providing immutability.

Returns:MutableIntIntMap: an unmodifiable view of this map

flipUniqueValues	back to summary
public MutableIntIntMap flipUniqueValues() Redeclares org.eclipse.collections.api.map.primitive.IntIntMap.flipUniqueValues. Doc from org.eclipse.collections.api.map.primitive.IntIntMap.flipUniqueValues. Return the IntIntMap that is obtained by flipping the direction of this map and making the associations from value to key. Annotations @Override

flipUniqueValues

back to summary

public MutableIntIntMap flipUniqueValues()

Redeclares org.eclipse.collections.api.map.primitive.IntIntMap.flipUniqueValues.

Doc from org.eclipse.collections.api.map.primitive.IntIntMap.flipUniqueValues.

Return the IntIntMap that is obtained by flipping the direction of this map and making the associations from value to key.

Annotations

@Override

getAndPut back to summary

getAndPut	back to summary
public default int getAndPut(int key, int putValue, int defaultValue) Retrieves the value associated with the key if one exists; associates a putValue with the key. Parameters key:int the key putValue:int the value to associate with `key` if no such mapping exists defaultValue:int the value to return if no mapping associated with `key` exists Returns:int the value associated with key, if one exists, or `defaultValue` if not Since 11.1.

public default int getAndPut(int key, int putValue, int defaultValue)

Retrieves the value associated with the key if one exists; associates a putValue with the key.

Parameters

key:int: the key
putValue:int: the value to associate with key if no such mapping exists
defaultValue:int: the value to return if no mapping associated with key exists

Returns:int

the value associated with key, if one exists, or defaultValue if not

Since

11.1.

getIfAbsentPut back to summary

getIfAbsentPut	back to summary
public 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. Parameters key:int the key value:int the value to associate with `key` if no such mapping exists Returns:int the value associated with key, if one exists, or `value` if not

public 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.

Parameters

key:int: the key
value:int: the value to associate with key if no such mapping exists

Returns:int

the value associated with key, if one exists, or value if not

getIfAbsentPut back to summary

getIfAbsentPut	back to summary
public 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. Parameters key:int the key function:IntFunction0 the supplier that provides the value if no mapping exists for `key` Returns:int the value associated with the key, if one exists, or the result of invoking `function` if not

public 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.

Parameters

key:int: the key
function:IntFunction0: the supplier that provides the value if no mapping exists for key

Returns:int

the value associated with the key, if one exists, or the result of invoking function if not

getIfAbsentPutWith back to summary

getIfAbsentPutWith	back to summary
public <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. Parameters <P> the type of the value function's `parameter` key:int the key function:IntFunction<? super P> the function that provides the value if no mapping exists. The specified `parameter` will be passed as the argument to the function. parameter:P the parameter to provide to `function` if no value exists for `key` Returns:int the value associated with the key, if one exists, or the result of invoking `function` with `parameter` if not

public <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.

Parameters

<P>: the type of the value function's parameter
key:int: the key
function:IntFunction<? super P>: the function that provides the value if no mapping exists. The specified parameter will be passed as the argument to the function.
parameter:P: the parameter to provide to function if no value exists for key

Returns:int

the value associated with the key, if one exists, or the result of invoking function with parameter if not

getIfAbsentPutWithKey back to summary

getIfAbsentPutWithKey	back to summary
public 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. Parameters key:int the key function:IntToIntFunction the function that provides the value if no mapping exists. The `key` will be passed as the argument to the function. Returns:int the value associated with the key, if one exists, or the result of invoking `function` with `key` if not

public 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.

Parameters

key:int: the key
function:IntToIntFunction: the function that provides the value if no mapping exists. The key will be passed as the argument to the function.

Returns:int

the value associated with the key, if one exists, or the result of invoking function with key if not

put back to summary

put	back to summary
public void put(int key, int value) Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with `value`. Parameters key:int the key value:int the value to associate with `value`

public void put(int key, int value)

Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with value.

Parameters

key:int: the key
value:int: the value to associate with value

putAll back to summary

putAll	back to summary
public void putAll(IntIntMap map) 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 in `map`. Parameters map:IntIntMap the map to copy into this map

public void putAll(IntIntMap map)

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 in map.

Parameters

map:IntIntMap: the map to copy into this map

putPair back to summary

putPair	back to summary
public default void putPair(IntIntPair keyValuePair) This method allows MutableIntIntMap the ability to add an element in the form of IntIntPair. Since 9.1.0 See Also `put(int, int)`

public default void putPair(IntIntPair keyValuePair)

This method allows MutableIntIntMap the ability to add an element in the form of IntIntPair.

Since: 9.1.0
See Also: put(int, int)

reject	back to summary
public MutableIntIntMap reject(IntIntPredicate predicate) Redeclares org.eclipse.collections.api.map.primitive.IntIntMap.reject. Doc from org.eclipse.collections.api.map.primitive.IntIntMap.reject. Return a copy of this map containing only the key/value pairs that do not match the predicate. Annotations @Override

reject

back to summary

public MutableIntIntMap reject(IntIntPredicate predicate)

Redeclares org.eclipse.collections.api.map.primitive.IntIntMap.reject.

Doc from org.eclipse.collections.api.map.primitive.IntIntMap.reject.

Return a copy of this map containing only the key/value pairs that do not match the predicate.

Annotations

@Override

remove back to summary

remove	back to summary
public void remove(int key) Removes the mapping associated with the key, if one exists, from the map. Parameters key:int the key to remove See Also `removeKey(int)`

public void remove(int key)

Removes the mapping associated with the key, if one exists, from the map.

Parameters

key:int: the key to remove

See Also

removeKey(int)

removeKey back to summary

removeKey	back to summary
public void removeKey(int key) Removes the mapping associated with the key, if one exists, from the map. Parameters key:int the key to remove See Also `remove(int)`

public void removeKey(int key)

Removes the mapping associated with the key, if one exists, from the map.

Parameters

key:int: the key to remove

See Also

remove(int)

removeKeyIfAbsent back to summary

removeKeyIfAbsent	back to summary
public 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. If no mapping existed for the key, the specified default value is returned. Parameters key:int the key to remove value:int the default value to return if no mapping for the key exists Returns:int the value previously associated with the key, if one existed, or `value` if not

public 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. If no mapping existed for the key, the specified default value is returned.

Parameters

key:int: the key to remove
value:int: the default value to return if no mapping for the key exists

Returns:int

the value previously associated with the key, if one existed, or value if not

select	back to summary
public MutableIntIntMap select(IntIntPredicate predicate) Redeclares org.eclipse.collections.api.map.primitive.IntIntMap.select. Doc from org.eclipse.collections.api.map.primitive.IntIntMap.select. Return a copy of this map containing only the key/value pairs that match the predicate. Annotations @Override

select

back to summary

public MutableIntIntMap select(IntIntPredicate predicate)

Redeclares org.eclipse.collections.api.map.primitive.IntIntMap.select.

Doc from org.eclipse.collections.api.map.primitive.IntIntMap.select.

Return a copy of this map containing only the key/value pairs that match the predicate.

Annotations

@Override

updateValue back to summary

updateValue	back to summary
public 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. Parameters key:int the key initialValueIfAbsent:int the initial value to supply to the function if no mapping exists for the key function:IntToIntFunction the function that returns the updated value based on the current value or the initial value, if no value exists Returns:int 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 to `initialValueIfAbsent` and associating the result with `key`

public 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.

Parameters

key:int: the key
initialValueIfAbsent:int: the initial value to supply to the function if no mapping exists for the key
function:IntToIntFunction: the function that returns the updated value based on the current value or the initial value, if no value exists

Returns:int

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 to initialValueIfAbsent and associating the result with key

updateValues	back to summary
public void updateValues(IntIntToIntFunction function) Updates the values in-place. Parameters function:IntIntToIntFunction that takes a key and its value and that returns a new value for this key Since 10.0

updateValues

back to summary

public void updateValues(IntIntToIntFunction function)

Updates the values in-place.

Parameters

function:IntIntToIntFunction: that takes a key and its value and that returns a new value for this key

Since

10.0

withAllKeyValues back to summary

withAllKeyValues	back to summary
public default MutableIntIntMap withAllKeyValues(Iterable<IntIntPair> keyValuePairs) Puts all of the key/value mappings from the specified pairs into this map. If this map already has a value associated with one of the keys in the pairs, it will be replaced with the value in the pair. Parameters keyValuePairs:Iterable<IntIntPair> the pairs to put into this map Returns:MutableIntIntMap this map See Also `putPair(IntIntPair)`

public default MutableIntIntMap withAllKeyValues(Iterable<IntIntPair> keyValuePairs)

Puts all of the key/value mappings from the specified pairs into this map. If this map already has a value associated with one of the keys in the pairs, it will be replaced with the value in the pair.

Parameters

keyValuePairs:Iterable<IntIntPair>: the pairs to put into this map

Returns:MutableIntIntMap

this map

See Also

putPair(IntIntPair)

withKeyValue back to summary

withKeyValue	back to summary
public MutableIntIntMap withKeyValue(int key, int value) Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with `value`. Parameters key:int the key value:int the value to associate with `value` Returns:MutableIntIntMap this map See Also `put(int, int)`

public MutableIntIntMap withKeyValue(int key, int value)

Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with value.

Parameters

key:int: the key
value:int: the value to associate with value

Returns:MutableIntIntMap

this map

See Also

put(int, int)

withoutAllKeys back to summary

withoutAllKeys	back to summary
public MutableIntIntMap withoutAllKeys(IntIterable keys) Removes the mappings associated with all the keys, if they exist, from this map. Parameters keys:IntIterable the keys to remove Returns:MutableIntIntMap this map See Also `remove(int)`

public MutableIntIntMap withoutAllKeys(IntIterable keys)

Removes the mappings associated with all the keys, if they exist, from this map.

Parameters

keys:IntIterable: the keys to remove

Returns:MutableIntIntMap

this map

See Also

remove(int)

withoutKey back to summary

withoutKey	back to summary
public MutableIntIntMap withoutKey(int key) Removes the mapping associated with the key, if one exists, from this map. Parameters key:int the key to remove Returns:MutableIntIntMap this map See Also `remove(int)`

public MutableIntIntMap withoutKey(int key)

Removes the mapping associated with the key, if one exists, from this map.

Parameters

key:int: the key to remove

Returns:MutableIntIntMap

this map

See Also

remove(int)

public Interface MutableIntIntMap

Method Summary

Method Detail