MutableObjectCharMap (Eclipse Collections API

All Superinterfaces:

CharIterable, ObjectCharMap<K>, PrimitiveIterable
```
public interface MutableObjectCharMap<K>
extends ObjectCharMap<K>
```
This file was automatically generated from template file mutableObjectPrimitiveMap.stg.

Since:

3.0.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`char`	`addToValue(K key, char toBeAdded)`
`MutableObjectCharMap<K>`	`asSynchronized()`
`MutableObjectCharMap<K>`	`asUnmodifiable()`
`MutableCharIterator`	`charIterator()` Returns a primitive iterator that can be used to iterate over the CharIterable in an imperative style.
`void`	`clear()` Removes all entries from this map.
`<V> MutableCollection<V>`	`collect(CharToObjectFunction<? extends V> function)` Returns a new collection with the results of applying the specified function on each element of the source collection.
`MutableCharObjectMap<K>`	`flipUniqueValues()` Return the CharObjectMap that is obtained by flipping the direction of this map and making the associations from value to key.
`char`	`getIfAbsentPut(K key, char value)` Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.
`char`	`getIfAbsentPut(K key, CharFunction0 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> char`	`getIfAbsentPutWith(K key, CharFunction<? 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.
`char`	`getIfAbsentPutWithKey(K key, CharFunction<? 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, char value)` Associates a value with the specified key.
`void`	`putAll(ObjectCharMap<? extends K> map)` Puts all of the key/value mappings from the specified map into this map.
`default void`	`putPair(ObjectCharPair<K> keyValuePair)` This method allows MutableObjectCharMap the ability to add an element in the form of `ObjectCharPair<K>`.
`MutableCharCollection`	`reject(CharPredicate predicate)` Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.
`MutableObjectCharMap<K>`	`reject(ObjectCharPredicate<? 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.
`char`	`removeKeyIfAbsent(K key, char value)` Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.
`MutableCharCollection`	`select(CharPredicate predicate)` Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.
`MutableObjectCharMap<K>`	`select(ObjectCharPredicate<? super K> predicate)` Return a copy of this map containing only the key/value pairs that match the predicate.
`default MutableObjectCharMap<K>`	`tap(CharProcedure procedure)`
`char`	`updateValue(K key, char initialValueIfAbsent, CharToCharFunction 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(ObjectCharToCharFunction<? super K> function)` Updates the values in-place.
`default MutableObjectCharMap<K>`	`withAllKeyValues(Iterable<ObjectCharPair<K>> keyValuePairs)`
`MutableObjectCharMap<K>`	`withKeyValue(K key, char value)` Associates a value with the specified key.
`MutableObjectCharMap<K>`	`withoutAllKeys(Iterable<? extends K> keys)` Removes the mappings associated with all the keys, if they exist, from this map.
`MutableObjectCharMap<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.map.primitive.ObjectCharMap
containsKey, containsValue, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getOrThrow, keySet, keysView, keyValuesView, toImmutable, toString, values

Methods inherited from interface org.eclipse.collections.api.CharIterable
allSatisfy, anySatisfy, asLazy, average, averageIfEmpty, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, contains, containsAll, containsAll, count, detectIfNone, each, flatCollect, forEach, injectInto, max, maxIfEmpty, median, medianIfEmpty, min, minIfEmpty, noneSatisfy, reduce, reduceIfEmpty, reject, select, sum, summaryStatistics, toArray, toArray, toBag, toList, toSet, toSortedArray, toSortedList

Methods inherited from interface org.eclipse.collections.api.PrimitiveIterable
appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size

- Method Detail
  - charIterator
```
MutableCharIterator charIterator()
```
    Description copied from interface: CharIterable
    
    Returns a primitive iterator that can be used to iterate over the CharIterable in an imperative style.
    
    Specified by:
    
    charIterator in interface CharIterable
  - clear
```
void clear()
```
    Removes all entries from this map.
  - put
```
void put(K key,
         char 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(ObjectCharPair<K> keyValuePair)
```
    This method allows MutableObjectCharMap the ability to add an element in the form of ObjectCharPair<K>.
    
    Since:
    
    9.1.0
    
    See Also:
    
    put(Object, char)
  - putAll
```
void putAll(ObjectCharMap<? 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(ObjectCharToCharFunction<? 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(Object)
  - 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:
    
    #removeKey(K)
  - removeKeyIfAbsent
```
char removeKeyIfAbsent(K key,
                       char 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
```
char getIfAbsentPut(K key,
                    char 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
  - getIfAbsentPut
```
char getIfAbsentPut(K key,
                    CharFunction0 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
```
char getIfAbsentPutWithKey(K key,
                           CharFunction<? 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> char getIfAbsentPutWith(K key,
                            CharFunction<? 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
```
char updateValue(K key,
                 char initialValueIfAbsent,
                 CharToCharFunction 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
  - flipUniqueValues
```
MutableCharObjectMap<K> flipUniqueValues()
```
    Description copied from interface: ObjectCharMap
    
    Return the CharObjectMap that is obtained by flipping the direction of this map and making the associations from value to key.
    
    Specified by:
    
    flipUniqueValues in interface ObjectCharMap<K>
  - select
```
MutableObjectCharMap<K> select(ObjectCharPredicate<? super K> predicate)
```
    Description copied from interface: ObjectCharMap
    
    Return a copy of this map containing only the key/value pairs that match the predicate.
    
    Specified by:
    
    select in interface ObjectCharMap<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
```
MutableObjectCharMap<K> reject(ObjectCharPredicate<? super K> predicate)
```
    Description copied from interface: ObjectCharMap
    
    Return a copy of this map containing only the key/value pairs that do not match the predicate.
    
    Specified by:
    
    reject in interface ObjectCharMap<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
```
MutableCharCollection select(CharPredicate predicate)
```
    Description copied from interface: CharIterable
    
    Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.
    
    Specified by:
    
    select in interface CharIterable
  - reject
```
MutableCharCollection reject(CharPredicate predicate)
```
    Description copied from interface: CharIterable
    
    Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.
    
    Specified by:
    
    reject in interface CharIterable
  - tap
```
default MutableObjectCharMap<K> tap(CharProcedure procedure)
```
    Specified by:
    
    tap in interface CharIterable
    
    Specified by:
    
    tap in interface ObjectCharMap<K>
    
    Since:
    
    9.0.
  - collect
```
<V> MutableCollection<V> collect(CharToObjectFunction<? extends V> function)
```
    Description copied from interface: CharIterable
    
    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 CharIterable
  - withKeyValue
```
MutableObjectCharMap<K> withKeyValue(K key,
                                     char 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(K, char)
  - withoutKey
```
MutableObjectCharMap<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:
    
    remove(Object)
  - withoutAllKeys
```
MutableObjectCharMap<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:
    
    remove(Object)
  - withAllKeyValues
```
default MutableObjectCharMap<K> withAllKeyValues(Iterable<ObjectCharPair<K>> keyValuePairs)
```
  - asUnmodifiable
```
MutableObjectCharMap<K> asUnmodifiable()
```
  - asSynchronized
```
MutableObjectCharMap<K> asSynchronized()
```
  - addToValue
```
char addToValue(K key,
                char toBeAdded)
```

Interface MutableObjectCharMap<K>

Method Summary

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

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

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

Method Detail

charIterator

clear

put

putPair

putAll

updateValues

removeKey

remove

removeKeyIfAbsent

getIfAbsentPut

getIfAbsentPut

getIfAbsentPutWithKey

getIfAbsentPutWith

updateValue

flipUniqueValues

select

reject

select

reject

tap

collect

withKeyValue

withoutKey

withoutAllKeys

withAllKeyValues

asUnmodifiable

asSynchronized

addToValue