public interface Object2FloatMap<K> extends Object2FloatFunction<K>, Map<K,Float>
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
Object2FloatMap.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 |
Object2FloatMap.Entry<K>
A type-specific
Map.Entry; provides some additional
methods that use polymorphism to avoid (un)boxing. |
static interface |
Object2FloatMap.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 float |
computeFloat(K key,
BiFunction<? super K,? super Float,? extends Float> remappingFunction)
Attempts to compute a mapping for the specified key and its current
mapped value (or
null if there is no current mapping). |
default float |
computeFloatIfAbsent(K key,
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.
|
default float |
computeFloatIfAbsentPartial(K key,
Object2FloatFunction<? 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 float |
computeFloatIfPresent(K key,
BiFunction<? super K,? super Float,? extends Float> remappingFunction)
If the value for the specified key is present, attempts to compute a new
mapping given the key and its current mapped value.
|
boolean |
containsKey(Object key)
Returns true if this function contains a mapping for the specified key.
|
boolean |
containsValue(float value)
Returns
true if this map maps one or more keys to the specified
value. |
default boolean |
containsValue(Object value)
Deprecated.
Please use the corresponding type-specific method instead.
|
float |
defaultReturnValue()
Gets the default return value.
|
void |
defaultReturnValue(float rv)
Sets the default return value (optional operation).
|
default ObjectSet<Map.Entry<K,Float>> |
entrySet()
Deprecated.
Please use the corresponding type-specific method instead.
|
default Float |
get(Object key)
Deprecated.
Please use the corresponding type-specific method instead.
|
default float |
getOrDefault(Object key,
float defaultValue)
Returns the value to which the specified key is mapped, or the
defaultValue if this map contains no mapping for the key. |
default Float |
getOrDefault(Object key,
Float defaultValue)
Deprecated.
Please use the corresponding type-specific method instead.
|
ObjectSet<K> |
keySet()
Returns a
Set view of the keys contained in this map. |
default Float |
merge(K key,
Float value,
BiFunction<? super Float,? super Float,? extends Float> remappingFunction)
Deprecated.
Please use the corresponding type-specific method instead.
|
default float |
mergeFloat(K key,
float value,
BiFunction<? super Float,? super Float,? extends Float> remappingFunction)
If the specified key is not already associated with a value, associates
it with the given
value. |
ObjectSet<Object2FloatMap.Entry<K>> |
object2FloatEntrySet()
Returns a type-specific set view of the mappings contained in this map.
|
default Float |
put(K key,
Float value)
Deprecated.
Please use the corresponding type-specific method instead.
|
default float |
putIfAbsent(K key,
float 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 Float |
putIfAbsent(K key,
Float value)
Deprecated.
Please use the corresponding type-specific method instead.
|
default Float |
remove(Object key)
Deprecated.
Please use the corresponding type-specific method instead.
|
default boolean |
remove(Object key,
float value)
Removes the entry for the specified key only if it is currently mapped to
the specified value.
|
default boolean |
remove(Object key,
Object value)
Deprecated.
Please use the corresponding type-specific method instead.
|
default float |
replace(K key,
float value)
Replaces the entry for the specified key only if it is currently mapped
to some value.
|
default Float |
replace(K key,
Float value)
Deprecated.
Please use the corresponding type-specific method instead.
|
default boolean |
replace(K key,
float oldValue,
float newValue)
Replaces the entry for the specified key only if currently mapped to the
specified value.
|
default boolean |
replace(K key,
Float oldValue,
Float newValue)
Deprecated.
Please use the corresponding type-specific method instead.
|
int |
size()
Returns the number of key/value mappings in this map.
|
FloatCollection |
values()
Returns a
Collection view of the values contained in this map. |
applyAsDouble, getFloat, put, removeFloatcompute, computeIfAbsent, computeIfPresent, equals, forEach, hashCode, isEmpty, putAll, replaceAllint size()
Integer.MAX_VALUE elements, returns
Integer.MAX_VALUE.default void clear()
clear in interface Map<K,Float>UnsupportedOperationException - if the clear operation is not supported by this mapMap.clear()void defaultReturnValue(float 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 Object2FloatFunction<K>rv - the new default return value.defaultReturnValue()float defaultReturnValue()
defaultReturnValue in interface Object2FloatFunction<K>ObjectSet<Object2FloatMap.Entry<K>> object2FloatEntrySet()
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<K,Float>> entrySet()
Note that this specification strengthens the one given in
Map.entrySet().
entrySet in interface Map<K,Float>Map.entrySet()@Deprecated default Float put(K key, Float value)
This default implementation just delegates to the corresponding type-specific–function method.
put in interface Map<K,Float>put in interface Object2FloatFunction<K>key - the key.value - the value.null if no value was present for the given key.Map.put(Object,Object)@Deprecated default Float get(Object key)
This default implementation just delegates to the corresponding type-specific–function method.
get in interface Map<K,Float>get in interface Object2FloatFunction<K>key - the key.null if no value was present for the given key.Map.get(Object)@Deprecated default Float remove(Object key)
This default implementation just delegates to the corresponding type-specific–function method.
remove in interface Map<K,Float>remove in interface Object2FloatFunction<K>key - the key.null if no value was present for the given key.Map.remove(Object)ObjectSet<K> 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<K,Float>Map.keySet()FloatCollection 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<K,Float>Map.values()boolean containsKey(Object key)
containsKey in interface Map<K,Float>key - the key.key.Map.containsKey(Object)boolean containsValue(float value)
true if this map maps one or more keys to the specified
value.Map.containsValue(Object)@Deprecated default boolean containsValue(Object value)
containsValue in interface Map<K,Float>value - value whose presence in this map is to be testeddefault float getOrDefault(Object key, float 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 float putIfAbsent(K key, float 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(Object key, float 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, float oldValue, float 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 float replace(K key, float value)
key - key with which the specified value is associated.value - value to be associated with the specified key.Map.replace(Object, Object)default float computeFloatIfAbsent(K key, 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)default float computeFloatIfAbsentPartial(K key, Object2FloatFunction<? 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)default float computeFloatIfPresent(K key, BiFunction<? super K,? super Float,? extends Float> 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 float computeFloat(K key, BiFunction<? super K,? super Float,? extends Float> 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 float mergeFloat(K key, float value, BiFunction<? super Float,? super Float,? extends Float> 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)@Deprecated default Float getOrDefault(Object key, Float 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<K,Float>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 Float putIfAbsent(K key, Float 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<K,Float>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(K key, Float oldValue, Float newValue)
This default implementation just delegates to the corresponding
Map method.
@Deprecated default Float replace(K key, Float value)
This default implementation just delegates to the corresponding
Map method.
replace in interface Map<K,Float>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 Float merge(K key, Float value, BiFunction<? super Float,? super Float,? extends Float> 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<K,Float>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