public interface Reference2DoubleMap<K> extends Reference2DoubleFunction<K>, java.util.Map<K,java.lang.Double>
Map
; provides some additional methods that use polymorphism to avoid (un)boxing, and handling of a default return value.
Besides extending the corresponding type-specific function, this interface strengthens Map.entrySet()
,
keySet()
and values()
. Moreover, a number of methods, such as size()
, defaultReturnValue()
, etc., are un-defaulted
as their function default do not make sense for a map.
Maps returning entry sets of type Reference2DoubleMap.FastEntrySet
support also fast iteration.
This interface specifies reference equality semantics (members will be compared equal with
==
instead of equals
) for its keys or values (or both), which may result in breaks in contract
if attempted to be used with non reference-equality semantics based Map
s. For example, a
aReferenceToIntMap.equals(aObjectToIntMap)
may return different a different result then
aObjectToIntMap.equals(aReferenceToIntMap)
, in violation of equals
's
contract requiring it being symmetric.
A submap or subset may or may not have an independent default return value (which however must be initialized to the default return value of the originator).
Map
Modifier and Type | Interface and Description |
---|---|
static interface |
Reference2DoubleMap.Entry<K>
A type-specific
Map.Entry ; provides some additional methods
that use polymorphism to avoid (un)boxing. |
static interface |
Reference2DoubleMap.FastEntrySet<K>
An entry set providing fast iteration.
|
Modifier and Type | Method and Description |
---|---|
default void |
clear()
Removes all of the mappings from this map (optional operation).
|
default double |
computeDouble(K key,
java.util.function.BiFunction<? super K,? super java.lang.Double,? extends java.lang.Double> remappingFunction)
Attempts to compute a mapping for the specified key and its current mapped value (or
null if there is no current mapping). |
default double |
computeDoubleIfAbsent(K key,
java.util.function.ToDoubleFunction<? super K> mappingFunction)
Deprecated.
Please use
computeIfAbsent() instead. |
default double |
computeDoubleIfAbsentPartial(K key,
Reference2DoubleFunction<? super K> mappingFunction)
Deprecated.
Please use
computeIfAbsent() instead. |
default double |
computeDoubleIfPresent(K key,
java.util.function.BiFunction<? super K,? super java.lang.Double,? extends java.lang.Double> remappingFunction)
If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.
|
default double |
computeIfAbsent(K key,
Reference2DoubleFunction<? super K> mappingFunction)
If the specified key is not already associated with a value, attempts to compute its value
using the given mapping function and enters it into this map, unless the key is not present
in the given mapping function.
|
default double |
computeIfAbsent(K key,
java.util.function.ToDoubleFunction<? super K> mappingFunction)
If the specified key is not already associated with a value, attempts to compute its value
using the given mapping function and enters it into this map.
|
boolean |
containsKey(java.lang.Object key)
Returns true if this function contains a mapping for the specified key.
|
boolean |
containsValue(double value)
Returns
true if this map maps one or more keys to the specified value. |
default boolean |
containsValue(java.lang.Object value)
Deprecated.
Please use the corresponding type-specific method instead.
|
double |
defaultReturnValue()
Gets the default return value.
|
void |
defaultReturnValue(double rv)
Sets the default return value (optional operation).
|
default ObjectSet<java.util.Map.Entry<K,java.lang.Double>> |
entrySet()
Deprecated.
Please use the corresponding type-specific method instead.
|
default void |
forEach(java.util.function.BiConsumer<? super K,? super java.lang.Double> consumer) |
default java.lang.Double |
get(java.lang.Object key)
Deprecated.
Please use the corresponding type-specific method instead.
|
default double |
getOrDefault(java.lang.Object key,
double defaultValue)
Returns the value to which the specified key is mapped, or the
defaultValue if this
map contains no mapping for the key. |
default java.lang.Double |
getOrDefault(java.lang.Object key,
java.lang.Double defaultValue)
Deprecated.
Please use the corresponding type-specific method instead.
|
ReferenceSet<K> |
keySet() |
default double |
merge(K key,
double value,
java.util.function.BiFunction<? super java.lang.Double,? super java.lang.Double,? extends java.lang.Double> remappingFunction)
If the specified key is not already associated with a value, associates it with the given
value . |
default java.lang.Double |
merge(K key,
java.lang.Double value,
java.util.function.BiFunction<? super java.lang.Double,? super java.lang.Double,? extends java.lang.Double> remappingFunction)
Deprecated.
Please use the corresponding type-specific method instead.
|
default double |
mergeDouble(K key,
double value,
java.util.function.BiFunction<? super java.lang.Double,? super java.lang.Double,? extends java.lang.Double> remappingFunction)
Deprecated.
Please use
merge() instead. |
default double |
mergeDouble(K key,
double value,
java.util.function.DoubleBinaryOperator remappingFunction)
If the specified key is not already associated with a value, associates it with the given
value . |
default double |
mergeDouble(K key,
double value,
DoubleBinaryOperator remappingFunction)
If the specified key is not already associated with a value, associates it with the given
value . |
default java.lang.Double |
put(K key,
java.lang.Double value)
Deprecated.
Please use the corresponding type-specific method instead.
|
default double |
putIfAbsent(K key,
double value)
If the specified key is not already associated with a value, associates it with the given
value and returns the default return value, else returns
the current value.
|
default java.lang.Double |
putIfAbsent(K key,
java.lang.Double value)
Deprecated.
Please use the corresponding type-specific method instead.
|
ObjectSet<Reference2DoubleMap.Entry<K>> |
reference2DoubleEntrySet()
Returns a type-specific set view of the mappings contained in this map.
|
default java.lang.Double |
remove(java.lang.Object key)
Deprecated.
Please use the corresponding type-specific method instead.
|
default boolean |
remove(java.lang.Object key,
double value)
Removes the entry for the specified key only if it is currently mapped to the specified value.
|
default boolean |
remove(java.lang.Object key,
java.lang.Object value)
Deprecated.
Please use the corresponding type-specific method instead.
|
default double |
replace(K key,
double value)
Replaces the entry for the specified key only if it is currently mapped to some value.
|
default java.lang.Double |
replace(K key,
java.lang.Double value)
Deprecated.
Please use the corresponding type-specific method instead.
|
default boolean |
replace(K key,
double oldValue,
double newValue)
Replaces the entry for the specified key only if currently mapped to the specified value.
|
default boolean |
replace(K key,
java.lang.Double oldValue,
java.lang.Double newValue)
Deprecated.
Please use the corresponding type-specific method instead.
|
int |
size()
Returns the number of key/value mappings in this map.
|
DoubleCollection |
values() |
andThen, andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, applyAsDouble, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort, getDouble, put, removeDouble
int size()
Integer.MAX_VALUE
elements, returns Integer.MAX_VALUE
.default void clear()
clear
in interface java.util.Map<K,java.lang.Double>
java.lang.UnsupportedOperationException
- if the clear()
operation is not supported by this mapMap.clear()
void defaultReturnValue(double rv)
get()
,
put()
and remove()
to denote that the map does not contain
the specified key. It must be 0/false
by default.defaultReturnValue
in interface Reference2DoubleFunction<K>
rv
- the new default return value.defaultReturnValue()
double defaultReturnValue()
defaultReturnValue
in interface Reference2DoubleFunction<K>
ObjectSet<Reference2DoubleMap.Entry<K>> reference2DoubleEntrySet()
This method is necessary because there is no inheritance along
type parameters: it is thus impossible to strengthen Map.entrySet()
so that it returns an ObjectSet
of type-specific entries (the latter makes it possible to
access keys and values with type-specific methods).
Map.entrySet()
@Deprecated default ObjectSet<java.util.Map.Entry<K,java.lang.Double>> entrySet()
entrySet
in interface java.util.Map<K,java.lang.Double>
Map.entrySet()
Map.entrySet()
.@Deprecated default java.lang.Double put(K key, java.lang.Double value)
This default implementation just delegates to the corresponding type-specific–function method.
put
in interface java.util.Map<K,java.lang.Double>
put
in interface Reference2DoubleFunction<K>
key
- the key.value
- the value.null
if no value was present for the given key.Map.put(Object,Object)
@Deprecated default java.lang.Double get(java.lang.Object key)
This default implementation just delegates to the corresponding type-specific–function method.
get
in interface java.util.Map<K,java.lang.Double>
get
in interface Reference2DoubleFunction<K>
key
- the key.null
if no value was present for the given key.Map.get(Object)
@Deprecated default java.lang.Double remove(java.lang.Object key)
This default implementation just delegates to the corresponding type-specific–function method.
remove
in interface java.util.Map<K,java.lang.Double>
remove
in interface Reference2DoubleFunction<K>
key
- the key.null
if no value was present for the given key.Map.remove(Object)
ReferenceSet<K> keySet()
keySet
in interface java.util.Map<K,java.lang.Double>
Map.keySet()
Map.keySet()
.DoubleCollection values()
values
in interface java.util.Map<K,java.lang.Double>
Map.values()
Map.values()
.boolean containsKey(java.lang.Object key)
containsKey
in interface java.util.Map<K,java.lang.Double>
key
- the key.key
.Map.containsKey(Object)
boolean containsValue(double value)
true
if this map maps one or more keys to the specified value.Map.containsValue(Object)
@Deprecated default boolean containsValue(java.lang.Object value)
containsValue
in interface java.util.Map<K,java.lang.Double>
default void forEach(java.util.function.BiConsumer<? super K,? super java.lang.Double> consumer)
forEach
in interface java.util.Map<K,java.lang.Double>
default double getOrDefault(java.lang.Object key, double defaultValue)
defaultValue
if this
map contains no mapping for the key.getOrDefault
in interface Reference2DoubleFunction<K>
key
- the key.defaultValue
- the default mapping of the key.defaultValue
if this map contains no mapping for the key.Map.getOrDefault(Object, Object)
@Deprecated default java.lang.Double getOrDefault(java.lang.Object key, java.lang.Double defaultValue)
This default implementation just delegates to the corresponding Map
method.
getOrDefault
in interface java.util.Map<K,java.lang.Double>
getOrDefault
in interface Reference2DoubleFunction<K>
key
- the key.defaultValue
- the default value to return if not present.defaultValue
if no value was present for the
given key.Map.getOrDefault(Object, Object)
default double putIfAbsent(K key, double value)
key
- key with which the specified value is to be associated.value
- value to be associated with the specified key.Map.putIfAbsent(Object, Object)
default boolean remove(java.lang.Object key, double value)
key
- key with which the specified value is associated.value
- value expected to be associated with the specified key.true
if the value was removed.Map.remove(Object, Object)
default boolean replace(K key, double oldValue, double newValue)
key
- key with which the specified value is associated.oldValue
- value expected to be associated with the specified key.newValue
- value to be associated with the specified key.true
if the value was replaced.Map.replace(Object, Object, Object)
default double replace(K key, double value)
key
- key with which the specified value is associated.value
- value to be associated with the specified key.Map.replace(Object, Object)
default double computeIfAbsent(K key, java.util.function.ToDoubleFunction<? super K> mappingFunction)
Note that contrarily to the default computeIfAbsent(),
it is not possible to not add a value for a given key, since the mappingFunction
cannot
return null
. If such a behavior is needed, please use the corresponding nullable version.
key
- key with which the specified value is to be associated.mappingFunction
- the function to compute a value.Map.computeIfAbsent(Object, java.util.function.Function)
computeIfAbsent()
methods have a different logic based on the argument;
no delegation is performed, contrarily to other superficially similar
methods such as Iterator.forEachRemaining(java.util.function.Consumer<? super E>)
or List.replaceAll(java.util.function.UnaryOperator<E>)
.@Deprecated default double computeDoubleIfAbsent(K key, java.util.function.ToDoubleFunction<? super K> mappingFunction)
computeIfAbsent()
instead.default double computeIfAbsent(K key, Reference2DoubleFunction<? super K> mappingFunction)
This version of computeIfAbsent()
uses a type-specific version of fastutil
's Function
.
Since Function
has a containsKey()
method, it is possible to avoid adding a key by having containsKey()
return false
for that key.
key
- key with which the specified value is to be associated.mappingFunction
- the function to compute a value.Map.computeIfAbsent(Object, java.util.function.Function)
computeIfAbsent()
methods have a different logic based on the argument;
no delegation is performed, contrarily to other superficially similar
methods such as Iterator.forEachRemaining(java.util.function.Consumer<? super E>)
or List.replaceAll(java.util.function.UnaryOperator<E>)
.@Deprecated default double computeDoubleIfAbsentPartial(K key, Reference2DoubleFunction<? super K> mappingFunction)
computeIfAbsent()
instead.default double computeDoubleIfPresent(K key, java.util.function.BiFunction<? super K,? super java.lang.Double,? extends java.lang.Double> remappingFunction)
key
- key with which the specified value is to be associated.remappingFunction
- the function to compute a value.Map.computeIfPresent(Object, java.util.function.BiFunction)
default double computeDouble(K key, java.util.function.BiFunction<? super K,? super java.lang.Double,? extends java.lang.Double> remappingFunction)
null
if there is no current mapping).
If the function returns null
, the mapping is removed (or remains absent if initially absent).
If the function itself throws an (unchecked) exception, the exception is rethrown, and the current mapping is left unchanged.
key
- key with which the specified value is to be associated.remappingFunction
- the function to compute a value.Map.compute(Object, java.util.function.BiFunction)
default double merge(K key, double value, java.util.function.BiFunction<? super java.lang.Double,? super java.lang.Double,? extends java.lang.Double> remappingFunction)
value
.
Otherwise, replaces the associated value with the results of the given remapping function, or removes if the result is null
.key
- key with which the resulting value is to be associated.value
- the value to be merged with the existing value associated with the key or, if no existing value is associated with the key, to be associated with the key.remappingFunction
- the function to recompute a value if present.Map.merge(Object, Object, java.util.function.BiFunction)
default double mergeDouble(K key, double value, java.util.function.DoubleBinaryOperator remappingFunction)
value
.
Otherwise, replaces the associated value with the results of the given remapping function.key
- key with which the resulting value is to be associated.value
- the value to be merged with the existing value associated with the key or, if no existing value is associated with the key, to be associated with the key.remappingFunction
- the function to recompute a value if present.Map.merge(Object, Object, java.util.function.BiFunction)
null
.default double mergeDouble(K key, double value, DoubleBinaryOperator remappingFunction)
value
.
Otherwise, replaces the associated value with the results of the given remapping function.key
- key with which the resulting value is to be associated.value
- the value to be merged with the existing value associated with the key or, if no existing value is associated with the key, to be associated with the key.remappingFunction
- the function to recompute a value if present.Map.merge(Object, Object, java.util.function.BiFunction)
null
.
WARNING: Overriding this method is almost always a mistake, as this
overload only exists to disambiguate. Instead, override the overload
that uses the JDK's primitive binary operator (e.g. IntBinaryOperator
).
If Java supported final default methods, this would be one, but sadly it does not.
If you checked and are overriding the version with java.util.function.XBinaryOperator
, and
still see this warning, then your IDE is incorrectly conflating this method with the proper
method to override, and you can safely ignore this message.
@Deprecated default double mergeDouble(K key, double value, java.util.function.BiFunction<? super java.lang.Double,? super java.lang.Double,? extends java.lang.Double> remappingFunction)
merge()
instead.@Deprecated default java.lang.Double putIfAbsent(K key, java.lang.Double value)
This default implementation just delegates to the corresponding Map
method.
putIfAbsent
in interface java.util.Map<K,java.lang.Double>
@Deprecated default boolean remove(java.lang.Object key, java.lang.Object value)
This default implementation just delegates to the corresponding Map
method.
remove
in interface java.util.Map<K,java.lang.Double>
@Deprecated default boolean replace(K key, java.lang.Double oldValue, java.lang.Double newValue)
This default implementation just delegates to the corresponding Map
method.
replace
in interface java.util.Map<K,java.lang.Double>
@Deprecated default java.lang.Double replace(K key, java.lang.Double value)
This default implementation just delegates to the corresponding Map
method.
replace
in interface java.util.Map<K,java.lang.Double>
@Deprecated default java.lang.Double merge(K key, java.lang.Double value, java.util.function.BiFunction<? super java.lang.Double,? super java.lang.Double,? extends java.lang.Double> remappingFunction)
This default implementation just delegates to the corresponding Map
method.
merge
in interface java.util.Map<K,java.lang.Double>