org.eclipse.collections.api.map.primitive

Interface MutableShortShortMap

All Superinterfaces:

MutableShortValuesMap, PrimitiveIterable, ShortIterable, ShortShortMap, ShortValuesMap

public interface MutableShortShortMap
extends ShortShortMap, MutableShortValuesMap

This file was automatically generated from template file mutablePrimitivePrimitiveMap.stg.

Since:

3.0.

Method Summary

Modifier and Type	Method and Description
short	addToValue(short key, short 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.
MutableShortShortMap	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.
MutableShortShortMap	asUnmodifiable() Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an UnsupportedOperationException for all mutating operations.
MutableShortShortMap	flipUniqueValues() Return the ShortShortMap that is obtained by flipping the direction of this map and making the associations from value to key.
default short	getAndPut(short key, short putValue, short defaultValue) Retrieves the value associated with the key if one exists; associates a putValue with the key.
short	getIfAbsentPut(short key, short value) Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.
short	getIfAbsentPut(short key, ShortFunction0 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> short	getIfAbsentPutWith(short key, ShortFunction<? 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.
short	getIfAbsentPutWithKey(short key, ShortToShortFunction 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.
void	put(short key, short value) Associates a value with the specified key.
void	putAll(ShortShortMap map) Puts all of the key/value mappings from the specified map into this map.
default void	putPair(ShortShortPair keyValuePair) This method allows MutableShortShortMap the ability to add an element in the form of ShortShortPair.
MutableShortShortMap	reject(ShortShortPredicate predicate) Return a copy of this map containing only the key/value pairs that do not match the predicate.
void	remove(short key) Removes the mapping associated with the key, if one exists, from the map.
void	removeKey(short key) Removes the mapping associated with the key, if one exists, from the map.
short	removeKeyIfAbsent(short key, short value) Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.
MutableShortShortMap	select(ShortShortPredicate predicate) Return a copy of this map containing only the key/value pairs that match the predicate.
short	updateValue(short key, short initialValueIfAbsent, ShortToShortFunction 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(ShortShortToShortFunction function) Updates the values in-place.
default MutableShortShortMap	withAllKeyValues(Iterable<ShortShortPair> keyValuePairs) Puts all of the key/value mappings from the specified pairs into this map.
MutableShortShortMap	withKeyValue(short key, short value) Associates a value with the specified key.
MutableShortShortMap	withoutAllKeys(ShortIterable keys) Removes the mappings associated with all the keys, if they exist, from this map.
MutableShortShortMap	withoutKey(short key) Removes the mapping associated with the key, if one exists, from this map.

Methods inherited from interface org.eclipse.collections.api.map.primitive.ShortShortMap

containsKey, equals, forEachKey, forEachKeyValue, get, getIfAbsent, getOrThrow, hashCode, injectIntoKeyValue, keySet, keysView, keyValuesView, toImmutable, toString

Methods inherited from interface org.eclipse.collections.api.map.primitive.MutableShortValuesMap

clear, collect, reject, select, shortIterator

Methods inherited from interface org.eclipse.collections.api.map.primitive.ShortValuesMap

containsValue, forEachValue, tap, values

Methods inherited from interface org.eclipse.collections.api.ShortIterable

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, injectInto, 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.api.PrimitiveIterable

appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size

Method Detail

put

void put(short key,
         short 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 - the key

value - the value to associate with value

putPair

default void putPair(ShortShortPair keyValuePair)

This method allows MutableShortShortMap the ability to add an element in the form of ShortShortPair.

Since:

9.1.0

See Also:

put(short, short)

putAll

void putAll(ShortShortMap 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 - the map to copy into this map

updateValues

void updateValues(ShortShortToShortFunction function)

Updates the values in-place.

Parameters:

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

Since:

10.0

removeKey

void removeKey(short key)

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

Parameters:

key - the key to remove

See Also:

remove(short)

remove

void remove(short key)

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

Parameters:

key - the key to remove

See Also:

removeKey(short)

removeKeyIfAbsent

short removeKeyIfAbsent(short key,
                        short 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 - the key to remove

value - 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

short getIfAbsentPut(short key,
                     short value)

Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.

Parameters:

key - the key

value - the value to associate with key if no such mapping exists

Returns:

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

getAndPut

default short getAndPut(short key,
                        short putValue,
                        short defaultValue)

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

Parameters:

key - the key

putValue - the value to associate with key if no such mapping exists

defaultValue - the value to return if no mapping associated with key exists

Returns:

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

Since:

11.1.

getIfAbsentPut

short getIfAbsentPut(short key,
                     ShortFunction0 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 - the key

function - the supplier that provides the value if no mapping exists for key

Returns:

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

getIfAbsentPutWithKey

short getIfAbsentPutWithKey(short key,
                            ShortToShortFunction 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 - the key

function - the function that provides the value if no mapping exists. The key 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 with key if not

getIfAbsentPutWith

<P> short getIfAbsentPutWith(short key,
                             ShortFunction<? 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.

Type Parameters:

P - the type of the value function's parameter

Parameters:

key - the key

function - the function that provides the value if no mapping exists. The specified parameter will be passed as the argument to the function.

parameter - the parameter to provide to function if no value exists for key

Returns:

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

updateValue

short updateValue(short key,
                  short initialValueIfAbsent,
                  ShortToShortFunction 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 - the key

initialValueIfAbsent - the initial value to supply to the function if no mapping exists for the key

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

flipUniqueValues

MutableShortShortMap flipUniqueValues()

Description copied from interface: ShortShortMap

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

Specified by:

flipUniqueValues in interface ShortShortMap

select

MutableShortShortMap select(ShortShortPredicate predicate)

Description copied from interface: ShortShortMap

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

Specified by:

select in interface ShortShortMap

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

MutableShortShortMap reject(ShortShortPredicate predicate)

Description copied from interface: ShortShortMap

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

Specified by:

reject in interface ShortShortMap

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

withKeyValue

MutableShortShortMap withKeyValue(short key,
                                  short 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 - the key

value - the value to associate with value

Returns:

this map

See Also:

put(short, short)

withoutKey

MutableShortShortMap withoutKey(short key)

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

Parameters:

key - the key to remove

Returns:

this map

See Also:

remove(short)

withoutAllKeys

MutableShortShortMap withoutAllKeys(ShortIterable keys)

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

Parameters:

keys - the keys to remove

Returns:

this map

See Also:

remove(short)

withAllKeyValues

default MutableShortShortMap withAllKeyValues(Iterable<ShortShortPair> 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:

iterable - the pairs to put into this map

Returns:

this map

See Also:

putPair(ShortShortPair)

asUnmodifiable

MutableShortShortMap 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 ShortShortMap.toImmutable() while still providing immutability.

Returns:

an unmodifiable view of this map

asSynchronized

MutableShortShortMap 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:

a synchronized view of this map

addToValue

short addToValue(short key,
                 short 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 - the key

toBeAdded - 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 with key or toBeAdded if one does not