Interface MutableShortByteMap
-
- All Superinterfaces:
ByteIterable,ByteValuesMap,MutableByteValuesMap,PrimitiveIterable,ShortByteMap
public interface MutableShortByteMap extends ShortByteMap, MutableByteValuesMap
This file was automatically generated from template file mutablePrimitivePrimitiveMap.stg.- Since:
- 3.0.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description byteaddToValue(short key, byte 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.MutableShortByteMapasSynchronized()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.MutableShortByteMapasUnmodifiable()Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing anUnsupportedOperationExceptionfor all mutating operations.MutableByteShortMapflipUniqueValues()Return the ByteShortMap that is obtained by flipping the direction of this map and making the associations from value to key.default bytegetAndPut(short key, byte putValue, byte defaultValue)Retrieves the value associated with the key if one exists; associates a putValue with the key.bytegetIfAbsentPut(short key, byte value)Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.bytegetIfAbsentPut(short key, ByteFunction0 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> bytegetIfAbsentPutWith(short key, ByteFunction<? 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.bytegetIfAbsentPutWithKey(short key, ShortToByteFunction 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.voidput(short key, byte value)Associates a value with the specified key.voidputAll(ShortByteMap map)Puts all of the key/value mappings from the specified map into this map.default voidputPair(ShortBytePair keyValuePair)This method allows MutableShortByteMap the ability to add an element in the form of ShortBytePair.MutableShortByteMapreject(ShortBytePredicate predicate)Return a copy of this map containing only the key/value pairs that do not match the predicate.voidremove(short key)Removes the mapping associated with the key, if one exists, from the map.voidremoveKey(short key)Removes the mapping associated with the key, if one exists, from the map.byteremoveKeyIfAbsent(short key, byte value)Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.MutableShortByteMapselect(ShortBytePredicate predicate)Return a copy of this map containing only the key/value pairs that match the predicate.byteupdateValue(short key, byte initialValueIfAbsent, ByteToByteFunction 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.voidupdateValues(ShortByteToByteFunction function)Updates the values in-place.default MutableShortByteMapwithAllKeyValues(Iterable<ShortBytePair> keyValuePairs)Puts all of the key/value mappings from the specified pairs into this map.MutableShortByteMapwithKeyValue(short key, byte value)Associates a value with the specified key.MutableShortByteMapwithoutAllKeys(ShortIterable keys)Removes the mappings associated with all the keys, if they exist, from this map.MutableShortByteMapwithoutKey(short key)Removes the mapping associated with the key, if one exists, from this map.-
Methods inherited from interface org.eclipse.collections.api.ByteIterable
allSatisfy, anySatisfy, asLazy, average, averageIfEmpty, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, contains, containsAll, containsAll, containsAny, containsAny, containsNone, containsNone, count, detectIfNone, each, flatCollect, forEach, injectInto, injectIntoBoolean, injectIntoByte, injectIntoChar, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, injectIntoShort, max, maxIfEmpty, median, medianIfEmpty, min, minIfEmpty, noneSatisfy, reduce, reduceIfEmpty, reject, select, sum, summaryStatistics, toArray, toArray, toBag, toList, toSet, toSortedArray, toSortedList, toSortedList, toSortedListBy, toSortedListBy
-
Methods inherited from interface org.eclipse.collections.api.map.primitive.ByteValuesMap
containsValue, forEachValue, tap, values
-
Methods inherited from interface org.eclipse.collections.api.map.primitive.MutableByteValuesMap
byteIterator, clear, collect, reject, select
-
Methods inherited from interface org.eclipse.collections.api.PrimitiveIterable
appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size
-
Methods inherited from interface org.eclipse.collections.api.map.primitive.ShortByteMap
containsKey, equals, forEachKey, forEachKeyValue, get, getIfAbsent, getOrThrow, hashCode, injectIntoKeyValue, keySet, keysView, keyValuesView, toImmutable, toString
-
-
-
-
Method Detail
-
put
void put(short key, byte value)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
default void putPair(ShortBytePair keyValuePair)
This method allows MutableShortByteMap the ability to add an element in the form of ShortBytePair.- Since:
- 9.1.0
- See Also:
put(short, byte)
-
putAll
void putAll(ShortByteMap 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 inmap.- Parameters:
map- the map to copy into this map
-
updateValues
void updateValues(ShortByteToByteFunction 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(short key)
Removes the mapping associated with the key, if one exists, from the map.- Parameters:
key- the key to remove- See Also:
remove(short)
-
remove
void remove(short key)
Removes the mapping associated with the key, if one exists, from the map.- Parameters:
key- the key to remove- See Also:
removeKey(short)
-
removeKeyIfAbsent
byte removeKeyIfAbsent(short key, byte 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 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
valueif not
-
getIfAbsentPut
byte getIfAbsentPut(short key, byte value)Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.- Parameters:
key- the keyvalue- the value to associate withkeyif no such mapping exists- Returns:
- the value associated with key, if one exists, or
valueif not
-
getAndPut
default byte getAndPut(short key, byte putValue, byte defaultValue)Retrieves the value associated with the key if one exists; associates a putValue with the key.- Parameters:
key- the keyputValue- the value to associate withkeyif no such mapping existsdefaultValue- the value to return if no mapping associated withkeyexists- Returns:
- the value associated with key, if one exists, or
defaultValueif not - Since:
- 11.1.
-
getIfAbsentPut
byte getIfAbsentPut(short key, ByteFunction0 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 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
functionif not
-
getIfAbsentPutWithKey
byte getIfAbsentPutWithKey(short key, ShortToByteFunction 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 keyfunction- the function that provides the value if no mapping exists. Thekeywill be passed as the argument to the function.- Returns:
- the value associated with the key, if one exists, or the result of
invoking
functionwithkeyif not
-
getIfAbsentPutWith
<P> byte getIfAbsentPutWith(short key, ByteFunction<? 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'sparameter- Parameters:
key- the keyfunction- the function that provides the value if no mapping exists. The specifiedparameterwill be passed as the argument to the function.parameter- the parameter to provide tofunctionif no value exists forkey- Returns:
- the value associated with the key, if one exists, or the result of
invoking
functionwithparameterif not
-
updateValue
byte updateValue(short key, byte initialValueIfAbsent, ByteToByteFunction 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 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
functionto the value already associated with the key or as a result of applying it toinitialValueIfAbsentand associating the result withkey
-
flipUniqueValues
MutableByteShortMap flipUniqueValues()
Description copied from interface:ShortByteMapReturn the ByteShortMap that is obtained by flipping the direction of this map and making the associations from value to key.- Specified by:
flipUniqueValuesin interfaceShortByteMap
-
select
MutableShortByteMap select(ShortBytePredicate predicate)
Description copied from interface:ShortByteMapReturn a copy of this map containing only the key/value pairs that match the predicate.- Specified by:
selectin interfaceShortByteMap- 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
MutableShortByteMap reject(ShortBytePredicate predicate)
Description copied from interface:ShortByteMapReturn a copy of this map containing only the key/value pairs that do not match the predicate.- Specified by:
rejectin interfaceShortByteMap- 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
MutableShortByteMap withKeyValue(short key, byte value)
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(short, byte)
-
withoutKey
MutableShortByteMap withoutKey(short 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(short)
-
withoutAllKeys
MutableShortByteMap withoutAllKeys(ShortIterable 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(short)
-
withAllKeyValues
default MutableShortByteMap withAllKeyValues(Iterable<ShortBytePair> 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(ShortBytePair)
-
asUnmodifiable
MutableShortByteMap asUnmodifiable()
Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing anUnsupportedOperationExceptionfor all mutating operations. This avoids the overhead of copying the map when callingShortByteMap.toImmutable()while still providing immutability.- Returns:
- an unmodifiable view of this map
-
asSynchronized
MutableShortByteMap 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
-
addToValue
byte addToValue(short key, byte 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- the keytoBeAdded- the amount to increment the existing value, if one exists, or to use as the initial value if one does not- Returns:
- the value after incrementing
toBeAddedto the existing value associated withkeyortoBeAddedif one does not
-
-