Package it.unimi.dsi.fastutil.chars

Interface Char2ShortMap

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static interface  Char2ShortMap.Entry
      A type-specific Map.Entry; provides some additional methods that use polymorphism to avoid (un)boxing.
      static interface  Char2ShortMap.FastEntrySet
      An entry set providing fast iteration.

    • Method Summary

      Modifier and Type Method Description
      ObjectSet<Char2ShortMap.Entry> char2ShortEntrySet()
      Returns a type-specific set view of the mappings contained in this map.
      default void clear()
      Removes all of the mappings from this map (optional operation).
      default short compute​(char key, BiFunction<? super Character,​? super Short,​? extends Short> remappingFunction)
      Attempts to compute a mapping for the specified key and its current mapped value (or null if there is no current mapping).
      default Short compute​(Character key, BiFunction<? super Character,​? super Short,​? extends Short> remappingFunction)
      Deprecated.
      Please use the corresponding type-specific method instead.
      default short computeIfAbsent​(char 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.
      default Short computeIfAbsent​(Character key, Function<? super Character,​? extends Short> mappingFunction)
      Deprecated.
      Please use the corresponding type-specific method instead.
      default short computeIfAbsentNullable​(char key, IntFunction<? extends Short> 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.
      default short computeIfAbsentPartial​(char key, Char2ShortFunction 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 short computeIfPresent​(char key, BiFunction<? super Character,​? super Short,​? extends Short> remappingFunction)
      If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.
      default Short computeIfPresent​(Character key, BiFunction<? super Character,​? super Short,​? extends Short> remappingFunction)
      Deprecated.
      Please use the corresponding type-specific method instead.
      boolean containsKey​(char key)
      Returns true if this function contains a mapping for the specified key.
      default boolean containsKey​(Object key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      boolean containsValue​(short value)
      Returns true 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.
      short defaultReturnValue()
      Gets the default return value.
      void defaultReturnValue​(short rv)
      Sets the default return value (optional operation).
      default ObjectSet<Map.Entry<Character,​Short>> entrySet()
      Deprecated.
      Please use the corresponding type-specific method instead.
      default Short get​(Object key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      default short getOrDefault​(char key, short defaultValue)
      Returns the value to which the specified key is mapped, or the defaultValue if this map contains no mapping for the key.
      default Short getOrDefault​(Object key, Short defaultValue)
      Deprecated.
      Please use the corresponding type-specific method instead.
      CharSet keySet()
      default short merge​(char key, short value, BiFunction<? super Short,​? super Short,​? extends Short> remappingFunction)
      If the specified key is not already associated with a value, associates it with the given value.
      default Short merge​(Character key, Short value, BiFunction<? super Short,​? super Short,​? extends Short> remappingFunction)
      Deprecated.
      Please use the corresponding type-specific method instead.
      default Short put​(Character key, Short value)
      Deprecated.
      Please use the corresponding type-specific method instead.
      default short putIfAbsent​(char key, short 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 Short putIfAbsent​(Character key, Short value)
      Deprecated.
      Please use the corresponding type-specific method instead.
      default boolean remove​(char key, short value)
      Removes the entry for the specified key only if it is currently mapped to the specified value.
      default Short remove​(Object key)
      Deprecated.
      Please use the corresponding type-specific method instead.
      default boolean remove​(Object key, Object value)
      Deprecated.
      Please use the corresponding type-specific method instead.
      default short replace​(char key, short value)
      Replaces the entry for the specified key only if it is currently mapped to some value.
      default boolean replace​(char key, short oldValue, short newValue)
      Replaces the entry for the specified key only if currently mapped to the specified value.
      default Short replace​(Character key, Short value)
      Deprecated.
      Please use the corresponding type-specific method instead.
      default boolean replace​(Character key, Short oldValue, Short newValue)
      Deprecated.
      Please use the corresponding type-specific method instead.
      int size()
      Returns the number of key/value mappings in this map.
      ShortCollection values()

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

        apply

    • Method Detail

      • defaultReturnValue

        void defaultReturnValue​(short 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 Char2ShortFunction
        Parameters:
        rv - the new default return value.
        See Also:
        defaultReturnValue()

      • defaultReturnValue

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

      • char2ShortEntrySet

        ObjectSet<Char2ShortMap.Entry> char2ShortEntrySet()
        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()

      • put

        @Deprecated
default Short put​(Character key,
                  Short 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 Char2ShortFunction
        Specified by:
        put in interface Function<Character,​Short>
        Specified by:
        put in interface Map<Character,​Short>
        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 Short 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 Char2ShortFunction
        Specified by:
        get in interface Function<Character,​Short>
        Specified by:
        get in interface Map<Character,​Short>
        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 Short 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 Char2ShortFunction
        Specified by:
        remove in interface Function<Character,​Short>
        Specified by:
        remove in interface Map<Character,​Short>
        Parameters:
        key - the key.
        Returns:
        the old value, or null if no value was present for the given key.
        See Also:
        Map.remove(Object)

      • containsKey

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

      • containsValue

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

      • getOrDefault

        default short getOrDefault​(char key,
                           short defaultValue)
        Returns the value to which the specified key is mapped, or the defaultValue 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 short putIfAbsent​(char key,
                          short 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​(char key,
                       short 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​(char key,
                        short oldValue,
                        short 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 short replace​(char key,
                      short 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 short computeIfAbsent​(char 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:
        Map.computeIfAbsent(Object, java.util.function.Function)

      • computeIfAbsentNullable

        default short computeIfAbsentNullable​(char key,
                                      IntFunction<? extends Short> 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:
        Map.computeIfAbsent(Object, java.util.function.Function)

      • computeIfAbsentPartial

        default short computeIfAbsentPartial​(char key,
                                     Char2ShortFunction 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)

      • computeIfPresent

        default short computeIfPresent​(char key,
                               BiFunction<? super Character,​? super Short,​? extends Short> 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 short compute​(char key,
                      BiFunction<? super Character,​? super Short,​? extends Short> 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 short merge​(char key,
                    short value,
                    BiFunction<? super Short,​? super Short,​? extends Short> 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)

      • getOrDefault

        @Deprecated
default Short getOrDefault​(Object key,
                           Short 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 Map<Character,​Short>

      • 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<Character,​Short>

      • replace

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

      • replace

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