it.unimi.dsi.fastutil.objects

Class Object2ReferenceMaps.UnmodifiableMap<K,V>

java.lang.Object

it.unimi.dsi.fastutil.objects.AbstractObject2ReferenceFunction<K,V>

it.unimi.dsi.fastutil.objects.Object2ReferenceFunctions.UnmodifiableFunction<K,V>

it.unimi.dsi.fastutil.objects.Object2ReferenceMaps.UnmodifiableMap<K,V>

All Implemented Interfaces:

it.unimi.dsi.fastutil.objects.Object2ReferenceFunction<K,V>, Object2ReferenceMap<K,V>, java.io.Serializable, java.util.function.Function<K,V>, java.util.Map<K,V>

Direct Known Subclasses:

Object2ReferenceSortedMaps.UnmodifiableSortedMap

Enclosing class:

Object2ReferenceMaps

public static class Object2ReferenceMaps.UnmodifiableMap<K,V>
extends Object2ReferenceFunctions.UnmodifiableFunction<K,V>
implements Object2ReferenceMap<K,V>, 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.Object2ReferenceMap

Object2ReferenceMap.Entry<K,V>, Object2ReferenceMap.FastEntrySet<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected it.unimi.dsi.fastutil.objects.ObjectSet<Object2ReferenceMap.Entry<K,V>>	entries
protected it.unimi.dsi.fastutil.objects.ObjectSet<K>	keys
protected Object2ReferenceMap<? extends K,? extends V>	map
protected it.unimi.dsi.fastutil.objects.ReferenceCollection<V>	values

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

function

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

defRetValue

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UnmodifiableMap(Object2ReferenceMap<? extends K,? extends V> m)

Method Summary

Modifier and Type	Method and Description
V	compute(K key, java.util.function.BiFunction<? super K,? 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	computeIfPresent(K key, java.util.function.BiFunction<? super K,? 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(java.lang.Object v)
it.unimi.dsi.fastutil.objects.ObjectSet<java.util.Map.Entry<K,V>>	entrySet() Returns a set view of the mappings contained in this map.
boolean	equals(java.lang.Object o)
void	forEach(java.util.function.BiConsumer<? super K,? super V> action)
V	getOrDefault(java.lang.Object 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.
int	hashCode()
boolean	isEmpty()
it.unimi.dsi.fastutil.objects.ObjectSet<K>	keySet()
V	merge(K key, V value, java.util.function.BiFunction<? super V,? super V,? extends V> remappingFunction) If the specified key is not already associated with a value, associates it with the given value.
it.unimi.dsi.fastutil.objects.ObjectSet<Object2ReferenceMap.Entry<K,V>>	object2ReferenceEntrySet() Returns a type-specific set view of the mappings contained in this map.
void	putAll(java.util.Map<? extends K,? extends V> m)
V	putIfAbsent(K 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(java.lang.Object key, java.lang.Object value) Removes the entry for the specified key only if it is currently mapped to the specified value.
V	replace(K key, V value) Replaces the entry for the specified key only if it is currently mapped to some value.
boolean	replace(K key, V oldValue, V 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 V,? extends V> function)
it.unimi.dsi.fastutil.objects.ReferenceCollection<V>	values()

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

clear, containsKey, defaultReturnValue, defaultReturnValue, get, put, 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.objects.Object2ReferenceMap

clear, computeIfAbsent, computeReferenceIfAbsentPartial, containsKey, defaultReturnValue, defaultReturnValue, put, remove, size

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

andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort, get

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.Map

computeIfAbsent, get

Field Detail

map

protected final Object2ReferenceMap<? extends K,? extends V> map

entries

protected transient it.unimi.dsi.fastutil.objects.ObjectSet<Object2ReferenceMap.Entry<K,V>> entries

keys

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

values

protected transient it.unimi.dsi.fastutil.objects.ReferenceCollection<V> values

Constructor Detail

UnmodifiableMap

protected UnmodifiableMap(Object2ReferenceMap<? extends K,? extends V> m)

Method Detail

containsValue

public boolean containsValue(java.lang.Object v)

Specified by:

containsValue in interface java.util.Map<K,V>

putAll

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

Specified by:

putAll in interface java.util.Map<K,V>

object2ReferenceEntrySet

public it.unimi.dsi.fastutil.objects.ObjectSet<Object2ReferenceMap.Entry<K,V>> object2ReferenceEntrySet()

Description copied from interface: Object2ReferenceMap

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:

object2ReferenceEntrySet in interface Object2ReferenceMap<K,V>

Returns:

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

See Also:

Map.entrySet()

entrySet

public it.unimi.dsi.fastutil.objects.ObjectSet<java.util.Map.Entry<K,V>> entrySet()

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

Specified by:

entrySet in interface Object2ReferenceMap<K,V>

Specified by:

entrySet in interface java.util.Map<K,V>

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: Object2ReferenceMap

Specified by:

keySet in interface Object2ReferenceMap<K,V>

Specified by:

keySet in interface java.util.Map<K,V>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public it.unimi.dsi.fastutil.objects.ReferenceCollection<V> values()

Description copied from interface: Object2ReferenceMap

Specified by:

values in interface Object2ReferenceMap<K,V>

Specified by:

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

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map<K,V>

Overrides:

hashCode in class Object2ReferenceFunctions.UnmodifiableFunction<K,V>

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Map<K,V>

Overrides:

equals in class Object2ReferenceFunctions.UnmodifiableFunction<K,V>

getOrDefault

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

Description copied from interface: Object2ReferenceMap

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.Object2ReferenceFunction<K,V>

Specified by:

getOrDefault in interface Object2ReferenceMap<K,V>

Specified by:

getOrDefault in interface java.util.Map<K,V>

Overrides:

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

Specified by:

forEach in interface Object2ReferenceMap<K,V>

Specified by:

forEach in interface java.util.Map<K,V>

replaceAll

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

Specified by:

replaceAll in interface java.util.Map<K,V>

putIfAbsent

public V putIfAbsent(K key,
                     V value)

Description copied from interface: Object2ReferenceMap

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

Specified by:

putIfAbsent in interface java.util.Map<K,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(java.lang.Object key,
                      java.lang.Object value)

Description copied from interface: Object2ReferenceMap

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

Specified by:

remove in interface Object2ReferenceMap<K,V>

Specified by:

remove in interface java.util.Map<K,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(K key,
                 V value)

Description copied from interface: Object2ReferenceMap

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

Specified by:

replace in interface Object2ReferenceMap<K,V>

Specified by:

replace in interface java.util.Map<K,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(K key,
                       V oldValue,
                       V newValue)

Description copied from interface: Object2ReferenceMap

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

Specified by:

replace in interface Object2ReferenceMap<K,V>

Specified by:

replace in interface java.util.Map<K,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)

computeIfPresent

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

Description copied from interface: Object2ReferenceMap

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

Specified by:

computeIfPresent in interface java.util.Map<K,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(K key,
                 java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)

Description copied from interface: Object2ReferenceMap

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

Specified by:

compute in interface java.util.Map<K,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(K key,
               V value,
               java.util.function.BiFunction<? super V,? super V,? extends V> remappingFunction)

Description copied from interface: Object2ReferenceMap

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

Specified by:

merge in interface java.util.Map<K,V>

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)