it.unimi.dsi.fastutil.chars

Interface Char2IntMap

All Superinterfaces:

Char2IntFunction, 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

public interface Char2IntMap
extends Char2IntFunction, Map<Character,Integer>

A type-specific 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:

Map

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Char2IntMap.Entry A type-specific Map.Entry; provides some additional methods that use polymorphism to avoid (un)boxing.
static interface	Char2IntMap.FastEntrySet An entry set providing fast iteration.

Method Summary

Modifier and Type	Method and Description
ObjectSet<Char2IntMap.Entry>	char2IntEntrySet() 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 Integer	compute(Character key, BiFunction<? super Character,? super Integer,? extends Integer> remappingFunction) Deprecated. Please use the corresponding type-specific method instead.
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 (or null if there is no current mapping).
default Integer	computeIfAbsent(Character key, Function<? super Character,? extends Integer> mappingFunction) Deprecated. Please use the corresponding type-specific method instead.
default int	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 int	computeIfAbsentNullable(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 is null.
default int	computeIfAbsentPartial(char key, 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 Integer	computeIfPresent(Character key, BiFunction<? super Character,? super Integer,? extends Integer> remappingFunction) Deprecated. Please use the corresponding type-specific method instead.
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.
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(int 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.
int	defaultReturnValue() Gets the default return value.
void	defaultReturnValue(int rv) Sets the default return value (optional operation).
default ObjectSet<Map.Entry<Character,Integer>>	entrySet() Deprecated. Please use the corresponding type-specific method instead.
default Integer	get(Object key) Deprecated. Please use the corresponding type-specific method instead.
default int	getOrDefault(char key, int defaultValue) Returns the value to which the specified key is mapped, or the defaultValue if this map contains no mapping for the key.
default Integer	getOrDefault(Object key, Integer defaultValue) Deprecated. Please use the corresponding type-specific method instead.
CharSet	keySet()
default Integer	merge(Character key, Integer value, BiFunction<? super Integer,? super Integer,? extends Integer> remappingFunction) Deprecated. Please use the corresponding type-specific method instead.
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 given value.
default Integer	put(Character key, Integer value) Deprecated. Please use the corresponding type-specific method instead.
default Integer	putIfAbsent(Character key, Integer value) Deprecated. Please use the corresponding type-specific method instead.
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.
default boolean	remove(char key, int value) Removes the entry for the specified key only if it is currently mapped to the specified value.
default Integer	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 Integer	replace(Character key, Integer value) Deprecated. Please use the corresponding type-specific method instead.
default boolean	replace(Character key, Integer oldValue, Integer newValue) Deprecated. Please use the corresponding type-specific method instead.
default int	replace(char key, int value) Replaces the entry for the specified key only if it is currently mapped to some value.
default boolean	replace(char key, int oldValue, int 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.
IntCollection	values()

Methods inherited from interface it.unimi.dsi.fastutil.chars.Char2IntFunction

applyAsInt, get, put, remove

Methods inherited from interface it.unimi.dsi.fastutil.Function

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Methods inherited from interface java.util.function.IntUnaryOperator

andThen, compose, identity

Methods inherited from interface java.util.Map

equals, forEach, hashCode, isEmpty, putAll, replaceAll

Method Detail

size

int size()

Returns the number of key/value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface Map<Character,Integer>

Returns:

the number of key-value mappings in this map.

See Also:

Size64

clear

default void clear()

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

Specified by:

clear in interface Map<Character,Integer>

Throws:

UnsupportedOperationException - if the clear() operation is not supported by this map

See Also:

Map.clear()

defaultReturnValue

void defaultReturnValue(int rv)

Sets the default return value (optional operation). This value must be returned by type-specific versions of get(), put() and remove() to denote that the map does not contain the specified key. It must be 0/false by default.

Specified by:

defaultReturnValue in interface Char2IntFunction

Parameters:

rv - the new default return value.

See Also:

defaultReturnValue()

defaultReturnValue

int defaultReturnValue()

Gets the default return value.

Specified by:

defaultReturnValue in interface Char2IntFunction

Returns:

the current default return value.

char2IntEntrySet

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 an ObjectSet 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<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.

Note that this specification strengthens the one given in Map.entrySet().

Specified by:

entrySet in interface Map<Character,Integer>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()

put

@Deprecated
default Integer put(Character key,
                                Integer 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 interface Char2IntFunction

Specified by:

put in interface Map<Character,Integer>

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 Integer get(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 interface Char2IntFunction

Specified by:

get in interface Map<Character,Integer>

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 Integer remove(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 interface Char2IntFunction

Specified by:

remove in interface Map<Character,Integer>

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

CharSet keySet()

Note that this specification strengthens the one given in Map.keySet().

Specified by:

keySet in interface Map<Character,Integer>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

IntCollection values()

Note that this specification strengthens the one given in Map.values().

Specified by:

values in interface Map<Character,Integer>

Returns:

a set view of the values contained in this map.

See Also:

Map.values()

containsKey

boolean containsKey(char key)

Returns true if this function contains a mapping for the specified key.

Specified by:

containsKey in interface Char2IntFunction

Parameters:

key - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

containsKey

@Deprecated
default boolean containsKey(Object key)

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.

Specified by:

containsKey in interface Char2IntFunction

Specified by:

containsKey in interface Map<Character,Integer>

Parameters:

key - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

containsValue

boolean containsValue(int value)

Returns true if this map maps one or more keys to the specified value.

See Also:

Map.containsValue(Object)

containsValue

@Deprecated
default boolean containsValue(Object value)

Deprecated. Please use the corresponding type-specific method instead.

Specified by:

containsValue in interface Map<Character,Integer>

getOrDefault

default int getOrDefault(char key,
                         int defaultValue)

Returns the value to which the specified key is mapped, or the defaultValue if this map contains no mapping for the key.

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)

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:

Map.putIfAbsent(Object, Object)

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:

true if the value was removed.

Since:

8.0.0

See Also:

Map.remove(Object, Object)

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:

true if the value was replaced.

Since:

8.0.0

See Also:

Map.replace(Object, Object, Object)

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:

Map.replace(Object, Object)

computeIfAbsent

default int 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.

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.

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)

computeIfAbsentNullable

default int computeIfAbsentNullable(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 is null.

Note that this version of computeIfAbsent() should be used only if you plan to return null in 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:

Map.computeIfAbsent(Object, java.util.function.Function)

computeIfAbsentPartial

default int computeIfAbsentPartial(char key,
                                   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's Function. Since Function has a containsKey() method, it is possible to avoid adding a key by having containsKey() return false 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)

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:

Map.computeIfPresent(Object, java.util.function.BiFunction)

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 (or 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.

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 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 given value. Otherwise, replaces the associated value with the results of the given remapping function, or removes if the result is null.

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)

getOrDefault

@Deprecated
default Integer getOrDefault(Object key,
                                         Integer defaultValue)

Deprecated. Please use the corresponding type-specific method instead.

This default implementation just delegates to the corresponding Map method.

Specified by:

getOrDefault in interface Map<Character,Integer>

putIfAbsent

@Deprecated
default Integer putIfAbsent(Character key,
                                        Integer value)

Deprecated. Please use the corresponding type-specific method instead.

This default implementation just delegates to the corresponding Map method.

Specified by:

putIfAbsent in interface Map<Character,Integer>

remove

@Deprecated
default boolean remove(Object key,
                                   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 interface Map<Character,Integer>

replace

@Deprecated
default boolean replace(Character key,
                                    Integer oldValue,
                                    Integer newValue)

Deprecated. Please use the corresponding type-specific method instead.

This default implementation just delegates to the corresponding Map method.

Specified by:

replace in interface Map<Character,Integer>

replace

@Deprecated
default Integer replace(Character key,
                                    Integer value)

Deprecated. Please use the corresponding type-specific method instead.

This default implementation just delegates to the corresponding Map method.

Specified by:

replace in interface Map<Character,Integer>

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 Map method.

Specified by:

computeIfAbsent in interface Map<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 Map method.

Specified by:

computeIfPresent in interface Map<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 Map method.

Specified by:

compute in interface Map<Character,Integer>

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 Map method.

Specified by:

merge in interface Map<Character,Integer>