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

Method Summary

Modifier and Type	Method and Description
public MutableByteBooleanMap	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 MutableByteBooleanMap	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 default boolean	Returns: the value associated with key, if one exists, or `defaultValue` if not getAndPut(byte the key key, boolean the value to associate with `key` if no such mapping exists putValue, boolean 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 boolean	Returns: the value associated with key, if one exists, or `value` if not getIfAbsentPut(byte the key key, boolean 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 boolean	Returns: the value associated with the key, if one exists, or the result of invoking `function` if not getIfAbsentPut(byte the key key, BooleanFunction0 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> boolean	Returns: the value associated with the key, if one exists, or the result of invoking `function` with `parameter` if not getIfAbsentPutWith(byte the key key, BooleanFunction<? 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 boolean	Returns: the value associated with the key, if one exists, or the result of invoking `function` with `key` if not getIfAbsentPutWithKey(byte the key key, ByteToBooleanFunction 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(byte the key key, boolean the value to associate with `value` value) Associates a value with the specified key.
public void	putAll(ByteBooleanMap 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(ByteBooleanPair keyValuePair) This method allows MutableByteBooleanMap the ability to add an element in the form of ByteBooleanPair.
public MutableByteBooleanMap	reject(ByteBooleanPredicate predicate) Redeclares org.eclipse.collections.api.map.primitive.ByteBooleanMap.reject. Return a copy of this map containing only the key/value pairs that do not match the predicate.
public void	remove(byte the key to remove key) Removes the mapping associated with the key, if one exists, from the map.
public void	removeKey(byte the key to remove key) Removes the mapping associated with the key, if one exists, from the map.
public boolean	Returns: the value previously associated with the key, if one existed, or `value` if not removeKeyIfAbsent(byte the key to remove key, boolean 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 MutableByteBooleanMap	select(ByteBooleanPredicate predicate) Redeclares org.eclipse.collections.api.map.primitive.ByteBooleanMap.select. Return a copy of this map containing only the key/value pairs that match the predicate.
public boolean	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(byte the key key, boolean the initial value to supply to the function if no mapping exists for the key initialValueIfAbsent, BooleanToBooleanFunction 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(ByteBooleanToBooleanFunction that takes a key and its value and that returns a new value for this key function) Updates the values in-place.
public default MutableByteBooleanMap	Returns: this map withAllKeyValues(Iterable<ByteBooleanPair> the pairs to put into this map keyValuePairs) Puts all of the key/value mappings from the specified pairs into this map.
public MutableByteBooleanMap	Returns: this map withKeyValue(byte the key key, boolean the value to associate with `value` value) Associates a value with the specified key.
public MutableByteBooleanMap	Returns: this map withoutAllKeys(ByteIterable the keys to remove keys) Removes the mappings associated with all the keys, if they exist, from this map.
public MutableByteBooleanMap	Returns: this map withoutKey(byte 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 MutableByteBooleanMap 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:MutableByteBooleanMap a synchronized view of this map

asSynchronized

back to summary

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

asUnmodifiable back to summary

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

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

getAndPut back to summary

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

public default boolean getAndPut(byte key, boolean putValue, boolean defaultValue)

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

Parameters

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

Returns:boolean

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

Since

11.1.

getIfAbsentPut back to summary

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

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

Returns:boolean

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

getIfAbsentPut back to summary

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

public boolean getIfAbsentPut(byte 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:byte: the key
function:BooleanFunction0: the supplier that provides the value if no mapping exists for key

Returns:boolean

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> boolean getIfAbsentPutWith(byte 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. Parameters <P> the type of the value function's `parameter` key:byte the key function:BooleanFunction<? 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:boolean the value associated with the key, if one exists, or the result of invoking `function` with `parameter` if not

public <P> boolean getIfAbsentPutWith(byte 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.

Parameters

<P>: the type of the value function's parameter
key:byte: the key
function:BooleanFunction<? 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:boolean

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

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

Returns:boolean

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(byte 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:byte the key value:boolean the value to associate with `value`

public void put(byte 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:byte: the key
value:boolean: the value to associate with value

putAll back to summary

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

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

putPair back to summary

putPair	back to summary
public default void putPair(ByteBooleanPair keyValuePair) This method allows MutableByteBooleanMap the ability to add an element in the form of ByteBooleanPair. Since 9.1.0 See Also `put(byte, boolean)`

public default void putPair(ByteBooleanPair keyValuePair)

This method allows MutableByteBooleanMap the ability to add an element in the form of ByteBooleanPair.

Since: 9.1.0
See Also: put(byte, boolean)

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

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

Doc from org.eclipse.collections.api.map.primitive.ByteBooleanMap.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(byte key) Removes the mapping associated with the key, if one exists, from the map. Parameters key:byte the key to remove See Also `removeKey(byte)`

public void remove(byte key)

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

Parameters

key:byte: the key to remove

See Also

removeKey(byte)

removeKey back to summary

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

public void removeKey(byte key)

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

Parameters

key:byte: the key to remove

See Also

remove(byte)

removeKeyIfAbsent back to summary

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

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

Returns:boolean

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

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

select

back to summary

public MutableByteBooleanMap select(ByteBooleanPredicate predicate)

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

Doc from org.eclipse.collections.api.map.primitive.ByteBooleanMap.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 boolean updateValue(byte 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:byte the key initialValueIfAbsent:boolean the initial value to supply to the function if no mapping exists for the key function:BooleanToBooleanFunction the function that returns the updated value based on the current value or the initial value, if no value exists Returns:boolean 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 boolean updateValue(byte 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:byte: the key
initialValueIfAbsent:boolean: the initial value to supply to the function if no mapping exists for the key
function:BooleanToBooleanFunction: the function that returns the updated value based on the current value or the initial value, if no value exists

Returns:boolean

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

Updates the values in-place.

Parameters

function:ByteBooleanToBooleanFunction: 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 MutableByteBooleanMap withAllKeyValues(Iterable<ByteBooleanPair> 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<ByteBooleanPair> the pairs to put into this map Returns:MutableByteBooleanMap this map See Also `putPair(ByteBooleanPair)`

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

Returns:MutableByteBooleanMap

this map

See Also

putPair(ByteBooleanPair)

withKeyValue back to summary

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

public MutableByteBooleanMap withKeyValue(byte 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:byte: the key
value:boolean: the value to associate with value

Returns:MutableByteBooleanMap

this map

See Also

put(byte, boolean)

withoutAllKeys back to summary

withoutAllKeys	back to summary
public MutableByteBooleanMap withoutAllKeys(ByteIterable keys) Removes the mappings associated with all the keys, if they exist, from this map. Parameters keys:ByteIterable the keys to remove Returns:MutableByteBooleanMap this map See Also `remove(byte)`

public MutableByteBooleanMap withoutAllKeys(ByteIterable keys)

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

Parameters

keys:ByteIterable: the keys to remove

Returns:MutableByteBooleanMap

this map

See Also

remove(byte)

withoutKey back to summary

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

public MutableByteBooleanMap withoutKey(byte key)

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

Parameters

key:byte: the key to remove

Returns:MutableByteBooleanMap

this map

See Also

remove(byte)

public Interface MutableByteBooleanMap

Method Summary

Method Detail