Interface Char2IntMap
- All Superinterfaces:
it.unimi.dsi.fastutil.chars.Char2IntFunction,it.unimi.dsi.fastutil.Function<Character,,Integer> Function<Character,,Integer> IntUnaryOperator,Map<Character,Integer>
- All Known Subinterfaces:
Char2IntSortedMap
- All Known Implementing Classes:
AbstractChar2IntMap,AbstractChar2IntSortedMap,Char2IntArrayMap,Char2IntAVLTreeMap,Char2IntLinkedOpenHashMap,Char2IntMaps.EmptyMap,Char2IntMaps.Singleton,Char2IntMaps.SynchronizedMap,Char2IntMaps.UnmodifiableMap,Char2IntOpenCustomHashMap,Char2IntOpenHashMap,Char2IntRBTreeMap,Char2IntSortedMaps.EmptySortedMap,Char2IntSortedMaps.Singleton,Char2IntSortedMaps.SynchronizedSortedMap,Char2IntSortedMaps.UnmodifiableSortedMap
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 Char2IntMap.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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interfaceA type-specificMap.Entry; provides some additional methods that use polymorphism to avoid (un)boxing.static interfaceAn entry set providing fast iteration. -
Method Summary
Modifier and TypeMethodDescriptionit.unimi.dsi.fastutil.objects.ObjectSet<Char2IntMap.Entry> Returns a type-specific set view of the mappings contained in this map.default voidclear()Removes all of the mappings from this map (optional operation).default intcompute(char key, BiFunction<? super Character, ? super Integer, ? extends Integer> remappingFunction) Attempts to compute a mapping for the specified key and its current mapped value (ornullif there is no current mapping).default Integercompute(Character key, BiFunction<? super Character, ? super Integer, ? extends Integer> remappingFunction) Deprecated.Please use the corresponding type-specific method instead.default intcomputeIfAbsent(char key, it.unimi.dsi.fastutil.chars.Char2IntFunction 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 intcomputeIfAbsent(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 IntegercomputeIfAbsent(Character key, Function<? super Character, ? extends Integer> mappingFunction) Deprecated.Please use the corresponding type-specific method instead.default intcomputeIfAbsentNullable(char key, IntFunction<? extends Integer> 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 isnull.default intcomputeIfAbsentPartial(char key, it.unimi.dsi.fastutil.chars.Char2IntFunction mappingFunction) Deprecated.Please usecomputeIfAbsent()instead.default intcomputeIfPresent(char key, BiFunction<? super Character, ? super Integer, ? extends Integer> 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 IntegercomputeIfPresent(Character key, BiFunction<? super Character, ? super Integer, ? extends Integer> remappingFunction) Deprecated.Please use the corresponding type-specific method instead.booleancontainsKey(char key) Returns true if this function contains a mapping for the specified key.default booleancontainsKey(Object key) Deprecated.Please use the corresponding type-specific method instead.booleancontainsValue(int value) Returnstrueif this map maps one or more keys to the specified value.default booleancontainsValue(Object value) Deprecated.Please use the corresponding type-specific method instead.intGets the default return value.voiddefaultReturnValue(int rv) Sets the default return value (optional operation).static Char2IntMap.Entryentry(char key, int value) Returns an unmodifiable, type-specific entry.entrySet()Deprecated.Please use the corresponding type-specific method instead.default voidforEach(it.unimi.dsi.fastutil.chars.CharIntBiConsumer consumer) Performs the given action for each entry in this map until all entries have been processed or the action throws an exception.default voidforEach(BiConsumer<? super Character, ? super Integer> action) Deprecated.Please use the corresponding type-specific method instead.default IntegerDeprecated.Please use the corresponding type-specific method instead.default intgetOrDefault(char key, int defaultValue) Returns the value to which the specified key is mapped, or thedefaultValueif this map contains no mapping for the key.default IntegergetOrDefault(Object key, Integer defaultValue) Deprecated.Please use the corresponding type-specific method instead.it.unimi.dsi.fastutil.chars.CharSetkeySet()default intmerge(char key, int value, BiFunction<? super Integer, ? super Integer, ? extends Integer> remappingFunction) If the specified key is not already associated with a value, associates it with the givenvalue.default Integermerge(Character key, Integer value, BiFunction<? super Integer, ? super Integer, ? extends Integer> remappingFunction) Deprecated.Please use the corresponding type-specific method instead.default intmergeInt(char key, int value, it.unimi.dsi.fastutil.ints.IntBinaryOperator remappingFunction) If the specified key is not already associated with a value, associates it with the givenvalue.default intmergeInt(char key, int value, IntBinaryOperator remappingFunction) If the specified key is not already associated with a value, associates it with the givenvalue.static Char2IntMapofEntries(Char2IntMap.Entry... entries) Returns an unmodifiable, type-specific map with the specified entries.default IntegerDeprecated.Please use the corresponding type-specific method instead.default intputIfAbsent(char key, int 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 IntegerputIfAbsent(Character key, Integer value) Deprecated.Please use the corresponding type-specific method instead.default booleanremove(char key, int value) Removes the entry for the specified key only if it is currently mapped to the specified value.default IntegerDeprecated.Please use the corresponding type-specific method instead.default booleanDeprecated.Please use the corresponding type-specific method instead.default intreplace(char key, int value) Replaces the entry for the specified key only if it is currently mapped to some value.default booleanreplace(char key, int oldValue, int newValue) Replaces the entry for the specified key only if currently mapped to the specified value.default IntegerDeprecated.Please use the corresponding type-specific method instead.default booleanDeprecated.Please use the corresponding type-specific method instead.intsize()Returns the number of key/value mappings in this map.it.unimi.dsi.fastutil.ints.IntCollectionvalues()Methods inherited from interface it.unimi.dsi.fastutil.chars.Char2IntFunction
andThen, andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, applyAsInt, compose, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort, get, put, removeMethods inherited from interface it.unimi.dsi.fastutil.Function
applyMethods inherited from interface java.util.function.IntUnaryOperator
andThen, compose
-
Method Details
-
size
int size()Returns the number of key/value mappings in this map. If the map contains more thanInteger.MAX_VALUEelements, 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(int 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/falseby default.- Specified by:
defaultReturnValuein interfaceit.unimi.dsi.fastutil.chars.Char2IntFunction- Parameters:
rv- the new default return value.- See Also:
-
defaultReturnValue
int defaultReturnValue()Gets the default return value.- Specified by:
defaultReturnValuein interfaceit.unimi.dsi.fastutil.chars.Char2IntFunction- Returns:
- the current default return value.
-
char2IntEntrySet
it.unimi.dsi.fastutil.objects.ObjectSet<Char2IntMap.Entry> char2IntEntrySet()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 anObjectSetof 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:
-
entrySet
@Deprecated default it.unimi.dsi.fastutil.objects.ObjectSet<Map.Entry<Character,Integer>> entrySet()Deprecated.Please use the corresponding type-specific method instead.Returns a set view of the mappings contained in this map. -
put
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding type-specific–function method.
-
get
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding type-specific–function method.
-
remove
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding type-specific–function method.
-
keySet
it.unimi.dsi.fastutil.chars.CharSet keySet() -
values
it.unimi.dsi.fastutil.ints.IntCollection values() -
containsKey
boolean containsKey(char key) Returns true if this function contains a mapping for the specified key.- Specified by:
containsKeyin interfaceit.unimi.dsi.fastutil.chars.Char2IntFunction- Parameters:
key- the key.- Returns:
- true if this function associates a value to
key. - See Also:
-
containsKey
Deprecated.Please use the corresponding type-specific method instead.Returns true if this function contains a mapping for the specified key.This default implementation just delegates to the corresponding type-specific–function method.
-
containsValue
boolean containsValue(int value) Returnstrueif this map maps one or more keys to the specified value.- See Also:
-
containsValue
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
containsValuein interfaceMap<Character,Integer>
-
forEach
default void forEach(it.unimi.dsi.fastutil.chars.CharIntBiConsumer consumer) Performs the given action for each entry in this map until all entries have been processed or the action throws an exception.This default implementation just delegates to
forEachon the type-specific entry set, taking care of usingfastForEachif available.- See Also:
-
forEach
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Mapmethod. -
getOrDefault
default int getOrDefault(char key, int defaultValue) Returns the value to which the specified key is mapped, or thedefaultValueif this map contains no mapping for the key.- Specified by:
getOrDefaultin interfaceit.unimi.dsi.fastutil.chars.Char2IntFunction- Parameters:
key- the key.defaultValue- the default mapping of the key.- Returns:
- the value to which the specified key is mapped, or the
defaultValueif this map contains no mapping for the key. - Since:
- 8.0.0
- See Also:
-
getOrDefault
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Mapmethod. -
putIfAbsent
default int putIfAbsent(char key, int 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:
-
remove
default boolean remove(char key, int 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:
trueif the value was removed.- Since:
- 8.0.0
- See Also:
-
replace
default boolean replace(char key, int oldValue, int 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:
trueif the value was replaced.- Since:
- 8.0.0
- See Also:
-
replace
default int replace(char key, int 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:
-
computeIfAbsent
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
mappingFunctioncannot 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:
-
computeIfAbsentNullable
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 isnull.Note that this version of computeIfAbsent() should be used only if you plan to return
nullin the mapping function.- 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,
or the default return value if the computed value is
null. - Since:
- 8.0.0
- See Also:
-
computeIfAbsent
default int computeIfAbsent(char key, it.unimi.dsi.fastutil.chars.Char2IntFunction 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. SinceFunctionhas acontainsKey()method, it is possible to avoid adding a key by havingcontainsKey()returnfalsefor 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:
-
computeIfAbsentPartial
@Deprecated default int computeIfAbsentPartial(char key, it.unimi.dsi.fastutil.chars.Char2IntFunction mappingFunction) Deprecated.Please usecomputeIfAbsent()instead. -
computeIfPresent
default int computeIfPresent(char key, BiFunction<? super Character, ? super Integer, ? extends Integer> 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:
-
compute
default int compute(char key, BiFunction<? super Character, ? super Integer, ? extends Integer> remappingFunction) Attempts to compute a mapping for the specified key and its current mapped value (ornullif 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:
-
merge
default int merge(char key, int value, BiFunction<? super Integer, ? super Integer, ? extends Integer> 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:
-
mergeInt
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:
-
mergeInt
default int mergeInt(char key, int value, it.unimi.dsi.fastutil.ints.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.- Since:
- 8.5.1
- See Also:
-
putIfAbsent
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Mapmethod.- Specified by:
putIfAbsentin interfaceMap<Character,Integer>
-
remove
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Mapmethod. -
replace
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Mapmethod. -
replace
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Mapmethod. -
computeIfAbsent
@Deprecated default Integer computeIfAbsent(Character key, Function<? super Character, ? extends Integer> mappingFunction) Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Mapmethod.- Specified by:
computeIfAbsentin interfaceMap<Character,Integer>
-
computeIfPresent
@Deprecated default Integer computeIfPresent(Character key, BiFunction<? super Character, ? super Integer, ? extends Integer> remappingFunction) Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Mapmethod.- Specified by:
computeIfPresentin interfaceMap<Character,Integer>
-
compute
@Deprecated default Integer compute(Character key, BiFunction<? super Character, ? super Integer, ? extends Integer> remappingFunction) Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Mapmethod. -
merge
@Deprecated default Integer merge(Character key, Integer value, BiFunction<? super Integer, ? super Integer, ? extends Integer> remappingFunction) Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Mapmethod. -
ofEntries
Returns an unmodifiable, type-specific map with the specified entries. SeeMap.ofEntries(Map.Entry[]) -
entry
Returns an unmodifiable, type-specific entry. SeeMap.entry(Object, Object)
-