public interface Char2CharMap extends Char2CharFunction, Map<Character,Character>
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 Char2CharMap.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 |
Char2CharMap.Entry
A type-specific
Map.Entry; provides some additional methods
that use polymorphism to avoid (un)boxing. |
static interface |
Char2CharMap.FastEntrySet
An entry set providing fast iteration.
|
| Modifier and Type | Method and Description |
|---|---|
ObjectSet<Char2CharMap.Entry> |
char2CharEntrySet()
Returns a type-specific set view of the mappings contained in this map.
|
default void |
clear()
Removes all of the mappings from this map (optional operation).
|
default Character |
compute(Character key,
BiFunction<? super Character,? super Character,? extends Character> remappingFunction)
Deprecated.
Please use the corresponding type-specific method instead.
|
default char |
compute(char key,
BiFunction<? super Character,? super Character,? extends Character> remappingFunction)
Attempts to compute a mapping for the specified key and its current mapped value (or
null if there is no current mapping). |
default Character |
computeIfAbsent(Character key,
Function<? super Character,? extends Character> mappingFunction)
Deprecated.
Please use the corresponding type-specific method instead.
|
default char |
computeIfAbsent(char key,
IntUnaryOperator 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 char |
computeIfAbsentNullable(char key,
IntFunction<? extends Character> 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 it is
null. |
default char |
computeIfAbsentPartial(char key,
Char2CharFunction 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 Character |
computeIfPresent(Character key,
BiFunction<? super Character,? super Character,? extends Character> remappingFunction)
Deprecated.
Please use the corresponding type-specific method instead.
|
default char |
computeIfPresent(char key,
BiFunction<? super Character,? super Character,? extends 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.
|
boolean |
containsKey(char 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.
|
boolean |
containsValue(char 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.
|
char |
defaultReturnValue()
Gets the default return value.
|
void |
defaultReturnValue(char rv)
Sets the default return value (optional operation).
|
default ObjectSet<Map.Entry<Character,Character>> |
entrySet()
Deprecated.
Please use the corresponding type-specific method instead.
|
default Character |
get(Object key)
Deprecated.
Please use the corresponding type-specific method instead.
|
default char |
getOrDefault(char key,
char defaultValue)
Returns the value to which the specified key is mapped, or the
defaultValue if this
map contains no mapping for the key. |
default Character |
getOrDefault(Object key,
Character defaultValue)
Deprecated.
Please use the corresponding type-specific method instead.
|
CharSet |
keySet()
Note that this specification strengthens the one given in
Map.keySet(). |
default Character |
merge(Character key,
Character value,
BiFunction<? super Character,? super Character,? extends Character> remappingFunction)
Deprecated.
Please use the corresponding type-specific method instead.
|
default char |
merge(char key,
char value,
BiFunction<? super Character,? super Character,? extends Character> remappingFunction)
If the specified key is not already associated with a value, associates it with the given
value. |
default Character |
put(Character key,
Character value)
Deprecated.
Please use the corresponding type-specific method instead.
|
default Character |
putIfAbsent(Character key,
Character value)
Deprecated.
Please use the corresponding type-specific method instead.
|
default char |
putIfAbsent(char 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 boolean |
remove(char key,
char value)
Removes the entry for the specified key only if it is currently mapped to the specified value.
|
default Character |
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 Character |
replace(Character key,
Character value)
Deprecated.
Please use the corresponding type-specific method instead.
|
default boolean |
replace(Character key,
Character oldValue,
Character newValue)
Deprecated.
Please use the corresponding type-specific method instead.
|
default char |
replace(char key,
char value)
Replaces the entry for the specified key only if it is currently mapped to some value.
|
default boolean |
replace(char key,
char oldValue,
char newValue)
Replaces the entry for the specified key only if currently mapped to the specified value.
|
int |
size()
Returns the number of key/value mappings in this map.
|
CharCollection |
values()
Note that this specification strengthens the one given in
Map.values(). |
applyAsInt, get, put, removeandThen, compose, identityint size()
Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.default void clear()
clear in interface Map<Character,Character>UnsupportedOperationException - if the clear() operation is not supported by this mapMap.clear()void defaultReturnValue(char 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 Char2CharFunctionrv - the new default return value.defaultReturnValue()char defaultReturnValue()
defaultReturnValue in interface Char2CharFunctionObjectSet<Char2CharMap.Entry> char2CharEntrySet()
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<Character,Character>> entrySet()
Note that this specification strengthens the one given in Map.entrySet().
entrySet in interface Map<Character,Character>Map.entrySet()@Deprecated default Character put(Character key, Character value)
This default implementation just delegates to the corresponding type-specific–function method.
put in interface Char2CharFunctionput in interface Map<Character,Character>key - the key.value - the value.null if no value was present for the given key.Map.put(Object,Object)@Deprecated default Character get(Object key)
This default implementation just delegates to the corresponding type-specific–function method.
get in interface Char2CharFunctionget in interface Map<Character,Character>key - the key.null if no value was present for the given key.Map.get(Object)@Deprecated default Character remove(Object key)
This default implementation just delegates to the corresponding type-specific–function method.
remove in interface Char2CharFunctionremove in interface Map<Character,Character>key - the key.null if no value was present for the given key.Map.remove(Object)CharSet keySet()
Note that this specification strengthens the one given in Map.keySet().
keySet in interface Map<Character,Character>Map.keySet()CharCollection values()
Note that this specification strengthens the one given in Map.values().
values in interface Map<Character,Character>Map.values()boolean containsKey(char key)
containsKey in interface Char2CharFunctionkey - 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 Char2CharFunctioncontainsKey in interface Map<Character,Character>key - the key.key.Map.containsKey(Object)boolean containsValue(char 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<Character,Character>default char getOrDefault(char key,
char 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 char putIfAbsent(char key,
char 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(char key,
char 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(char key,
char oldValue,
char 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 char replace(char key,
char value)
key - key with which the specified value is associated.value - value to be associated with the specified key.Map.replace(Object, Object)default char computeIfAbsent(char key,
IntUnaryOperator 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 char computeIfAbsentNullable(char key,
IntFunction<? extends Character> mappingFunction)
null.
Note that this version of computeIfAbsent()
should be used only if you plan to return null in the mapping function.
key - key with which the specified value is to be associated.mappingFunction - the function to compute a value.null.Map.computeIfAbsent(Object, java.util.function.Function)default char computeIfAbsentPartial(char key,
Char2CharFunction 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 char computeIfPresent(char key,
BiFunction<? super Character,? super Character,? extends Character> 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 char compute(char key,
BiFunction<? super Character,? super Character,? extends Character> 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 char merge(char key,
char value,
BiFunction<? super Character,? super Character,? extends Character> 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 Character getOrDefault(Object key, Character defaultValue)
This default implementation just delegates to the corresponding Map method.
getOrDefault in interface Map<Character,Character>@Deprecated default Character putIfAbsent(Character key, Character value)
This default implementation just delegates to the corresponding Map method.
putIfAbsent in interface Map<Character,Character>@Deprecated default boolean remove(Object key, Object value)
This default implementation just delegates to the corresponding Map method.
@Deprecated default boolean replace(Character key, Character oldValue, Character newValue)
This default implementation just delegates to the corresponding Map method.
@Deprecated default Character replace(Character key, Character value)
This default implementation just delegates to the corresponding Map method.
@Deprecated default Character computeIfAbsent(Character key, Function<? super Character,? extends Character> mappingFunction)
This default implementation just delegates to the corresponding Map method.
computeIfAbsent in interface Map<Character,Character>@Deprecated default Character computeIfPresent(Character key, BiFunction<? super Character,? super Character,? extends Character> remappingFunction)
This default implementation just delegates to the corresponding Map method.
computeIfPresent in interface Map<Character,Character>@Deprecated default Character compute(Character key, BiFunction<? super Character,? super Character,? extends Character> remappingFunction)
This default implementation just delegates to the corresponding Map method.
@Deprecated default Character merge(Character key, Character value, BiFunction<? super Character,? super Character,? extends Character> remappingFunction)
This default implementation just delegates to the corresponding Map method.