Interface Int2ReferenceMap<V>

All Superinterfaces:
Function<java.lang.Integer,​V>, java.util.function.Function<java.lang.Integer,​V>, Int2ReferenceFunction<V>, java.util.function.IntFunction<V>, java.util.Map<java.lang.Integer,​V>
All Known Subinterfaces:
Int2ReferenceSortedMap<V>
All Known Implementing Classes:
AbstractInt2ReferenceMap, AbstractInt2ReferenceSortedMap, Int2ReferenceArrayMap, Int2ReferenceAVLTreeMap, Int2ReferenceLinkedOpenHashMap, Int2ReferenceMaps.EmptyMap, Int2ReferenceMaps.Singleton, Int2ReferenceMaps.SynchronizedMap, Int2ReferenceMaps.UnmodifiableMap, Int2ReferenceOpenCustomHashMap, Int2ReferenceOpenHashMap, Int2ReferenceRBTreeMap, Int2ReferenceSortedMaps.EmptySortedMap, Int2ReferenceSortedMaps.Singleton, Int2ReferenceSortedMaps.SynchronizedSortedMap, Int2ReferenceSortedMaps.UnmodifiableSortedMap

public interface Int2ReferenceMap<V>
extends Int2ReferenceFunction<V>, java.util.Map<java.lang.Integer,​V>
A type-specific Map; 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() and values(). Moreover, a number of methods, such as size(), defaultReturnValue(), etc., are un-defaulted as their function default do not make sense for a map. Maps returning entry sets of type Int2ReferenceMap.FastEntrySet support also fast iteration.

