Interface Reference2CharMap<K>

    • Method Detail

      • 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 Reference2CharFunction<K>
        Parameters:
        rv - the new default return value.
        See Also:
        defaultReturnValue()
      • reference2CharEntrySet

        ObjectSet<Reference2CharMap.Entry<K>> reference2CharEntrySet()
        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 Character put​(K 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<K,​Character>
        Specified by:
        put in interface Map<K,​Character>
        Specified by:
        put in interface Reference2CharFunction<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 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<K,​Character>
        Specified by:
        get in interface Map<K,​Character>
        Specified by:
        get in interface Reference2CharFunction<K>
        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 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<K,​Character>
        Specified by:
        remove in interface Map<K,​Character>
        Specified by:
        remove in interface Reference2CharFunction<K>
        Parameters:
        key - the key.
        Returns:
        the old value, or null if no value was present for the given key.
        See Also:
        Map.remove(Object)
      • containsValue

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

        default char getOrDefault​(Object 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.
        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 char putIfAbsent​(K 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:
        Map.putIfAbsent(Object, Object)
      • remove

        default boolean remove​(Object 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:
        Map.remove(Object, Object)
      • replace

        default boolean replace​(K 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:
        Map.replace(Object, Object, Object)
      • replace

        default char replace​(K 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:
        Map.replace(Object, Object)
      • computeCharIfAbsent

        default char computeCharIfAbsent​(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 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)
      • computeCharIfAbsentPartial

        default char computeCharIfAbsentPartial​(K key,
                                                Reference2CharFunction<? 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'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)
      • computeCharIfPresent

        default char computeCharIfPresent​(K key,
                                          BiFunction<? super K,​? 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:
        Map.computeIfPresent(Object, java.util.function.BiFunction)
      • computeChar

        default char computeChar​(K key,
                                 BiFunction<? super K,​? 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:
        Map.compute(Object, java.util.function.BiFunction)
      • mergeChar

        default char mergeChar​(K 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:
        Map.merge(Object, Object, java.util.function.BiFunction)
      • putIfAbsent

        @Deprecated
        default Character putIfAbsent​(K 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<K,​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<K,​Character>
      • replace

        @Deprecated
        default boolean replace​(K 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<K,​Character>
      • replace

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