public interface CharFloatMap extends Map<Character,Float>, Container
Map specialization with char keys and float values.CharFloatMapFactory| Modifier and Type | Method and Description |
|---|---|
float |
addValue(char key,
float addition)
Adds the given
addition value to the value associated with the specified key,
or default
value if this map contains no mapping for the key, and associates the resulting
value with the key. |
float |
addValue(char key,
float addition,
float defaultValue)
Adds the given
addition value to the value associated with the specified key,
or defaultValue if this map contains no mapping for the key, and associates
the resulting value with the key. |
Float |
compute(Character key,
java.util.function.BiFunction<? super Character,? super Float,? extends Float> remappingFunction)
Deprecated.
Use specialization
compute(char, CharFloatToFloatFunction) instead |
float |
compute(char key,
CharFloatToFloatFunction remappingFunction)
Attempts to compute a mapping for the specified key and its current mapped value
(or default
value if there is no current mapping).
|
Float |
computeIfAbsent(Character key,
java.util.function.Function<? super Character,? extends Float> mappingFunction)
Deprecated.
Use specialization
computeIfAbsent(char, CharToFloatFunction) instead |
float |
computeIfAbsent(char key,
CharToFloatFunction 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
.
|
Float |
computeIfPresent(Character key,
java.util.function.BiFunction<? super Character,? super Float,? extends Float> remappingFunction)
Deprecated.
Use specialization
computeIfPresent(char, CharFloatToFloatFunction) instead |
float |
computeIfPresent(char key,
CharFloatToFloatFunction 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(char key)
Returns
true if this map contains a mapping for the specified key. |
boolean |
containsKey(Object key)
Deprecated.
Use specialization
containsKey(char) instead |
boolean |
containsValue(float value)
Returns
true if this map maps one or more keys to the specified value. |
boolean |
containsValue(Object value)
Deprecated.
Use specialization
containsValue(float) instead |
CharFloatCursor |
cursor()
Returns a new cursor over the entries of this map.
|
float |
defaultValue()
Returns the default value of this map, which is used instead of
null
in primitive specialization methods, when the key is absent in the map. |
ObjSet<Map.Entry<Character,Float>> |
entrySet()
Returns a
Set view of the mappings contained in this map. |
void |
forEach(java.util.function.BiConsumer<? super Character,? super Float> action)
Deprecated.
Use specialization
forEach(CharFloatConsumer) instead |
void |
forEach(CharFloatConsumer action)
Performs the given
action on each entry in this map until all entries
have been processed or the action throws an Exception. |
boolean |
forEachWhile(CharFloatPredicate predicate)
Checks the given
predicate on each entry in this map until all entries
have been processed or the predicate returns false for some entry,
or throws an Exception. |
float |
get(char key)
Returns the value to which the specified key is mapped, or default
value if this map
contains no mapping for the key.
|
Float |
get(Object key)
Deprecated.
Use specialization
get(char) instead |
float |
getOrDefault(char key,
float defaultValue)
Returns the value to which the specified key is mapped, or
defaultValue if this map
contains no mapping for the key. |
Float |
getOrDefault(Object key,
Float defaultValue)
Deprecated.
Use specialization
getOrDefault(char, float) instead |
CharSet |
keySet()
Returns a
Set view of the keys contained in this map. |
Float |
merge(Character key,
Float value,
java.util.function.BiFunction<? super Float,? super Float,? extends Float> remappingFunction)
Deprecated.
Use specialization
merge(char, float, FloatBinaryOperator) instead |
float |
merge(char key,
float value,
FloatBinaryOperator remappingFunction)
If the specified key is not already associated with a value, associates
it with the given value, otherwise, replaces the value with the results of the given
remapping function.
|
Float |
put(Character key,
Float value)
Deprecated.
Use specialization
put(char, float) instead |
float |
put(char key,
float value)
Associates the specified value with the specified key in this map (optional operation).
|
Float |
putIfAbsent(Character key,
Float value)
Deprecated.
Use specialization
putIfAbsent(char, float) instead |
float |
putIfAbsent(char key,
float value)
If the specified key is not already associated with a value, associates
it with the given value and returns default
value, else returns the current value.
|
float |
remove(char key)
Removes the mapping for a key from this map if it is present (optional operation).
|
boolean |
remove(char key,
float value)
Removes the entry for the specified key only if it is currently mapped to the specified
value.
|
Float |
remove(Object key)
Deprecated.
Use specialization
remove(char) instead |
boolean |
remove(Object key,
Object value)
Deprecated.
Use specialization
remove(char, float) instead |
boolean |
removeIf(CharFloatPredicate filter)
Removes all of the entries of this collection that satisfy the given predicate.
|
Float |
replace(Character key,
Float value)
Deprecated.
Use specialization
replace(char, float) instead |
boolean |
replace(Character key,
Float oldValue,
Float newValue)
Deprecated.
Use specialization
replace(char, float, float) instead |
float |
replace(char key,
float value)
Replaces the entry for the specified key only if it is currently mapped to some value.
|
boolean |
replace(char key,
float oldValue,
float newValue)
Replaces the entry for the specified key only if currently mapped to the specified value.
|
void |
replaceAll(java.util.function.BiFunction<? super Character,? super Float,? extends Float> function)
Deprecated.
Use specialization
replaceAll(CharFloatToFloatFunction) instead |
void |
replaceAll(CharFloatToFloatFunction function)
Replaces each entry's value with the result of invoking the given function on that entry,
in the order entries are returned by an entry set iterator, until all entries have been
processed or the function throws an exception.
|
FloatCollection |
values()
Returns a
Collection view of the values contained in this map. |
clear, ensureCapacity, isEmpty, shrink, size, sizeAsLongfloat defaultValue()
null
in primitive specialization methods, when the key is absent in the map.CharFloatMapFactory.withDefaultValue(float)@Deprecated boolean containsKey(Object key)
containsKey(char) insteadcontainsKey in interface Map<Character,Float>key - key whose presence in this map is to be testedboolean containsKey(char key)
true if this map contains a mapping for the specified key.key - the char key whose presence in this map is to be testedtrue if this map contains a mapping for the specified key@Deprecated boolean containsValue(Object value)
containsValue(float) insteadcontainsValue in interface Map<Character,Float>value - value whose presence in this map is to be testedboolean containsValue(float value)
true if this map maps one or more keys to the specified value. This operation
will probably require time linear in the map size for most implementations
of the CharFloatMap interface.value - the float value whose presence in this map is to be testedtrue if this map maps one or more keys to the specified value@Nullable @Deprecated Float get(Object key)
get(char) insteadnull if this map contains no mapping for the key.
More formally, if this map contains a mapping from a key
k to a value v such that (key==null ? k==null :
key.equals(k)), then this method returns v; otherwise
it returns null. (There can be at most one such mapping.)
If this map permits null values, then a return value of
null does not necessarily indicate that the map
contains no mapping for the key; it's also possible that the map
explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.
get in interface Map<Character,Float>key - the key whose associated value is to be returnednull if this map contains no mapping for the keyfloat get(char key)
key - the key whose associated value is to be returned@Deprecated
Float getOrDefault(Object key,
Float defaultValue)
getOrDefault(char, float) insteaddefaultValue if this map contains no mapping for the key.getOrDefault in interface Map<Character,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 keyfloat getOrDefault(char key,
float defaultValue)
defaultValue if this map
contains no mapping for the key.key - the key whose associated value is to be returneddefaultValue - the value to return if the specified key is absent in the mapdefaultValue if this map contains no mapping for the key@Deprecated
void forEach(@Nonnull
java.util.function.BiConsumer<? super Character,? super Float> action)
forEach(CharFloatConsumer) insteadforEach in interface Map<Character,Float>action - The action to be performed for each entryvoid forEach(@Nonnull
CharFloatConsumer action)
action on each entry in this map until all entries
have been processed or the action throws an Exception.
Exceptions thrown by the action are relayed to the caller. The entries
will be processed in the same order as the entry set iterator unless that
order is unspecified in which case implementations may use an order which
differs from the entry set iterator.action - The action to be performed for each entryboolean forEachWhile(@Nonnull
CharFloatPredicate predicate)
predicate on each entry in this map until all entries
have been processed or the predicate returns false for some entry,
or throws an Exception. Exceptions thrown by the predicate are relayed to the caller.
The entries will be processed in the same order as the entry set iterator unless that order is unspecified in which case implementations may use an order which differs from the entry set iterator.
If the map is empty, this method returns true immediately.
predicate - the predicate to be checked for each entrytrue if the predicate returned true for all entries of the map,
false if it returned false for the entry@Nonnull CharFloatCursor cursor()
@Nonnull CharSet keySet()
java.util.MapSet 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.keySet in interface Map<Character,Float>@Nonnull FloatCollection values()
java.util.MapCollection 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.values in interface Map<Character,Float>@Nonnull ObjSet<Map.Entry<Character,Float>> entrySet()
java.util.MapSet view of the mappings 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, or through the
setValue operation on a map entry returned by the
iterator) 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.entrySet in interface Map<Character,Float>@Deprecated
Float put(Character key,
Float value)
put(char, float) insteadm.containsKey(k) would return
true.)put in interface Map<Character,Float>key - key with which the specified value is to be associatedvalue - value to be associated with the specified keyfloat put(char key,
float value)
m is said to contain a mapping for a key k
if and only if m.containsKey(k) would return true.)key - key with which the specified value is to be associatedvalue - value to be associated with the specified keykey, or default
value if there was
no mapping for key. (A default
value return can also indicate that the map
previously associated default
value with key.)UnsupportedOperationException - if the put operation
is not supported by this mapIllegalArgumentException - if some property of a specified key
or value prevents it from being stored in this map@Nullable
@Deprecated
Float putIfAbsent(Character key,
Float value)
putIfAbsent(char, float) insteadnull, else returns the current value.putIfAbsent in interface Map<Character,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.)UnsupportedOperationException - if the put operation
is not supported by this mapClassCastException - if the key or value is of an inappropriate type for this mapNullPointerException - if the specified key or value is nullIllegalArgumentException - if some property of the specified key
or value prevents it from being stored in this mapfloat putIfAbsent(char key,
float value)
key - key with which the specified value is to be associatedvalue - value to be associated with the specified keyUnsupportedOperationException - if the put operation
is not supported by this mapIllegalArgumentException - if some property of a specified key
or value prevents it from being stored in this map@Deprecated
Float compute(Character key,
@Nonnull
java.util.function.BiFunction<? super Character,? super Float,? extends Float> remappingFunction)
compute(char, CharFloatToFloatFunction) insteadnull 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.
compute in interface Map<Character,Float>key - key with which the specified value is to be associatedremappingFunction - the function to compute a valuefloat compute(char key,
@Nonnull
CharFloatToFloatFunction remappingFunction)
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 associatedremappingFunction - the function to compute a valueUnsupportedOperationException - if the put operation
is not supported by this map@Deprecated
Float computeIfAbsent(Character key,
@Nonnull
java.util.function.Function<? super Character,? extends Float> mappingFunction)
computeIfAbsent(char, CharToFloatFunction) insteadnull), 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);
computeIfAbsent in interface Map<Character,Float>key - key with which the specified value is to be associatedmappingFunction - the function to compute a valuefloat computeIfAbsent(char key,
@Nonnull
CharToFloatFunction mappingFunction)
If the function itself throws an (unchecked) exception, the exception is rethrown, and no mapping is recorded.
key - key with which the specified value is to be associatedmappingFunction - the function to compute a valueUnsupportedOperationException - if the put operation
is not supported by this map@Deprecated
Float computeIfPresent(Character key,
@Nonnull
java.util.function.BiFunction<? super Character,? super Float,? extends Float> remappingFunction)
computeIfPresent(char, CharFloatToFloatFunction) insteadIf 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.
computeIfPresent in interface Map<Character,Float>key - key with which the specified value is to be associatedremappingFunction - the function to compute a valuefloat computeIfPresent(char key,
@Nonnull
CharFloatToFloatFunction remappingFunction)
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 associatedremappingFunction - the function to compute a valueUnsupportedOperationException - if the put operation
is not supported by this map@Deprecated
Float merge(Character key,
Float value,
@Nonnull
java.util.function.BiFunction<? super Float,? super Float,? extends Float> remappingFunction)
merge(char, float, FloatBinaryOperator) insteadnull. 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.
merge in interface Map<Character,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 presentfloat merge(char key,
float value,
@Nonnull
FloatBinaryOperator remappingFunction)
If the remappingFunction 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 associatedvalue - the value to use if absentremappingFunction - the function to recompute a value if presentNullPointerException - if the remappingFunction is nullUnsupportedOperationException - if the put operation
is not supported by this mapfloat addValue(char key,
float addition)
addition value to the value associated with the specified key,
or default
value if this map contains no mapping for the key, and associates the resulting
value with the key.key - the key to which value add the given valueaddition - the value to addUnsupportedOperationException - if the put operation
is not supported by this mapfloat addValue(char key,
float addition,
float defaultValue)
addition value to the value associated with the specified key,
or defaultValue if this map contains no mapping for the key, and associates
the resulting value with the key.
This version of addValue(char, float) is useful if you want to count
values from the different initial value, than the default value
of this map.
key - the key to which value add the given valueaddition - the value to adddefaultValue - the value to be used if the map contains no mapping for the given keyUnsupportedOperationException - if the put operation
is not supported by this map@Nullable
@Deprecated
Float replace(Character key,
Float value)
replace(char, float) insteadreplace in interface Map<Character,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.UnsupportedOperationException - if the put operation
is not supported by this mapNullPointerException - if the specified key or value is nullIllegalArgumentException - if some property of the specified value
prevents it from being stored in this mapfloat replace(char key,
float value)
key - key with which the specified value is associatedvalue - value to be associated with the specified keyIllegalArgumentException - if some property of a specified key
or value prevents it from being stored in this mapUnsupportedOperationException - if the put operation
is not supported by this map@Deprecated
boolean replace(Character key,
Float oldValue,
Float newValue)
replace(char, float, float) insteadreplace in interface Map<Character,Float>key - key with which the specified value is associatedoldValue - value expected to be associated with the specified keynewValue - value to be associated with the specified keytrue if the value was replacedUnsupportedOperationException - if the put operation
is not supported by this mapNullPointerException - if the specified key or value is nullIllegalArgumentException - if some property of the specified value
prevents it from being stored in this mapboolean replace(char key,
float oldValue,
float newValue)
key - key with which the specified value is associatedoldValue - value expected to be associated with the specified keynewValue - value to be associated with the specified keytrue if the value was replacedIllegalArgumentException - if some property of a specified key
or value prevents it from being stored in this mapUnsupportedOperationException - if the put operation
is not supported by this map@Deprecated
void replaceAll(@Nonnull
java.util.function.BiFunction<? super Character,? super Float,? extends Float> function)
replaceAll(CharFloatToFloatFunction) insteadreplaceAll in interface Map<Character,Float>function - the function to apply to each entryvoid replaceAll(@Nonnull
CharFloatToFloatFunction function)
function - the function to apply to each entryUnsupportedOperationException - if the set operation
is not supported by this map's entry set iteratorIllegalArgumentException - if some property of a replacement value
prevents it from being stored in this map (optional restriction)@Nullable @Deprecated Float remove(Object key)
remove(char) instead(key==null ? k==null : key.equals(k)), that mapping
is removed. (The map can contain at most one such mapping.)
Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.
If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.
The map will not contain a mapping for the specified key once the call returns.
remove in interface Map<Character,Float>key - key whose mapping is to be removed from the mapfloat remove(char key)
Returns the value to which this map previously associated the key, or default value if the map contained no mapping for the key.
A return value of default value does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to default value.
The map will not contain a mapping for the specified key once the call returns.
key - key whose mapping is to be removed from the mapkey, or default
value if there was
no mapping for keyUnsupportedOperationException - if the remove operation
is not supported by this map@Deprecated
boolean remove(Object key,
Object value)
remove(char, float) insteadremove in interface Map<Character,Float>key - key with which the specified value is associatedvalue - value expected to be associated with the specified keytrue if the value was removedNullPointerException - if the specified key or value is nullUnsupportedOperationException - if the remove operation
is not supported by this mapboolean remove(char key,
float value)
key - key with which the specified value is associatedvalue - value expected to be associated with the specified keytrue if the value was removedUnsupportedOperationException - if the remove operation
is not supported by this mapboolean removeIf(@Nonnull
CharFloatPredicate filter)
filter - a predicate which returns true for elements to be removedtrue if any elements were removedNullPointerException - if the specified filter is nullUnsupportedOperationException - if elements cannot be removed from this collection.
Implementations may throw this exception if a matching element cannot be removed
or if, in general, removal is not supported.