org.eclipse.collections.api.map.primitive

Interface MutableCharBooleanMap

All Superinterfaces:

BooleanIterable, BooleanValuesMap, CharBooleanMap, MutableBooleanValuesMap, PrimitiveIterable

public interface MutableCharBooleanMap
extends CharBooleanMap, MutableBooleanValuesMap

This file was automatically generated from template file mutablePrimitivePrimitiveMap.stg.

Since:

3.0.

Method Summary

Modifier and Type	Method and Description
MutableCharBooleanMap	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.
MutableCharBooleanMap	asUnmodifiable() Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an UnsupportedOperationException for all mutating operations.
boolean	getIfAbsentPut(char 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(char 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(char 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(char key, CharToBooleanFunction 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(char key, boolean value) Associates a value with the specified key.
void	putAll(CharBooleanMap map) Puts all of the key/value mappings from the specified map into this map.
default void	putPair(CharBooleanPair keyValuePair) This method allows MutableCharBooleanMap the ability to add an element in the form of CharBooleanPair.
MutableCharBooleanMap	reject(CharBooleanPredicate predicate) Return a copy of this map containing only the key/value pairs that do not match the predicate.
void	remove(char key) Removes the mapping associated with the key, if one exists, from the map.
void	removeKey(char key) Removes the mapping associated with the key, if one exists, from the map.
boolean	removeKeyIfAbsent(char key, boolean value) Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.
MutableCharBooleanMap	select(CharBooleanPredicate predicate) Return a copy of this map containing only the key/value pairs that match the predicate.
boolean	updateValue(char 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(CharBooleanToBooleanFunction function) Updates the values in-place.
default MutableCharBooleanMap	withAllKeyValues(Iterable<CharBooleanPair> keyValuePairs) Puts all of the key/value mappings from the specified pairs into this map.
MutableCharBooleanMap	withKeyValue(char key, boolean value) Associates a value with the specified key.
MutableCharBooleanMap	withoutAllKeys(CharIterable keys) Removes the mappings associated with all the keys, if they exist, from this map.
MutableCharBooleanMap	withoutKey(char key) Removes the mapping associated with the key, if one exists, from this map.

Methods inherited from interface org.eclipse.collections.api.map.primitive.CharBooleanMap

containsKey, equals, forEachKey, forEachKeyValue, get, getIfAbsent, getOrThrow, hashCode, keySet, keysView, keyValuesView, toImmutable, toString

Methods inherited from interface org.eclipse.collections.api.map.primitive.MutableBooleanValuesMap

booleanIterator, clear, collect, reject, select

Methods inherited from interface org.eclipse.collections.api.map.primitive.BooleanValuesMap

containsValue, forEachValue, tap, values

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, containsAny, containsAny, containsNone, containsNone, count, detectIfNone, each, flatCollect, forEach, injectInto, noneSatisfy, reduce, reduceIfEmpty, reject, select, toArray, toArray, toBag, toList, toSet

Methods inherited from interface org.eclipse.collections.api.PrimitiveIterable

appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size

Method Detail

put

void put(char 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(CharBooleanPair keyValuePair)

This method allows MutableCharBooleanMap the ability to add an element in the form of CharBooleanPair.

Since:

9.1.0

See Also:

put(char, boolean)

putAll

void putAll(CharBooleanMap 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(CharBooleanToBooleanFunction 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(char key)

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

Parameters:

key - the key to remove

See Also:

remove(char)

remove

void remove(char key)

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

Parameters:

key - the key to remove

See Also:

removeKey(char)

removeKeyIfAbsent

boolean removeKeyIfAbsent(char 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(char 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(char 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(char key,
                              CharToBooleanFunction 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(char 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(char 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

MutableCharBooleanMap select(CharBooleanPredicate predicate)

Description copied from interface: CharBooleanMap

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

Specified by:

select in interface CharBooleanMap

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

MutableCharBooleanMap reject(CharBooleanPredicate predicate)

Description copied from interface: CharBooleanMap

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

Specified by:

reject in interface CharBooleanMap

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

MutableCharBooleanMap withKeyValue(char 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(char, boolean)

withoutKey

MutableCharBooleanMap withoutKey(char 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(char)

withoutAllKeys

MutableCharBooleanMap withoutAllKeys(CharIterable 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(char)

withAllKeyValues

default MutableCharBooleanMap withAllKeyValues(Iterable<CharBooleanPair> 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(CharBooleanPair)

asUnmodifiable

MutableCharBooleanMap 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 CharBooleanMap.toImmutable() while still providing immutability.

Returns:

an unmodifiable view of this map

asSynchronized

MutableCharBooleanMap 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