it.unimi.dsi.fastutil.ints

Class Int2CharMaps.UnmodifiableMap

java.lang.Object

it.unimi.dsi.fastutil.ints.AbstractInt2CharFunction

it.unimi.dsi.fastutil.ints.Int2CharFunctions.UnmodifiableFunction

it.unimi.dsi.fastutil.ints.Int2CharMaps.UnmodifiableMap

All Implemented Interfaces:

Int2CharFunction, Int2CharMap, Serializable, Function<Integer,Character>, IntUnaryOperator, Map<Integer,Character>

Direct Known Subclasses:

Int2CharSortedMaps.UnmodifiableSortedMap

Enclosing class:

Int2CharMaps

public static class Int2CharMaps.UnmodifiableMap
extends Int2CharFunctions.UnmodifiableFunction
implements Int2CharMap, Serializable

An unmodifiable wrapper class for maps.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2CharMap

Int2CharMap.Entry, Int2CharMap.FastEntrySet

Field Summary

Fields

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

Fields inherited from class it.unimi.dsi.fastutil.ints.Int2CharFunctions.UnmodifiableFunction

function

Fields inherited from class it.unimi.dsi.fastutil.ints.AbstractInt2CharFunction

defRetValue

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UnmodifiableMap(Int2CharMap m)

Method Summary

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

Methods inherited from class it.unimi.dsi.fastutil.ints.Int2CharFunctions.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.ints.Int2CharMap

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

Methods inherited from interface it.unimi.dsi.fastutil.ints.Int2CharFunction

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 Int2CharMap map

entries

protected transient ObjectSet<Int2CharMap.Entry> entries

keys

protected transient IntSet keys

values

protected transient CharCollection values

Constructor Detail

UnmodifiableMap

protected UnmodifiableMap(Int2CharMap m)

Method Detail

containsValue

public boolean containsValue(char v)

Description copied from interface: Int2CharMap

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

Specified by:

containsValue in interface Int2CharMap

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 Int2CharMap

Specified by:

containsValue in interface Map<Integer,Character>

putAll

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

Specified by:

putAll in interface Map<Integer,Character>

int2CharEntrySet

public ObjectSet<Int2CharMap.Entry> int2CharEntrySet()

Description copied from interface: Int2CharMap

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:

int2CharEntrySet in interface Int2CharMap

Returns:

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

See Also:

Map.entrySet()

entrySet

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

Specified by:

entrySet in interface Map<Integer,Character>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()

keySet

public IntSet keySet()

Description copied from interface: Int2CharMap

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

Specified by:

keySet in interface Int2CharMap

Specified by:

keySet in interface Map<Integer,Character>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public CharCollection values()

Description copied from interface: Int2CharMap

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

Specified by:

values in interface Int2CharMap

Specified by:

values in interface Map<Integer,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<Integer,Character>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<Integer,Character>

Overrides:

hashCode in class Int2CharFunctions.UnmodifiableFunction

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<Integer,Character>

Overrides:

equals in class Int2CharFunctions.UnmodifiableFunction

getOrDefault

public char getOrDefault(int key,
                         char defaultValue)

Description copied from interface: Int2CharMap

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 Int2CharMap

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 Integer,? super Character> action)

Specified by:

forEach in interface Map<Integer,Character>

replaceAll

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

Specified by:

replaceAll in interface Map<Integer,Character>

putIfAbsent

public char putIfAbsent(int key,
                        char value)

Description copied from interface: Int2CharMap

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 Int2CharMap

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(int key,
                      char value)

Description copied from interface: Int2CharMap

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

Specified by:

remove in interface Int2CharMap

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(int key,
                    char value)

Description copied from interface: Int2CharMap

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

Specified by:

replace in interface Int2CharMap

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(int key,
                       char oldValue,
                       char newValue)

Description copied from interface: Int2CharMap

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

Specified by:

replace in interface Int2CharMap

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(int key,
                            IntUnaryOperator mappingFunction)

Description copied from interface: Int2CharMap

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 Int2CharMap

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(int key,
                                    IntFunction<? extends Character> mappingFunction)

Description copied from interface: Int2CharMap

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 Int2CharMap

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(int key,
                                   Int2CharFunction mappingFunction)

Description copied from interface: Int2CharMap

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 Int2CharMap

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(int key,
                             BiFunction<? super Integer,? super Character,? extends Character> remappingFunction)

Description copied from interface: Int2CharMap

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 Int2CharMap

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(int key,
                    BiFunction<? super Integer,? super Character,? extends Character> remappingFunction)

Description copied from interface: Int2CharMap

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 Int2CharMap

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(int key,
                  char value,
                  BiFunction<? super Character,? super Character,? extends Character> remappingFunction)

Description copied from interface: Int2CharMap

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 Int2CharMap

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 Int2CharMap

Specified by:

getOrDefault in interface Map<Integer,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 Int2CharMap

Specified by:

remove in interface Map<Integer,Character>

replace

@Deprecated
public Character replace(Integer 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 Int2CharMap

Specified by:

replace in interface Map<Integer,Character>

replace

@Deprecated
public boolean replace(Integer 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 Int2CharMap

Specified by:

replace in interface Map<Integer,Character>

putIfAbsent

@Deprecated
public Character putIfAbsent(Integer 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 Int2CharMap

Specified by:

putIfAbsent in interface Map<Integer,Character>

computeIfAbsent

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

Specified by:

computeIfAbsent in interface Map<Integer,Character>

computeIfPresent

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

Specified by:

computeIfPresent in interface Map<Integer,Character>

compute

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

Specified by:

compute in interface Map<Integer,Character>

merge

@Deprecated
public Character merge(Integer 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 Int2CharMap

Specified by:

merge in interface Map<Integer,Character>