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

Method Summary

Modifier and Type	Method and Description
public short	Returns: the value after incrementing `toBeAdded` to the existing value associated with `key` or `toBeAdded` if one does not addToValue(char the key key, short the amount to increment the existing value, if one exists, or to use as the initial value if one does not toBeAdded) Increments and updates the value associated with the key, if a value exists, or sets the value to be the specified value if one does not.
public MutableCharShortMap	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 MutableCharShortMap	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 MutableShortCharMap	flipUniqueValues() Redeclares org.eclipse.collections.api.map.primitive.CharShortMap.flipUniqueValues. Return the ShortCharMap that is obtained by flipping the direction of this map and making the associations from value to key.
public default short	Returns: the value associated with key, if one exists, or `defaultValue` if not getAndPut(char the key key, short the value to associate with `key` if no such mapping exists putValue, short the value to return if no mapping associated with `key` exists defaultValue) Retrieves the value associated with the key if one exists; associates a putValue with the key.
public short	Returns: the value associated with key, if one exists, or `value` if not getIfAbsentPut(char the key key, short 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 short	Returns: the value associated with the key, if one exists, or the result of invoking `function` if not getIfAbsentPut(char the key key, ShortFunction0 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> short	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, ShortFunction<? 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 short	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, CharToShortFunction 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(char the key key, short the value to associate with `value` value) Associates a value with the specified key.
public void	putAll(CharShortMap 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(CharShortPair keyValuePair) This method allows MutableCharShortMap the ability to add an element in the form of CharShortPair.
public MutableCharShortMap	reject(CharShortPredicate predicate) Redeclares org.eclipse.collections.api.map.primitive.CharShortMap.reject. Return a copy of this map containing only the key/value pairs that do not match the predicate.
public void	remove(char the key to remove key) Removes the mapping associated with the key, if one exists, from the map.
public void	removeKey(char the key to remove key) Removes the mapping associated with the key, if one exists, from the map.
public short	Returns: the value previously associated with the key, if one existed, or `value` if not removeKeyIfAbsent(char the key to remove key, short 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 MutableCharShortMap	select(CharShortPredicate predicate) Redeclares org.eclipse.collections.api.map.primitive.CharShortMap.select. Return a copy of this map containing only the key/value pairs that match the predicate.
public short	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(char the key key, short the initial value to supply to the function if no mapping exists for the key initialValueIfAbsent, ShortToShortFunction 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(CharShortToShortFunction that takes a key and its value and that returns a new value for this key function) Updates the values in-place.
public default MutableCharShortMap	Returns: this map withAllKeyValues(Iterable<CharShortPair> the pairs to put into this map keyValuePairs) Puts all of the key/value mappings from the specified pairs into this map.
public MutableCharShortMap	Returns: this map withKeyValue(char the key key, short the value to associate with `value` value) Associates a value with the specified key.
public MutableCharShortMap	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 MutableCharShortMap	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

addToValue back to summary

addToValue	back to summary
public short addToValue(char key, short toBeAdded) Increments and updates the value associated with the key, if a value exists, or sets the value to be the specified value if one does not. Parameters key:char the key toBeAdded:short the amount to increment the existing value, if one exists, or to use as the initial value if one does not Returns:short the value after incrementing `toBeAdded` to the existing value associated with `key` or `toBeAdded` if one does not

public short addToValue(char key, short toBeAdded)

Increments and updates the value associated with the key, if a value exists, or sets the value to be the specified value if one does not.

Parameters

key:char: the key
toBeAdded:short: the amount to increment the existing value, if one exists, or to use as the initial value if one does not

Returns:short

the value after incrementing toBeAdded to the existing value associated with key or toBeAdded if one does not

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

asSynchronized

back to summary

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

asUnmodifiable back to summary

asUnmodifiable	back to summary
public MutableCharShortMap 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:MutableCharShortMap an unmodifiable view of this map

public MutableCharShortMap 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:MutableCharShortMap: an unmodifiable view of this map

flipUniqueValues	back to summary
public MutableShortCharMap flipUniqueValues() Redeclares org.eclipse.collections.api.map.primitive.CharShortMap.flipUniqueValues. Doc from org.eclipse.collections.api.map.primitive.CharShortMap.flipUniqueValues. Return the ShortCharMap 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 MutableShortCharMap flipUniqueValues()

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

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

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

Annotations

@Override

getAndPut back to summary

getAndPut	back to summary
public default short getAndPut(char key, short putValue, short defaultValue) Retrieves the value associated with the key if one exists; associates a putValue with the key. Parameters key:char the key putValue:short the value to associate with `key` if no such mapping exists defaultValue:short the value to return if no mapping associated with `key` exists Returns:short the value associated with key, if one exists, or `defaultValue` if not Since 11.1.

public default short getAndPut(char key, short putValue, short defaultValue)

Retrieves the value associated with the key if one exists; associates a putValue with the key.

Parameters

key:char: the key
putValue:short: the value to associate with key if no such mapping exists
defaultValue:short: the value to return if no mapping associated with key exists

Returns:short

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

Since

11.1.

getIfAbsentPut back to summary

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

public short getIfAbsentPut(char key, short 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:short: the value to associate with key if no such mapping exists

Returns:short

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

getIfAbsentPut back to summary

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

public short getIfAbsentPut(char key, ShortFunction0 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:ShortFunction0: the supplier that provides the value if no mapping exists for key

Returns:short

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

public <P> short getIfAbsentPutWith(char key, ShortFunction<? 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:char: the key
function:ShortFunction<? 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:short

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

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

Returns:short

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(char key, short 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:short the value to associate with `value`

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

putAll back to summary

putAll	back to summary
public void putAll(CharShortMap 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:CharShortMap the map to copy into this map

public void putAll(CharShortMap 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:CharShortMap: the map to copy into this map

putPair back to summary

putPair	back to summary
public default void putPair(CharShortPair keyValuePair) This method allows MutableCharShortMap the ability to add an element in the form of CharShortPair. Since 9.1.0 See Also `put(char, short)`

public default void putPair(CharShortPair keyValuePair)

This method allows MutableCharShortMap the ability to add an element in the form of CharShortPair.

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

reject	back to summary
public MutableCharShortMap reject(CharShortPredicate predicate) Redeclares org.eclipse.collections.api.map.primitive.CharShortMap.reject. Doc from org.eclipse.collections.api.map.primitive.CharShortMap.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 MutableCharShortMap reject(CharShortPredicate predicate)

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

Doc from org.eclipse.collections.api.map.primitive.CharShortMap.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 void 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 void 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)

removeKey back to summary

removeKey	back to summary
public void 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 void 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)

removeKeyIfAbsent back to summary

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

public short removeKeyIfAbsent(char key, short 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:char: the key to remove
value:short: the default value to return if no mapping for the key exists

Returns:short

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

select	back to summary
public MutableCharShortMap select(CharShortPredicate predicate) Redeclares org.eclipse.collections.api.map.primitive.CharShortMap.select. Doc from org.eclipse.collections.api.map.primitive.CharShortMap.select. Return a copy of this map containing only the key/value pairs that match the predicate. Annotations @Override

select

back to summary

public MutableCharShortMap select(CharShortPredicate predicate)

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

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

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

Annotations

@Override

updateValue back to summary

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

Returns:short

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(CharShortToShortFunction function) Updates the values in-place. Parameters function:CharShortToShortFunction 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(CharShortToShortFunction function)

Updates the values in-place.

Parameters

function:CharShortToShortFunction: that takes a key and its value and that returns a new value for this key

Since

10.0

withAllKeyValues back to summary

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

public default MutableCharShortMap withAllKeyValues(Iterable<CharShortPair> 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<CharShortPair>: the pairs to put into this map

Returns:MutableCharShortMap

this map

See Also

putPair(CharShortPair)

withKeyValue back to summary

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

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

Returns:MutableCharShortMap

this map

See Also

put(char, short)

withoutAllKeys back to summary

withoutAllKeys	back to summary
public MutableCharShortMap 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:MutableCharShortMap this map See Also `remove(char)`

public MutableCharShortMap 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:MutableCharShortMap

this map

See Also

remove(char)

withoutKey back to summary

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

public MutableCharShortMap withoutKey(char key)

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

Parameters

key:char: the key to remove

Returns:MutableCharShortMap

this map

See Also

remove(char)

public Interface MutableCharShortMap

Method Summary

Method Detail