Package org.eclipse.collections.api.map.primitive

Interface MutableFloatBooleanMap

All Superinterfaces:
BooleanIterable, BooleanValuesMap, FloatBooleanMap, MutableBooleanValuesMap, PrimitiveIterable
All Known Implementing Classes:
FloatBooleanHashMap, SynchronizedFloatBooleanMap, UnmodifiableFloatBooleanMap
public interface MutableFloatBooleanMap
extends FloatBooleanMap, MutableBooleanValuesMap
This file was automatically generated from template file mutablePrimitivePrimitiveMap.stg.
Since:
3.0.

  • Method Details

    • put

      void put​(float key, boolean value)
      Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with value.
      Parameters:
      key - the key
      value - the value to associate with value

    • putPair

      default void putPair​(FloatBooleanPair keyValuePair)
      This method allows MutableFloatBooleanMap the ability to add an element in the form of FloatBooleanPair.
      Since:
      9.1.0
      See Also:
      put(float, boolean)

    • putAll

      void putAll​(FloatBooleanMap map)
      Puts all of the key/value mappings from the specified map into this map. If this map already has a value associated with one of the keys in the map, it will be replaced with the value in map.
      Parameters:
      map - the map to copy into this map

    • updateValues

      void updateValues​(FloatBooleanToBooleanFunction function)
      Updates the values in-place.
      Parameters:
      function - that takes a key and its value and that returns a new value for this key
      Since:
      10.0

    • removeKey

      void removeKey​(float key)
      Removes the mapping associated with the key, if one exists, from the map.
      Parameters:
      key - the key to remove
      See Also:
      remove(float)

    • remove

      void remove​(float key)
      Removes the mapping associated with the key, if one exists, from the map.
      Parameters:
      key - the key to remove
      See Also:
      removeKey(float)

    • removeKeyIfAbsent

      boolean removeKeyIfAbsent​(float key, boolean value)
      Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key. If no mapping existed for the key, the specified default value is returned.
      Parameters:
      key - the key to remove
      value - the default value to return if no mapping for the key exists
      Returns:
      the value previously associated with the key, if one existed, or value if not

    • getIfAbsentPut

      boolean getIfAbsentPut​(float key, boolean value)
      Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.
      Parameters:
      key - the key
      value - the value to associate with key if no such mapping exists
      Returns:
      the value associated with key, if one exists, or value if not

    • getIfAbsentPut

      boolean getIfAbsentPut​(float key, BooleanFunction0 function)
      Retrieves the value associated with the key if one exists; if it does not, invokes the supplier and associates the result with the key.
      Parameters:
      key - the key
      function - the supplier that provides the value if no mapping exists for key
      Returns:
      the value associated with the key, if one exists, or the result of invoking function if not

    • getIfAbsentPutWithKey

      boolean getIfAbsentPutWithKey​(float key, FloatToBooleanFunction function)
      Retrieves the value associated with the key if one exists; if it does not, associates the result of invoking the value function with the key.
      Parameters:
      key - the key
      function - the function that provides the value if no mapping exists. The key will be passed as the argument to the function.
      Returns:
      the value associated with the key, if one exists, or the result of invoking function with key if not

    • getIfAbsentPutWith

      <P> boolean getIfAbsentPutWith​(float key, BooleanFunction<? super P> function, P parameter)
      Retrieves the value associated with the key if one exists; if it does not, invokes the value function with the parameter and associates the result with the key.
      Type Parameters:
      P - the type of the value function's parameter
      Parameters:
      key - the key
      function - the function that provides the value if no mapping exists. The specified parameter will be passed as the argument to the function.
      parameter - the parameter to provide to function if no value exists for key
      Returns:
      the value associated with the key, if one exists, or the result of invoking function with parameter if not

    • updateValue

      boolean updateValue​(float key, boolean initialValueIfAbsent, BooleanToBooleanFunction function)
      Updates or sets the value associated with the key by applying the function to the existing value, if one exists, or to the specified initial value if one does not.
      Parameters:
      key - the key
      initialValueIfAbsent - the initial value to supply to the function if no mapping exists for the key
      function - the function that returns the updated value based on the current value or the initial value, if no value exists
      Returns:
      the new value associated with the key, either as a result of applying function to the value already associated with the key or as a result of applying it to initialValueIfAbsent and associating the result with key

    • select

      MutableFloatBooleanMap select​(FloatBooleanPredicate predicate)
      Description copied from interface: FloatBooleanMap
      Return a copy of this map containing only the key/value pairs that match the predicate.
      Specified by:
      select in interface FloatBooleanMap
      Parameters:
      predicate - the predicate to determine which key/value pairs in this map should be included in the returned map
      Returns:
      a copy of this map with the matching key/value pairs

    • reject

      MutableFloatBooleanMap reject​(FloatBooleanPredicate predicate)
      Description copied from interface: FloatBooleanMap
      Return a copy of this map containing only the key/value pairs that do not match the predicate.
      Specified by:
      reject in interface FloatBooleanMap
      Parameters:
      predicate - the predicate to determine which key/value pairs in this map should be excluded from the returned map
      Returns:
      a copy of this map without the matching key/value pairs

    • withKeyValue

      MutableFloatBooleanMap withKeyValue​(float key, boolean value)
      Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with value.
      Parameters:
      key - the key
      value - the value to associate with value
      Returns:
      this map
      See Also:
      put(float, boolean)

    • withoutKey

      MutableFloatBooleanMap withoutKey​(float key)
      Removes the mapping associated with the key, if one exists, from this map.
      Parameters:
      key - the key to remove
      Returns:
      this map
      See Also:
      remove(float)

    • withoutAllKeys

      MutableFloatBooleanMap withoutAllKeys​(FloatIterable keys)
      Removes the mappings associated with all the keys, if they exist, from this map.
      Parameters:
      keys - the keys to remove
      Returns:
      this map
      See Also:
      remove(float)

    • withAllKeyValues

      default MutableFloatBooleanMap withAllKeyValues​(Iterable<FloatBooleanPair> keyValuePairs)
      Puts all of the key/value mappings from the specified pairs into this map. If this map already has a value associated with one of the keys in the pairs, it will be replaced with the value in the pair.
      Parameters:
      iterable - the pairs to put into this map
      Returns:
      this map
      See Also:
      putPair(FloatBooleanPair)

    • asUnmodifiable

      MutableFloatBooleanMap asUnmodifiable()
      Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an UnsupportedOperationException for all mutating operations. This avoids the overhead of copying the map when calling FloatBooleanMap.toImmutable() while still providing immutability.
      Returns:
      an unmodifiable view of this map

    • asSynchronized

      MutableFloatBooleanMap asSynchronized()
      Returns a synchronized view of this map, delegating all operations to this map but ensuring only one caller has access to the map at a time.
      Returns:
      a synchronized view of this map