Interface Char2CharMap

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Interface Description
      static interface  Char2CharMap.Entry
      A type-specific Map.Entry; provides some additional methods that use polymorphism to avoid (un)boxing.
      static interface  Char2CharMap.FastEntrySet
      An entry set providing fast iteration.
    • 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 Char2CharFunction
        Parameters:
        rv - the new default return value.
        See Also:
        defaultReturnValue()
      • defaultReturnValue

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

        ObjectSet<Char2CharMap.Entry> char2CharEntrySet()
        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()
      • containsKey

        boolean containsKey​(char key)
        Returns true if this function contains a mapping for the specified key.
        Specified by:
        containsKey in interface Char2CharFunction
        Parameters:
        key - the key.
        Returns:
        true if this function associates a value to key.
        See Also:
        Map.containsKey(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​(char 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​(char 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​(char 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​(char 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​(char 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)
      • computeIfAbsent

        default char 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 char computeIfAbsentNullable​(char 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:
        Map.computeIfAbsent(Object, java.util.function.Function)
      • computeIfAbsentPartial

        default char computeIfAbsentPartial​(char key,
                                            Char2CharFunction 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 char computeIfPresent​(char key,
                                      BiFunction<? super Character,​? 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)
      • compute

        default char compute​(char key,
                             BiFunction<? super Character,​? 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)
      • merge

        default char merge​(char 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)
      • 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,​Character>