it.unimi.dsi.fastutil.chars

Class Char2ObjectMaps.UnmodifiableMap<V>

java.lang.Object

it.unimi.dsi.fastutil.chars.AbstractChar2ObjectFunction<V>

it.unimi.dsi.fastutil.chars.Char2ObjectFunctions.UnmodifiableFunction<V>

it.unimi.dsi.fastutil.chars.Char2ObjectMaps.UnmodifiableMap<V>

All Implemented Interfaces:

Char2ObjectFunction<V>, Char2ObjectMap<V>, Serializable, Function<Character,V>, IntFunction<V>, Map<Character,V>

Direct Known Subclasses:

Char2ObjectSortedMaps.UnmodifiableSortedMap

Enclosing class:

Char2ObjectMaps

public static class Char2ObjectMaps.UnmodifiableMap<V>
extends Char2ObjectFunctions.UnmodifiableFunction<V>
implements Char2ObjectMap<V>, 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.Char2ObjectMap

Char2ObjectMap.Entry<V>, Char2ObjectMap.FastEntrySet<V>

Field Summary

Fields

Modifier and Type	Field and Description
protected ObjectSet<Char2ObjectMap.Entry<V>>	entries
protected CharSet	keys
protected Char2ObjectMap<V>	map
protected ObjectCollection<V>	values

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

function

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

defRetValue

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UnmodifiableMap(Char2ObjectMap<V> m)

Method Summary

