Package it.unimi.dsi.fastutil.objects

Class Reference2ShortMaps.UnmodifiableMap<K>

java.lang.Object

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

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

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

All Implemented Interfaces:

Function<K,Short>, Reference2ShortFunction<K>, Reference2ShortMap<K>, Serializable, Function<K,Short>, ToIntFunction<K>, Map<K,Short>

Direct Known Subclasses:

Reference2ShortSortedMaps.UnmodifiableSortedMap

Enclosing class:

Reference2ShortMaps

public static class Reference2ShortMaps.UnmodifiableMap<K>
extends Reference2ShortFunctions.UnmodifiableFunction<K>
implements Reference2ShortMap<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.Reference2ShortMap

Reference2ShortMap.Entry<K>, Reference2ShortMap.FastEntrySet<K>

Method Summary

Modifier and Type	Method	Description
Short	compute(K key, BiFunction<? super K,? super Short,? extends Short> remappingFunction)
Short	computeIfAbsent(K key, Function<? super K,? extends Short> mappingFunction)
Short	computeIfPresent(K key, BiFunction<? super K,? super Short,? extends Short> remappingFunction)
short	computeShort(K key, BiFunction<? super K,? super Short,? extends Short> remappingFunction)	Attempts to compute a mapping for the specified key and its current mapped value (or null if there is no current mapping).
short	computeShortIfAbsent(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.
short	computeShortIfAbsentPartial(K key, Reference2ShortFunction<? 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.
short	computeShortIfPresent(K key, BiFunction<? super K,? super Short,? extends Short> 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(short 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,Short>>	entrySet()	Deprecated. Please use the corresponding type-specific method instead.
boolean	equals(Object o)
void	forEach(BiConsumer<? super K,? super Short> action)
short	getOrDefault(Object key, short defaultValue)	Returns the value to which the specified key is mapped, or the defaultValue if this map contains no mapping for the key.
Short	getOrDefault(Object key, Short defaultValue)	Deprecated. Please use the corresponding type-specific method instead.
int	hashCode()
boolean	isEmpty()
ReferenceSet<K>	keySet()
Short	merge(K key, Short value, BiFunction<? super Short,? super Short,? extends Short> remappingFunction)	Deprecated. Please use the corresponding type-specific method instead.
short	mergeShort(K key, short value, BiFunction<? super Short,? super Short,? extends Short> remappingFunction)	If the specified key is not already associated with a value, associates it with the given value.
void	putAll(Map<? extends K,? extends Short> m)
short	putIfAbsent(K key, short 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.
Short	putIfAbsent(K key, Short value)	Deprecated. Please use the corresponding type-specific method instead.
ObjectSet<Reference2ShortMap.Entry<K>>	reference2ShortEntrySet()	Returns a type-specific set view of the mappings contained in this map.
boolean	remove(Object key, short 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.
short	replace(K key, short value)	Replaces the entry for the specified key only if it is currently mapped to some value.
boolean	replace(K key, short oldValue, short newValue)	Replaces the entry for the specified key only if currently mapped to the specified value.
Short	replace(K key, Short value)	Deprecated. Please use the corresponding type-specific method instead.
boolean	replace(K key, Short oldValue, Short newValue)	Deprecated. Please use the corresponding type-specific method instead.
void	replaceAll(BiFunction<? super K,? super Short,? extends Short> function)
ShortCollection	values()

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

clear, containsKey, defaultReturnValue, defaultReturnValue, get, getShort, put, put, remove, removeShort, size, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

apply

Methods inherited from interface java.util.function.Function

andThen, compose

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

applyAsInt, getShort, put, removeShort

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

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

Method Detail

containsValue

public boolean containsValue(short v)

Description copied from interface: Reference2ShortMap

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

Specified by:

containsValue in interface Reference2ShortMap<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 Map<K,Short>

Specified by:

containsValue in interface Reference2ShortMap<K>

putAll

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

Specified by:

putAll in interface Map<K,Short>

reference2ShortEntrySet

public ObjectSet<Reference2ShortMap.Entry<K>> reference2ShortEntrySet()

Description copied from interface: Reference2ShortMap

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:

reference2ShortEntrySet in interface Reference2ShortMap<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,Short>> 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 Map<K,Short>

Specified by:

entrySet in interface Reference2ShortMap<K>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()

keySet

public ReferenceSet<K> keySet()

Description copied from interface: Reference2ShortMap

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

Specified by:

keySet in interface Map<K,Short>

Specified by:

keySet in interface Reference2ShortMap<K>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public ShortCollection values()

Description copied from interface: Reference2ShortMap

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

Specified by:

values in interface Map<K,Short>

Specified by:

values in interface Reference2ShortMap<K>

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,Short>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,Short>

Overrides:

hashCode in class Reference2ShortFunctions.UnmodifiableFunction<K>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<K,Short>

Overrides:

equals in class Reference2ShortFunctions.UnmodifiableFunction<K>

getOrDefault

public short getOrDefault(Object key,
                          short defaultValue)

Description copied from interface: Reference2ShortMap

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 Reference2ShortMap<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 Short> action)

Specified by:

forEach in interface Map<K,Short>

replaceAll

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

Specified by:

replaceAll in interface Map<K,Short>

putIfAbsent

public short putIfAbsent(K key,
                         short value)

Description copied from interface: Reference2ShortMap

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 Reference2ShortMap<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,
                      short value)

Description copied from interface: Reference2ShortMap

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

Specified by:

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

Description copied from interface: Reference2ShortMap

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

Specified by:

replace in interface Reference2ShortMap<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,
                       short oldValue,
                       short newValue)

Description copied from interface: Reference2ShortMap

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

Specified by:

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

computeShortIfAbsent

public short computeShortIfAbsent(K key,
                                  ToIntFunction<? super K> mappingFunction)

Description copied from interface: Reference2ShortMap

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:

computeShortIfAbsent in interface Reference2ShortMap<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)

computeShortIfAbsentPartial

public short computeShortIfAbsentPartial(K key,
                                         Reference2ShortFunction<? super K> mappingFunction)

Description copied from interface: Reference2ShortMap

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:

computeShortIfAbsentPartial in interface Reference2ShortMap<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)

computeShortIfPresent

public short computeShortIfPresent(K key,
                                   BiFunction<? super K,? super Short,? extends Short> remappingFunction)

Description copied from interface: Reference2ShortMap

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:

computeShortIfPresent in interface Reference2ShortMap<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)

