Interface MutableShortObjectMap<V>
- All Superinterfaces:
InternalIterable<V>
,Iterable<V>
,MutablePrimitiveObjectMap<V>
,PrimitiveObjectMap<V>
,RichIterable<V>
,ShortObjectMap<V>
- All Known Implementing Classes:
ShortObjectHashMap
,SynchronizedShortObjectMap
,UnmodifiableShortObjectMap
This file was automatically generated from template file mutablePrimitiveObjectMap.stg.
- Since:
- 3.0.
-
Method Summary
Modifier and TypeMethodDescriptionReturns 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.Return the ObjectShortMap that is obtained by flipping the direction of this map and making the associations from value to key.getIfAbsentPut
(short key, Function0<? extends V> 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.getIfAbsentPut
(short key, V value) Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.<P> V
getIfAbsentPutWith
(short key, Function<? super P, ? extends V> 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.getIfAbsentPutWithKey
(short key, ShortToObjectFunction<? extends V> 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.Associates a value with the specified key.void
putAll
(ShortObjectMap<? extends V> map) Puts all of the key/value mappings from the specified map into this map.default V
putPair
(ShortObjectPair<V> keyValuePair) This method allows MutableShortObjectMap the ability to add an element in the form ofShortObjectPair<V>
.reject
(ShortObjectPredicate<? super V> predicate) Return a copy of this map containing only the key/value pairs that do not match the predicate.remove
(short key) Removes the mapping associated with the key, if one exists, from the map.removeKey
(short key) Removes the mapping associated with the key, if one exists, from the map.select
(ShortObjectPredicate<? super V> predicate) Return a copy of this map containing only the key/value pairs that match the predicate.Executes the Procedure for each element in the iterable and returnsthis
.Look up the value associated withkey
, apply thefunction
to it, and replace the value.<P> V
updateValueWith
(short key, Function0<? extends V> factory, Function2<? super V, ? super P, ? extends V> function, P parameter) Updates or sets the value associated with the key by applying the function to the existing value, if one exists, or the initial value supplied by the factory if one does not.default MutableShortObjectMap<V>
withAllKeyValues
(Iterable<ShortObjectPair<V>> keyValuePairs) Puts all of the key/value mappings from the specified pairs into this map.withKeyValue
(short key, V value) Associates a value with the specified key.withoutAllKeys
(ShortIterable keys) Removes the mappings associated with all the keys, if they exist, from this map.withoutKey
(short key) Removes the mapping associated with the key, if one exists, from this map.Methods inherited from interface org.eclipse.collections.api.InternalIterable
forEach, forEachWith, forEachWithIndex
Methods inherited from interface org.eclipse.collections.api.map.primitive.MutablePrimitiveObjectMap
aggregateBy, aggregateInPlaceBy, clear, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, flatCollect, flatCollectWith, groupBy, groupByEach, groupByUniqueKey, partition, partitionWith, reject, rejectWith, select, selectInstancesOf, selectWith, sumByDouble, sumByFloat, sumByInt, sumByLong, zip, zipWithIndex
Methods inherited from interface org.eclipse.collections.api.map.primitive.PrimitiveObjectMap
containsValue, equals, forEachValue, hashCode, parallelStream, spliterator, stream, toString, values
Methods inherited from interface org.eclipse.collections.api.RichIterable
aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, count, countBy, countBy, countByEach, countByEach, countByWith, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getFirst, getLast, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, isEmpty, makeString, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex
Methods inherited from interface org.eclipse.collections.api.map.primitive.ShortObjectMap
containsKey, forEachKey, forEachKeyValue, get, getIfAbsent, injectIntoKeyValue, keySet, keysView, keyValuesView, toImmutable
-
Method Details
-
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
- Returns:
- the value previously associated with
key
if one existed, ornull
if not
-
putPair
This method allows MutableShortObjectMap the ability to add an element in the form ofShortObjectPair<V>
.- Since:
- 9.1.0
- See Also:
-
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- Since:
- 5.0.
-
removeKey
Removes the mapping associated with the key, if one exists, from the map.- Parameters:
key
- the key to remove- See Also:
-
remove
Removes the mapping associated with the key, if one exists, from the map.- Parameters:
key
- the key to remove- See Also:
-
getIfAbsentPut
Retrieves the value associated with the key if one exists; if it does not, associates a value with the 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
Look up the value associated withkey
, apply thefunction
to it, and replace the value. If there is no value associated withkey
, start it off with a value supplied byfactory
. -
updateValueWith
<P> V updateValueWith(short key, Function0<? extends V> factory, Function2<? super V, ? super P, ? extends V> function, P parameter) Updates or sets the value associated with the key by applying the function to the existing value, if one exists, or the initial value supplied by the factory if one does not.- Type Parameters:
P
- the type of the value function'sparameter
- Parameters:
key
- the keyfactory
- the supplier providing the initial value 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. The specifiedparameter
will also be passed as the second argument to the function.parameter
- the parameter to provide tofunction
if no value exists forkey
- 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 the value returned byfactory
and associating the result withkey
-
flipUniqueValues
MutableObjectShortMap<V> flipUniqueValues()Description copied from interface:ShortObjectMap
Return the ObjectShortMap that is obtained by flipping the direction of this map and making the associations from value to key.- Specified by:
flipUniqueValues
in interfaceShortObjectMap<V>
-
tap
Description copied from interface:RichIterable
Executes the Procedure for each element in the iterable and returnsthis
.Example using a Java 8 lambda expression:
RichIterable<Person> tapped = people.tap(person -> LOGGER.info(person.getName()));
Example using an anonymous inner class:
RichIterable<Person> tapped = people.tap(new Procedure<Person>() { public void value(Person person) { LOGGER.info(person.getName()); } });
- Specified by:
tap
in interfaceRichIterable<V>
- Specified by:
tap
in interfaceShortObjectMap<V>
- See Also:
-
select
Description copied from interface:ShortObjectMap
Return a copy of this map containing only the key/value pairs that match the predicate.- Specified by:
select
in interfaceShortObjectMap<V>
- 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:ShortObjectMap
Return a copy of this map containing only the key/value pairs that do not match the predicate.- Specified by:
reject
in interfaceShortObjectMap<V>
- 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
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:
-
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:
-
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:
-
withAllKeyValues
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:
-
asUnmodifiable
MutableShortObjectMap<V> asUnmodifiable()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 callingShortObjectMap.toImmutable()
while still providing immutability.- Returns:
- an unmodifiable view of this map
-
asSynchronized
MutableShortObjectMap<V> 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
-