Interface MutableObjectShortMap<K>
- All Superinterfaces:
ObjectShortMap<K>
,PrimitiveIterable
,ShortIterable
- All Known Implementing Classes:
ObjectShortHashMap
,ObjectShortHashMapWithHashingStrategy
,SynchronizedObjectShortMap
,UnmodifiableObjectShortMap
public interface MutableObjectShortMap<K> extends ObjectShortMap<K>
This file was automatically generated from template file mutableObjectPrimitiveMap.stg.
- Since:
- 3.0.
-
Method Summary
Modifier and Type Method Description short
addToValue(K key, short toBeAdded)
MutableObjectShortMap<K>
asSynchronized()
MutableObjectShortMap<K>
asUnmodifiable()
void
clear()
Removes all entries from this map.<V> MutableCollection<V>
collect(ShortToObjectFunction<? extends V> function)
Returns a new collection with the results of applying the specified function on each element of the source collection.MutableShortObjectMap<K>
flipUniqueValues()
Return the ShortObjectMap that is obtained by flipping the direction of this map and making the associations from value to key.short
getIfAbsentPut(K 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(K 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(K 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(K key, ShortFunction<? super K> 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(K key, short value)
Associates a value with the specified key.void
putAll(ObjectShortMap<? extends K> map)
Puts all of the key/value mappings from the specified map into this map.default void
putPair(ObjectShortPair<K> keyValuePair)
This method allows MutableObjectShortMap the ability to add an element in the form ofObjectShortPair<K>
.MutableObjectShortMap<K>
reject(ObjectShortPredicate<? super K> predicate)
Return a copy of this map containing only the key/value pairs that do not match the predicate.MutableShortCollection
reject(ShortPredicate predicate)
Returns a new ShortIterable with all of the elements in the ShortIterable that return false for the specified predicate.void
remove(Object key)
Removes the mapping associated with the key, if one exists, from the map.void
removeKey(K key)
Removes the mapping associated with the key, if one exists, from the map.short
removeKeyIfAbsent(K key, short value)
Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.MutableObjectShortMap<K>
select(ObjectShortPredicate<? super K> predicate)
Return a copy of this map containing only the key/value pairs that match the predicate.MutableShortCollection
select(ShortPredicate predicate)
Returns a new ShortIterable with all of the elements in the ShortIterable that return true for the specified predicate.MutableShortIterator
shortIterator()
Returns a primitive iterator that can be used to iterate over the ShortIterable in an imperative style.default MutableObjectShortMap<K>
tap(ShortProcedure procedure)
short
updateValue(K 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(ObjectShortToShortFunction<? super K> function)
Updates the values in-place.default MutableObjectShortMap<K>
withAllKeyValues(Iterable<ObjectShortPair<K>> keyValuePairs)
MutableObjectShortMap<K>
withKeyValue(K key, short value)
Associates a value with the specified key.MutableObjectShortMap<K>
withoutAllKeys(Iterable<? extends K> keys)
Removes the mappings associated with all the keys, if they exist, from this map.MutableObjectShortMap<K>
withoutKey(K key)
Removes the mapping associated with the key, if one exists, from this map.Methods inherited from interface org.eclipse.collections.api.map.primitive.ObjectShortMap
containsKey, containsValue, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getOrThrow, keySet, keysView, keyValuesView, toImmutable, toString, values
Methods inherited from interface org.eclipse.collections.api.PrimitiveIterable
appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size
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, count, detectIfNone, each, flatCollect, forEach, injectInto, max, maxIfEmpty, median, medianIfEmpty, min, minIfEmpty, noneSatisfy, reduce, reduceIfEmpty, reject, select, sum, summaryStatistics, toArray, toArray, toBag, toList, toSet, toSortedArray, toSortedList
-
Method Details
-
shortIterator
MutableShortIterator shortIterator()Description copied from interface:ShortIterable
Returns a primitive iterator that can be used to iterate over the ShortIterable in an imperative style.- Specified by:
shortIterator
in interfaceShortIterable
-
clear
void clear()Removes all entries from this map. -
put
Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced withvalue
.- Parameters:
key
- the keyvalue
- the value to associate withvalue
-
putPair
This method allows MutableObjectShortMap the ability to add an element in the form ofObjectShortPair<K>
.- Since:
- 9.1.0
- See Also:
put(Object, short)
-
putAll
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
.- Parameters:
map
- the map to copy into this map
-
updateValues
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
Removes the mapping associated with the key, if one exists, from the map.- Parameters:
key
- the key to remove- See Also:
remove(Object)
-
remove
Removes the mapping associated with the key, if one exists, from the map.- Parameters:
key
- the key to remove- See Also:
#removeKey(K)
-
removeKeyIfAbsent
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 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
Retrieves the value associated with the key if one exists; if it does not, associates a value with the key. a new value with they key- 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
-
getIfAbsentPut
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 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
-
getIfAbsentPutWithKey
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 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
-
getIfAbsentPutWith
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'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
-
updateValue
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 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
-
flipUniqueValues
MutableShortObjectMap<K> flipUniqueValues()Description copied from interface:ObjectShortMap
Return the ShortObjectMap that is obtained by flipping the direction of this map and making the associations from value to key.- Specified by:
flipUniqueValues
in interfaceObjectShortMap<K>
-
select
Description copied from interface:ObjectShortMap
Return a copy of this map containing only the key/value pairs that match the predicate.- Specified by:
select
in interfaceObjectShortMap<K>
- 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:ObjectShortMap
Return a copy of this map containing only the key/value pairs that do not match the predicate.- Specified by:
reject
in interfaceObjectShortMap<K>
- 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
-
select
Description copied from interface:ShortIterable
Returns a new ShortIterable with all of the elements in the ShortIterable that return true for the specified predicate.- Specified by:
select
in interfaceShortIterable
-
reject
Description copied from interface:ShortIterable
Returns a new ShortIterable with all of the elements in the ShortIterable that return false for the specified predicate.- Specified by:
reject
in interfaceShortIterable
-
tap
- Specified by:
tap
in interfaceObjectShortMap<K>
- Specified by:
tap
in interfaceShortIterable
- Since:
- 9.0.
-
collect
Description copied from interface:ShortIterable
Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.- Specified by:
collect
in interfaceShortIterable
-
withKeyValue
Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced withvalue
.- Parameters:
key
- the keyvalue
- the value to associate withvalue
- Returns:
- this map
- See Also:
#put(K, short)
-
withoutKey
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(Object)
-
withoutAllKeys
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(Object)
-
withAllKeyValues
-
asUnmodifiable
MutableObjectShortMap<K> asUnmodifiable() -
asSynchronized
MutableObjectShortMap<K> asSynchronized() -
addToValue
-