it.unimi.dsi.fastutil.objects

Class Object2IntMaps.UnmodifiableMap<K>

java.lang.Object

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

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

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

All Implemented Interfaces:

it.unimi.dsi.fastutil.objects.Object2IntFunction<K>, Object2IntMap<K>, java.io.Serializable, java.util.function.Function<K,java.lang.Integer>, java.util.function.ToIntFunction<K>, java.util.Map<K,java.lang.Integer>

Direct Known Subclasses:

Object2IntSortedMaps.UnmodifiableSortedMap

Enclosing class:

Object2IntMaps

public static class Object2IntMaps.UnmodifiableMap<K>
extends Object2IntFunctions.UnmodifiableFunction<K>
implements Object2IntMap<K>, java.io.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.Object2IntMap

Object2IntMap.Entry<K>, Object2IntMap.FastEntrySet<K>

Field Summary

Fields

Modifier and Type	Field and Description
protected it.unimi.dsi.fastutil.objects.ObjectSet<Object2IntMap.Entry<K>>	entries
protected it.unimi.dsi.fastutil.objects.ObjectSet<K>	keys
protected Object2IntMap<? extends K>	map
protected it.unimi.dsi.fastutil.ints.IntCollection	values

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

function

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

defRetValue

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UnmodifiableMap(Object2IntMap<? extends K> m)

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	compute(K key, java.util.function.BiFunction<? super K,? super java.lang.Integer,? extends java.lang.Integer> remappingFunction)
java.lang.Integer	computeIfAbsent(K key, java.util.function.Function<? super K,? extends java.lang.Integer> mappingFunction)
int	computeIfAbsent(K key, it.unimi.dsi.fastutil.objects.Object2IntFunction<? 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	computeIfAbsent(K key, java.util.function.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.
java.lang.Integer	computeIfPresent(K key, java.util.function.BiFunction<? super K,? super java.lang.Integer,? extends java.lang.Integer> remappingFunction)
int	computeInt(K key, java.util.function.BiFunction<? super K,? super java.lang.Integer,? extends java.lang.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	computeIntIfPresent(K key, java.util.function.BiFunction<? super K,? super java.lang.Integer,? extends java.lang.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(java.lang.Object ov) Deprecated. Please use the corresponding type-specific method instead.
it.unimi.dsi.fastutil.objects.ObjectSet<java.util.Map.Entry<K,java.lang.Integer>>	entrySet() Deprecated. Please use the corresponding type-specific method instead.
boolean	equals(java.lang.Object o)
void	forEach(java.util.function.BiConsumer<? super K,? super java.lang.Integer> action)
int	getOrDefault(java.lang.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.
java.lang.Integer	getOrDefault(java.lang.Object key, java.lang.Integer defaultValue) Deprecated. Please use the corresponding type-specific method instead.
int	hashCode()
boolean	isEmpty()
it.unimi.dsi.fastutil.objects.ObjectSet<K>	keySet()
int	merge(K key, int value, java.util.function.BiFunction<? super java.lang.Integer,? super java.lang.Integer,? extends java.lang.Integer> remappingFunction) If the specified key is not already associated with a value, associates it with the given value.
java.lang.Integer	merge(K key, java.lang.Integer value, java.util.function.BiFunction<? super java.lang.Integer,? super java.lang.Integer,? extends java.lang.Integer> remappingFunction) Deprecated. Please use the corresponding type-specific method instead.
it.unimi.dsi.fastutil.objects.ObjectSet<Object2IntMap.Entry<K>>	object2IntEntrySet() Returns a type-specific set view of the mappings contained in this map.
void	putAll(java.util.Map<? extends K,? extends java.lang.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.
java.lang.Integer	putIfAbsent(K key, java.lang.Integer value) Deprecated. Please use the corresponding type-specific method instead.
boolean	remove(java.lang.Object key, int value) Removes the entry for the specified key only if it is currently mapped to the specified value.
boolean	remove(java.lang.Object key, java.lang.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.
java.lang.Integer	replace(K key, java.lang.Integer value) Deprecated. Please use the corresponding type-specific method instead.
boolean	replace(K key, java.lang.Integer oldValue, java.lang.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(java.util.function.BiFunction<? super K,? super java.lang.Integer,? extends java.lang.Integer> function)
it.unimi.dsi.fastutil.ints.IntCollection	values()

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

clear, containsKey, defaultReturnValue, defaultReturnValue, get, getInt, put, put, remove, removeInt, 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.Object2IntMap

clear, computeIntIfAbsent, computeIntIfAbsentPartial, containsKey, defaultReturnValue, defaultReturnValue, get, mergeInt, mergeInt, mergeInt, put, remove, size

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

andThen, andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, applyAsInt, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort, getInt, put, removeInt

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

apply

Methods inherited from interface java.util.function.Function

compose, identity

Field Detail

map

protected final Object2IntMap<? extends K> map

entries

protected transient it.unimi.dsi.fastutil.objects.ObjectSet<Object2IntMap.Entry<K>> entries

keys

protected transient it.unimi.dsi.fastutil.objects.ObjectSet<K> keys

values

protected transient it.unimi.dsi.fastutil.ints.IntCollection values

Constructor Detail

UnmodifiableMap

protected UnmodifiableMap(Object2IntMap<? extends K> m)

Method Detail

containsValue

public boolean containsValue(int v)

Description copied from interface: Object2IntMap

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

Specified by:

containsValue in interface Object2IntMap<K>

See Also:

Map.containsValue(Object)

containsValue

@Deprecated
public boolean containsValue(java.lang.Object ov)

Deprecated. Please use the corresponding type-specific method instead.

Specified by:

containsValue in interface Object2IntMap<K>

Specified by:

containsValue in interface java.util.Map<K,java.lang.Integer>

putAll

public void putAll(java.util.Map<? extends K,? extends java.lang.Integer> m)

Specified by:

putAll in interface java.util.Map<K,java.lang.Integer>

object2IntEntrySet

public it.unimi.dsi.fastutil.objects.ObjectSet<Object2IntMap.Entry<K>> object2IntEntrySet()

Description copied from interface: Object2IntMap

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:

object2IntEntrySet in interface Object2IntMap<K>

Returns:

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

See Also:

Map.entrySet()

entrySet

@Deprecated
public it.unimi.dsi.fastutil.objects.ObjectSet<java.util.Map.Entry<K,java.lang.Integer>> entrySet()

Deprecated. Please use the corresponding type-specific method instead.

Returns a set view of the mappings contained in this map.

Specified by:

entrySet in interface Object2IntMap<K>

Specified by:

entrySet in interface java.util.Map<K,java.lang.Integer>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()

keySet

public it.unimi.dsi.fastutil.objects.ObjectSet<K> keySet()

Description copied from interface: Object2IntMap

Specified by:

keySet in interface Object2IntMap<K>

Specified by:

keySet in interface java.util.Map<K,java.lang.Integer>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public it.unimi.dsi.fastutil.ints.IntCollection values()

Description copied from interface: Object2IntMap

Specified by:

values in interface Object2IntMap<K>

Specified by:

values in interface java.util.Map<K,java.lang.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 java.util.Map<K,java.lang.Integer>

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map<K,java.lang.Integer>

Overrides:

hashCode in class Object2IntFunctions.UnmodifiableFunction<K>

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Map<K,java.lang.Integer>

Overrides:

equals in class Object2IntFunctions.UnmodifiableFunction<K>

getOrDefault

public int getOrDefault(java.lang.Object key,
                        int defaultValue)

Description copied from interface: Object2IntMap

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 it.unimi.dsi.fastutil.objects.Object2IntFunction<K>

Specified by:

getOrDefault in interface Object2IntMap<K>

Overrides:

getOrDefault in class Object2IntFunctions.UnmodifiableFunction<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(java.util.function.BiConsumer<? super K,? super java.lang.Integer> action)

Specified by:

forEach in interface Object2IntMap<K>

Specified by:

forEach in interface java.util.Map<K,java.lang.Integer>

replaceAll

public void replaceAll(java.util.function.BiFunction<? super K,? super java.lang.Integer,? extends java.lang.Integer> function)

Specified by:

replaceAll in interface java.util.Map<K,java.lang.Integer>

putIfAbsent

public int putIfAbsent(K key,
                       int value)

Description copied from interface: Object2IntMap

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 Object2IntMap<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(java.lang.Object key,
                      int value)

Description copied from interface: Object2IntMap

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

Specified by:

remove in interface Object2IntMap<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: Object2IntMap

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

Specified by:

replace in interface Object2IntMap<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: Object2IntMap

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

Specified by:

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

computeIfAbsent

public int computeIfAbsent(K key,
                           java.util.function.ToIntFunction<? super K> mappingFunction)

Description copied from interface: Object2IntMap

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 Object2IntMap<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)

computeIfAbsent

public int computeIfAbsent(K key,
                           it.unimi.dsi.fastutil.objects.Object2IntFunction<? super K> mappingFunction)

Description copied from interface: Object2IntMap

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:

computeIfAbsent in interface Object2IntMap<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,
                               java.util.function.BiFunction<? super K,? super java.lang.Integer,? extends java.lang.Integer> remappingFunction)

Description copied from interface: Object2IntMap

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 Object2IntMap<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,
                      java.util.function.BiFunction<? super K,? super java.lang.Integer,? extends java.lang.Integer> remappingFunction)

Description copied from interface: Object2IntMap

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 Object2IntMap<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)

merge

public int merge(K key,
                 int value,
                 java.util.function.BiFunction<? super java.lang.Integer,? super java.lang.Integer,? extends java.lang.Integer> remappingFunction)

Description copied from interface: Object2IntMap

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 Object2IntMap<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 java.lang.Integer getOrDefault(java.lang.Object key,
                                                  java.lang.Integer defaultValue)

Deprecated. Please use the corresponding type-specific method instead.

Specified by:

getOrDefault in interface it.unimi.dsi.fastutil.objects.Object2IntFunction<K>

Specified by:

getOrDefault in interface Object2IntMap<K>

Specified by:

getOrDefault in interface java.util.Map<K,java.lang.Integer>

Overrides:

getOrDefault in class Object2IntFunctions.UnmodifiableFunction<K>

remove

@Deprecated
public boolean remove(java.lang.Object key,
                                  java.lang.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 Object2IntMap<K>

Specified by:

remove in interface java.util.Map<K,java.lang.Integer>

replace

@Deprecated
public java.lang.Integer replace(K key,
                                             java.lang.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 Object2IntMap<K>

Specified by:

replace in interface java.util.Map<K,java.lang.Integer>

replace

@Deprecated
public boolean replace(K key,
                                   java.lang.Integer oldValue,
                                   java.lang.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 Object2IntMap<K>

Specified by:

replace in interface java.util.Map<K,java.lang.Integer>

putIfAbsent

@Deprecated
public java.lang.Integer putIfAbsent(K key,
                                                 java.lang.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 Object2IntMap<K>

Specified by:

putIfAbsent in interface java.util.Map<K,java.lang.Integer>

computeIfAbsent

public java.lang.Integer computeIfAbsent(K key,
                                         java.util.function.Function<? super K,? extends java.lang.Integer> mappingFunction)

Specified by:

computeIfAbsent in interface java.util.Map<K,java.lang.Integer>

computeIfPresent

public java.lang.Integer computeIfPresent(K key,
                                          java.util.function.BiFunction<? super K,? super java.lang.Integer,? extends java.lang.Integer> remappingFunction)

Specified by:

computeIfPresent in interface java.util.Map<K,java.lang.Integer>

compute

public java.lang.Integer compute(K key,
                                 java.util.function.BiFunction<? super K,? super java.lang.Integer,? extends java.lang.Integer> remappingFunction)

Specified by:

compute in interface java.util.Map<K,java.lang.Integer>

merge

@Deprecated
public java.lang.Integer merge(K key,
                                           java.lang.Integer value,
                                           java.util.function.BiFunction<? super java.lang.Integer,? super java.lang.Integer,? extends java.lang.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 Object2IntMap<K>

Specified by:

merge in interface java.util.Map<K,java.lang.Integer>