it.unimi.dsi.fastutil.shorts

Class Short2ReferenceMaps.UnmodifiableMap<V>

java.lang.Object

it.unimi.dsi.fastutil.shorts.AbstractShort2ReferenceFunction<V>

it.unimi.dsi.fastutil.shorts.Short2ReferenceFunctions.UnmodifiableFunction<V>

it.unimi.dsi.fastutil.shorts.Short2ReferenceMaps.UnmodifiableMap<V>

All Implemented Interfaces:

Short2ReferenceFunction<V>, Short2ReferenceMap<V>, Serializable, Function<Short,V>, IntFunction<V>, Map<Short,V>

Direct Known Subclasses:

Short2ReferenceSortedMaps.UnmodifiableSortedMap

Enclosing class:

Short2ReferenceMaps

public static class Short2ReferenceMaps.UnmodifiableMap<V>
extends Short2ReferenceFunctions.UnmodifiableFunction<V>
implements Short2ReferenceMap<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.shorts.Short2ReferenceMap

Short2ReferenceMap.Entry<V>, Short2ReferenceMap.FastEntrySet<V>

Field Summary

Fields

Modifier and Type	Field and Description
protected ObjectSet<Short2ReferenceMap.Entry<V>>	entries
protected ShortSet	keys
protected Short2ReferenceMap<V>	map
protected ReferenceCollection<V>	values

Fields inherited from class it.unimi.dsi.fastutil.shorts.Short2ReferenceFunctions.UnmodifiableFunction

function

Fields inherited from class it.unimi.dsi.fastutil.shorts.AbstractShort2ReferenceFunction

