Class Char2ObjectMaps.SynchronizedMap<V>

    • Method Detail

      • char2ObjectEntrySet

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

        public V getOrDefault​(char key,
                              V defaultValue)
        Description copied from interface: Char2ObjectMap
        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 Char2ObjectMap<V>
        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.
        See Also:
        Map.getOrDefault(Object, Object)
      • putIfAbsent

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

        public V computeIfAbsentPartial​(char key,
                                        Char2ObjectFunction<? extends V> mappingFunction)
        Description copied from interface: Char2ObjectMap
        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:
        computeIfAbsentPartial in interface Char2ObjectMap<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)
      • compute

        public V compute​(char key,
                         BiFunction<? super Character,​? super V,​? extends V> remappingFunction)
        Description copied from interface: Char2ObjectMap
        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 Char2ObjectMap<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​(char key,
                       V value,
                       BiFunction<? super V,​? super V,​? extends V> remappingFunction)
        Description copied from interface: Char2ObjectMap
        If the specified key is not already associated with a value or is associated with null, associates it with the given non-null 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 Char2ObjectMap<V>
        Parameters:
        key - key with which the resulting value is to be associated.
        value - the non-null 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)
      • remove

        @Deprecated
        public 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 Char2ObjectMap<V>
        Specified by:
        remove in interface Map<Character,​V>
      • replace

        @Deprecated
        public boolean replace​(Character key,
                               V oldValue,
                               V 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 Char2ObjectMap<V>
        Specified by:
        replace in interface Map<Character,​V>
      • merge

        @Deprecated
        public V merge​(Character key,
                       V value,
                       BiFunction<? super V,​? super V,​? extends V> 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 Char2ObjectMap<V>
        Specified by:
        merge in interface Map<Character,​V>