Interface Object2CharMap<K>
-
- All Superinterfaces:
Function<K,java.lang.Character>
,java.util.function.Function<K,java.lang.Character>
,java.util.Map<K,java.lang.Character>
,Object2CharFunction<K>
,java.util.function.ToIntFunction<K>
- All Known Subinterfaces:
Object2CharSortedMap<K>
- All Known Implementing Classes:
AbstractObject2CharMap
,AbstractObject2CharSortedMap
,Object2CharArrayMap
,Object2CharAVLTreeMap
,Object2CharLinkedOpenCustomHashMap
,Object2CharLinkedOpenHashMap
,Object2CharMaps.EmptyMap
,Object2CharMaps.Singleton
,Object2CharMaps.SynchronizedMap
,Object2CharMaps.UnmodifiableMap
,Object2CharOpenCustomHashMap
,Object2CharOpenHashMap
,Object2CharRBTreeMap
,Object2CharSortedMaps.EmptySortedMap
,Object2CharSortedMaps.Singleton
,Object2CharSortedMaps.SynchronizedSortedMap
,Object2CharSortedMaps.UnmodifiableSortedMap
public interface Object2CharMap<K> extends Object2CharFunction<K>, java.util.Map<K,java.lang.Character>
A type-specificMap
; 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()
andvalues()
. Moreover, a number of methods, such assize()
,defaultReturnValue()
, etc., are un-defaulted as their function default do not make sense for a map. Maps returning entry sets of typeObject2CharMap.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).
- See Also:
Map
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
Object2CharMap.Entry<K>
A type-specificMap.Entry
; provides some additional methods that use polymorphism to avoid (un)boxing.static interface
Object2CharMap.FastEntrySet<K>
An entry set providing fast iteration.
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description default void
clear()
Removes all of the mappings from this map (optional operation).default char
computeChar(K key, java.util.function.BiFunction<? super K,? super java.lang.Character,? extends java.lang.Character> remappingFunction)
Attempts to compute a mapping for the specified key and its current mapped value (ornull
if there is no current mapping).default char
computeCharIfAbsent(K key, java.util.function.ToIntFunction<? super K> mappingFunction)
Deprecated.Please usecomputeIfAbsent()
instead.default char
computeCharIfAbsentPartial(K key, Object2CharFunction<? super K> mappingFunction)
Deprecated.Please usecomputeIfAbsent()
instead.default char
computeCharIfPresent(K key, java.util.function.BiFunction<? super K,? super java.lang.Character,? extends java.lang.Character> 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 char
computeIfAbsent(K key, Object2CharFunction<? 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 char
computeIfAbsent(K key, java.util.function.ToIntFunction<? 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(char value)
Returnstrue
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.char
defaultReturnValue()
Gets the default return value.void
defaultReturnValue(char rv)
Sets the default return value (optional operation).default ObjectSet<java.util.Map.Entry<K,java.lang.Character>>
entrySet()
Deprecated.Please use the corresponding type-specific method instead.default void
forEach(java.util.function.BiConsumer<? super K,? super java.lang.Character> consumer)
default java.lang.Character
get(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.default char
getOrDefault(java.lang.Object key, char defaultValue)
Returns the value to which the specified key is mapped, or thedefaultValue
if this map contains no mapping for the key.default java.lang.Character
getOrDefault(java.lang.Object key, java.lang.Character defaultValue)
Deprecated.Please use the corresponding type-specific method instead.ObjectSet<K>
keySet()
default char
merge(K key, char value, java.util.function.BiFunction<? super java.lang.Character,? super java.lang.Character,? extends java.lang.Character> remappingFunction)
If the specified key is not already associated with a value, associates it with the givenvalue
.default java.lang.Character
merge(K key, java.lang.Character value, java.util.function.BiFunction<? super java.lang.Character,? super java.lang.Character,? extends java.lang.Character> remappingFunction)
Deprecated.Please use the corresponding type-specific method instead.default char
mergeChar(K key, char value, CharBinaryOperator remappingFunction)
If the specified key is not already associated with a value, associates it with the givenvalue
.default char
mergeChar(K key, char value, java.util.function.BiFunction<? super java.lang.Character,? super java.lang.Character,? extends java.lang.Character> remappingFunction)
Deprecated.Please usemerge()
instead.default char
mergeChar(K key, char value, java.util.function.IntBinaryOperator remappingFunction)
If the specified key is not already associated with a value, associates it with the givenvalue
.ObjectSet<Object2CharMap.Entry<K>>
object2CharEntrySet()
Returns a type-specific set view of the mappings contained in this map.default java.lang.Character
put(K key, java.lang.Character value)
Deprecated.Please use the corresponding type-specific method instead.default char
putIfAbsent(K key, char 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.Character
putIfAbsent(K key, java.lang.Character value)
Deprecated.Please use the corresponding type-specific method instead.default java.lang.Character
remove(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.default boolean
remove(java.lang.Object key, char 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 char
replace(K key, char value)
Replaces the entry for the specified key only if it is currently mapped to some value.default boolean
replace(K key, char oldValue, char newValue)
Replaces the entry for the specified key only if currently mapped to the specified value.default java.lang.Character
replace(K key, java.lang.Character value)
Deprecated.Please use the corresponding type-specific method instead.default boolean
replace(K key, java.lang.Character oldValue, java.lang.Character newValue)
Deprecated.Please use the corresponding type-specific method instead.int
size()
Returns the number of key/value mappings in this map.CharCollection
values()
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, hashCode, isEmpty, putAll, replaceAll
-
Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2CharFunction
andThen, andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, applyAsInt, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort, getChar, put, removeChar
-
-
-
-
Method Detail
-
size
int size()
Returns the number of key/value mappings in this map. If the map contains more thanInteger.MAX_VALUE
elements, returnsInteger.MAX_VALUE
.
-
clear
default void clear()
Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.
-
defaultReturnValue
void defaultReturnValue(char rv)
Sets the default return value (optional operation). This value must be returned by type-specific versions ofget()
,put()
andremove()
to denote that the map does not contain the specified key. It must be 0/false
by default.- Specified by:
defaultReturnValue
in interfaceObject2CharFunction<K>
- Parameters:
rv
- the new default return value.- See Also:
defaultReturnValue()
-
defaultReturnValue
char defaultReturnValue()
Gets the default return value.- Specified by:
defaultReturnValue
in interfaceObject2CharFunction<K>
- Returns:
- the current default return value.
-
object2CharEntrySet
ObjectSet<Object2CharMap.Entry<K>> object2CharEntrySet()
Returns a type-specific set view of the mappings contained in this map.This method is necessary because there is no inheritance along type parameters: it is thus impossible to strengthen
Map.entrySet()
so that it returns anObjectSet
of type-specific entries (the latter makes it possible to access keys and values with type-specific methods).- Returns:
- a type-specific set view of the mappings contained in this map.
- See Also:
Map.entrySet()
-
entrySet
@Deprecated default ObjectSet<java.util.Map.Entry<K,java.lang.Character>> entrySet()
Deprecated.Please use the corresponding type-specific method instead.Returns a set view of the mappings contained in this map.- Specified by:
entrySet
in interfacejava.util.Map<K,java.lang.Character>
- Returns:
- a set view of the mappings contained in this map.
- See Also:
Map.entrySet()
- API Notes:
- Note that this specification strengthens the one given in
Map.entrySet()
.
-
put
@Deprecated default java.lang.Character put(K key, java.lang.Character value)
Deprecated.Please use the corresponding type-specific method instead.Associates the specified value with the specified key in this function (optional operation).This default implementation just delegates to the corresponding type-specific–function method.
- Specified by:
put
in interfaceFunction<K,java.lang.Character>
- Specified by:
put
in interfacejava.util.Map<K,java.lang.Character>
- Specified by:
put
in interfaceObject2CharFunction<K>
- Parameters:
key
- the key.value
- the value.- Returns:
- the old value, or
null
if no value was present for the given key. - See Also:
Map.put(Object,Object)
-
get
@Deprecated default java.lang.Character get(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.Returns the value associated by this function to the specified key.This default implementation just delegates to the corresponding type-specific–function method.
- Specified by:
get
in interfaceFunction<K,java.lang.Character>
- Specified by:
get
in interfacejava.util.Map<K,java.lang.Character>
- Specified by:
get
in interfaceObject2CharFunction<K>
- Parameters:
key
- the key.- Returns:
- the corresponding value, or
null
if no value was present for the given key. - See Also:
Map.get(Object)
-
remove
@Deprecated default java.lang.Character remove(java.lang.Object key)
Deprecated.Please use the corresponding type-specific method instead.Removes this key and the associated value from this function if it is present (optional operation).This default implementation just delegates to the corresponding type-specific–function method.
- Specified by:
remove
in interfaceFunction<K,java.lang.Character>
- Specified by:
remove
in interfacejava.util.Map<K,java.lang.Character>
- Specified by:
remove
in interfaceObject2CharFunction<K>
- Parameters:
key
- the key.- Returns:
- the old value, or
null
if no value was present for the given key. - See Also:
Map.remove(Object)
-
keySet
ObjectSet<K> keySet()
- Specified by:
keySet
in interfacejava.util.Map<K,java.lang.Character>
- Returns:
- a set view of the keys contained in this map.
- See Also:
Map.keySet()
- API Notes:
- Note that this specification strengthens the one given in
Map.keySet()
.
-
values
CharCollection values()
- Specified by:
values
in interfacejava.util.Map<K,java.lang.Character>
- Returns:
- a set view of the values contained in this map.
- See Also:
Map.values()
- API Notes:
- Note that this specification strengthens the one given in
Map.values()
.
-
containsKey
boolean containsKey(java.lang.Object key)
Returns true if this function contains a mapping for the specified key.- Specified by:
containsKey
in interfaceFunction<K,java.lang.Character>
- Specified by:
containsKey
in interfacejava.util.Map<K,java.lang.Character>
- Parameters:
key
- the key.- Returns:
- true if this function associates a value to
key
. - See Also:
Map.containsKey(Object)
-
containsValue
boolean containsValue(char value)
Returnstrue
if this map maps one or more keys to the specified value.- See Also:
Map.containsValue(Object)
-
containsValue
@Deprecated default boolean containsValue(java.lang.Object value)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
containsValue
in interfacejava.util.Map<K,java.lang.Character>
-
forEach
default void forEach(java.util.function.BiConsumer<? super K,? super java.lang.Character> consumer)
- Specified by:
forEach
in interfacejava.util.Map<K,java.lang.Character>
-
getOrDefault
default char getOrDefault(java.lang.Object key, char defaultValue)
Returns the value to which the specified key is mapped, or thedefaultValue
if this map contains no mapping for the key.- Specified by:
getOrDefault
in interfaceObject2CharFunction<K>
- Parameters:
key
- the key.defaultValue
- the default mapping of the key.- Returns:
- the value to which the specified key is mapped, or the
defaultValue
if this map contains no mapping for the key. - Since:
- 8.0.0
- See Also:
Map.getOrDefault(Object, Object)
-
getOrDefault
@Deprecated default java.lang.Character getOrDefault(java.lang.Object key, java.lang.Character defaultValue)
Deprecated.Please use the corresponding type-specific method instead.Returns the value associated by this function to the specified key, or give the specified value if not present.This default implementation just delegates to the corresponding
Map
method.- Specified by:
getOrDefault
in interfaceFunction<K,java.lang.Character>
- Specified by:
getOrDefault
in interfacejava.util.Map<K,java.lang.Character>
- Specified by:
getOrDefault
in interfaceObject2CharFunction<K>
- Parameters:
key
- the key.defaultValue
- the default value to return if not present.- Returns:
- the corresponding value, or
defaultValue
if no value was present for the given key. - See Also:
Map.getOrDefault(Object, Object)
-
putIfAbsent
default char putIfAbsent(K key, char 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.- Parameters:
key
- key with which the specified value is to be associated.value
- value to be associated with the specified key.- Returns:
- the previous value associated with the specified key, or the default return value if there was no mapping for the key.
- Since:
- 8.0.0
- See Also:
Map.putIfAbsent(Object, Object)
-
remove
default boolean remove(java.lang.Object key, char value)
Removes the entry for the specified key only if it is currently mapped to the specified value.- Parameters:
key
- key with which the specified value is associated.value
- value expected to be associated with the specified key.- Returns:
true
if the value was removed.- Since:
- 8.0.0
- See Also:
Map.remove(Object, Object)
-
replace
default boolean replace(K key, char oldValue, char newValue)
Replaces the entry for the specified key only if currently mapped to the specified value.- Parameters:
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.- Returns:
true
if the value was replaced.- Since:
- 8.0.0
- See Also:
Map.replace(Object, Object, Object)
-
replace
default char replace(K key, char value)
Replaces the entry for the specified key only if it is currently mapped to some value.- Parameters:
key
- key with which the specified value is associated.value
- value to be associated with the specified key.- Returns:
- the previous value associated with the specified key, or the default return value if there was no mapping for the key.
- Since:
- 8.0.0
- See Also:
Map.replace(Object, Object)
-
computeIfAbsent
default char computeIfAbsent(K key, java.util.function.ToIntFunction<? 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.Note that contrarily to the default computeIfAbsent(), it is not possible to not add a value for a given key, since the
mappingFunction
cannot returnnull
. If such a behavior is needed, please use the corresponding nullable version.- Parameters:
key
- key with which the specified value is to be associated.mappingFunction
- the function to compute a value.- Returns:
- the current (existing or computed) value associated with the specified key.
- Since:
- 8.0.0
- See Also:
Map.computeIfAbsent(Object, java.util.function.Function)
- API Notes:
- all
computeIfAbsent()
methods have a different logic based on the argument; no delegation is performed, contrarily to other superficially similar methods such asIterator.forEachRemaining(java.util.function.Consumer<? super E>)
orList.replaceAll(java.util.function.UnaryOperator<E>)
.
-
computeCharIfAbsent
@Deprecated default char computeCharIfAbsent(K key, java.util.function.ToIntFunction<? super K> mappingFunction)
Deprecated.Please usecomputeIfAbsent()
instead.
-
computeIfAbsent
default char computeIfAbsent(K key, Object2CharFunction<? 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.This version of computeIfAbsent() uses a type-specific version of
fastutil
'sFunction
. SinceFunction
has acontainsKey()
method, it is possible to avoid adding a key by havingcontainsKey()
returnfalse
for that key.- Parameters:
key
- key with which the specified value is to be associated.mappingFunction
- the function to compute a value.- Returns:
- the current (existing or computed) value associated with the specified key.
- Since:
- 8.0.0
- See Also:
Map.computeIfAbsent(Object, java.util.function.Function)
- API Notes:
- all
computeIfAbsent()
methods have a different logic based on the argument; no delegation is performed, contrarily to other superficially similar methods such asIterator.forEachRemaining(java.util.function.Consumer<? super E>)
orList.replaceAll(java.util.function.UnaryOperator<E>)
.
-
computeCharIfAbsentPartial
@Deprecated default char computeCharIfAbsentPartial(K key, Object2CharFunction<? super K> mappingFunction)
Deprecated.Please usecomputeIfAbsent()
instead.
-
computeCharIfPresent
default char computeCharIfPresent(K key, java.util.function.BiFunction<? super K,? super java.lang.Character,? extends java.lang.Character> remappingFunction)
If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.- Parameters:
key
- key with which the specified value is to be associated.remappingFunction
- the function to compute a value.- Returns:
- the new value associated with the specified key, or the default return value if none.
- Since:
- 8.0.0
- See Also:
Map.computeIfPresent(Object, java.util.function.BiFunction)
-
computeChar
default char computeChar(K key, java.util.function.BiFunction<? super K,? super java.lang.Character,? extends java.lang.Character> remappingFunction)
Attempts to compute a mapping for the specified key and its current mapped value (ornull
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.- Parameters:
key
- key with which the specified value is to be associated.remappingFunction
- the function to compute a value.- Returns:
- the new value associated with the specified key, or the default return value if none.
- Since:
- 8.0.0
- See Also:
Map.compute(Object, java.util.function.BiFunction)
-
merge
default char merge(K key, char value, java.util.function.BiFunction<? super java.lang.Character,? super java.lang.Character,? extends java.lang.Character> remappingFunction)
If the specified key is not already associated with a value, associates it with the givenvalue
. Otherwise, replaces the associated value with the results of the given remapping function, or removes if the result isnull
.- Parameters:
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.- Returns:
- the new value associated with the specified key, or the default return value if no value is associated with the key.
- Since:
- 8.0.0
- See Also:
Map.merge(Object, Object, java.util.function.BiFunction)
- API Notes:
- The JDK specification for this method equates not being associated with a value with being associated with {code null}. This is not the case for this method.
-
mergeChar
default char mergeChar(K key, char value, CharBinaryOperator remappingFunction)
If the specified key is not already associated with a value, associates it with the givenvalue
. Otherwise, replaces the associated value with the results of the given remapping function.- Parameters:
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.- Returns:
- the new value associated with the specified key.
- Since:
- 8.5.0
- See Also:
Map.merge(Object, Object, java.util.function.BiFunction)
- API Notes:
- The JDK specification for this method equates not being associated with a value with being associated with {code null}.
This is not the case for this method. Moreover, this method cannot delete entries as the type-specific remapping
function cannot return
null
.
-
mergeChar
default char mergeChar(K key, char value, java.util.function.IntBinaryOperator remappingFunction)
If the specified key is not already associated with a value, associates it with the givenvalue
. Otherwise, replaces the associated value with the results of the given remapping function.- Parameters:
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.- Returns:
- the new value associated with the specified key.
- Since:
- 8.5.0
- See Also:
Map.merge(Object, Object, java.util.function.BiFunction)
- API Notes:
- The JDK specification for this method equates not being associated with a value with being associated with {code null}.
This is not the case for this method. Moreover, this method cannot delete entries as the type-specific remapping
function cannot return
null
. - Implementation Notes:
- Unless the argument is type-specific, this method will introduce an intermediary lambda to perform narrowing and widening casts. Please use the type-specific overload to avoid this overhead.
-
mergeChar
@Deprecated default char mergeChar(K key, char value, java.util.function.BiFunction<? super java.lang.Character,? super java.lang.Character,? extends java.lang.Character> remappingFunction)
Deprecated.Please usemerge()
instead.
-
putIfAbsent
@Deprecated default java.lang.Character putIfAbsent(K key, java.lang.Character value)
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Map
method.- Specified by:
putIfAbsent
in interfacejava.util.Map<K,java.lang.Character>
-
remove
@Deprecated default boolean remove(java.lang.Object key, java.lang.Object value)
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Map
method.- Specified by:
remove
in interfacejava.util.Map<K,java.lang.Character>
-
replace
@Deprecated default boolean replace(K key, java.lang.Character oldValue, java.lang.Character newValue)
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Map
method.- Specified by:
replace
in interfacejava.util.Map<K,java.lang.Character>
-
replace
@Deprecated default java.lang.Character replace(K key, java.lang.Character value)
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Map
method.- Specified by:
replace
in interfacejava.util.Map<K,java.lang.Character>
-
merge
@Deprecated default java.lang.Character merge(K key, java.lang.Character value, java.util.function.BiFunction<? super java.lang.Character,? super java.lang.Character,? extends java.lang.Character> remappingFunction)
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Map
method.- Specified by:
merge
in interfacejava.util.Map<K,java.lang.Character>
-
-