This interface specifies reference equality semantics (members will be compared equal with == instead of equals) for its keys or values (or both), which may result in breaks in contract if attempted to be used with non reference-equality semantics based Maps. For example, a aReferenceToIntMap.equals(aObjectToIntMap) may return different a different result then aObjectToIntMap.equals(aReferenceToIntMap), in violation of equals's contract requiring it being symmetric.

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  Int2ReferenceMap.Entry<V>
    A type-specific Map.Entry; provides some additional methods that use polymorphism to avoid (un)boxing.
    static interface  Int2ReferenceMap.FastEntrySet<V>
    An entry set providing fast iteration.
  • Method Summary

    Modifier and Type Method Description
    default void clear()
    Removes all of the mappings from this map (optional operation).
    default V compute​(int key, java.util.function.BiFunction<? super java.lang.Integer,​? 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).
    default V computeIfAbsent​(int key, Int2ReferenceFunction<? 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.
    default V computeIfAbsent​(int key, java.util.function.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.
    default V computeIfAbsentPartial​(int key, Int2ReferenceFunction<? extends V> mappingFunction)
    Deprecated.
    Please use computeIfAbsent() instead.
    default V computeIfPresent​(int key, java.util.function.BiFunction<? super java.lang.Integer,​? 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 containsKey​(int key)
    Returns true if this function contains a mapping for the specified key.
    default boolean containsKey​(java.lang.Object key)
    Deprecated.
    Please use the corresponding type-specific method instead.
    V defaultReturnValue()
    Gets the default return value.
    void defaultReturnValue​(V rv)
    Sets the default return value (optional operation).
    default ObjectSet<java.util.Map.Entry<java.lang.Integer,​V>> entrySet()
    Deprecated.
    Please use the corresponding type-specific method instead.
    default void forEach​(java.util.function.BiConsumer<? super java.lang.Integer,​? super V> consumer)  
    default V get​(java.lang.Object key)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default V getOrDefault​(int 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.
    default V getOrDefault​(java.lang.Object key, V defaultValue)
    Deprecated.
    Please use the corresponding type-specific method instead.
    ObjectSet<Int2ReferenceMap.Entry<V>> int2ReferenceEntrySet()
    Returns a type-specific set view of the mappings contained in this map.
    IntSet keySet()
    default V merge​(int 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.
    default V put​(java.lang.Integer key, V value)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default V putIfAbsent​(int 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.
    default boolean remove​(int key, java.lang.Object value)
    Removes the entry for the specified key only if it is currently mapped to the specified value.
    default V remove​(java.lang.Object key)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default V replace​(int key, V value)
    Replaces the entry for the specified key only if it is currently mapped to some value.
    default boolean replace​(int key, V oldValue, V newValue)
    Replaces the entry for the specified key only if currently mapped to the specified value.
    int size()
    Returns the number of key/value mappings in this map.
    ReferenceCollection<V> values()

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

    apply

    Methods inherited from interface java.util.function.Function

    andThen

    Methods inherited from interface java.util.Map

    compute, computeIfAbsent, computeIfPresent, containsValue, equals, hashCode, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, replaceAll
  • Method Details

    • size

      int size()
      Returns the number of key/value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
      Specified by:
      size in interface Function<java.lang.Integer,​V>
      Specified by:
      size in interface java.util.Map<java.lang.Integer,​V>
      Returns:
      the number of key-value mappings in this map.
      See Also:
      Size64
    • 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 interface Function<java.lang.Integer,​V>
      Specified by:
      clear in interface java.util.Map<java.lang.Integer,​V>
      Throws:
      java.lang.UnsupportedOperationException - if the clear() operation is not supported by this map
      See Also:
      Map.clear()
    • defaultReturnValue

      void defaultReturnValue​(V rv)
      Sets the default return value (optional operation). This value must be returned by type-specific versions of get(), put() and remove() to denote that the map does not contain the specified key. It must be null by default.

      Warning: Changing this to a non-null value can have unforeseen consequences. Especially, it breaks compatibility with the specifications of Java's Map interface. It has to be used with great care and thorough study of all method comments is recommended.

      Specified by:
      defaultReturnValue in interface Int2ReferenceFunction<V>
      Parameters:
      rv - the new default return value.
      See Also:
      defaultReturnValue()
    • defaultReturnValue

      V defaultReturnValue()
      Gets the default return value.
      Specified by:
      defaultReturnValue in interface Int2ReferenceFunction<V>
      Returns:
      the current default return value.
    • int2ReferenceEntrySet

      ObjectSet<Int2ReferenceMap.Entry<V>> int2ReferenceEntrySet()
      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).

      Returns:
      a type-specific set view of the mappings contained in this map.
      See Also:
      Map.entrySet()
    • entrySet

      @Deprecated default ObjectSet<java.util.Map.Entry<java.lang.Integer,​V>> entrySet()
      Deprecated.
      Please use the corresponding type-specific method instead.
      Returns a set view of the mappings contained in this map.
      Specified by:
      entrySet in interface java.util.Map<java.lang.Integer,​V>
      Returns:
      a set view of the mappings contained in this map.
      See Also:
      Map.entrySet()
      API Notes:
      Note that this specification strengthens the one given in Map.entrySet().
    • put

      @Deprecated default V put​(java.lang.Integer key, V 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 interface Function<java.lang.Integer,​V>
      Specified by:
      put in interface Int2ReferenceFunction<V>
      Specified by:
      put in interface java.util.Map<java.lang.Integer,​V>
      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 V get​(java.lang.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.

      Specified by:
      get in interface Function<java.lang.Integer,​V>
      Specified by:
      get in interface Int2ReferenceFunction<V>
      Specified by:
      get in interface java.util.Map<java.lang.Integer,​V>
      Parameters:
      key - the key.
      Returns:
      the corresponding value, or null if no value was present for the given key.
      See Also:
      Map.get(Object)
    • remove

      @Deprecated default V remove​(java.lang.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.

      Specified by:
      remove in interface Function<java.lang.Integer,​V>
      Specified by:
      remove in interface Int2ReferenceFunction<V>
      Specified by:
      remove in interface java.util.Map<java.lang.Integer,​V>
      Parameters:
      key - the key.
      Returns:
      the old value, or null if no value was present for the given key.
      See Also:
      Map.remove(Object)
    • keySet

      IntSet keySet()
      Specified by:
      keySet in interface java.util.Map<java.lang.Integer,​V>
      Returns:
      a set view of the keys contained in this map.
      See Also:
      Map.keySet()
      API Notes:
      Note that this specification strengthens the one given in Map.keySet().
    • values

      Specified by:
      values in interface java.util.Map<java.lang.Integer,​V>
      Returns:
      a set view of the values contained in this map.
      See Also:
      Map.values()
      API Notes:
      Note that this specification strengthens the one given in Map.values().
    • containsKey

      boolean containsKey​(int key)
      Returns true if this function contains a mapping for the specified key.
      Specified by:
      containsKey in interface Int2ReferenceFunction<V>
      Parameters:
      key - the key.
      Returns:
      true if this function associates a value to key.
      See Also:
      Map.containsKey(Object)
    • containsKey

      @Deprecated default boolean containsKey​(java.lang.Object key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Returns true if this function contains a mapping for the specified key.

      This default implementation just delegates to the corresponding type-specific–function method.

      Specified by:
      containsKey in interface Function<java.lang.Integer,​V>
      Specified by:
      containsKey in interface Int2ReferenceFunction<V>
      Specified by:
      containsKey in interface java.util.Map<java.lang.Integer,​V>
      Parameters:
      key - the key.
      Returns:
      true if this function associates a value to key.
      See Also:
      Map.containsKey(Object)
    • forEach

      default void forEach​(java.util.function.BiConsumer<? super java.lang.Integer,​? super V> consumer)
      Specified by:
      forEach in interface java.util.Map<java.lang.Integer,​V>
    • getOrDefault

      default V getOrDefault​(int 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.
      Specified by:
      getOrDefault in interface Int2ReferenceFunction<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.
      Since:
      8.0.0
      See Also:
      Map.getOrDefault(Object, Object)
    • getOrDefault

      @Deprecated default V getOrDefault​(java.lang.Object key, V defaultValue)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Returns the value associated by this function to the specified key, or give the specified value if not present.

      This default implementation just delegates to the corresponding Map method.

      Specified by:
      getOrDefault in interface Function<java.lang.Integer,​V>
      Specified by:
      getOrDefault in interface Int2ReferenceFunction<V>
      Specified by:
      getOrDefault in interface java.util.Map<java.lang.Integer,​V>
      Parameters:
      key - the key.
      defaultValue - the default value to return if not present.
      Returns:
      the corresponding value, or defaultValue if no value was present for the given key.
      See Also:
      Map.getOrDefault(Object, Object)
    • putIfAbsent

      default V putIfAbsent​(int 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.
      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​(int key, java.lang.Object 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​(int key, V oldValue, V 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 V replace​(int key, V 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)
    • computeIfAbsent

      default V computeIfAbsent​(int key, java.util.function.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.

      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.

      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)
      API Notes:
      all computeIfAbsent() methods have a different logic based on the argument; no delegation is performed, contrarily to other superficially similar methods such as Iterator.forEachRemaining(java.util.function.Consumer<? super E>) or List.replaceAll(java.util.function.UnaryOperator<E>).
    • computeIfAbsent

      default V computeIfAbsent​(int key, Int2ReferenceFunction<? 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.

      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.

      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)
      API Notes:
      all computeIfAbsent() methods have a different logic based on the argument; no delegation is performed, contrarily to other superficially similar methods such as Iterator.forEachRemaining(java.util.function.Consumer<? super E>) or List.replaceAll(java.util.function.UnaryOperator<E>).
    • computeIfAbsentPartial

      @Deprecated default V computeIfAbsentPartial​(int key, Int2ReferenceFunction<? extends V> mappingFunction)
      Deprecated.
      Please use computeIfAbsent() instead.
    • computeIfPresent

      default V computeIfPresent​(int key, java.util.function.BiFunction<? super java.lang.Integer,​? 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.
      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)
    • compute

      default V compute​(int key, java.util.function.BiFunction<? super java.lang.Integer,​? 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).

      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)
    • merge

      default V merge​(int 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. Otherwise, replaces the associated value with the results of the given remapping function, or removes if the result is null.
      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)
      API Notes:
      The JDK specification for this method equates not being associated with a value with being associated with {code null}. This is not the case for this method.