Package it.unimi.dsi.fastutil.ints

Interface Int2CharMap

All Superinterfaces:
Function<Integer,Character>, Function<Integer,Character>, Int2CharFunction, IntUnaryOperator, Map<Integer,Character>
All Known Subinterfaces:
Int2CharSortedMap
All Known Implementing Classes:
AbstractInt2CharMap, AbstractInt2CharSortedMap, Int2CharArrayMap, Int2CharAVLTreeMap, Int2CharLinkedOpenHashMap, Int2CharMaps.EmptyMap, Int2CharMaps.Singleton, Int2CharMaps.SynchronizedMap, Int2CharMaps.UnmodifiableMap, Int2CharOpenCustomHashMap, Int2CharOpenHashMap, Int2CharRBTreeMap, Int2CharSortedMaps.EmptySortedMap, Int2CharSortedMaps.Singleton, Int2CharSortedMaps.SynchronizedSortedMap, Int2CharSortedMaps.UnmodifiableSortedMap
public interface Int2CharMap extends Int2CharFunction, Map<Integer,Character>
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 Int2CharMap.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:

  • 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<Integer,Character>
      Specified by:
      size in interface Map<Integer,Character>
      Returns:
      the number of key-value mappings in this map.
      See Also:

    • 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<Integer,Character>
      Specified by:
      clear in interface Map<Integer,Character>
      Throws:
      UnsupportedOperationException - if the clear() operation is not supported by this map
      See Also:

    • defaultReturnValue

      void defaultReturnValue(char 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 0/false by default.
      Specified by:
      defaultReturnValue in interface Int2CharFunction
      Parameters:
      rv - the new default return value.
      See Also:

    • defaultReturnValue

      char defaultReturnValue()
      Gets the default return value.
      Specified by:
      defaultReturnValue in interface Int2CharFunction
      Returns:
      the current default return value.

    • int2CharEntrySet

      ObjectSet<Int2CharMap.Entry> int2CharEntrySet()
      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:

    • entrySet

      @Deprecated default ObjectSet<Map.Entry<Integer,Character>> 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 Map<Integer,Character>
      Returns:
      a set view of the mappings contained in this map.
      See Also:
      API Notes:
      Note that this specification strengthens the one given in Map.entrySet().

    • put

      @Deprecated default Character put(Integer key, Character 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<Integer,Character>
      Specified by:
      put in interface Int2CharFunction
      Specified by:
      put in interface Map<Integer,Character>
      Parameters:
      key - the key.
      value - the value.
      Returns:
      the old value, or null if no value was present for the given key.
      See Also:

    • get

      @Deprecated default Character 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.

      Specified by:
      get in interface Function<Integer,Character>
      Specified by:
      get in interface Int2CharFunction
      Specified by:
      get in interface Map<Integer,Character>
      Parameters:
      key - the key.
      Returns:
      the corresponding value, or null if no value was present for the given key.
      See Also:

    • remove

      @Deprecated default Character 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.

      Specified by:
      remove in interface Function<Integer,Character>
      Specified by:
      remove in interface Int2CharFunction
      Specified by:
      remove in interface Map<Integer,Character>
      Parameters:
      key - the key.
      Returns:
      the old value, or null if no value was present for the given key.
      See Also:

    • keySet

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

    • values

      CharCollection values()
      Specified by:
      values in interface Map<Integer,Character>
      Returns:
      a set view of the values contained in this map.
      See Also:
      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 Int2CharFunction
      Parameters:
      key - the key.
      Returns:
      true if this function associates a value to key.
      See Also:

    • containsKey

      @Deprecated default boolean containsKey(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<Integer,Character>
      Specified by:
      containsKey in interface Int2CharFunction
      Specified by:
      containsKey in interface Map<Integer,Character>
      Parameters:
      key - the key.
      Returns:
      true if this function associates a value to key.
      See Also:

    • containsValue

      boolean containsValue(char value)
      Returns true if this map maps one or more keys to the specified value.
      See Also:

    • containsValue

      @Deprecated default boolean containsValue(Object value)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      containsValue in interface Map<Integer,Character>

    • forEach

      default void forEach(BiConsumer<? super Integer,? super Character> consumer)
      Specified by:
      forEach in interface Map<Integer,Character>

    • getOrDefault

      default char getOrDefault(int key, char 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 Int2CharFunction
      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:

    • getOrDefault

      @Deprecated default Character getOrDefault(Object key, Character 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<Integer,Character>
      Specified by:
      getOrDefault in interface Int2CharFunction
      Specified by:
      getOrDefault in interface Map<Integer,Character>
      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:

    • putIfAbsent

      default char putIfAbsent(int key, char 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:

    • remove

      default boolean remove(int key, char 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:

    • replace

      default boolean replace(int key, char oldValue, char 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:

    • replace

      default char replace(int key, char 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:

    • computeIfAbsent

      default char computeIfAbsent(int key, IntUnaryOperator 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:
      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>).

    • computeIfAbsentNullable

      default char computeIfAbsentNullable(int key, IntFunction<? extends Character> 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 it is null.

      Note that this version of computeIfAbsent() should be used only if you plan to return null in the mapping function.

      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, or the default return value if the computed value is null.
      Since:
      8.0.0
      See Also:

    • computeIfAbsent

      default char computeIfAbsent(int key, Int2CharFunction 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:
      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 char computeIfAbsentPartial(int key, Int2CharFunction mappingFunction)
      Deprecated.
      Please use computeIfAbsent() instead.

    • computeIfPresent

      default char computeIfPresent(int key, BiFunction<? super Integer,? super Character,? extends Character> 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:
      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.

    • compute

      default char compute(int key, BiFunction<? super Integer,? super Character,? extends Character> 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:

    • merge

      default char merge(int key, char value, BiFunction<? super Character,? super Character,? extends Character> 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:
      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.

    • mergeChar

      default char mergeChar(int key, char value, CharBinaryOperator 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.
      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.
      Since:
      8.5.0
      See Also:
      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. Moreover, this method cannot delete entries as the type-specific remapping function cannot return null.

    • mergeChar

      default char mergeChar(int key, char value, IntBinaryOperator 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.
      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.
      Since:
      8.5.0
      See Also:
      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. Moreover, this method cannot delete entries as the type-specific remapping function cannot return null.
      Implementation Notes:
      Unless the argument is type-specific, this method will introduce an intermediary lambda to perform narrowing and widening casts. Please use the type-specific overload to avoid this overhead.

    • putIfAbsent

      @Deprecated default Character putIfAbsent(Integer key, Character 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<Integer,Character>

    • 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.

      Specified by:
      remove in interface Map<Integer,Character>

    • replace

      @Deprecated default boolean replace(Integer key, Character oldValue, Character 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<Integer,Character>

    • replace

      @Deprecated default Character replace(Integer key, Character 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<Integer,Character>

    • computeIfAbsent

      @Deprecated default Character computeIfAbsent(Integer key, Function<? super Integer,? extends Character> mappingFunction)
      Deprecated.
      Please use the corresponding type-specific method instead.

      This default implementation just delegates to the corresponding Map method.

      Specified by:
      computeIfAbsent in interface Map<Integer,Character>

    • computeIfPresent

      @Deprecated default Character computeIfPresent(Integer key, BiFunction<? super Integer,? super Character,? extends Character> remappingFunction)
      Deprecated.
      Please use the corresponding type-specific method instead.

      This default implementation just delegates to the corresponding Map method.

      Specified by:
      computeIfPresent in interface Map<Integer,Character>

    • compute

      @Deprecated default Character compute(Integer key, BiFunction<? super Integer,? super Character,? extends Character> remappingFunction)
      Deprecated.
      Please use the corresponding type-specific method instead.

      This default implementation just delegates to the corresponding Map method.

      Specified by:
      compute in interface Map<Integer,Character>

    • merge

      @Deprecated default Character merge(Integer key, Character value, BiFunction<? super Character,? super Character,? extends Character> 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<Integer,Character>