computeShort

public short computeShort(K key,
                          BiFunction<? super K,? super Short,? extends Short> remappingFunction)

Description copied from interface: Reference2ShortMap

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:

computeShort in interface Reference2ShortMap<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)

mergeShort

public short mergeShort(K key,
                        short value,
                        BiFunction<? super Short,? super Short,? extends Short> remappingFunction)

Description copied from interface: Reference2ShortMap

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:

mergeShort in interface Reference2ShortMap<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 Short getOrDefault(Object key,
                          Short 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 Map<K,Short>

Specified by:

getOrDefault in interface Reference2ShortMap<K>

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 Map<K,Short>

Specified by:

remove in interface Reference2ShortMap<K>

replace

@Deprecated
public Short replace(K key,
                     Short 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 Map<K,Short>

Specified by:

replace in interface Reference2ShortMap<K>

replace

@Deprecated
public boolean replace(K key,
                       Short oldValue,
                       Short 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 Map<K,Short>

Specified by:

replace in interface Reference2ShortMap<K>

putIfAbsent

@Deprecated
public Short putIfAbsent(K key,
                         Short 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 Map<K,Short>

Specified by:

putIfAbsent in interface Reference2ShortMap<K>

computeIfAbsent

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

Specified by:

computeIfAbsent in interface Map<K,Short>

computeIfPresent

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

Specified by:

computeIfPresent in interface Map<K,Short>

compute

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

Specified by:

compute in interface Map<K,Short>

merge

@Deprecated
public Short merge(K key,
                   Short value,
                   BiFunction<? super Short,? super Short,? extends Short> 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 Map<K,Short>

Specified by:

merge in interface Reference2ShortMap<K>