Interface MutableObjectDoubleMap<K>
-
- All Superinterfaces:
DoubleIterable
,ObjectDoubleMap<K>
,PrimitiveIterable
- All Known Implementing Classes:
ObjectDoubleHashMap
,ObjectDoubleHashMapWithHashingStrategy
,SynchronizedObjectDoubleMap
,UnmodifiableObjectDoubleMap
public interface MutableObjectDoubleMap<K> extends ObjectDoubleMap<K>
This file was automatically generated from template file mutableObjectPrimitiveMap.stg.- Since:
- 3.0.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description double
addToValue(K key, double toBeAdded)
MutableObjectDoubleMap<K>
asSynchronized()
MutableObjectDoubleMap<K>
asUnmodifiable()
void
clear()
Removes all entries from this map.<V> MutableCollection<V>
collect(DoubleToObjectFunction<? extends V> function)
Returns a new collection with the results of applying the specified function on each element of the source collection.MutableDoubleIterator
doubleIterator()
Returns a primitive iterator that can be used to iterate over the DoubleIterable in an imperative style.MutableDoubleObjectMap<K>
flipUniqueValues()
Return the DoubleObjectMap that is obtained by flipping the direction of this map and making the associations from value to key.default double
getAndPut(K key, double putValue, double defaultValue)
Retrieves the value associated with the key if one exists; if it does not, associates a putValue with the key.double
getIfAbsentPut(K key, double value)
Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.double
getIfAbsentPut(K key, DoubleFunction0 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> double
getIfAbsentPutWith(K key, DoubleFunction<? 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.double
getIfAbsentPutWithKey(K key, DoubleFunction<? 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, double value)
Associates a value with the specified key.void
putAll(ObjectDoubleMap<? extends K> map)
Puts all of the key/value mappings from the specified map into this map.default void
putPair(ObjectDoublePair<K> keyValuePair)
This method allows MutableObjectDoubleMap the ability to add an element in the form ofObjectDoublePair<K>
.MutableDoubleCollection
reject(DoublePredicate predicate)
Returns a new DoubleIterable with all of the elements in the DoubleIterable that return false for the specified predicate.MutableObjectDoubleMap<K>
reject(ObjectDoublePredicate<? super K> predicate)
Return a copy of this map containing only the key/value pairs that do not match the predicate.void
remove(java.lang.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.double
removeKeyIfAbsent(K key, double value)
Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.MutableDoubleCollection
select(DoublePredicate predicate)
Returns a new DoubleIterable with all of the elements in the DoubleIterable that return true for the specified predicate.MutableObjectDoubleMap<K>
select(ObjectDoublePredicate<? super K> predicate)
Return a copy of this map containing only the key/value pairs that match the predicate.default MutableObjectDoubleMap<K>
tap(DoubleProcedure procedure)
double
updateValue(K key, double initialValueIfAbsent, DoubleToDoubleFunction 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(ObjectDoubleToDoubleFunction<? super K> function)
Updates the values in-place.default MutableObjectDoubleMap<K>
withAllKeyValues(java.lang.Iterable<ObjectDoublePair<K>> keyValuePairs)
MutableObjectDoubleMap<K>
withKeyValue(K key, double value)
Associates a value with the specified key.MutableObjectDoubleMap<K>
withoutAllKeys(java.lang.Iterable<? extends K> keys)
Removes the mappings associated with all the keys, if they exist, from this map.MutableObjectDoubleMap<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.DoubleIterable
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.map.primitive.ObjectDoubleMap
containsKey, containsValue, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getOrThrow, injectIntoKeyValue, keySet, keysView, keyValuesView, toImmutable, toString, values
-
Methods inherited from interface org.eclipse.collections.api.PrimitiveIterable
appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size
-
-
-
-
Method Detail
-
doubleIterator
MutableDoubleIterator doubleIterator()
Description copied from interface:DoubleIterable
Returns a primitive iterator that can be used to iterate over the DoubleIterable in an imperative style.- Specified by:
doubleIterator
in interfaceDoubleIterable
-
clear
void clear()
Removes all entries from this map.
-
put
void put(K key, double value)
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
default void putPair(ObjectDoublePair<K> keyValuePair)
This method allows MutableObjectDoubleMap the ability to add an element in the form ofObjectDoublePair<K>
.- Since:
- 9.1.0
- See Also:
put(Object, double)
-
putAll
void putAll(ObjectDoubleMap<? extends K> 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 inmap
.- Parameters:
map
- the map to copy into this map
-
updateValues
void updateValues(ObjectDoubleToDoubleFunction<? super K> 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(K key)
Removes the mapping associated with the key, if one exists, from the map.- Parameters:
key
- the key to remove- See Also:
remove(Object)
-
remove
void remove(java.lang.Object key)
Removes the mapping associated with the key, if one exists, from the map.- Parameters:
key
- the key to remove- See Also:
#removeKey(K)
-
removeKeyIfAbsent
double removeKeyIfAbsent(K key, double 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 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
double getIfAbsentPut(K key, double value)
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
-
getAndPut
default double getAndPut(K key, double putValue, double defaultValue)
Retrieves the value associated with the key if one exists; if it does not, associates a putValue with the key.- 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 - Since:
- 11.1.
-
getIfAbsentPut
double getIfAbsentPut(K key, DoubleFunction0 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 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
double getIfAbsentPutWithKey(K key, DoubleFunction<? 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.- 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
<P> double getIfAbsentPutWith(K key, DoubleFunction<? 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'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
double updateValue(K key, double initialValueIfAbsent, DoubleToDoubleFunction 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 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
MutableDoubleObjectMap<K> flipUniqueValues()
Description copied from interface:ObjectDoubleMap
Return the DoubleObjectMap that is obtained by flipping the direction of this map and making the associations from value to key.- Specified by:
flipUniqueValues
in interfaceObjectDoubleMap<K>
-
select
MutableObjectDoubleMap<K> select(ObjectDoublePredicate<? super K> predicate)
Description copied from interface:ObjectDoubleMap
Return a copy of this map containing only the key/value pairs that match the predicate.- Specified by:
select
in interfaceObjectDoubleMap<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
MutableObjectDoubleMap<K> reject(ObjectDoublePredicate<? super K> predicate)
Description copied from interface:ObjectDoubleMap
Return a copy of this map containing only the key/value pairs that do not match the predicate.- Specified by:
reject
in interfaceObjectDoubleMap<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
MutableDoubleCollection select(DoublePredicate predicate)
Description copied from interface:DoubleIterable
Returns a new DoubleIterable with all of the elements in the DoubleIterable that return true for the specified predicate.- Specified by:
select
in interfaceDoubleIterable
-
reject
MutableDoubleCollection reject(DoublePredicate predicate)
Description copied from interface:DoubleIterable
Returns a new DoubleIterable with all of the elements in the DoubleIterable that return false for the specified predicate.- Specified by:
reject
in interfaceDoubleIterable
-
tap
default MutableObjectDoubleMap<K> tap(DoubleProcedure procedure)
- Specified by:
tap
in interfaceDoubleIterable
- Specified by:
tap
in interfaceObjectDoubleMap<K>
- Since:
- 9.0.
-
collect
<V> MutableCollection<V> collect(DoubleToObjectFunction<? extends V> function)
Description copied from interface:DoubleIterable
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 interfaceDoubleIterable
-
withKeyValue
MutableObjectDoubleMap<K> withKeyValue(K key, double value)
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, double)
-
withoutKey
MutableObjectDoubleMap<K> withoutKey(K 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(Object)
-
withoutAllKeys
MutableObjectDoubleMap<K> withoutAllKeys(java.lang.Iterable<? extends K> 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(Object)
-
withAllKeyValues
default MutableObjectDoubleMap<K> withAllKeyValues(java.lang.Iterable<ObjectDoublePair<K>> keyValuePairs)
-
asUnmodifiable
MutableObjectDoubleMap<K> asUnmodifiable()
-
asSynchronized
MutableObjectDoubleMap<K> asSynchronized()
-
addToValue
double addToValue(K key, double toBeAdded)
-
-