it.unimi.dsi.fastutil.chars

Interface Char2CharMap

All Superinterfaces:

it.unimi.dsi.fastutil.chars.Char2CharFunction, java.util.function.Function<java.lang.Character,java.lang.Character>, java.util.function.IntUnaryOperator, java.util.Map<java.lang.Character,java.lang.Character>

All Known Subinterfaces:

Char2CharSortedMap

All Known Implementing Classes:

AbstractChar2CharMap, AbstractChar2CharSortedMap, Char2CharArrayMap, Char2CharAVLTreeMap, Char2CharLinkedOpenHashMap, Char2CharMaps.EmptyMap, Char2CharMaps.Singleton, Char2CharMaps.SynchronizedMap, Char2CharMaps.UnmodifiableMap, Char2CharOpenCustomHashMap, Char2CharOpenHashMap, Char2CharRBTreeMap, Char2CharSortedMaps.EmptySortedMap, Char2CharSortedMaps.Singleton, Char2CharSortedMaps.SynchronizedSortedMap, Char2CharSortedMaps.UnmodifiableSortedMap

public interface Char2CharMap
extends it.unimi.dsi.fastutil.chars.Char2CharFunction, java.util.Map<java.lang.Character,java.lang.Character>

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 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).

See Also:

Map

Nested Class Summary

Nested Classes

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.

Method Summary

