it.unimi.dsi.fastutil.chars

Class Char2IntMaps.UnmodifiableMap

java.lang.Object

it.unimi.dsi.fastutil.chars.AbstractChar2IntFunction

it.unimi.dsi.fastutil.chars.Char2IntFunctions.UnmodifiableFunction

it.unimi.dsi.fastutil.chars.Char2IntMaps.UnmodifiableMap

All Implemented Interfaces:

Char2IntFunction, Char2IntMap, Serializable, Function<Character,Integer>, IntUnaryOperator, Map<Character,Integer>

Direct Known Subclasses:

Char2IntSortedMaps.UnmodifiableSortedMap

Enclosing class:

Char2IntMaps

public static class Char2IntMaps.UnmodifiableMap
extends Char2IntFunctions.UnmodifiableFunction
implements Char2IntMap, 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.Char2IntMap

Char2IntMap.Entry, Char2IntMap.FastEntrySet

Field Summary

Fields

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

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

function

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

defRetValue

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UnmodifiableMap(Char2IntMap m)

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.
Integer	compute(Character key, BiFunction<? super Character,? super Integer,? extends Integer> remappingFunction) Deprecated. Please use the corresponding type-specific method instead.
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).
Integer	computeIfAbsent(Character key, Function<? super Character,? extends Integer> mappingFunction) Deprecated. Please use the corresponding type-specific method instead.
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.
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.
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.
Integer	computeIfPresent(Character key, BiFunction<? super Character,? super Integer,? extends Integer> remappingFunction) Deprecated. Please use the corresponding type-specific method instead.
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	containsValue(int 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,Integer>>	entrySet() Deprecated. Please use the corresponding type-specific method instead.
boolean	equals(Object o)
void	forEach(BiConsumer<? super Character,? super Integer> action)
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.
Integer	getOrDefault(Object key, Integer defaultValue) Deprecated. Please use the corresponding type-specific method instead.
int	hashCode()
boolean	isEmpty()
CharSet	keySet()
Integer	merge(Character key, Integer value, BiFunction<? super Integer,? super Integer,? extends Integer> remappingFunction) Deprecated. Please use the corresponding type-specific method instead.
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.
void	putAll(Map<? extends Character,? extends Integer> m)
Integer	putIfAbsent(Character key, Integer value) Deprecated. Please use the corresponding type-specific method instead.
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.
boolean	remove(char key, int 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.
Integer	replace(Character key, Integer value) Deprecated. Please use the corresponding type-specific method instead.
boolean	replace(Character key, Integer oldValue, Integer newValue) Deprecated. Please use the corresponding type-specific method instead.
int	replace(char key, int value) Replaces the entry for the specified key only if it is currently mapped to some value.
boolean	replace(char key, int oldValue, int newValue) Replaces the entry for the specified key only if currently mapped to the specified value.
void	replaceAll(BiFunction<? super Character,? super Integer,? extends Integer> function)
IntCollection	values()

Methods inherited from class it.unimi.dsi.fastutil.chars.Char2IntFunctions.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.Char2IntMap

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

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

Field Detail

map

protected final Char2IntMap map

entries

protected transient ObjectSet<Char2IntMap.Entry> entries

keys

protected transient CharSet keys

values

protected transient IntCollection values

Constructor Detail

UnmodifiableMap

protected UnmodifiableMap(Char2IntMap m)

Method Detail

containsValue

public boolean containsValue(int v)

Description copied from interface: Char2IntMap

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

Specified by:

containsValue in interface Char2IntMap

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 Char2IntMap

Specified by:

containsValue in interface Map<Character,Integer>

putAll

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

Specified by:

putAll in interface Map<Character,Integer>

char2IntEntrySet

public ObjectSet<Char2IntMap.Entry> char2IntEntrySet()

Description copied from interface: Char2IntMap

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:

char2IntEntrySet in interface Char2IntMap

Returns:

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

See Also:

Map.entrySet()

entrySet

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

Specified by:

entrySet in interface Map<Character,Integer>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()

keySet

public CharSet keySet()

Description copied from interface: Char2IntMap

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

Specified by:

keySet in interface Char2IntMap

Specified by:

keySet in interface Map<Character,Integer>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public IntCollection values()

Description copied from interface: Char2IntMap

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

Specified by:

values in interface Char2IntMap

Specified by:

values in interface Map<Character,Integer>

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

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<Character,Integer>

Overrides:

hashCode in class Char2IntFunctions.UnmodifiableFunction

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<Character,Integer>

Overrides:

equals in class Char2IntFunctions.UnmodifiableFunction

getOrDefault

public int getOrDefault(char key,
                        int defaultValue)

Description copied from interface: Char2IntMap

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 Char2IntMap

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 Integer> action)

Specified by:

forEach in interface Map<Character,Integer>

replaceAll

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

Specified by:

replaceAll in interface Map<Character,Integer>

putIfAbsent

public int putIfAbsent(char key,
                       int value)

Description copied from interface: Char2IntMap

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 Char2IntMap

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

Description copied from interface: Char2IntMap

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

Specified by:

remove in interface Char2IntMap

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

Description copied from interface: Char2IntMap

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

Specified by:

replace in interface Char2IntMap

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

Description copied from interface: Char2IntMap

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

Specified by:

replace in interface Char2IntMap

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

Description copied from interface: Char2IntMap

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 Char2IntMap

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

Description copied from interface: Char2IntMap

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 Char2IntMap

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 int computeIfAbsentPartial(char key,
                                  Char2IntFunction mappingFunction)

Description copied from interface: Char2IntMap

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 Char2IntMap

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

Description copied from interface: Char2IntMap

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 Char2IntMap

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

Description copied from interface: Char2IntMap

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 Char2IntMap

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

Description copied from interface: Char2IntMap

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 Char2IntMap

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 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 Char2IntMap

Specified by:

getOrDefault in interface Map<Character,Integer>

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 Char2IntMap

Specified by:

remove in interface Map<Character,Integer>

replace

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

Specified by:

replace in interface Map<Character,Integer>

replace

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

Specified by:

replace in interface Map<Character,Integer>

putIfAbsent

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

Specified by:

putIfAbsent in interface Map<Character,Integer>

computeIfAbsent

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

Specified by:

computeIfAbsent in interface Map<Character,Integer>

computeIfPresent

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

Specified by:

computeIfPresent in interface Map<Character,Integer>

compute

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

Specified by:

compute in interface Map<Character,Integer>

merge

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

Specified by:

merge in interface Map<Character,Integer>