it.unimi.dsi.fastutil.objects

Class Reference2IntMaps.UnmodifiableMap<K>

java.lang.Object

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

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

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

All Implemented Interfaces:

Reference2IntFunction<K>, Reference2IntMap<K>, Serializable, Function<K,Integer>, ToIntFunction<K>, Map<K,Integer>

Direct Known Subclasses:

Reference2IntSortedMaps.UnmodifiableSortedMap

Enclosing class:

Reference2IntMaps

public static class Reference2IntMaps.UnmodifiableMap<K>
extends Reference2IntFunctions.UnmodifiableFunction<K>
implements Reference2IntMap<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.Reference2IntMap

Reference2IntMap.Entry<K>, Reference2IntMap.FastEntrySet<K>

Method Summary

Modifier and Type	Method and Description
Integer	compute(K key, BiFunction<? super K,? super Integer,? extends Integer> remappingFunction)
Integer	computeIfAbsent(K key, Function<? super K,? extends Integer> mappingFunction)
Integer	computeIfPresent(K key, BiFunction<? super K,? super Integer,? extends Integer> remappingFunction)
int	computeInt(K key, BiFunction<? super K,? 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).
int	computeIntIfAbsent(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.
int	computeIntIfAbsentPartial(K key, Reference2IntFunction<? 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.
int	computeIntIfPresent(K key, BiFunction<? super K,? 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<K,Integer>>	entrySet() Deprecated. Please use the corresponding type-specific method instead.
boolean	equals(Object o)
void	forEach(BiConsumer<? super K,? super Integer> action)
int	getOrDefault(Object 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()
ReferenceSet<K>	keySet() Note that this specification strengthens the one given in Map.keySet().
Integer	merge(K key, Integer value, BiFunction<? super Integer,? super Integer,? extends Integer> remappingFunction) Deprecated. Please use the corresponding type-specific method instead.
int	mergeInt(K 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 K,? extends Integer> m)
int	putIfAbsent(K 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.
Integer	putIfAbsent(K key, Integer value) Deprecated. Please use the corresponding type-specific method instead.
ObjectSet<Reference2IntMap.Entry<K>>	reference2IntEntrySet() Returns a type-specific set view of the mappings contained in this map.
boolean	remove(Object 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.
int	replace(K key, int value) Replaces the entry for the specified key only if it is currently mapped to some value.
Integer	replace(K key, Integer value) Deprecated. Please use the corresponding type-specific method instead.
boolean	replace(K key, Integer oldValue, Integer newValue) Deprecated. Please use the corresponding type-specific method instead.
boolean	replace(K key, int oldValue, int newValue) Replaces the entry for the specified key only if currently mapped to the specified value.
void	replaceAll(BiFunction<? super K,? super Integer,? extends Integer> function)
IntCollection	values() Note that this specification strengthens the one given in Map.values().

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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

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

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

applyAsInt, getInt, put, removeInt

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

apply

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Method Detail

containsValue

public boolean containsValue(int v)

Description copied from interface: Reference2IntMap

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

Specified by:

containsValue in interface Reference2IntMap<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 Reference2IntMap<K>

Specified by:

containsValue in interface Map<K,Integer>

putAll

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

Specified by:

putAll in interface Map<K,Integer>

reference2IntEntrySet

public ObjectSet<Reference2IntMap.Entry<K>> reference2IntEntrySet()

Description copied from interface: Reference2IntMap

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:

reference2IntEntrySet in interface Reference2IntMap<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,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 Reference2IntMap<K>

Specified by:

entrySet in interface Map<K,Integer>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()

keySet

public ReferenceSet<K> keySet()

Description copied from interface: Reference2IntMap

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

Specified by:

keySet in interface Reference2IntMap<K>

Specified by:

keySet in interface Map<K,Integer>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public IntCollection values()

Description copied from interface: Reference2IntMap

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

Specified by:

values in interface Reference2IntMap<K>

Specified by:

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

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,Integer>

Overrides:

hashCode in class Reference2IntFunctions.UnmodifiableFunction<K>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<K,Integer>

Overrides:

equals in class Reference2IntFunctions.UnmodifiableFunction<K>

getOrDefault

public int getOrDefault(Object key,
                        int defaultValue)

Description copied from interface: Reference2IntMap

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

Specified by:

forEach in interface Map<K,Integer>

replaceAll

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

Specified by:

replaceAll in interface Map<K,Integer>

putIfAbsent

public int putIfAbsent(K key,
                       int value)

Description copied from interface: Reference2IntMap

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

Description copied from interface: Reference2IntMap

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

Specified by:

remove in interface Reference2IntMap<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 int replace(K key,
                   int value)

Description copied from interface: Reference2IntMap

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

Specified by:

replace in interface Reference2IntMap<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,
                       int oldValue,
                       int newValue)

Description copied from interface: Reference2IntMap

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

Specified by:

replace in interface Reference2IntMap<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)

computeIntIfAbsent

public int computeIntIfAbsent(K key,
                              ToIntFunction<? super K> mappingFunction)

Description copied from interface: Reference2IntMap

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:

computeIntIfAbsent in interface Reference2IntMap<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)

computeIntIfAbsentPartial

public int computeIntIfAbsentPartial(K key,
                                     Reference2IntFunction<? super K> mappingFunction)

Description copied from interface: Reference2IntMap

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:

computeIntIfAbsentPartial in interface Reference2IntMap<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)

computeIntIfPresent

public int computeIntIfPresent(K key,
                               BiFunction<? super K,? super Integer,? extends Integer> remappingFunction)

Description copied from interface: Reference2IntMap

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:

computeIntIfPresent in interface Reference2IntMap<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)

computeInt

public int computeInt(K key,
                      BiFunction<? super K,? super Integer,? extends Integer> remappingFunction)

Description copied from interface: Reference2IntMap

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:

computeInt in interface Reference2IntMap<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)

mergeInt

public int mergeInt(K key,
                    int value,
                    BiFunction<? super Integer,? super Integer,? extends Integer> remappingFunction)

Description copied from interface: Reference2IntMap

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:

mergeInt in interface Reference2IntMap<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 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 Reference2IntMap<K>

Specified by:

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

Specified by:

remove in interface Map<K,Integer>

replace

@Deprecated
public Integer replace(K 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 Reference2IntMap<K>

Specified by:

replace in interface Map<K,Integer>

replace

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

Specified by:

replace in interface Map<K,Integer>

putIfAbsent

@Deprecated
public Integer putIfAbsent(K 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 Reference2IntMap<K>

Specified by:

putIfAbsent in interface Map<K,Integer>

computeIfAbsent

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

Specified by:

computeIfAbsent in interface Map<K,Integer>

computeIfPresent

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

Specified by:

computeIfPresent in interface Map<K,Integer>

compute

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

Specified by:

compute in interface Map<K,Integer>

merge

@Deprecated
public Integer merge(K 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 Reference2IntMap<K>

Specified by:

merge in interface Map<K,Integer>