it.unimi.dsi.fastutil.objects

Class Reference2CharMaps.UnmodifiableMap<K>

java.lang.Object

it.unimi.dsi.fastutil.objects.AbstractReference2CharFunction<K>

it.unimi.dsi.fastutil.objects.Reference2CharFunctions.UnmodifiableFunction<K>

it.unimi.dsi.fastutil.objects.Reference2CharMaps.UnmodifiableMap<K>

All Implemented Interfaces:

Reference2CharFunction<K>, Reference2CharMap<K>, Serializable, Function<K,Character>, ToIntFunction<K>, Map<K,Character>

Direct Known Subclasses:

Reference2CharSortedMaps.UnmodifiableSortedMap

Enclosing class:

Reference2CharMaps

public static class Reference2CharMaps.UnmodifiableMap<K>
extends Reference2CharFunctions.UnmodifiableFunction<K>
implements Reference2CharMap<K>, Serializable

An unmodifiable wrapper class for maps.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.objects.Reference2CharMap

Reference2CharMap.Entry<K>, Reference2CharMap.FastEntrySet<K>

Field Summary

Fields

Modifier and Type	Field and Description
protected ObjectSet<Reference2CharMap.Entry<K>>	entries
protected ReferenceSet<K>	keys
protected Reference2CharMap<K>	map
protected CharCollection	values

Fields inherited from class it.unimi.dsi.fastutil.objects.Reference2CharFunctions.UnmodifiableFunction

function

Fields inherited from class it.unimi.dsi.fastutil.objects.AbstractReference2CharFunction

defRetValue

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UnmodifiableMap(Reference2CharMap<K> m)

Method Summary

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

Methods inherited from class it.unimi.dsi.fastutil.objects.Reference2CharFunctions.UnmodifiableFunction

clear, containsKey, defaultReturnValue, defaultReturnValue, get, getChar, put, put, remove, removeChar, 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.objects.Reference2CharMap

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

Methods inherited from interface it.unimi.dsi.fastutil.objects.Reference2CharFunction

applyAsInt, getChar, put, removeChar

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 Reference2CharMap<K> map

entries

protected transient ObjectSet<Reference2CharMap.Entry<K>> entries

keys

protected transient ReferenceSet<K> keys

values

protected transient CharCollection values

Constructor Detail

UnmodifiableMap

protected UnmodifiableMap(Reference2CharMap<K> m)

Method Detail

containsValue

public boolean containsValue(char v)

Description copied from interface: Reference2CharMap

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

Specified by:

containsValue in interface Reference2CharMap<K>

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 Reference2CharMap<K>

Specified by:

containsValue in interface Map<K,Character>

putAll

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

Specified by:

putAll in interface Map<K,Character>

reference2CharEntrySet

public ObjectSet<Reference2CharMap.Entry<K>> reference2CharEntrySet()

Description copied from interface: Reference2CharMap

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:

reference2CharEntrySet in interface Reference2CharMap<K>

Returns:

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

See Also:

Map.entrySet()

entrySet

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

Specified by:

entrySet in interface Map<K,Character>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()

keySet

public ReferenceSet<K> keySet()

Description copied from interface: Reference2CharMap

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

Specified by:

keySet in interface Reference2CharMap<K>

Specified by:

keySet in interface Map<K,Character>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public CharCollection values()

Description copied from interface: Reference2CharMap

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

Specified by:

values in interface Reference2CharMap<K>

Specified by:

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

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,Character>

Overrides:

hashCode in class Reference2CharFunctions.UnmodifiableFunction<K>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<K,Character>

Overrides:

equals in class Reference2CharFunctions.UnmodifiableFunction<K>

getOrDefault

public char getOrDefault(Object key,
                         char defaultValue)

Description copied from interface: Reference2CharMap

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 Reference2CharMap<K>

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

Specified by:

forEach in interface Map<K,Character>

replaceAll

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

Specified by:

replaceAll in interface Map<K,Character>

putIfAbsent

public char putIfAbsent(K key,
                        char value)

Description copied from interface: Reference2CharMap

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 Reference2CharMap<K>

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

Description copied from interface: Reference2CharMap

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

Specified by:

remove in interface Reference2CharMap<K>

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

Description copied from interface: Reference2CharMap

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

Specified by:

replace in interface Reference2CharMap<K>

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

Description copied from interface: Reference2CharMap

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

Specified by:

replace in interface Reference2CharMap<K>

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)

computeCharIfAbsent

public char computeCharIfAbsent(K key,
                                ToIntFunction<? super K> mappingFunction)

Description copied from interface: Reference2CharMap

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:

computeCharIfAbsent in interface Reference2CharMap<K>

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)

computeCharIfAbsentPartial

public char computeCharIfAbsentPartial(K key,
                                       Reference2CharFunction<? super K> mappingFunction)

Description copied from interface: Reference2CharMap

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:

computeCharIfAbsentPartial in interface Reference2CharMap<K>

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)

computeCharIfPresent

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

Description copied from interface: Reference2CharMap

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:

computeCharIfPresent in interface Reference2CharMap<K>

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)

computeChar

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

Description copied from interface: Reference2CharMap

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:

computeChar in interface Reference2CharMap<K>

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)

mergeChar

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

Description copied from interface: Reference2CharMap

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:

mergeChar in interface Reference2CharMap<K>

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 Reference2CharMap<K>

Specified by:

getOrDefault in interface Map<K,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 Reference2CharMap<K>

Specified by:

remove in interface Map<K,Character>

replace

@Deprecated
public Character replace(K 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 Reference2CharMap<K>

Specified by:

replace in interface Map<K,Character>

replace

@Deprecated
public boolean replace(K 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 Reference2CharMap<K>

Specified by:

replace in interface Map<K,Character>

putIfAbsent

@Deprecated
public Character putIfAbsent(K 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 Reference2CharMap<K>

Specified by:

putIfAbsent in interface Map<K,Character>

computeIfAbsent

public Character computeIfAbsent(K key,
                                 Function<? super K,? extends Character> mappingFunction)

Specified by:

computeIfAbsent in interface Map<K,Character>

computeIfPresent

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

Specified by:

computeIfPresent in interface Map<K,Character>

compute

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

Specified by:

compute in interface Map<K,Character>

merge

@Deprecated
public Character merge(K 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 Reference2CharMap<K>

Specified by:

merge in interface Map<K,Character>