it.unimi.dsi.fastutil.objects

Class Reference2LongMaps.UnmodifiableMap<K>

java.lang.Object

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

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

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

All Implemented Interfaces:

Reference2LongFunction<K>, Reference2LongMap<K>, Serializable, Function<K,Long>, ToLongFunction<K>, Map<K,Long>

Direct Known Subclasses:

Reference2LongSortedMaps.UnmodifiableSortedMap

Enclosing class:

Reference2LongMaps

public static class Reference2LongMaps.UnmodifiableMap<K>
extends Reference2LongFunctions.UnmodifiableFunction<K>
implements Reference2LongMap<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.Reference2LongMap

Reference2LongMap.Entry<K>, Reference2LongMap.FastEntrySet<K>

Field Summary

Fields

Modifier and Type	Field and Description
protected ObjectSet<Reference2LongMap.Entry<K>>	entries
protected ReferenceSet<K>	keys
protected Reference2LongMap<K>	map
protected LongCollection	values

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

function

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

defRetValue

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UnmodifiableMap(Reference2LongMap<K> m)

Method Summary

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

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

clear, containsKey, defaultReturnValue, defaultReturnValue, get, getLong, put, put, remove, removeLong, 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.Reference2LongMap

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

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

applyAsLong, getLong, put, removeLong

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 Reference2LongMap<K> map

entries

protected transient ObjectSet<Reference2LongMap.Entry<K>> entries

keys

protected transient ReferenceSet<K> keys

values

protected transient LongCollection values

Constructor Detail

UnmodifiableMap

protected UnmodifiableMap(Reference2LongMap<K> m)

Method Detail

containsValue

public boolean containsValue(long v)

Description copied from interface: Reference2LongMap

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

Specified by:

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

Specified by:

containsValue in interface Map<K,Long>

putAll

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

Specified by:

putAll in interface Map<K,Long>

reference2LongEntrySet

public ObjectSet<Reference2LongMap.Entry<K>> reference2LongEntrySet()

Description copied from interface: Reference2LongMap

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:

reference2LongEntrySet in interface Reference2LongMap<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,Long>> 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 Reference2LongMap<K>

Specified by:

entrySet in interface Map<K,Long>

Returns:

a set view of the mappings contained in this map.

See Also:

Map.entrySet()

keySet

public ReferenceSet<K> keySet()

Description copied from interface: Reference2LongMap

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

Specified by:

keySet in interface Reference2LongMap<K>

Specified by:

keySet in interface Map<K,Long>

Returns:

a set view of the keys contained in this map.

See Also:

Map.keySet()

values

public LongCollection values()

Description copied from interface: Reference2LongMap

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

Specified by:

values in interface Reference2LongMap<K>

Specified by:

values in interface Map<K,Long>

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

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,Long>

Overrides:

hashCode in class Reference2LongFunctions.UnmodifiableFunction<K>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<K,Long>

Overrides:

equals in class Reference2LongFunctions.UnmodifiableFunction<K>

getOrDefault

public long getOrDefault(Object key,
                         long defaultValue)

Description copied from interface: Reference2LongMap

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 Reference2LongMap<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 Long> action)

Specified by:

forEach in interface Map<K,Long>

replaceAll

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

Specified by:

replaceAll in interface Map<K,Long>

putIfAbsent

public long putIfAbsent(K key,
                        long value)

Description copied from interface: Reference2LongMap

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 Reference2LongMap<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,
                      long value)

Description copied from interface: Reference2LongMap

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

Specified by:

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

Description copied from interface: Reference2LongMap

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

Specified by:

replace in interface Reference2LongMap<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,
                       long oldValue,
                       long newValue)

Description copied from interface: Reference2LongMap

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

Specified by:

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

computeLongIfAbsent

public long computeLongIfAbsent(K key,
                                ToLongFunction<? super K> mappingFunction)

Description copied from interface: Reference2LongMap

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:

computeLongIfAbsent in interface Reference2LongMap<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)

computeLongIfAbsentPartial

public long computeLongIfAbsentPartial(K key,
                                       Reference2LongFunction<? super K> mappingFunction)

Description copied from interface: Reference2LongMap

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:

computeLongIfAbsentPartial in interface Reference2LongMap<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)

computeLongIfPresent

public long computeLongIfPresent(K key,
                                 BiFunction<? super K,? super Long,? extends Long> remappingFunction)

Description copied from interface: Reference2LongMap

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:

computeLongIfPresent in interface Reference2LongMap<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)

computeLong

public long computeLong(K key,
                        BiFunction<? super K,? super Long,? extends Long> remappingFunction)

Description copied from interface: Reference2LongMap

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:

computeLong in interface Reference2LongMap<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)

mergeLong

public long mergeLong(K key,
                      long value,
                      BiFunction<? super Long,? super Long,? extends Long> remappingFunction)

Description copied from interface: Reference2LongMap

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:

mergeLong in interface Reference2LongMap<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 Long getOrDefault(Object key,
                                     Long 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 Reference2LongMap<K>

Specified by:

getOrDefault in interface Map<K,Long>

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 Reference2LongMap<K>

Specified by:

remove in interface Map<K,Long>

replace

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

Specified by:

replace in interface Map<K,Long>

replace

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

Specified by:

replace in interface Map<K,Long>

putIfAbsent

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

Specified by:

putIfAbsent in interface Map<K,Long>

computeIfAbsent

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

Specified by:

computeIfAbsent in interface Map<K,Long>

computeIfPresent

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

Specified by:

computeIfPresent in interface Map<K,Long>

compute

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

Specified by:

compute in interface Map<K,Long>

merge

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

Specified by:

merge in interface Map<K,Long>