Class Int2ReferenceMaps.UnmodifiableMap<V>

java.lang.Object
All Implemented Interfaces:
Function<java.lang.Integer,​V>, Int2ReferenceFunction<V>, Int2ReferenceMap<V>, java.io.Serializable, java.util.function.Function<java.lang.Integer,​V>, java.util.function.IntFunction<V>, java.util.Map<java.lang.Integer,​V>
Direct Known Subclasses:
Int2ReferenceSortedMaps.UnmodifiableSortedMap
Enclosing class:
Int2ReferenceMaps

public static class Int2ReferenceMaps.UnmodifiableMap<V>
extends Int2ReferenceFunctions.UnmodifiableFunction<V>
implements Int2ReferenceMap<V>, java.io.Serializable
An unmodifiable wrapper class for maps.
See Also:
Serialized Form
  • Nested Class Summary

    Nested classes/interfaces inherited from interface it.unimi.dsi.fastutil.ints.Int2ReferenceMap

    Int2ReferenceMap.Entry<V>, Int2ReferenceMap.FastEntrySet<V>
  • Method Summary

    Modifier and Type Method Description
    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).
    V compute​(java.lang.Integer key, java.util.function.BiFunction<? super java.lang.Integer,​? super V,​? extends V> remappingFunction)
    Deprecated.
    Please use the corresponding type-specific method instead.
    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.
    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.
    V computeIfAbsent​(java.lang.Integer key, java.util.function.Function<? super java.lang.Integer,​? extends V> mappingFunction)
    Deprecated.
    Please use the corresponding type-specific method instead.
    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.
    V computeIfPresent​(java.lang.Integer key, java.util.function.BiFunction<? super java.lang.Integer,​? super V,​? extends V> remappingFunction)
    Deprecated.
    Please use the corresponding type-specific method instead.
    boolean containsValue​(java.lang.Object v)  
    ObjectSet<java.util.Map.Entry<java.lang.Integer,​V>> entrySet()
    Deprecated.
    Please use the corresponding type-specific method instead.
    boolean equals​(java.lang.Object o)  
    void forEach​(java.util.function.BiConsumer<? super java.lang.Integer,​? super V> action)  
    V getOrDefault​(int key, V defaultValue)
    Returns the value associated by this function to the specified key, or give the specified value if not present.
    V getOrDefault​(java.lang.Object key, V defaultValue)
    Deprecated.
    Please use the corresponding type-specific method instead.
    int hashCode()  
    ObjectSet<Int2ReferenceMap.Entry<V>> int2ReferenceEntrySet()
    Returns a type-specific set view of the mappings contained in this map.
    boolean isEmpty()  
    IntSet keySet()
    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.
    V merge​(java.lang.Integer key, V value, java.util.function.BiFunction<? super V,​? super V,​? extends V> remappingFunction)
    Deprecated.
    Please use the corresponding type-specific method instead.
    void putAll​(java.util.Map<? extends java.lang.Integer,​? extends V> m)  
    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.
    V putIfAbsent​(java.lang.Integer key, V value)
    Deprecated.
    Please use the corresponding type-specific method instead.
    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.
    boolean remove​(java.lang.Object key, java.lang.Object value)
    Deprecated.
    Please use the corresponding type-specific method instead.
    V replace​(int key, V value)
    Replaces the entry for the specified key only if it is currently mapped to some value.
    boolean replace​(int key, V oldValue, V newValue)
    Replaces the entry for the specified key only if currently mapped to the specified value.
    V replace​(java.lang.Integer key, V value)
    Deprecated.
    Please use the corresponding type-specific method instead.
    boolean replace​(java.lang.Integer key, V oldValue, V newValue)
    Deprecated.
    Please use the corresponding type-specific method instead.
    void replaceAll​(java.util.function.BiFunction<? super java.lang.Integer,​? super V,​? extends V> function)  
    ReferenceCollection<V> values()

    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

    Methods inherited from interface it.unimi.dsi.fastutil.ints.Int2ReferenceMap

    clear, computeIfAbsentPartial, containsKey, containsKey, defaultReturnValue, defaultReturnValue, get, put, remove, size
  • Method Details

    • containsValue

      public boolean containsValue​(java.lang.Object v)
      Specified by:
      containsValue in interface java.util.Map<java.lang.Integer,​V>
    • putAll

      public void putAll​(java.util.Map<? extends java.lang.Integer,​? extends V> m)
      Specified by:
      putAll in interface java.util.Map<java.lang.Integer,​V>
    • int2ReferenceEntrySet

      public ObjectSet<Int2ReferenceMap.Entry<V>> int2ReferenceEntrySet()
      Description copied from interface: Int2ReferenceMap
      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:
      int2ReferenceEntrySet in interface Int2ReferenceMap<V>
      Returns:
      a type-specific set view of the mappings contained in this map.
      See Also:
      Map.entrySet()
    • entrySet

      @Deprecated public 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 Int2ReferenceMap<V>
      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()
    • keySet

      public IntSet keySet()
      Description copied from interface: Int2ReferenceMap
      Specified by:
      keySet in interface Int2ReferenceMap<V>
      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()
    • values

      public ReferenceCollection<V> values()
      Description copied from interface: Int2ReferenceMap
      Specified by:
      values in interface Int2ReferenceMap<V>
      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()
    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface java.util.Map<java.lang.Integer,​V>
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface java.util.Map<java.lang.Integer,​V>
      Overrides:
      hashCode in class Int2ReferenceFunctions.UnmodifiableFunction<V>
    • equals

      public boolean equals​(java.lang.Object o)
      Specified by:
      equals in interface java.util.Map<java.lang.Integer,​V>
      Overrides:
      equals in class Int2ReferenceFunctions.UnmodifiableFunction<V>
    • getOrDefault

      public V getOrDefault​(int key, V defaultValue)
      Description copied from interface: Int2ReferenceFunction
      Returns the value associated by this function to the specified key, or give the specified value if not present.
      Specified by:
      getOrDefault in interface Int2ReferenceFunction<V>
      Specified by:
      getOrDefault in interface Int2ReferenceMap<V>
      Overrides:
      getOrDefault in class Int2ReferenceFunctions.UnmodifiableFunction<V>
      Parameters:
      key - the key.
      defaultValue - the value to return if not present.
      Returns:
      the corresponding value, or defaultValue if no value was present for the given key.
      See Also:
      Function.getOrDefault(Object, Object)
    • forEach

      public void forEach​(java.util.function.BiConsumer<? super java.lang.Integer,​? super V> action)
      Specified by:
      forEach in interface Int2ReferenceMap<V>
      Specified by:
      forEach in interface java.util.Map<java.lang.Integer,​V>
    • replaceAll

      public void replaceAll​(java.util.function.BiFunction<? super java.lang.Integer,​? super V,​? extends V> function)
      Specified by:
      replaceAll in interface java.util.Map<java.lang.Integer,​V>
    • putIfAbsent

      public V putIfAbsent​(int key, V value)
      Description copied from interface: Int2ReferenceMap
      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 Int2ReferenceMap<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​(int key, java.lang.Object value)
      Description copied from interface: Int2ReferenceMap
      Removes the entry for the specified key only if it is currently mapped to the specified value.
      Specified by:
      remove in interface Int2ReferenceMap<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​(int key, V value)
      Description copied from interface: Int2ReferenceMap
      Replaces the entry for the specified key only if it is currently mapped to some value.
      Specified by:
      replace in interface Int2ReferenceMap<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​(int key, V oldValue, V newValue)
      Description copied from interface: Int2ReferenceMap
      Replaces the entry for the specified key only if currently mapped to the specified value.
      Specified by:
      replace in interface Int2ReferenceMap<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​(int key, java.util.function.IntFunction<? extends V> mappingFunction)
      Description copied from interface: Int2ReferenceMap
      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 Int2ReferenceMap<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)
    • computeIfAbsent

      public V computeIfAbsent​(int key, Int2ReferenceFunction<? extends V> mappingFunction)
      Description copied from interface: Int2ReferenceMap
      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:
      computeIfAbsent in interface Int2ReferenceMap<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​(int key, java.util.function.BiFunction<? super java.lang.Integer,​? super V,​? extends V> remappingFunction)
      Description copied from interface: Int2ReferenceMap
      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 Int2ReferenceMap<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​(int key, java.util.function.BiFunction<? super java.lang.Integer,​? super V,​? extends V> remappingFunction)
      Description copied from interface: Int2ReferenceMap
      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 Int2ReferenceMap<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​(int key, V value, java.util.function.BiFunction<? super V,​? super V,​? extends V> remappingFunction)
      Description copied from interface: Int2ReferenceMap
      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:
      merge in interface Int2ReferenceMap<V>
      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 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.
      Specified by:
      getOrDefault in interface Function<java.lang.Integer,​V>
      Specified by:
      getOrDefault in interface Int2ReferenceFunction<V>
      Specified by:
      getOrDefault in interface Int2ReferenceMap<V>
      Specified by:
      getOrDefault in interface java.util.Map<java.lang.Integer,​V>
      Overrides:
      getOrDefault in class Int2ReferenceFunctions.UnmodifiableFunction<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)
    • remove

      @Deprecated public boolean remove​(java.lang.Object key, java.lang.Object value)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      remove in interface java.util.Map<java.lang.Integer,​V>
    • replace

      @Deprecated public V replace​(java.lang.Integer key, V value)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      replace in interface java.util.Map<java.lang.Integer,​V>
    • replace

      @Deprecated public boolean replace​(java.lang.Integer key, V oldValue, V newValue)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      replace in interface java.util.Map<java.lang.Integer,​V>
    • putIfAbsent

      @Deprecated public V putIfAbsent​(java.lang.Integer key, V value)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      putIfAbsent in interface java.util.Map<java.lang.Integer,​V>
    • computeIfAbsent

      @Deprecated public V computeIfAbsent​(java.lang.Integer key, java.util.function.Function<? super java.lang.Integer,​? extends V> mappingFunction)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      computeIfAbsent in interface java.util.Map<java.lang.Integer,​V>
    • computeIfPresent

      @Deprecated public V computeIfPresent​(java.lang.Integer key, java.util.function.BiFunction<? super java.lang.Integer,​? super V,​? extends V> remappingFunction)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      computeIfPresent in interface java.util.Map<java.lang.Integer,​V>
    • compute

      @Deprecated public V compute​(java.lang.Integer key, java.util.function.BiFunction<? super java.lang.Integer,​? super V,​? extends V> remappingFunction)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      compute in interface java.util.Map<java.lang.Integer,​V>
    • merge

      @Deprecated public V merge​(java.lang.Integer key, V value, java.util.function.BiFunction<? super V,​? super V,​? extends V> remappingFunction)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      merge in interface java.util.Map<java.lang.Integer,​V>