public interface Double2ReferenceMap<V> extends Double2ReferenceFunction<V>, Map<Double,V>
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
Double2ReferenceMap.FastEntrySet support also fast iteration.
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 |
Double2ReferenceMap.Entry<V>
A type-specific
Map.Entry; provides some additional
methods that use polymorphism to avoid (un)boxing. |
static interface |
Double2ReferenceMap.FastEntrySet<V>
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 V |
compute(double key,
BiFunction<? super Double,? super V,? extends V> remappingFunction)
Attempts to compute a mapping for the specified key and its current
mapped value (or
null if there is no current mapping). |
default V |
compute(Double key,
BiFunction<? super Double,? super V,? extends V> remappingFunction)
Deprecated.
Please use the corresponding type-specific method instead.
|
default V |
computeIfAbsent(double key,
DoubleFunction<? extends V> 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.
|
default V |
computeIfAbsent(Double key,
Function<? super Double,? extends V> mappingFunction)
Deprecated.
Please use the corresponding type-specific method instead.
|
default V |
computeIfAbsentPartial(double key,
Double2ReferenceFunction<? extends V> 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 V |
computeIfPresent(double key,
BiFunction<? super Double,? super V,? extends V> 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 V |
computeIfPresent(Double key,
BiFunction<? super Double,? super V,? extends V> remappingFunction)
Deprecated.
Please use the corresponding type-specific method instead.
|
boolean |
containsKey(double key)
Returns true if this function contains a mapping for the specified key.
|
default boolean |
containsKey(Object key)
Deprecated.
Please use the corresponding type-specific method instead.
|
V |
defaultReturnValue()
Gets the default return value.
|
void |
defaultReturnValue(V rv)
Sets the default return value (optional operation).
|
ObjectSet<Double2ReferenceMap.Entry<V>> |
double2ReferenceEntrySet()
Returns a type-specific set view of the mappings contained in this map.
|
default ObjectSet<Map.Entry<Double,V>> |
entrySet()
Deprecated.
Please use the corresponding type-specific method instead.
|
default V |
get(Object key)
Deprecated.
Please use the corresponding type-specific method instead.
|
default V |
getOrDefault(double key,
V defaultValue)
Returns the value to which the specified key is mapped, or the
defaultValue if this map contains no mapping for the key. |
default V |
getOrDefault(Object key,
V defaultValue)
Deprecated.
Please use the corresponding type-specific method instead.
|
DoubleSet |
keySet()
Returns a
Set view of the keys contained in this map. |
default V |
merge(double key,
V value,
BiFunction<? super V,? super V,? extends V> remappingFunction)
If the specified key is not already associated with a value or is
associated with null, associates it with the given non-null
value. |
default V |
merge(Double key,
V value,
BiFunction<? super V,? super V,? extends V> remappingFunction)
Deprecated.
Please use the corresponding type-specific method instead.
|
default V |
put(Double key,
V value)
Deprecated.
Please use the corresponding type-specific method instead.
|
default V |
putIfAbsent(double key,
V 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 V |
putIfAbsent(Double key,
V value)
Deprecated.
Please use the corresponding type-specific method instead.
|
default boolean |
remove(double key,
Object value)
Removes the entry for the specified key only if it is currently mapped to
the specified value.
|
default V |
remove(Object key)
Deprecated.
Please use the corresponding type-specific method instead.
|
default boolean |
remove(Object key,
Object value)
Deprecated.
Please use the corresponding type-specific method instead.
|
default V |
replace(double key,
V value)
Replaces the entry for the specified key only if it is currently mapped
to some value.
|
default V |
replace(Double key,
V value)
Deprecated.
Please use the corresponding type-specific method instead.
|
default boolean |
replace(double key,
V oldValue,
V newValue)
Replaces the entry for the specified key only if currently mapped to the
specified value.
|
default boolean |
replace(Double key,
V oldValue,
V newValue)
Deprecated.
Please use the corresponding type-specific method instead.
|
int |
size()
Returns the number of key/value mappings in this map.
|
ReferenceCollection<V> |
values()
Returns a
Collection view of the values contained in this map. |
apply, get, put, removecontainsValue, equals, forEach, hashCode, isEmpty, putAll, replaceAllint size()
Integer.MAX_VALUE elements, returns
Integer.MAX_VALUE.default void clear()
clear in interface Map<Double,V>UnsupportedOperationException - if the clear operation is not supported by this mapMap.clear()void defaultReturnValue(V rv)
get(),
put() and remove() to denote that the map does not
contain the specified key. It must be null by default.
Warning: Changing this to a non-null value can have
unforeseen consequences. Especially, it breaks compatibility with the
specifications of Java's Map interface. It has to be
used with great care and thorough study of all method comments is
recommended.
defaultReturnValue in interface Double2ReferenceFunction<V>rv - the new default return value.defaultReturnValue()V defaultReturnValue()
defaultReturnValue in interface Double2ReferenceFunction<V>ObjectSet<Double2ReferenceMap.Entry<V>> double2ReferenceEntrySet()
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<Map.Entry<Double,V>> entrySet()
Note that this specification strengthens the one given in
Map.entrySet().
entrySet in interface Map<Double,V>Map.entrySet()@Deprecated default V put(Double key, V value)
This default implementation just delegates to the corresponding type-specific–function method.
put in interface Double2ReferenceFunction<V>put in interface Map<Double,V>key - the key.value - the value.null if no value was present for the given key.Map.put(Object,Object)@Deprecated default V get(Object key)
This default implementation just delegates to the corresponding type-specific–function method.
get in interface Double2ReferenceFunction<V>get in interface Map<Double,V>key - the key.null if no value was present for the given key.Map.get(Object)@Deprecated default V remove(Object key)
This default implementation just delegates to the corresponding type-specific–function method.
remove in interface Double2ReferenceFunction<V>remove in interface Map<Double,V>key - the key.null if no value was present for the given key.Map.remove(Object)DoubleSet keySet()
Set view of the keys contained in this map.
The set is backed by the map, so changes to the map are
reflected in the set, and vice-versa. If the map is modified
while an iteration over the set is in progress (except through
the iterator's own remove operation), the results of
the iteration are undefined. The set supports element removal,
which removes the corresponding mapping from the map, via the
Iterator.remove, Set.remove,
removeAll, retainAll, and clear
operations. It does not support the add or addAll
operations.
Note that this specification strengthens the one given in
Map.keySet().
keySet in interface Map<Double,V>Map.keySet()ReferenceCollection<V> values()
Collection view of the values contained in this map.
The collection is backed by the map, so changes to the map are
reflected in the collection, and vice-versa. If the map is
modified while an iteration over the collection is in progress
(except through the iterator's own remove operation),
the results of the iteration are undefined. The collection
supports element removal, which removes the corresponding
mapping from the map, via the Iterator.remove,
Collection.remove, removeAll,
retainAll and clear operations. It does not
support the add or addAll operations.
Note that this specification strengthens the one given in
Map.values().
values in interface Map<Double,V>Map.values()boolean containsKey(double key)
containsKey in interface Double2ReferenceFunction<V>key - the key.key.Map.containsKey(Object)@Deprecated default boolean containsKey(Object key)
This default implementation just delegates to the corresponding type-specific–function method.
containsKey in interface Double2ReferenceFunction<V>containsKey in interface Map<Double,V>key - the key.key.Map.containsKey(Object)default V getOrDefault(double key, V defaultValue)
defaultValue if this map contains no mapping for the key.key - the key.defaultValue - the default mapping of the key.defaultValue if this map contains no mapping for the key.Map.getOrDefault(Object, Object)default V putIfAbsent(double key, V 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(double key,
Object 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(double key,
V oldValue,
V 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 V replace(double key, V value)
key - key with which the specified value is associated.value - value to be associated with the specified key.Map.replace(Object, Object)default V computeIfAbsent(double key, DoubleFunction<? extends V> 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)default V computeIfAbsentPartial(double key, Double2ReferenceFunction<? extends V> 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)default V computeIfPresent(double key, BiFunction<? super Double,? super V,? extends V> 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 V compute(double key, BiFunction<? super Double,? super V,? extends V> 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 V merge(double key, V value, BiFunction<? super V,? super V,? extends V> 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 non-null 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)@Deprecated default V getOrDefault(Object key, V defaultValue)
defaultValue if this map contains no mapping for the key.
This default implementation just delegates to the corresponding
Map method.
getOrDefault in interface Map<Double,V>key - the key whose associated value is to be returneddefaultValue - the default mapping of the keydefaultValue if this map contains no mapping for the key@Deprecated default V putIfAbsent(Double key, V value)
null) associates it with the given value and returns
null, else returns the current value.
This default implementation just delegates to the corresponding
Map method.
putIfAbsent in interface Map<Double,V>key - key with which the specified value is to be associatedvalue - value to be associated with the specified keynull if there was no mapping for the key.
(A null return can also indicate that the map
previously associated null with the key,
if the implementation supports null values.)@Deprecated default boolean remove(Object key, Object value)
This default implementation just delegates to the corresponding
Map method.
@Deprecated default boolean replace(Double key, V oldValue, V newValue)
This default implementation just delegates to the corresponding
Map method.
@Deprecated default V replace(Double key, V value)
This default implementation just delegates to the corresponding
Map method.
replace in interface Map<Double,V>key - key with which the specified value is associatedvalue - value to be associated with the specified keynull if there was no mapping for the key.
(A null return can also indicate that the map
previously associated null with the key,
if the implementation supports null values.)@Deprecated default V computeIfAbsent(Double key, Function<? super Double,? extends V> mappingFunction)
null), attempts to compute its value using the given mapping
function and enters it into this map unless null.
If the function returns null no mapping is recorded. If
the function itself throws an (unchecked) exception, the
exception is rethrown, and no mapping is recorded. The most
common usage is to construct a new object serving as an initial
mapped value or memoized result, as in:
map.computeIfAbsent(key, k -> new Value(f(k)));
Or to implement a multi-value map, Map<K,Collection<V>>,
supporting multiple values per key:
map.computeIfAbsent(key, k -> new HashSet<V>()).add(v);
This default implementation just delegates to the corresponding
Map method.
computeIfAbsent in interface Map<Double,V>key - key with which the specified value is to be associatedmappingFunction - the function to compute a value@Deprecated default V computeIfPresent(Double key, BiFunction<? super Double,? super V,? extends V> remappingFunction)
If the function returns null, the mapping is removed. If the
function itself throws an (unchecked) exception, the exception is
rethrown, and the current mapping is left unchanged.
This default implementation just delegates to the corresponding
Map method.
computeIfPresent in interface Map<Double,V>key - key with which the specified value is to be associatedremappingFunction - the function to compute a value@Deprecated default V compute(Double key, BiFunction<? super Double,? super V,? extends V> remappingFunction)
null if there is no current mapping). For
example, to either create or append a String msg to a value
mapping:
map.compute(key, (k, v) -> (v == null) ? msg : v.concat(msg))
(Method merge() is often simpler to use for such purposes.)
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.
This default implementation just delegates to the corresponding
Map method.
@Deprecated default V merge(Double key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction)
null. This
method may be of use when combining multiple mapped values for a key.
For example, to either create or append a String msg to a
value mapping:
map.merge(key, msg, String::concat)
If the function returns null the mapping is removed. If the
function itself throws an (unchecked) exception, the exception is
rethrown, and the current mapping is left unchanged.
This default implementation just delegates to the corresponding
Map method.
merge in interface Map<Double,V>key - key with which the resulting value is to be associatedvalue - the non-null value to be merged with the existing value
associated with the key or, if no existing value or a null value
is associated with the key, to be associated with the keyremappingFunction - the function to recompute a value if present