Modifier and Type	Method and Description
ObjectSet<Char2ObjectMap.Entry<V>>	char2ObjectEntrySet() Returns a type-specific set view of the mappings contained in this map.
V	compute(Character key, BiFunction<? super Character,? super V,? extends V> remappingFunction) Deprecated. Please use the corresponding type-specific method instead.
V	compute(char key, BiFunction<? super Character,? super V,? extends V> remappingFunction) Attempts to compute a mapping for the specified key and its current mapped value (or null if there is no current mapping).
V	computeIfAbsent(Character key, Function<? super Character,? extends V> mappingFunction) Deprecated. Please use the corresponding type-specific method instead.
V	computeIfAbsent(char key, IntFunction<? extends V> 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.
V	computeIfAbsentPartial(char key, Char2ObjectFunction<? extends V> 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.
V	computeIfPresent(Character key, BiFunction<? super Character,? super V,? extends V> remappingFunction) Deprecated. Please use the corresponding type-specific method instead.
V	computeIfPresent(char key, BiFunction<? super Character,? super V,? extends V> 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(Object v)
ObjectSet<Map.Entry<Character,V>>	entrySet() Deprecated. Please use the corresponding type-specific method instead.
boolean	equals(Object o)
void	forEach(BiConsumer<? super Character,? super V> action)
V	getOrDefault(char key, V defaultValue) Returns the value to which the specified key is mapped, or the defaultValue if this map contains no mapping for the key.
V	getOrDefault(Object key, V defaultValue) Deprecated. Please use the corresponding type-specific method instead.
int	hashCode()
boolean	isEmpty()
CharSet	keySet()
V	merge(Character key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction) Deprecated. Please use the corresponding type-specific method instead.
V	merge(char key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction) If the specified key is not already associated with a value or is associated with null, associates it with the given non-null value.
void	putAll(Map<? extends Character,? extends V> m)
V	putIfAbsent(Character key, V value) Deprecated. Please use the corresponding type-specific method instead.
V	putIfAbsent(char key, V 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, Object 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.
V	replace(Character key, V value) Deprecated. Please use the corresponding type-specific method instead.
boolean	replace(Character key, V oldValue, V newValue) Deprecated. Please use the corresponding type-specific method instead.
V	replace(char key, V value) Replaces the entry for the specified key only if it is currently mapped to some value.
boolean	replace(char key, V oldValue, V newValue) Replaces the entry for the specified key only if currently mapped to the specified value.
void	replaceAll(BiFunction<? super Character,? super V,? extends V> function)
ObjectCollection<V>	values()

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

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

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

apply, get, put, remove

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

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Field Detail

map

protected final Char2ObjectMap<V> map

entries

protected transient ObjectSet<Char2ObjectMap.Entry<V>> entries

keys

protected transient CharSet keys

values

protected transient ObjectCollection<V> values

Constructor Detail

UnmodifiableMap

protected UnmodifiableMap(Char2ObjectMap<V> m)

Method Detail

containsValue

public boolean containsValue(Object v)

Specified by:

containsValue in interface Map<Character,V>

putAll

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

Specified by:

putAll in interface Map<Character,V>

char2ObjectEntrySet

public ObjectSet<Char2ObjectMap.Entry<V>> char2ObjectEntrySet()

Description copied from interface: Char2ObjectMap

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:

char2ObjectEntrySet in interface Char2ObjectMap<V>

Returns:

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

See Also:

Map.entrySet()

entrySet

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

Specified by:

entrySet in interface Map<Character,V>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()

keySet

public CharSet keySet()

Description copied from interface: Char2ObjectMap

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

Specified by:

keySet in interface Char2ObjectMap<V>

Specified by:

keySet in interface Map<Character,V>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public ObjectCollection<V> values()

Description copied from interface: Char2ObjectMap

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

Specified by:

values in interface Char2ObjectMap<V>

Specified by:

values in interface Map<Character,V>

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

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<Character,V>

Overrides:

hashCode in class Char2ObjectFunctions.UnmodifiableFunction<V>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<Character,V>

Overrides:

equals in class Char2ObjectFunctions.UnmodifiableFunction<V>

getOrDefault

public V getOrDefault(char key,
                      V defaultValue)

Description copied from interface: Char2ObjectMap

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 Char2ObjectMap<V>

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

Specified by:

forEach in interface Map<Character,V>

replaceAll

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

Specified by:

replaceAll in interface Map<Character,V>

putIfAbsent

public V putIfAbsent(char key,
                     V value)

Description copied from interface: Char2ObjectMap

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 Char2ObjectMap<V>

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

Description copied from interface: Char2ObjectMap

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

Specified by:

remove in interface Char2ObjectMap<V>

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

Description copied from interface: Char2ObjectMap

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

Specified by:

replace in interface Char2ObjectMap<V>

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

Description copied from interface: Char2ObjectMap

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

Specified by:

replace in interface Char2ObjectMap<V>

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 V computeIfAbsent(char key,
                         IntFunction<? extends V> mappingFunction)

Description copied from interface: Char2ObjectMap

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 Char2ObjectMap<V>

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)

computeIfAbsentPartial

public V computeIfAbsentPartial(char key,
                                Char2ObjectFunction<? extends V> mappingFunction)

Description copied from interface: Char2ObjectMap

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 Char2ObjectMap<V>

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

Description copied from interface: Char2ObjectMap

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 Char2ObjectMap<V>

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

Description copied from interface: Char2ObjectMap

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 Char2ObjectMap<V>

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

Description copied from interface: Char2ObjectMap

If the specified key is not already associated with a value or is associated with null, associates it with the given non-null 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 Char2ObjectMap<V>

Parameters:

key - key with which the resulting value is to be associated.

value - the non-null 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 V getOrDefault(Object key,
                                  V 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 Char2ObjectMap<V>

Specified by:

getOrDefault in interface Map<Character,V>

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 Char2ObjectMap<V>

Specified by:

remove in interface Map<Character,V>

replace

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

Specified by:

replace in interface Map<Character,V>

replace

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

Specified by:

replace in interface Map<Character,V>

putIfAbsent

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

Specified by:

putIfAbsent in interface Map<Character,V>

computeIfAbsent

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

Specified by:

computeIfAbsent in interface Map<Character,V>

computeIfPresent

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

Specified by:

computeIfPresent in interface Map<Character,V>

compute

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

Specified by:

compute in interface Map<Character,V>

merge

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

Specified by:

merge in interface Map<Character,V>