Interface Reference2IntMap<K>
-
- All Superinterfaces:
Function<K,Integer>
,Function<K,Integer>
,Map<K,Integer>
,Reference2IntFunction<K>
,ToIntFunction<K>
- All Known Subinterfaces:
Reference2IntSortedMap<K>
- All Known Implementing Classes:
AbstractReference2IntMap
,AbstractReference2IntSortedMap
,Reference2IntArrayMap
,Reference2IntLinkedOpenHashMap
,Reference2IntMaps.EmptyMap
,Reference2IntMaps.Singleton
,Reference2IntMaps.SynchronizedMap
,Reference2IntMaps.UnmodifiableMap
,Reference2IntOpenCustomHashMap
,Reference2IntOpenHashMap
,Reference2IntSortedMaps.EmptySortedMap
,Reference2IntSortedMaps.Singleton
,Reference2IntSortedMaps.SynchronizedSortedMap
,Reference2IntSortedMaps.UnmodifiableSortedMap
public interface Reference2IntMap<K> extends Reference2IntFunction<K>, Map<K,Integer>
A type-specificMap
; provides some additional methods that use polymorphism to avoid (un)boxing, and handling of a default return value.Besides extending the corresponding type-specific function, this interface strengthens
Map.entrySet()
,keySet()
andvalues()
. Moreover, a number of methods, such assize()
,defaultReturnValue()
, etc., are un-defaulted as their function default do not make sense for a map. Maps returning entry sets of typeReference2IntMap.FastEntrySet
support also fast iteration.A submap or subset may or may not have an independent default return value (which however must be initialized to the default return value of the originator).
- See Also:
Map
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
Reference2IntMap.Entry<K>
A type-specificMap.Entry
; provides some additional methods that use polymorphism to avoid (un)boxing.static interface
Reference2IntMap.FastEntrySet<K>
An entry set providing fast iteration.
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description default void
clear()
Removes all of the mappings from this map (optional operation).default int
computeInt(K key, BiFunction<? super K,? super Integer,? extends Integer> remappingFunction)
Attempts to compute a mapping for the specified key and its current mapped value (ornull
if there is no current mapping).default int
computeIntIfAbsent(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.default int
computeIntIfAbsentPartial(K key, Reference2IntFunction<? 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.default int
computeIntIfPresent(K key, BiFunction<? super K,? super Integer,? extends 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
containsKey(Object key)
Returns true if this function contains a mapping for the specified key.boolean
containsValue(int value)
Returnstrue
if this map maps one or more keys to the specified value.default boolean
containsValue(Object value)
Deprecated.Please use the corresponding type-specific method instead.int
defaultReturnValue()
Gets the default return value.void
defaultReturnValue(int rv)
Sets the default return value (optional operation).default ObjectSet<Map.Entry<K,Integer>>
entrySet()
Deprecated.Please use the corresponding type-specific method instead.default Integer
get(Object key)
Deprecated.Please use the corresponding type-specific method instead.default int
getOrDefault(Object key, int defaultValue)
Returns the value to which the specified key is mapped, or thedefaultValue
if this map contains no mapping for the key.default Integer
getOrDefault(Object key, Integer defaultValue)
Deprecated.Please use the corresponding type-specific method instead.ReferenceSet<K>
keySet()
default Integer
merge(K key, Integer value, BiFunction<? super Integer,? super Integer,? extends Integer> remappingFunction)
Deprecated.Please use the corresponding type-specific method instead.default int
mergeInt(K key, int value, BiFunction<? super Integer,? super Integer,? extends Integer> remappingFunction)
If the specified key is not already associated with a value, associates it with the givenvalue
.default Integer
put(K key, Integer value)
Deprecated.Please use the corresponding type-specific method instead.default 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.default Integer
putIfAbsent(K key, Integer value)
Deprecated.Please use the corresponding type-specific method instead.ObjectSet<Reference2IntMap.Entry<K>>
reference2IntEntrySet()
Returns a type-specific set view of the mappings contained in this map.default Integer
remove(Object key)
Deprecated.Please use the corresponding type-specific method instead.default boolean
remove(Object key, int value)
Removes the entry for the specified key only if it is currently mapped to the specified value.default boolean
remove(Object key, Object value)
Deprecated.Please use the corresponding type-specific method instead.default int
replace(K key, int value)
Replaces the entry for the specified key only if it is currently mapped to some value.default boolean
replace(K key, int oldValue, int newValue)
Replaces the entry for the specified key only if currently mapped to the specified value.default Integer
replace(K key, Integer value)
Deprecated.Please use the corresponding type-specific method instead.default boolean
replace(K key, Integer oldValue, Integer newValue)
Deprecated.Please use the corresponding type-specific method instead.int
size()
Returns the number of key/value mappings in this map.IntCollection
values()
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, hashCode, isEmpty, putAll, replaceAll
-
Methods inherited from interface it.unimi.dsi.fastutil.objects.Reference2IntFunction
andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, applyAsInt, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort, getInt, put, removeInt
-
-
-
-
Method Detail
-
size
int size()
Returns the number of key/value mappings in this map. If the map contains more thanInteger.MAX_VALUE
elements, returnsInteger.MAX_VALUE
.
-
clear
default void clear()
Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.- Specified by:
clear
in interfaceFunction<K,Integer>
- Specified by:
clear
in interfaceMap<K,Integer>
- Throws:
UnsupportedOperationException
- if theclear()
operation is not supported by this map- See Also:
Map.clear()
-
defaultReturnValue
void defaultReturnValue(int rv)
Sets the default return value (optional operation). This value must be returned by type-specific versions ofget()
,put()
andremove()
to denote that the map does not contain the specified key. It must be 0/false
by default.- Specified by:
defaultReturnValue
in interfaceReference2IntFunction<K>
- Parameters:
rv
- the new default return value.- See Also:
defaultReturnValue()
-
defaultReturnValue
int defaultReturnValue()
Gets the default return value.- Specified by:
defaultReturnValue
in interfaceReference2IntFunction<K>
- Returns:
- the current default return value.
-
reference2IntEntrySet
ObjectSet<Reference2IntMap.Entry<K>> reference2IntEntrySet()
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 anObjectSet
of type-specific entries (the latter makes it possible to access keys and values with type-specific methods).- Returns:
- a type-specific set view of the mappings contained in this map.
- See Also:
Map.entrySet()
-
entrySet
@Deprecated default ObjectSet<Map.Entry<K,Integer>> 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 interfaceMap<K,Integer>
- Returns:
- a set view of the mappings contained in this map.
- See Also:
Map.entrySet()
-
put
@Deprecated default Integer put(K key, Integer value)
Deprecated.Please use the corresponding type-specific method instead.Associates the specified value with the specified key in this function (optional operation).This default implementation just delegates to the corresponding type-specific–function method.
- Specified by:
put
in interfaceFunction<K,Integer>
- Specified by:
put
in interfaceMap<K,Integer>
- Specified by:
put
in interfaceReference2IntFunction<K>
- Parameters:
key
- the key.value
- the value.- Returns:
- the old value, or
null
if no value was present for the given key. - See Also:
Map.put(Object,Object)
-
get
@Deprecated default Integer get(Object key)
Deprecated.Please use the corresponding type-specific method instead.Returns the value associated by this function to the specified key.This default implementation just delegates to the corresponding type-specific–function method.
-
remove
@Deprecated default Integer remove(Object key)
Deprecated.Please use the corresponding type-specific method instead.Removes this key and the associated value from this function if it is present (optional operation).This default implementation just delegates to the corresponding type-specific–function method.
-
keySet
ReferenceSet<K> keySet()
Note that this specification strengthens the one given in
Map.keySet()
.- Specified by:
keySet
in interfaceMap<K,Integer>
- Returns:
- a set view of the keys contained in this map.
- See Also:
Map.keySet()
-
values
IntCollection values()
Note that this specification strengthens the one given in
Map.values()
.- Specified by:
values
in interfaceMap<K,Integer>
- Returns:
- a set view of the values contained in this map.
- See Also:
Map.values()
-
containsKey
boolean containsKey(Object key)
Returns true if this function contains a mapping for the specified key.- Specified by:
containsKey
in interfaceFunction<K,Integer>
- Specified by:
containsKey
in interfaceMap<K,Integer>
- Parameters:
key
- the key.- Returns:
- true if this function associates a value to
key
. - See Also:
Map.containsKey(Object)
-
containsValue
boolean containsValue(int value)
Returnstrue
if this map maps one or more keys to the specified value.- See Also:
Map.containsValue(Object)
-
containsValue
@Deprecated default boolean containsValue(Object value)
Deprecated.Please use the corresponding type-specific method instead.- Specified by:
containsValue
in interfaceMap<K,Integer>
-
getOrDefault
default int getOrDefault(Object key, int defaultValue)
Returns the value to which the specified key is mapped, or thedefaultValue
if this map contains no mapping for the key.- 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. - Since:
- 8.0.0
- See Also:
Map.getOrDefault(Object, Object)
-
putIfAbsent
default 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.- 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.
- Since:
- 8.0.0
- See Also:
Map.putIfAbsent(Object, Object)
-
remove
default boolean remove(Object key, int value)
Removes the entry for the specified key only if it is currently mapped to the specified value.- 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.- Since:
- 8.0.0
- See Also:
Map.remove(Object, Object)
-
replace
default boolean replace(K key, int oldValue, int newValue)
Replaces the entry for the specified key only if currently mapped to the specified value.- 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.- Since:
- 8.0.0
- See Also:
Map.replace(Object, Object, Object)
-
replace
default int replace(K key, int value)
Replaces the entry for the specified key only if it is currently mapped to some value.- 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.
- Since:
- 8.0.0
- See Also:
Map.replace(Object, Object)
-
computeIntIfAbsent
default int computeIntIfAbsent(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.Note that contrarily to the default computeIfAbsent(), it is not possible to not add a value for a given key, since the
mappingFunction
cannot returnnull
. If such a behavior is needed, please use the corresponding nullable version.- 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.
- Since:
- 8.0.0
- See Also:
Map.computeIfAbsent(Object, java.util.function.Function)
-
computeIntIfAbsentPartial
default int computeIntIfAbsentPartial(K key, Reference2IntFunction<? 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.This version of computeIfAbsent() uses a type-specific version of
fastutil
'sFunction
. SinceFunction
has acontainsKey()
method, it is possible to avoid adding a key by havingcontainsKey()
returnfalse
for that key.- 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.
- Since:
- 8.0.0
- See Also:
Map.computeIfAbsent(Object, java.util.function.Function)
-
computeIntIfPresent
default int computeIntIfPresent(K key, BiFunction<? super K,? super Integer,? extends 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.- 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.
- Since:
- 8.0.0
- See Also:
Map.computeIfPresent(Object, java.util.function.BiFunction)
-
computeInt
default int computeInt(K key, BiFunction<? super K,? super Integer,? extends Integer> remappingFunction)
Attempts to compute a mapping for the specified key and its current mapped value (ornull
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.- 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.
- Since:
- 8.0.0
- See Also:
Map.compute(Object, java.util.function.BiFunction)
-
mergeInt
default int mergeInt(K key, int value, BiFunction<? super Integer,? super Integer,? extends Integer> remappingFunction)
If the specified key is not already associated with a value, associates it with the givenvalue
. Otherwise, replaces the associated value with the results of the given remapping function, or removes if the result isnull
.- 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.
- Since:
- 8.0.0
- See Also:
Map.merge(Object, Object, java.util.function.BiFunction)
-
getOrDefault
@Deprecated default Integer getOrDefault(Object key, Integer defaultValue)
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Map
method.- Specified by:
getOrDefault
in interfaceMap<K,Integer>
-
putIfAbsent
@Deprecated default Integer putIfAbsent(K key, 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 interfaceMap<K,Integer>
-
remove
@Deprecated default 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.
-
replace
@Deprecated default boolean replace(K key, Integer oldValue, Integer newValue)
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Map
method.
-
replace
@Deprecated default Integer replace(K key, Integer value)
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Map
method.
-
merge
@Deprecated default Integer merge(K key, Integer value, BiFunction<? super Integer,? super Integer,? extends Integer> remappingFunction)
Deprecated.Please use the corresponding type-specific method instead.This default implementation just delegates to the corresponding
Map
method.
-
-