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

Interface MutableObjectBooleanMap<K>

All Superinterfaces:
BooleanIterable, ObjectBooleanMap<K>, PrimitiveIterable
All Known Implementing Classes:
ObjectBooleanHashMap, ObjectBooleanHashMapWithHashingStrategy, SynchronizedObjectBooleanMap, UnmodifiableObjectBooleanMap
public interface MutableObjectBooleanMap<K> extends ObjectBooleanMap<K>
This file was automatically generated from template file mutableObjectPrimitiveMap.stg.
Since:
3.0.

  • Method Details

    • booleanIterator

      MutableBooleanIterator booleanIterator()
      Description copied from interface: BooleanIterable
      Returns a primitive iterator that can be used to iterate over the BooleanIterable in an imperative style.
      Specified by:
      booleanIterator in interface BooleanIterable

    • clear

      void clear()
      Removes all entries from this map.

    • put

      void put(K 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(ObjectBooleanPair<K> keyValuePair)
      This method allows MutableObjectBooleanMap the ability to add an element in the form of ObjectBooleanPair<K>.
      Since:
      9.1.0
      See Also:

    • putAll

      void putAll(ObjectBooleanMap<? extends K> 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(ObjectBooleanToBooleanFunction<? super K> 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(K key)
      Removes the mapping associated with the key, if one exists, from the map.
      Parameters:
      key - the key to remove
      See Also:

    • remove

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

    • removeKeyIfAbsent

      boolean removeKeyIfAbsent(K 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(K key, boolean value)
      Retrieves the value associated with the key if one exists; if it does not, associates a value with the key. a new value with they 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

    • getAndPut

      default boolean getAndPut(K key, boolean putValue, boolean defaultValue)
      Retrieves the value associated with the key if one exists; if it does not, associates a putValue with the key.
      Parameters:
      key - the key
      putValue - the value to associate with key if no such mapping exists
      defaultValue - the value to return if no mapping associated with key exists
      Returns:
      the value associated with key, if one exists, or defaultValue if not
      Since:
      11.1.

    • getIfAbsentPut

      boolean getIfAbsentPut(K 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(K key, BooleanFunction<? super K> 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(K 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(K 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

      MutableObjectBooleanMap<K> select(ObjectBooleanPredicate<? super K> predicate)
      Description copied from interface: ObjectBooleanMap
      Return a copy of this map containing only the key/value pairs that match the predicate.
      Specified by:
      select in interface ObjectBooleanMap<K>
      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

      MutableObjectBooleanMap<K> reject(ObjectBooleanPredicate<? super K> predicate)
      Description copied from interface: ObjectBooleanMap
      Return a copy of this map containing only the key/value pairs that do not match the predicate.
      Specified by:
      reject in interface ObjectBooleanMap<K>
      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

    • select

      MutableBooleanCollection select(BooleanPredicate predicate)
      Description copied from interface: BooleanIterable
      Returns a new BooleanIterable with all of the elements in the BooleanIterable that return true for the specified predicate.
      Specified by:
      select in interface BooleanIterable

    • reject

      MutableBooleanCollection reject(BooleanPredicate predicate)
      Description copied from interface: BooleanIterable
      Returns a new BooleanIterable with all of the elements in the BooleanIterable that return false for the specified predicate.
      Specified by:
      reject in interface BooleanIterable

    • tap

      default MutableObjectBooleanMap<K> tap(BooleanProcedure procedure)
      Specified by:
      tap in interface BooleanIterable
      Specified by:
      tap in interface ObjectBooleanMap<K>
      Since:
      9.0.

    • collect

      <V> MutableCollection<V> collect(BooleanToObjectFunction<? extends V> function)
      Description copied from interface: BooleanIterable
      Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
      Specified by:
      collect in interface BooleanIterable

    • withKeyValue

      MutableObjectBooleanMap<K> withKeyValue(K 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:

    • withoutKey

      MutableObjectBooleanMap<K> withoutKey(K 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:

    • withoutAllKeys

      MutableObjectBooleanMap<K> withoutAllKeys(Iterable<? extends K> 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:

    • withAllKeyValues

      default MutableObjectBooleanMap<K> withAllKeyValues(Iterable<ObjectBooleanPair<K>> keyValuePairs)

    • asUnmodifiable

      MutableObjectBooleanMap<K> asUnmodifiable()

    • asSynchronized

      MutableObjectBooleanMap<K> asSynchronized()