defRetValue

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
V	compute(short key, BiFunction<? super Short,? 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	compute(Short key, BiFunction<? super Short,? super V,? extends V> remappingFunction) Deprecated. Please use the corresponding type-specific method instead.
V	computeIfAbsent(Short key, Function<? super Short,? extends V> mappingFunction) Deprecated. Please use the corresponding type-specific method instead.
V	computeIfAbsent(short 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(short key, Short2ReferenceFunction<? 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(short key, BiFunction<? super Short,? 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.
V	computeIfPresent(Short key, BiFunction<? super Short,? super V,? extends V> remappingFunction) Deprecated. Please use the corresponding type-specific method instead.
boolean	containsValue(Object v)
ObjectSet<Map.Entry<Short,V>>	entrySet() Deprecated. Please use the corresponding type-specific method instead.
boolean	equals(Object o)
void	forEach(BiConsumer<? super Short,? super V> action)
V	getOrDefault(Object key, V defaultValue) Deprecated. Please use the corresponding type-specific method instead.
V	getOrDefault(short 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()
ShortSet	keySet()
V	merge(short 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.
V	merge(Short key, V value, BiFunction<? super V,? super V,? extends V> remappingFunction) Deprecated. Please use the corresponding type-specific method instead.
void	putAll(Map<? extends Short,? extends V> m)
V	putIfAbsent(short 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.
V	putIfAbsent(Short key, V value) Deprecated. Please use the corresponding type-specific method instead.
boolean	remove(Object key, Object value) Deprecated. Please use the corresponding type-specific method instead.
boolean	remove(short key, Object value) Removes the entry for the specified key only if it is currently mapped to the specified value.
V	replace(short key, V value) Replaces the entry for the specified key only if it is currently mapped to some value.
V	replace(Short key, V value) Deprecated. Please use the corresponding type-specific method instead.
boolean	replace(short key, V oldValue, V newValue) Replaces the entry for the specified key only if currently mapped to the specified value.
boolean	replace(Short key, V oldValue, V newValue) Deprecated. Please use the corresponding type-specific method instead.
void	replaceAll(BiFunction<? super Short,? super V,? extends V> function)
ObjectSet<Short2ReferenceMap.Entry<V>>	short2ReferenceEntrySet() Returns a type-specific set view of the mappings contained in this map.
ReferenceCollection<V>	values()

Methods inherited from class it.unimi.dsi.fastutil.shorts.Short2ReferenceFunctions.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.shorts.Short2ReferenceMap

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

Methods inherited from interface it.unimi.dsi.fastutil.shorts.Short2ReferenceFunction

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 Short2ReferenceMap<V> map

entries

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

keys

protected transient ShortSet keys

values

protected transient ReferenceCollection<V> values

Constructor Detail

UnmodifiableMap

protected UnmodifiableMap(Short2ReferenceMap<V> m)

Method Detail

containsValue

public boolean containsValue(Object v)

Specified by:

containsValue in interface Map<Short,V>

putAll

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

Specified by:

putAll in interface Map<Short,V>

short2ReferenceEntrySet

public ObjectSet<Short2ReferenceMap.Entry<V>> short2ReferenceEntrySet()

Description copied from interface: Short2ReferenceMap

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:

short2ReferenceEntrySet in interface Short2ReferenceMap<V>

Returns:

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

See Also:

Map.entrySet()

entrySet

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

Specified by:

entrySet in interface Map<Short,V>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()

keySet

public ShortSet keySet()

Description copied from interface: Short2ReferenceMap

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

Specified by:

keySet in interface Short2ReferenceMap<V>

Specified by:

keySet in interface Map<Short,V>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public ReferenceCollection<V> values()

Description copied from interface: Short2ReferenceMap

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

Specified by:

values in interface Short2ReferenceMap<V>

Specified by:

values in interface Map<Short,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<Short,V>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<Short,V>

Overrides:

hashCode in class Short2ReferenceFunctions.UnmodifiableFunction<V>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<Short,V>

Overrides:

equals in class Short2ReferenceFunctions.UnmodifiableFunction<V>

getOrDefault

public V getOrDefault(short key,
                      V defaultValue)

Description copied from interface: Short2ReferenceMap

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 Short2ReferenceMap<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 Short,? super V> action)

Specified by:

forEach in interface Map<Short,V>

replaceAll

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

Specified by:

replaceAll in interface Map<Short,V>

putIfAbsent

public V putIfAbsent(short key,
                     V value)

Description copied from interface: Short2ReferenceMap

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

Description copied from interface: Short2ReferenceMap

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

Specified by:

remove in interface Short2ReferenceMap<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(short key,
                 V value)

Description copied from interface: Short2ReferenceMap

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

Specified by:

replace in interface Short2ReferenceMap<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(short key,
                       V oldValue,
                       V newValue)

Description copied from interface: Short2ReferenceMap

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

Specified by:

replace in interface Short2ReferenceMap<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(short key,
                         IntFunction<? extends V> mappingFunction)

Description copied from interface: Short2ReferenceMap

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 Short2ReferenceMap<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(short key,
                                Short2ReferenceFunction<? extends V> mappingFunction)

Description copied from interface: Short2ReferenceMap

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 Short2ReferenceMap<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(short key,
                          BiFunction<? super Short,? super V,? extends V> remappingFunction)

Description copied from interface: Short2ReferenceMap

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 Short2ReferenceMap<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(short key,
                 BiFunction<? super Short,? super V,? extends V> remappingFunction)

Description copied from interface: Short2ReferenceMap

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

Description copied from interface: Short2ReferenceMap

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

Specified by:

getOrDefault in interface Map<Short,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 Short2ReferenceMap<V>

Specified by:

remove in interface Map<Short,V>

replace

@Deprecated
public V replace(Short 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 Short2ReferenceMap<V>

Specified by:

replace in interface Map<Short,V>

replace

@Deprecated
public boolean replace(Short 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 Short2ReferenceMap<V>

Specified by:

replace in interface Map<Short,V>

putIfAbsent

@Deprecated
public V putIfAbsent(Short 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 Short2ReferenceMap<V>

Specified by:

putIfAbsent in interface Map<Short,V>

computeIfAbsent

@Deprecated
public V computeIfAbsent(Short key,
                                     Function<? super Short,? 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 Short2ReferenceMap<V>

Specified by:

computeIfAbsent in interface Map<Short,V>

computeIfPresent

@Deprecated
public V computeIfPresent(Short key,
                                      BiFunction<? super Short,? 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 Short2ReferenceMap<V>

Specified by:

computeIfPresent in interface Map<Short,V>

compute

@Deprecated
public V compute(Short key,
                             BiFunction<? super Short,? 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 Short2ReferenceMap<V>

Specified by:

compute in interface Map<Short,V>

merge

@Deprecated
public V merge(Short 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 Short2ReferenceMap<V>

Specified by:

merge in interface Map<Short,V>