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 Summary
Modifier and Type Method Description MutableObjectBooleanMap<K>
asSynchronized()
MutableObjectBooleanMap<K>
asUnmodifiable()
MutableBooleanIterator
booleanIterator()
Returns a primitive iterator that can be used to iterate over the BooleanIterable in an imperative style.void
clear()
Removes all entries from this map.<V> MutableCollection<V>
collect(BooleanToObjectFunction<? extends V> function)
Returns a new collection with the results of applying the specified function on each element of the source collection.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.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.<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.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.void
put(K key, boolean value)
Associates a value with the specified key.void
putAll(ObjectBooleanMap<? extends K> map)
Puts all of the key/value mappings from the specified map into this map.default void
putPair(ObjectBooleanPair<K> keyValuePair)
This method allows MutableObjectBooleanMap the ability to add an element in the form ofObjectBooleanPair<K>
.MutableBooleanCollection
reject(BooleanPredicate predicate)
Returns a new BooleanIterable with all of the elements in the BooleanIterable that return false for the specified predicate.MutableObjectBooleanMap<K>
reject(ObjectBooleanPredicate<? super K> predicate)
Return a copy of this map containing only the key/value pairs that do not match the predicate.void
remove(Object key)
Removes the mapping associated with the key, if one exists, from the map.void
removeKey(K key)
Removes the mapping associated with the key, if one exists, from the map.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.MutableBooleanCollection
select(BooleanPredicate predicate)
Returns a new BooleanIterable with all of the elements in the BooleanIterable that return true for the specified predicate.MutableObjectBooleanMap<K>
select(ObjectBooleanPredicate<? super K> predicate)
Return a copy of this map containing only the key/value pairs that match the predicate.default MutableObjectBooleanMap<K>
tap(BooleanProcedure procedure)
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.void
updateValues(ObjectBooleanToBooleanFunction<? super K> function)
Updates the values in-place.default MutableObjectBooleanMap<K>
withAllKeyValues(Iterable<ObjectBooleanPair<K>> keyValuePairs)
MutableObjectBooleanMap<K>
withKeyValue(K key, boolean value)
Associates a value with the specified key.MutableObjectBooleanMap<K>
withoutAllKeys(Iterable<? extends K> keys)
Removes the mappings associated with all the keys, if they exist, from this map.MutableObjectBooleanMap<K>
withoutKey(K key)
Removes the mapping associated with the key, if one exists, from this map.Methods inherited from interface org.eclipse.collections.api.BooleanIterable
allSatisfy, anySatisfy, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, contains, containsAll, containsAll, count, detectIfNone, each, flatCollect, forEach, injectInto, noneSatisfy, reduce, reduceIfEmpty, reject, select, toArray, toArray, toBag, toList, toSet
Methods inherited from interface org.eclipse.collections.api.map.primitive.ObjectBooleanMap
containsKey, containsValue, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getOrThrow, keySet, keysView, keyValuesView, toImmutable, toString, values
Methods inherited from interface org.eclipse.collections.api.PrimitiveIterable
appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size
-
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 interfaceBooleanIterable
-
clear
void clear()Removes all entries from this map. -
put
Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced withvalue
.- Parameters:
key
- the keyvalue
- the value to associate withvalue
-
putPair
This method allows MutableObjectBooleanMap the ability to add an element in the form ofObjectBooleanPair<K>
.- Since:
- 9.1.0
- See Also:
put(Object, boolean)
-
putAll
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 inmap
.- Parameters:
map
- the map to copy into this map
-
updateValues
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
Removes the mapping associated with the key, if one exists, from the map.- Parameters:
key
- the key to remove- See Also:
remove(Object)
-
remove
Removes the mapping associated with the key, if one exists, from the map.- Parameters:
key
- the key to remove- See Also:
#removeKey(K)
-
removeKeyIfAbsent
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 removevalue
- 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
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 keyvalue
- the value to associate withkey
if no such mapping exists- Returns:
- the value associated with key, if one exists, or
value
if not
-
getIfAbsentPut
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 keyfunction
- the supplier that provides the value if no mapping exists forkey
- Returns:
- the value associated with the key, if one exists, or the result of
invoking
function
if not
-
getIfAbsentPutWithKey
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 keyfunction
- the function that provides the value if no mapping exists. Thekey
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
withkey
if not
-
getIfAbsentPutWith
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'sparameter
- Parameters:
key
- the keyfunction
- the function that provides the value if no mapping exists. The specifiedparameter
will be passed as the argument to the function.parameter
- the parameter to provide tofunction
if no value exists forkey
- Returns:
- the value associated with the key, if one exists, or the result of
invoking
function
withparameter
if not
-
updateValue
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 keyinitialValueIfAbsent
- the initial value to supply to the function if no mapping exists for the keyfunction
- 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 toinitialValueIfAbsent
and associating the result withkey
-
select
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 interfaceObjectBooleanMap<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
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 interfaceObjectBooleanMap<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
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 interfaceBooleanIterable
-
reject
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 interfaceBooleanIterable
-
tap
- Specified by:
tap
in interfaceBooleanIterable
- Specified by:
tap
in interfaceObjectBooleanMap<K>
- Since:
- 9.0.
-
collect
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 interfaceBooleanIterable
-
withKeyValue
Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced withvalue
.- Parameters:
key
- the keyvalue
- the value to associate withvalue
- Returns:
- this map
- See Also:
#put(K, boolean)
-
withoutKey
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(Object)
-
withoutAllKeys
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(Object)
-
withAllKeyValues
-
asUnmodifiable
MutableObjectBooleanMap<K> asUnmodifiable() -
asSynchronized
MutableObjectBooleanMap<K> asSynchronized()
-