it.unimi.dsi.fastutil.chars

Class Char2CharMaps.UnmodifiableMap

java.lang.Object

it.unimi.dsi.fastutil.chars.AbstractChar2CharFunction

it.unimi.dsi.fastutil.chars.Char2CharFunctions.UnmodifiableFunction

it.unimi.dsi.fastutil.chars.Char2CharMaps.UnmodifiableMap

All Implemented Interfaces:

Char2CharFunction, Char2CharMap, Serializable, Function<Character,Character>, IntUnaryOperator, Map<Character,Character>

Direct Known Subclasses:

Char2CharSortedMaps.UnmodifiableSortedMap

Enclosing class:

Char2CharMaps

public static class Char2CharMaps.UnmodifiableMap
extends Char2CharFunctions.UnmodifiableFunction
implements Char2CharMap, Serializable

An unmodifiable wrapper class for maps.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.chars.Char2CharMap

Char2CharMap.Entry, Char2CharMap.FastEntrySet

Field Summary

Fields

Modifier and Type	Field and Description
protected ObjectSet<Char2CharMap.Entry>	entries
protected CharSet	keys
protected Char2CharMap	map
protected CharCollection	values

Fields inherited from class it.unimi.dsi.fastutil.chars.Char2CharFunctions.UnmodifiableFunction

function

Fields inherited from class it.unimi.dsi.fastutil.chars.AbstractChar2CharFunction

defRetValue

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UnmodifiableMap(Char2CharMap m)

Method Summary

Modifier and Type	Method and Description
ObjectSet<Char2CharMap.Entry>	char2CharEntrySet() Returns a type-specific set view of the mappings contained in this map.
Character	compute(Character key, BiFunction<? super Character,? super Character,? extends Character> remappingFunction) Deprecated. Please use the corresponding type-specific method instead.
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).
Character	computeIfAbsent(Character key, Function<? super Character,? extends Character> mappingFunction) Deprecated. Please use the corresponding type-specific method instead.
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.
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.
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.
Character	computeIfPresent(Character key, BiFunction<? super Character,? super Character,? extends Character> remappingFunction) Deprecated. Please use the corresponding type-specific method instead.
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	containsValue(char v) Returns true if this map maps one or more keys to the specified value.
boolean	containsValue(Object ov) Deprecated. Please use the corresponding type-specific method instead.
ObjectSet<Map.Entry<Character,Character>>	entrySet() Deprecated. Please use the corresponding type-specific method instead.
boolean	equals(Object o)
void	forEach(BiConsumer<? super Character,? super Character> action)
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.
Character	getOrDefault(Object key, Character defaultValue) Deprecated. Please use the corresponding type-specific method instead.
int	hashCode()
boolean	isEmpty()
CharSet	keySet()
Character	merge(Character key, Character value, BiFunction<? super Character,? super Character,? extends Character> remappingFunction) Deprecated. Please use the corresponding type-specific method instead.
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.
void	putAll(Map<? extends Character,? extends Character> m)
Character	putIfAbsent(Character key, Character value) Deprecated. Please use the corresponding type-specific method instead.
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.
boolean	remove(char key, char value) Removes the entry for the specified key only if it is currently mapped to the specified value.
boolean	remove(Object key, Object value) Deprecated. Please use the corresponding type-specific method instead.
Character	replace(Character key, Character value) Deprecated. Please use the corresponding type-specific method instead.
boolean	replace(Character key, Character oldValue, Character newValue) Deprecated. Please use the corresponding type-specific method instead.
char	replace(char key, char value) Replaces the entry for the specified key only if it is currently mapped to some value.
boolean	replace(char key, char oldValue, char newValue) Replaces the entry for the specified key only if currently mapped to the specified value.
void	replaceAll(BiFunction<? super Character,? super Character,? extends Character> function)
CharCollection	values()

Methods inherited from class it.unimi.dsi.fastutil.chars.Char2CharFunctions.UnmodifiableFunction

clear, containsKey, defaultReturnValue, defaultReturnValue, get, get, put, put, remove, remove, size, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

clear, containsKey, containsKey, defaultReturnValue, defaultReturnValue, get, put, remove, size

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

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

Field Detail

map

protected final Char2CharMap map

entries

protected transient ObjectSet<Char2CharMap.Entry> entries

keys

protected transient CharSet keys

values

protected transient CharCollection values

Constructor Detail

UnmodifiableMap

protected UnmodifiableMap(Char2CharMap m)

Method Detail

containsValue

public boolean containsValue(char v)

Description copied from interface: Char2CharMap

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

Specified by:

containsValue in interface Char2CharMap

See Also:

Map.containsValue(Object)

containsValue

@Deprecated
public boolean containsValue(Object ov)

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

Specified by:

containsValue in interface Char2CharMap

Specified by:

containsValue in interface Map<Character,Character>

putAll

public void putAll(Map<? extends Character,? extends Character> m)

Specified by:

putAll in interface Map<Character,Character>

char2CharEntrySet

public ObjectSet<Char2CharMap.Entry> char2CharEntrySet()

Description copied from interface: Char2CharMap

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

Specified by:

char2CharEntrySet in interface Char2CharMap

Returns:

a type-specific set view of the mappings contained in this map.

See Also:

Map.entrySet()

entrySet

@Deprecated
public ObjectSet<Map.Entry<Character,Character>> 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 Char2CharMap

