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

Method Summary

Modifier and Type	Method and Description
public MutableCharObjectMap<V>	Returns: a synchronized view of this map 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.
public MutableCharObjectMap<V>	Returns: an unmodifiable view of this map asUnmodifiable() Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an `UnsupportedOperationException` for all mutating operations.
public MutableObjectCharMap<V>	flipUniqueValues() Redeclares org.eclipse.collections.api.map.primitive.CharObjectMap.flipUniqueValues. Return the ObjectCharMap that is obtained by flipping the direction of this map and making the associations from value to key.
public V	Returns: the value associated with key, if one exists, or `value` if not getIfAbsentPut(char the key key, V 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 V	Returns: the value associated with the key, if one exists, or the result of invoking `function` if not getIfAbsentPut(char the key key, Function0<? extends V> 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> V	Returns: the value associated with the key, if one exists, or the result of invoking `function` with `parameter` if not getIfAbsentPutWith(char the key key, Function<? super P, ? extends V> 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 V	Returns: the value associated with the key, if one exists, or the result of invoking `function` with `key` if not getIfAbsentPutWithKey(char the key key, CharToObjectFunction<? extends V> 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 V	Returns: the value previously associated with `key` if one existed, or `null` if not put(char the key key, V the value to associate with `value` value) Associates a value with the specified key.
public void	putAll(CharObjectMap<? extends V> the map to copy into this map map) Puts all of the key/value mappings from the specified map into this map.
public default V	putPair(CharObjectPair<V> keyValuePair) This method allows MutableCharObjectMap the ability to add an element in the form of `CharObjectPair<V>`.
public MutableCharObjectMap<V>	reject(CharObjectPredicate<? super V> predicate) Redeclares org.eclipse.collections.api.map.primitive.CharObjectMap.reject. Return a copy of this map containing only the key/value pairs that do not match the predicate.
public V	remove(char the key to remove key) Removes the mapping associated with the key, if one exists, from the map.
public boolean	Returns: true if any entry is removed. removeIf(CharObjectPredicate<? super V> should return true if the key/value pair should be removed. predicate) Remove an entry from the map if the `predicate` evaluates to true.
public V	removeKey(char the key to remove key) Removes the mapping associated with the key, if one exists, from the map.
public MutableCharObjectMap<V>	select(CharObjectPredicate<? super V> predicate) Redeclares org.eclipse.collections.api.map.primitive.CharObjectMap.select. Return a copy of this map containing only the key/value pairs that match the predicate.
public MutableCharObjectMap<V>	tap(Procedure<? super V> procedure) Redeclares org.eclipse.collections.api.map.primitive.CharObjectMap.tap, org.eclipse.collections.api.RichIterable.tap. Executes the Procedure for each element in the iterable and returns `this`.
public V	updateValue(char key, Function0<? extends V> factory, Function<? super V, ? extends V> function) Look up the value associated with `key`, apply the `function` to it, and replace the value.
public < the type of the value function's `parameter` P> V	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 the value returned by `factory` and associating the result with `key` updateValueWith(char the key key, Function0<? extends V> the supplier providing the initial value to the function if no mapping exists for the key factory, Function2<? super V, ? super P, ? extends V> the function that returns the updated value based on the current value or the initial value, if no value exists. The specified `parameter` will also be passed as the second argument to the function. function, P the parameter to provide to `function` if no value exists for `key` parameter) Updates or sets the value associated with the key by applying the function to the existing value, if one exists, or the initial value supplied by the factory if one does not.
public default MutableCharObjectMap<V>	Returns: this map withAllKeyValues(Iterable<CharObjectPair<V>> the pairs to put into this map keyValuePairs) Puts all of the key/value mappings from the specified pairs into this map.
public MutableCharObjectMap<V>	Returns: this map withKeyValue(char the key key, V the value to associate with `value` value) Associates a value with the specified key.
public MutableCharObjectMap<V>	Returns: this map withoutAllKeys(CharIterable the keys to remove keys) Removes the mappings associated with all the keys, if they exist, from this map.
public MutableCharObjectMap<V>	Returns: this map withoutKey(char the key to remove key) Removes the mapping associated with the key, if one exists, from this map.

Method Detail

asSynchronized	back to summary
public MutableCharObjectMap<V> 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:MutableCharObjectMap<V> a synchronized view of this map

asSynchronized

back to summary

public MutableCharObjectMap<V> 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:MutableCharObjectMap<V>: a synchronized view of this map

asUnmodifiable back to summary

asUnmodifiable	back to summary
public MutableCharObjectMap<V> 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 `toImmutable()` while still providing immutability. Returns:MutableCharObjectMap<V> an unmodifiable view of this map

public MutableCharObjectMap<V> 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 toImmutable() while still providing immutability.

Returns:MutableCharObjectMap<V>: an unmodifiable view of this map

flipUniqueValues	back to summary
public MutableObjectCharMap<V> flipUniqueValues() Redeclares org.eclipse.collections.api.map.primitive.CharObjectMap.flipUniqueValues. Doc from org.eclipse.collections.api.map.primitive.CharObjectMap.flipUniqueValues. Return the ObjectCharMap that is obtained by flipping the direction of this map and making the associations from value to key. Annotations @Override

flipUniqueValues

back to summary

public MutableObjectCharMap<V> flipUniqueValues()

Redeclares org.eclipse.collections.api.map.primitive.CharObjectMap.flipUniqueValues.

Doc from org.eclipse.collections.api.map.primitive.CharObjectMap.flipUniqueValues.

Return the ObjectCharMap that is obtained by flipping the direction of this map and making the associations from value to key.

Annotations

@Override

getIfAbsentPut back to summary

getIfAbsentPut	back to summary
public V getIfAbsentPut(char key, V value) Retrieves the value associated with the key if one exists; if it does not, associates a value with the key. Parameters key:char the key value:V the value to associate with `key` if no such mapping exists Returns:V the value associated with key, if one exists, or `value` if not

public V getIfAbsentPut(char key, V value)

Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.

Parameters

key:char: the key
value:V: the value to associate with key if no such mapping exists

Returns:V

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

getIfAbsentPut back to summary

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

public V getIfAbsentPut(char key, Function0<? extends V> 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:char: the key
function:Function0<? extends V>: the supplier that provides the value if no mapping exists for key

Returns:V

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> V getIfAbsentPutWith(char key, Function<? super P, ? extends V> 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:char the key function:Function<? super P, ? extends V> 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:V the value associated with the key, if one exists, or the result of invoking `function` with `parameter` if not

public <P> V getIfAbsentPutWith(char key, Function<? super P, ? extends V> 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:char: the key
function:Function<? super P, ? extends V>: 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:V

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 V getIfAbsentPutWithKey(char key, CharToObjectFunction<? extends V> 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:char the key function:CharToObjectFunction<? extends V> the function that provides the value if no mapping exists. The `key` will be passed as the argument to the function. Returns:V the value associated with the key, if one exists, or the result of invoking `function` with `key` if not

public V getIfAbsentPutWithKey(char key, CharToObjectFunction<? extends V> 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:char: the key
function:CharToObjectFunction<? extends V>: the function that provides the value if no mapping exists. The key will be passed as the argument to the function.

Returns:V

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 V put(char key, V 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:char the key value:V the value to associate with `value` Returns:V the value previously associated with `key` if one existed, or `null` if not

public V put(char key, V 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:char: the key
value:V: the value to associate with value

Returns:V

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

putAll back to summary

putAll	back to summary
public void putAll(CharObjectMap<? extends V> 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:CharObjectMap<? extends V> the map to copy into this map Since 5.0.

public void putAll(CharObjectMap<? extends V> 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:CharObjectMap<? extends V>: the map to copy into this map

Since

5.0.

putPair back to summary

putPair	back to summary
public default V putPair(CharObjectPair<V> keyValuePair) This method allows MutableCharObjectMap the ability to add an element in the form of `CharObjectPair<V>`. Since 9.1.0 See Also `put(char, Object)`

public default V putPair(CharObjectPair<V> keyValuePair)

This method allows MutableCharObjectMap the ability to add an element in the form of CharObjectPair<V>.

Since: 9.1.0
See Also: put(char, Object)

reject	back to summary
public MutableCharObjectMap<V> reject(CharObjectPredicate<? super V> predicate) Redeclares org.eclipse.collections.api.map.primitive.CharObjectMap.reject. Doc from org.eclipse.collections.api.map.primitive.CharObjectMap.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 MutableCharObjectMap<V> reject(CharObjectPredicate<? super V> predicate)

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

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

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

Annotations

@Override

remove back to summary

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

public V remove(char key)

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

Parameters

key:char: the key to remove

See Also

removeKey(char)

removeIf back to summary

removeIf	back to summary
public boolean removeIf(CharObjectPredicate<? super V> predicate) Remove an entry from the map if the `predicate` evaluates to true. Parameters predicate:CharObjectPredicate<? super V> should return true if the key/value pair should be removed. Returns:boolean true if any entry is removed. Since 12.0

public boolean removeIf(CharObjectPredicate<? super V> predicate)

Remove an entry from the map if the predicate evaluates to true.

Parameters

predicate:CharObjectPredicate<? super V>: should return true if the key/value pair should be removed.

Returns:boolean

true if any entry is removed.

Since

12.0

removeKey back to summary

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

public V removeKey(char key)

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

Parameters

key:char: the key to remove

See Also

remove(char)

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

select

back to summary

public MutableCharObjectMap<V> select(CharObjectPredicate<? super V> predicate)

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

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

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

Annotations

@Override

tap back to summary

tap	back to summary
public MutableCharObjectMap<V> tap(Procedure<? super V> procedure) Redeclares org.eclipse.collections.api.map.primitive.CharObjectMap.tap, org.eclipse.collections.api.RichIterable.tap. Doc from org.eclipse.collections.api.RichIterable.tap. Executes the Procedure for each element in the iterable and returns `this`. Example using a Java 8 lambda expression: RichIterable<Person> tapped = people.tap(person -> LOGGER.info(person.getName())); Annotations @Override

public MutableCharObjectMap<V> tap(Procedure<? super V> procedure)

Redeclares org.eclipse.collections.api.map.primitive.CharObjectMap.tap, org.eclipse.collections.api.RichIterable.tap.

Doc from org.eclipse.collections.api.RichIterable.tap.

Executes the Procedure for each element in the iterable and returns this.

Example using a Java 8 lambda expression:

RichIterable<Person> tapped =
    people.tap(person -> LOGGER.info(person.getName()));

Annotations

@Override

updateValue	back to summary
public V updateValue(char key, Function0<? extends V> factory, Function<? super V, ? extends V> function) Look up the value associated with `key`, apply the `function` to it, and replace the value. If there is no value associated with `key`, start it off with a value supplied by `factory`.

updateValueWith back to summary

updateValueWith	back to summary
public <P> V updateValueWith(char key, Function0<? extends V> factory, Function2<? super V, ? super P, ? extends V> function, P parameter) Updates or sets the value associated with the key by applying the function to the existing value, if one exists, or the initial value supplied by the factory if one does not. Parameters <P> the type of the value function's `parameter` key:char the key factory:Function0<? extends V> the supplier providing the initial value to the function if no mapping exists for the key function:Function2<? super V, ? super P, ? extends V> the function that returns the updated value based on the current value or the initial value, if no value exists. The specified `parameter` will also be passed as the second argument to the function. parameter:P the parameter to provide to `function` if no value exists for `key` Returns:V 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 the value returned by `factory` and associating the result with `key`

public <P> V updateValueWith(char key, Function0<? extends V> factory, Function2<? super V, ? super P, ? extends V> function, P parameter)

Updates or sets the value associated with the key by applying the function to the existing value, if one exists, or the initial value supplied by the factory if one does not.

Parameters

<P>: the type of the value function's parameter
key:char: the key
factory:Function0<? extends V>: the supplier providing the initial value to the function if no mapping exists for the key
function:Function2<? super V, ? super P, ? extends V>: the function that returns the updated value based on the current value or the initial value, if no value exists. The specified parameter will also be passed as the second argument to the function.
parameter:P: the parameter to provide to function if no value exists for key

Returns:V

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 the value returned by factory and associating the result with key

withAllKeyValues back to summary

withAllKeyValues	back to summary
public default MutableCharObjectMap<V> withAllKeyValues(Iterable<CharObjectPair<V>> 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 keyValuePairs:Iterable<CharObjectPair<V>> the pairs to put into this map Returns:MutableCharObjectMap<V> this map See Also `putPair(CharObjectPair)`

public default MutableCharObjectMap<V> withAllKeyValues(Iterable<CharObjectPair<V>> 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

keyValuePairs:Iterable<CharObjectPair<V>>: the pairs to put into this map

Returns:MutableCharObjectMap<V>

this map

See Also

putPair(CharObjectPair)

withKeyValue back to summary

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

public MutableCharObjectMap<V> withKeyValue(char key, V 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:char: the key
value:V: the value to associate with value

Returns:MutableCharObjectMap<V>

this map

See Also

put(char, V)

withoutAllKeys back to summary

withoutAllKeys	back to summary
public MutableCharObjectMap<V> withoutAllKeys(CharIterable keys) Removes the mappings associated with all the keys, if they exist, from this map. Parameters keys:CharIterable the keys to remove Returns:MutableCharObjectMap<V> this map See Also `remove(char)`

public MutableCharObjectMap<V> withoutAllKeys(CharIterable keys)

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

Parameters

keys:CharIterable: the keys to remove

Returns:MutableCharObjectMap<V>

this map

See Also

remove(char)

withoutKey back to summary

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

public MutableCharObjectMap<V> withoutKey(char key)

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

Parameters

key:char: the key to remove

Returns:MutableCharObjectMap<V>

this map

See Also

remove(char)

public Interface MutableCharObjectMap<V>

Method Summary

Method Detail