Eclipse Collections 13.0.0 · org.eclipse.collections.api.map.primitive.MutableObjectBooleanMap

Method Summary

Modifier and Type	Method and Description
public MutableObjectBooleanMap<K>	asSynchronized()
public MutableObjectBooleanMap<K>	asUnmodifiable()
public MutableBooleanIterator	booleanIterator() Redeclares org.eclipse.collections.api.BooleanIterable.booleanIterator. Returns a primitive iterator that can be used to iterate over the BooleanIterable in an imperative style.
public void	clear() Removes all entries from this map.
public <V> MutableCollection<V>	collect(BooleanToObjectFunction<? extends V> function) Redeclares org.eclipse.collections.api.BooleanIterable.collect. Returns a new collection with the results of applying the specified function on each element of the source collection.
public default boolean	Returns: the value associated with key, if one exists, or `defaultValue` if not getAndPut(K the key key, boolean the value to associate with `key` if no such mapping exists putValue, boolean the value to return if no mapping associated with `key` exists defaultValue) Retrieves the value associated with the key if one exists; if it does not, associates a putValue with the key.
public boolean	Returns: the value associated with key, if one exists, or `value` if not getIfAbsentPut(K the key key, boolean the value to associate with `key` if no such mapping exists value) Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.
public boolean	Returns: the value associated with the key, if one exists, or the result of invoking `function` if not getIfAbsentPut(K the key key, BooleanFunction0 the supplier that provides the value if no mapping exists for `key` 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.
public < the type of the value function's `parameter` P> boolean	Returns: the value associated with the key, if one exists, or the result of invoking `function` with `parameter` if not getIfAbsentPutWith(K the key key, BooleanFunction<? super P> the function that provides the value if no mapping exists. The specified `parameter` will be passed as the argument to the function. function, P the parameter to provide to `function` if no value exists for `key` 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.
public boolean	Returns: the value associated with the key, if one exists, or the result of invoking `function` with `key` if not getIfAbsentPutWithKey(K the key key, BooleanFunction<? super K> the function that provides the value if no mapping exists. The `key` will be passed as the argument to the function. 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.
public void	put(K the key key, boolean the value to associate with `value` value) Associates a value with the specified key.
public void	putAll(ObjectBooleanMap<? extends K> the map to copy into this map map) Puts all of the key/value mappings from the specified map into this map.
public default void	putPair(ObjectBooleanPair<K> keyValuePair) This method allows MutableObjectBooleanMap the ability to add an element in the form of `ObjectBooleanPair<K>`.
public MutableObjectBooleanMap<K>	reject(ObjectBooleanPredicate<? super K> predicate) Redeclares org.eclipse.collections.api.map.primitive.ObjectBooleanMap.reject. Return a copy of this map containing only the key/value pairs that do not match the predicate.
public MutableBooleanCollection	reject(BooleanPredicate predicate) Redeclares org.eclipse.collections.api.BooleanIterable.reject. Returns a new BooleanIterable with all of the elements in the BooleanIterable that return false for the specified predicate.
public void	remove(Object the key to remove key) Removes the mapping associated with the key, if one exists, from the map.
public void	removeKey(K the key to remove key) Removes the mapping associated with the key, if one exists, from the map.
public boolean	Returns: the value previously associated with the key, if one existed, or `value` if not removeKeyIfAbsent(K the key to remove key, boolean the default value to return if no mapping for the key exists value) Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.
public MutableObjectBooleanMap<K>	select(ObjectBooleanPredicate<? super K> predicate) Redeclares org.eclipse.collections.api.map.primitive.ObjectBooleanMap.select. Return a copy of this map containing only the key/value pairs that match the predicate.
public MutableBooleanCollection	select(BooleanPredicate predicate) Redeclares org.eclipse.collections.api.BooleanIterable.select. Returns a new BooleanIterable with all of the elements in the BooleanIterable that return true for the specified predicate.
public default MutableObjectBooleanMap<K>	tap(BooleanProcedure procedure) Overrides default org.eclipse.collections.api.map.primitive.ObjectBooleanMap.tap.
public boolean	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` updateValue(K the key key, boolean the initial value to supply to the function if no mapping exists for the key initialValueIfAbsent, BooleanToBooleanFunction the function that returns the updated value based on the current value or the initial value, if no value exists 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.
public void	updateValues(ObjectBooleanToBooleanFunction<? super K> that takes a key and its value and that returns a new value for this key function) Updates the values in-place.
public default MutableObjectBooleanMap<K>	withAllKeyValues(Iterable<ObjectBooleanPair<K>> keyValuePairs)
public MutableObjectBooleanMap<K>	Returns: this map withKeyValue(K the key key, boolean the value to associate with `value` value) Associates a value with the specified key.
public MutableObjectBooleanMap<K>	Returns: this map withoutAllKeys(Iterable<? extends K> the keys to remove keys) Removes the mappings associated with all the keys, if they exist, from this map.
public MutableObjectBooleanMap<K>	Returns: this map withoutKey(K the key to remove key) Removes the mapping associated with the key, if one exists, from this map.

Inherited from org.eclipse.collections.api.map.primitive.ObjectBooleanMap:: allSatisfyKeyValue containsKey containsValue forEachKey forEachKeyValue forEachValue get getIfAbsent getOrThrow injectIntoKeyValue keySet keysView keyValuesView toImmutable toString values

Method Detail

asSynchronized	back to summary
public MutableObjectBooleanMap<K> asSynchronized()

asUnmodifiable	back to summary
public MutableObjectBooleanMap<K> asUnmodifiable()

booleanIterator	back to summary
public MutableBooleanIterator booleanIterator() Redeclares org.eclipse.collections.api.BooleanIterable.booleanIterator. Doc from org.eclipse.collections.api.BooleanIterable.booleanIterator. Returns a primitive iterator that can be used to iterate over the BooleanIterable in an imperative style. Annotations @Override

booleanIterator

back to summary

public MutableBooleanIterator booleanIterator()

Redeclares org.eclipse.collections.api.BooleanIterable.booleanIterator.

Doc from org.eclipse.collections.api.BooleanIterable.booleanIterator.

Returns a primitive iterator that can be used to iterate over the BooleanIterable in an imperative style.

Annotations

@Override

clear	back to summary
public void clear() Removes all entries from this map.

collect	back to summary
public <V> MutableCollection<V> collect(BooleanToObjectFunction<? extends V> function) Redeclares org.eclipse.collections.api.BooleanIterable.collect. Doc from org.eclipse.collections.api.BooleanIterable.collect. 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. Annotations @Override

collect

back to summary

public <V> MutableCollection<V> collect(BooleanToObjectFunction<? extends V> function)

Redeclares org.eclipse.collections.api.BooleanIterable.collect.

Doc from org.eclipse.collections.api.BooleanIterable.collect.

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.

Annotations

@Override

getAndPut back to summary

getAndPut	back to summary
public 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:K the key putValue:boolean the value to associate with `key` if no such mapping exists defaultValue:boolean the value to return if no mapping associated with `key` exists Returns:boolean the value associated with key, if one exists, or `defaultValue` if not Since 11.1.

public 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:K: the key
putValue:boolean: the value to associate with key if no such mapping exists
defaultValue:boolean: the value to return if no mapping associated with key exists

Returns:boolean

the value associated with key, if one exists, or defaultValue if not

Since

11.1.

getIfAbsentPut back to summary

getIfAbsentPut	back to summary
public 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:K the key value:boolean the value to associate with `key` if no such mapping exists Returns:boolean the value associated with key, if one exists, or `value` if not

public 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:K: the key
value:boolean: the value to associate with key if no such mapping exists

Returns:boolean

the value associated with key, if one exists, or value if not

getIfAbsentPut back to summary

getIfAbsentPut	back to summary
public 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:K the key function:BooleanFunction0 the supplier that provides the value if no mapping exists for `key` Returns:boolean the value associated with the key, if one exists, or the result of invoking `function` if not

public 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:K: the key
function:BooleanFunction0: the supplier that provides the value if no mapping exists for key

Returns:boolean

the value associated with the key, if one exists, or the result of invoking function if not

getIfAbsentPutWith back to summary

getIfAbsentPutWith	back to summary
public <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. Parameters <P> the type of the value function's `parameter` key:K the key function:BooleanFunction<? super P> the function that provides the value if no mapping exists. The specified `parameter` will be passed as the argument to the function. parameter:P the parameter to provide to `function` if no value exists for `key` Returns:boolean the value associated with the key, if one exists, or the result of invoking `function` with `parameter` if not

public <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.

Parameters

<P>: the type of the value function's parameter
key:K: the key
function:BooleanFunction<? super P>: the function that provides the value if no mapping exists. The specified parameter will be passed as the argument to the function.
parameter:P: the parameter to provide to function if no value exists for key

Returns:boolean

the value associated with the key, if one exists, or the result of invoking function with parameter if not

getIfAbsentPutWithKey back to summary

getIfAbsentPutWithKey	back to summary
public 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:K the key function:BooleanFunction<? super K> the function that provides the value if no mapping exists. The `key` will be passed as the argument to the function. Returns:boolean the value associated with the key, if one exists, or the result of invoking `function` with `key` if not

public 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:K: the key
function:BooleanFunction<? super K>: the function that provides the value if no mapping exists. The key will be passed as the argument to the function.

Returns:boolean

the value associated with the key, if one exists, or the result of invoking function with key if not

put back to summary

put	back to summary
public 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:K the key value:boolean the value to associate with `value`

public 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:K: the key
value:boolean: the value to associate with value

putAll back to summary

putAll	back to summary
public 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:ObjectBooleanMap<? extends K> the map to copy into this map

public 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:ObjectBooleanMap<? extends K>: the map to copy into this map

putPair back to summary

putPair	back to summary
public 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 `put(Object, boolean)`

public 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: put(Object, boolean)

reject	back to summary
public MutableObjectBooleanMap<K> reject(ObjectBooleanPredicate<? super K> predicate) Redeclares org.eclipse.collections.api.map.primitive.ObjectBooleanMap.reject. Doc from org.eclipse.collections.api.map.primitive.ObjectBooleanMap.reject. Return a copy of this map containing only the key/value pairs that do not match the predicate. Annotations @Override

reject

back to summary

public MutableObjectBooleanMap<K> reject(ObjectBooleanPredicate<? super K> predicate)

Redeclares org.eclipse.collections.api.map.primitive.ObjectBooleanMap.reject.

Doc from org.eclipse.collections.api.map.primitive.ObjectBooleanMap.reject.

Return a copy of this map containing only the key/value pairs that do not match the predicate.

Annotations

@Override

reject	back to summary
public MutableBooleanCollection reject(BooleanPredicate predicate) Redeclares org.eclipse.collections.api.BooleanIterable.reject. Doc from org.eclipse.collections.api.BooleanIterable.reject. Returns a new BooleanIterable with all of the elements in the BooleanIterable that return false for the specified predicate. Annotations @Override

reject

back to summary

public MutableBooleanCollection reject(BooleanPredicate predicate)

Redeclares org.eclipse.collections.api.BooleanIterable.reject.

Doc from org.eclipse.collections.api.BooleanIterable.reject.

Returns a new BooleanIterable with all of the elements in the BooleanIterable that return false for the specified predicate.

Annotations

@Override

remove back to summary

remove	back to summary
public void remove(Object key) Removes the mapping associated with the key, if one exists, from the map. Parameters key:Object the key to remove See Also `removeKey(K)`

public void remove(Object key)

Removes the mapping associated with the key, if one exists, from the map.

Parameters

key:Object: the key to remove

See Also

removeKey(K)

removeKey back to summary

removeKey	back to summary
public void removeKey(K key) Removes the mapping associated with the key, if one exists, from the map. Parameters key:K the key to remove See Also `remove(Object)`

public void removeKey(K key)

Removes the mapping associated with the key, if one exists, from the map.

Parameters

key:K: the key to remove

See Also

remove(Object)

removeKeyIfAbsent back to summary

removeKeyIfAbsent	back to summary
public 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:K the key to remove value:boolean the default value to return if no mapping for the key exists Returns:boolean the value previously associated with the key, if one existed, or `value` if not

public 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:K: the key to remove
value:boolean: the default value to return if no mapping for the key exists

Returns:boolean

the value previously associated with the key, if one existed, or value if not

select	back to summary
public MutableObjectBooleanMap<K> select(ObjectBooleanPredicate<? super K> predicate) Redeclares org.eclipse.collections.api.map.primitive.ObjectBooleanMap.select. Doc from org.eclipse.collections.api.map.primitive.ObjectBooleanMap.select. Return a copy of this map containing only the key/value pairs that match the predicate. Annotations @Override

select

back to summary

public MutableObjectBooleanMap<K> select(ObjectBooleanPredicate<? super K> predicate)

Redeclares org.eclipse.collections.api.map.primitive.ObjectBooleanMap.select.

Doc from org.eclipse.collections.api.map.primitive.ObjectBooleanMap.select.

Return a copy of this map containing only the key/value pairs that match the predicate.

Annotations

@Override

select	back to summary
public MutableBooleanCollection select(BooleanPredicate predicate) Redeclares org.eclipse.collections.api.BooleanIterable.select. Doc from org.eclipse.collections.api.BooleanIterable.select. Returns a new BooleanIterable with all of the elements in the BooleanIterable that return true for the specified predicate. Annotations @Override

select

back to summary

public MutableBooleanCollection select(BooleanPredicate predicate)

Redeclares org.eclipse.collections.api.BooleanIterable.select.

Doc from org.eclipse.collections.api.BooleanIterable.select.

Returns a new BooleanIterable with all of the elements in the BooleanIterable that return true for the specified predicate.

Annotations

@Override

tap	back to summary
public default MutableObjectBooleanMap<K> tap(BooleanProcedure procedure) Overrides default org.eclipse.collections.api.map.primitive.ObjectBooleanMap.tap. Annotations @Override Since 9.0.

tap

back to summary

public default MutableObjectBooleanMap<K> tap(BooleanProcedure procedure)

Overrides default org.eclipse.collections.api.map.primitive.ObjectBooleanMap.tap.

Annotations

@Override

Since

9.0.

updateValue back to summary

updateValue	back to summary
public 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:K the key initialValueIfAbsent:boolean the initial value to supply to the function if no mapping exists for the key function:BooleanToBooleanFunction the function that returns the updated value based on the current value or the initial value, if no value exists Returns:boolean 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`

public 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:K: the key
initialValueIfAbsent:boolean: the initial value to supply to the function if no mapping exists for the key
function:BooleanToBooleanFunction: the function that returns the updated value based on the current value or the initial value, if no value exists

Returns:boolean

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

updateValues	back to summary
public void updateValues(ObjectBooleanToBooleanFunction<? super K> function) Updates the values in-place. Parameters function:ObjectBooleanToBooleanFunction<? super K> that takes a key and its value and that returns a new value for this key Since 10.0

updateValues

back to summary

public void updateValues(ObjectBooleanToBooleanFunction<? super K> function)

Updates the values in-place.

Parameters

function:ObjectBooleanToBooleanFunction<? super K>: that takes a key and its value and that returns a new value for this key

Since

10.0

withAllKeyValues	back to summary
public default MutableObjectBooleanMap<K> withAllKeyValues(Iterable<ObjectBooleanPair<K>> keyValuePairs)

withKeyValue back to summary

withKeyValue	back to summary
public 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:K the key value:boolean the value to associate with `value` Returns:MutableObjectBooleanMap<K> this map See Also `put(K, boolean)`

public 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:K: the key
value:boolean: the value to associate with value

Returns:MutableObjectBooleanMap<K>

this map

See Also

put(K, boolean)

withoutAllKeys back to summary

withoutAllKeys	back to summary
public MutableObjectBooleanMap<K> withoutAllKeys(Iterable<? extends K> keys) Removes the mappings associated with all the keys, if they exist, from this map. Parameters keys:Iterable<? extends K> the keys to remove Returns:MutableObjectBooleanMap<K> this map See Also `remove(Object)`

public MutableObjectBooleanMap<K> withoutAllKeys(Iterable<? extends K> keys)

Removes the mappings associated with all the keys, if they exist, from this map.

Parameters

keys:Iterable<? extends K>: the keys to remove

Returns:MutableObjectBooleanMap<K>

this map

See Also

remove(Object)

withoutKey back to summary

withoutKey	back to summary
public MutableObjectBooleanMap<K> withoutKey(K key) Removes the mapping associated with the key, if one exists, from this map. Parameters key:K the key to remove Returns:MutableObjectBooleanMap<K> this map See Also `remove(Object)`

public MutableObjectBooleanMap<K> withoutKey(K key)

Removes the mapping associated with the key, if one exists, from this map.

Parameters

key:K: the key to remove

Returns:MutableObjectBooleanMap<K>

this map

See Also

remove(Object)

public Interface MutableObjectBooleanMap<K>

Method Summary

Method Detail