Specified by:

entrySet in interface Map<Character,Character>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()

keySet

public CharSet keySet()

Description copied from interface: Char2CharMap

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

Specified by:

keySet in interface Char2CharMap

Specified by:

keySet in interface Map<Character,Character>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public CharCollection values()

Description copied from interface: Char2CharMap

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

Specified by:

values in interface Char2CharMap

Specified by:

values in interface Map<Character,Character>

Returns:

a set view of the values contained in this map.

See Also:

Map.values()

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Character,Character>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<Character,Character>

Overrides:

hashCode in class Char2CharFunctions.UnmodifiableFunction

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<Character,Character>

Overrides:

equals in class Char2CharFunctions.UnmodifiableFunction

getOrDefault

public char getOrDefault(char key,
                         char defaultValue)

Description copied from interface: Char2CharMap

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 Char2CharMap

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.

See Also:

Map.getOrDefault(Object, Object)

forEach

public void forEach(BiConsumer<? super Character,? super Character> action)

Specified by:

forEach in interface Map<Character,Character>

replaceAll

public void replaceAll(BiFunction<? super Character,? super Character,? extends Character> function)

Specified by:

replaceAll in interface Map<Character,Character>

putIfAbsent

public char putIfAbsent(char key,
                        char value)

Description copied from interface: Char2CharMap

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.

Specified by:

putIfAbsent in interface Char2CharMap

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.

See Also:

Map.putIfAbsent(Object, Object)

remove

public boolean remove(char key,
                      char value)

Description copied from interface: Char2CharMap

Removes the entry for the specified key only if it is currently mapped to the specified value.

Specified by:

remove in interface Char2CharMap

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.

See Also:

Map.remove(Object, Object)

replace

public char replace(char key,
                    char value)

Description copied from interface: Char2CharMap

Replaces the entry for the specified key only if it is currently mapped to some value.

Specified by:

replace in interface Char2CharMap

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.

See Also:

Map.replace(Object, Object)

replace

public boolean replace(char key,
                       char oldValue,
                       char newValue)

Description copied from interface: Char2CharMap

Replaces the entry for the specified key only if currently mapped to the specified value.

Specified by:

replace in interface Char2CharMap

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.

See Also:

Map.replace(Object, Object, Object)

computeIfAbsent

public char computeIfAbsent(char key,
                            IntUnaryOperator mappingFunction)

Description copied from interface: Char2CharMap

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.

Specified by:

computeIfAbsent in interface Char2CharMap

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.

See Also:

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

computeIfAbsentNullable

public char computeIfAbsentNullable(char key,
                                    IntFunction<? extends Character> mappingFunction)

Description copied from interface: Char2CharMap

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.

Specified by:

computeIfAbsentNullable in interface Char2CharMap

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.

See Also:

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

computeIfAbsentPartial

public char computeIfAbsentPartial(char key,
                                   Char2CharFunction mappingFunction)

Description copied from interface: Char2CharMap

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.

Specified by:

computeIfAbsentPartial in interface Char2CharMap

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.

See Also:

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

computeIfPresent

public char computeIfPresent(char key,
                             BiFunction<? super Character,? super Character,? extends Character> remappingFunction)

Description copied from interface: Char2CharMap

If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.

Specified by:

computeIfPresent in interface Char2CharMap

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.

See Also:

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

compute

public char compute(char key,
                    BiFunction<? super Character,? super Character,? extends Character> remappingFunction)

Description copied from interface: Char2CharMap

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.

Specified by:

compute in interface Char2CharMap

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.

See Also:

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

merge

public char merge(char key,
                  char value,
                  BiFunction<? super Character,? super Character,? extends Character> remappingFunction)

Description copied from interface: Char2CharMap

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.

Specified by:

merge in interface Char2CharMap

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.

See Also:

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

getOrDefault

@Deprecated
public Character getOrDefault(Object key,
                                          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 Char2CharMap

Specified by:

getOrDefault in interface Map<Character,Character>

remove

@Deprecated
public 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 Char2CharMap

Specified by:

remove in interface Map<Character,Character>

replace

@Deprecated
public Character replace(Character key,
                                     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 Char2CharMap

Specified by:

replace in interface Map<Character,Character>

replace

@Deprecated
public boolean replace(Character key,
                                   Character oldValue,
                                   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 Char2CharMap

Specified by:

replace in interface Map<Character,Character>

putIfAbsent

@Deprecated
public Character putIfAbsent(Character key,
                                         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 Char2CharMap

Specified by:

putIfAbsent in interface Map<Character,Character>

computeIfAbsent

@Deprecated
public Character computeIfAbsent(Character key,
                                             Function<? super Character,? extends 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 Char2CharMap

Specified by:

computeIfAbsent in interface Map<Character,Character>

computeIfPresent

@Deprecated
public Character computeIfPresent(Character key,
                                              BiFunction<? super Character,? super Character,? extends 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 Char2CharMap

Specified by:

computeIfPresent in interface Map<Character,Character>

compute

@Deprecated
public Character compute(Character key,
                                     BiFunction<? super Character,? super Character,? extends 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 Char2CharMap

Specified by:

compute in interface Map<Character,Character>

merge

@Deprecated
public Character merge(Character key,
                                   Character value,
                                   BiFunction<? super Character,? super Character,? extends 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 Char2CharMap

Specified by:

merge in interface Map<Character,Character>