Modifier and Type	Method and Description
it.unimi.dsi.fastutil.objects.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 java.lang.Character	compute(java.lang.Character key, 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	compute(char key, java.util.function.BiFunction<? super java.lang.Character,? super java.lang.Character,? extends java.lang.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 java.lang.Character	computeIfAbsent(java.lang.Character key, java.util.function.Function<? super java.lang.Character,? extends java.lang.Character> mappingFunction) Deprecated. Please use the corresponding type-specific method instead.
default char	computeIfAbsent(char key, it.unimi.dsi.fastutil.chars.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 char	computeIfAbsent(char key, java.util.function.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, java.util.function.IntFunction<? extends java.lang.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, it.unimi.dsi.fastutil.chars.Char2CharFunction mappingFunction) Deprecated. Please use computeIfAbsent() instead.
default java.lang.Character	computeIfPresent(java.lang.Character key, 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	computeIfPresent(char key, java.util.function.BiFunction<? super java.lang.Character,? 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.
boolean	containsKey(char key) Returns true if this function contains a mapping for the specified key.
default boolean	containsKey(java.lang.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(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 it.unimi.dsi.fastutil.objects.ObjectSet<java.util.Map.Entry<java.lang.Character,java.lang.Character>>	entrySet() Deprecated. Please use the corresponding type-specific method instead.
default void	forEach(java.util.function.BiConsumer<? super java.lang.Character,? 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(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 java.lang.Character	getOrDefault(java.lang.Object key, java.lang.Character defaultValue) Deprecated. Please use the corresponding type-specific method instead.
it.unimi.dsi.fastutil.chars.CharSet	keySet()
default java.lang.Character	merge(java.lang.Character 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	merge(char 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 given value.
default char	mergeChar(char key, char value, it.unimi.dsi.fastutil.chars.CharBinaryOperator remappingFunction) If the specified key is not already associated with a value, associates it with the given value.
default char	mergeChar(char key, char value, java.util.function.IntBinaryOperator remappingFunction) If the specified key is not already associated with a value, associates it with the given value.
default java.lang.Character	put(java.lang.Character key, java.lang.Character value) Deprecated. Please use the corresponding type-specific method instead.
default java.lang.Character	putIfAbsent(java.lang.Character key, java.lang.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 java.lang.Character	remove(java.lang.Object key) Deprecated. Please use the corresponding type-specific method instead.
default boolean	remove(java.lang.Object key, java.lang.Object value) Deprecated. Please use the corresponding type-specific method instead.
default java.lang.Character	replace(java.lang.Character key, java.lang.Character value) Deprecated. Please use the corresponding type-specific method instead.
default boolean	replace(java.lang.Character key, java.lang.Character oldValue, java.lang.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.
it.unimi.dsi.fastutil.chars.CharCollection	values()

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

andThen, andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, applyAsInt, compose, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort, get, identity, put, remove

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

apply

Methods inherited from interface java.util.function.IntUnaryOperator

andThen, compose

Methods inherited from interface java.util.Map

equals, 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 java.util.Map<java.lang.Character,java.lang.Character>

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 java.util.Map<java.lang.Character,java.lang.Character>

Throws:

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

defaultReturnValue

void defaultReturnValue(char 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 it.unimi.dsi.fastutil.chars.Char2CharFunction

Parameters:

rv - the new default return value.

See Also:

defaultReturnValue()

defaultReturnValue

char defaultReturnValue()

Gets the default return value.

Specified by:

defaultReturnValue in interface it.unimi.dsi.fastutil.chars.Char2CharFunction

Returns:

the current default return value.

char2CharEntrySet

it.unimi.dsi.fastutil.objects.ObjectSet<Char2CharMap.Entry> char2CharEntrySet()

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 it.unimi.dsi.fastutil.objects.ObjectSet<java.util.Map.Entry<java.lang.Character,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 interface java.util.Map<java.lang.Character,java.lang.Character>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()

put

@Deprecated
default java.lang.Character put(java.lang.Character key,
                                            java.lang.Character value)

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

This default implementation just delegates to the corresponding type-specific–function method.

Specified by:

put in interface it.unimi.dsi.fastutil.chars.Char2CharFunction

Specified by:

put in interface java.util.Map<java.lang.Character,java.lang.Character>

get

@Deprecated
default java.lang.Character get(java.lang.Object key)

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

This default implementation just delegates to the corresponding type-specific–function method.

Specified by:

get in interface it.unimi.dsi.fastutil.chars.Char2CharFunction

Specified by:

get in interface java.util.Map<java.lang.Character,java.lang.Character>

remove

@Deprecated
default java.lang.Character remove(java.lang.Object key)

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

This default implementation just delegates to the corresponding type-specific–function method.

Specified by:

remove in interface it.unimi.dsi.fastutil.chars.Char2CharFunction

Specified by:

remove in interface java.util.Map<java.lang.Character,java.lang.Character>

keySet

it.unimi.dsi.fastutil.chars.CharSet keySet()

Specified by:

keySet in interface java.util.Map<java.lang.Character,java.lang.Character>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

it.unimi.dsi.fastutil.chars.CharCollection values()

Specified by:

values in interface java.util.Map<java.lang.Character,java.lang.Character>

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 it.unimi.dsi.fastutil.chars.Char2CharFunction

Parameters:

key - the key.

Returns:

true if this function associates a value to key.

See Also:

Map.containsKey(Object)

containsKey

@Deprecated
default boolean containsKey(java.lang.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 it.unimi.dsi.fastutil.chars.Char2CharFunction

Specified by:

containsKey in interface java.util.Map<java.lang.Character,java.lang.Character>

containsValue

boolean containsValue(char 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(java.lang.Object value)

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

Specified by:

containsValue in interface java.util.Map<java.lang.Character,java.lang.Character>

forEach

default void forEach(java.util.function.BiConsumer<? super java.lang.Character,? super java.lang.Character> consumer)

Specified by:

forEach in interface java.util.Map<java.lang.Character,java.lang.Character>

getOrDefault

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.

Specified by:

getOrDefault in interface it.unimi.dsi.fastutil.chars.Char2CharFunction

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.

This default implementation just delegates to the corresponding Map method.

Specified by:

getOrDefault in interface it.unimi.dsi.fastutil.chars.Char2CharFunction

Specified by:

getOrDefault in interface java.util.Map<java.lang.Character,java.lang.Character>

putIfAbsent

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.

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,
                       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(char 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(char 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(char key,
                             java.util.function.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 char computeIfAbsentNullable(char key,
                                     java.util.function.IntFunction<? extends java.lang.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.

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)

computeIfAbsent

default char computeIfAbsent(char key,
                             it.unimi.dsi.fastutil.chars.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.

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)

computeIfAbsentPartial

@Deprecated
default char computeIfAbsentPartial(char key,
                                                it.unimi.dsi.fastutil.chars.Char2CharFunction mappingFunction)

Deprecated. Please use computeIfAbsent() instead.

computeIfPresent

default char computeIfPresent(char key,
                              java.util.function.BiFunction<? super java.lang.Character,? 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)

compute

default char compute(char key,
                     java.util.function.BiFunction<? super java.lang.Character,? super java.lang.Character,? extends java.lang.Character> 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 char merge(char 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 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)

mergeChar

default char mergeChar(char key,
                       char value,
                       it.unimi.dsi.fastutil.chars.CharBinaryOperator 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.

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)

mergeChar

default char mergeChar(char key,
                       char value,
                       java.util.function.IntBinaryOperator 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.

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)

putIfAbsent

@Deprecated
default java.lang.Character putIfAbsent(java.lang.Character 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 interface java.util.Map<java.lang.Character,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 interface java.util.Map<java.lang.Character,java.lang.Character>

replace

@Deprecated
default boolean replace(java.lang.Character 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 interface java.util.Map<java.lang.Character,java.lang.Character>

replace

@Deprecated
default java.lang.Character replace(java.lang.Character 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 interface java.util.Map<java.lang.Character,java.lang.Character>

computeIfAbsent

@Deprecated
default java.lang.Character computeIfAbsent(java.lang.Character key,
                                                        java.util.function.Function<? super java.lang.Character,? extends java.lang.Character> 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 java.util.Map<java.lang.Character,java.lang.Character>

computeIfPresent

@Deprecated
default java.lang.Character computeIfPresent(java.lang.Character key,
                                                         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:

computeIfPresent in interface java.util.Map<java.lang.Character,java.lang.Character>

compute

@Deprecated
default java.lang.Character compute(java.lang.Character key,
                                                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:

compute in interface java.util.Map<java.lang.Character,java.lang.Character>

merge

@Deprecated
default java.lang.Character merge(java.lang.Character 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 interface java.util.Map<java.lang.Character,java.lang.Character>