Package org.eclipse.collections.impl.map.mutable.primitive

Class CharBooleanHashMap

java.lang.Object

org.eclipse.collections.impl.primitive.AbstractBooleanIterable

org.eclipse.collections.impl.map.mutable.primitive.AbstractMutableBooleanValuesMap

org.eclipse.collections.impl.map.mutable.primitive.CharBooleanHashMap

All Implemented Interfaces:

Externalizable, Serializable, BooleanIterable, BooleanValuesMap, CharBooleanMap, MutableBooleanValuesMap, MutableCharBooleanMap, PrimitiveIterable, MutableCharKeysMap, CharKeysMap

public class CharBooleanHashMap
extends AbstractMutableBooleanValuesMap
implements MutableCharBooleanMap, MutableCharKeysMap, Externalizable

This file was automatically generated from template file primitiveBooleanHashMap.stg.

Since:

3.0.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CharBooleanHashMap()
CharBooleanHashMap(int initialCapacity)
CharBooleanHashMap(int initialCapacity, float loadFactor)	Deprecated. in 5.1.0.
CharBooleanHashMap(CharBooleanMap map)

Method Summary

Modifier and Type	Method	Description
MutableCharBooleanMap	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.
MutableCharBooleanMap	asUnmodifiable()	Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an UnsupportedOperationException for all mutating operations.
MutableBooleanIterator	booleanIterator()	Returns a primitive iterator that can be used to iterate over the BooleanIterable in an imperative style.
void	clear()	Removes all entries from this map.
void	compact()	Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels.
boolean	containsKey(char key)	Returns whether or not the key is present in the map.
boolean	containsValue(boolean value)	Returns whether or not this map contains the value.
boolean	equals(Object obj)	Follows the same general contract as Map.equals(Object).
void	forEachKey(CharProcedure procedure)	Iterates through each key in the map, invoking the procedure for each.
void	forEachKeyValue(CharBooleanProcedure procedure)	Iterates through each key/value pair in the map, invoking the procedure for each.
boolean	get(char key)	Retrieves the value associated with the key.
boolean	getIfAbsent(char key, boolean ifAbsent)	Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
boolean	getIfAbsentPut(char key, boolean value)	Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.
boolean	getIfAbsentPut(char 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.
<P> boolean	getIfAbsentPutWith(char 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.
boolean	getIfAbsentPutWithKey(char key, CharToBooleanFunction 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.
boolean	getOrThrow(char key)	Retrieves the value associated with the key, throwing an IllegalStateException if no such mapping exists.
int	hashCode()	Follows the same general contract as Map.hashCode().
MutableCharSet	keySet()	Returns a set containing all the keys in this map.
LazyCharIterable	keysView()	Returns a view of the keys in this map.
RichIterable<CharBooleanPair>	keyValuesView()	Returns a view of the key/value pairs in this map.
static CharBooleanHashMap	newWithKeysValues(char key1, boolean value1)
static CharBooleanHashMap	newWithKeysValues(char key1, boolean value1, char key2, boolean value2)
static CharBooleanHashMap	newWithKeysValues(char key1, boolean value1, char key2, boolean value2, char key3, boolean value3)
static CharBooleanHashMap	newWithKeysValues(char key1, boolean value1, char key2, boolean value2, char key3, boolean value3, char key4, boolean value4)
void	put(char key, boolean value)	Associates a value with the specified key.
void	putAll(CharBooleanMap map)	Puts all of the key/value mappings from the specified map into this map.
void	readExternal(ObjectInput in)
CharBooleanHashMap	reject(CharBooleanPredicate predicate)	Return a copy of this map containing only the key/value pairs that do not match the predicate.
void	remove(char key)	Removes the mapping associated with the key, if one exists, from the map.
void	removeKey(char key)	Removes the mapping associated with the key, if one exists, from the map.
boolean	removeKeyIfAbsent(char key, boolean value)	Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.
CharBooleanHashMap	select(CharBooleanPredicate predicate)	Return a copy of this map containing only the key/value pairs that match the predicate.
ImmutableCharBooleanMap	toImmutable()	Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.
String	toString()	Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.
boolean	updateValue(char 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.
void	updateValues(CharBooleanToBooleanFunction function)	Updates the values in-place.
MutableBooleanCollection	values()	Returns the values in this map as a separate collection.
CharBooleanHashMap	withKeysValues(char key1, boolean value1, char key2, boolean value2)
CharBooleanHashMap	withKeysValues(char key1, boolean value1, char key2, boolean value2, char key3, boolean value3)
CharBooleanHashMap	withKeysValues(char key1, boolean value1, char key2, boolean value2, char key3, boolean value3, char key4, boolean value4)
CharBooleanHashMap	withKeyValue(char key1, boolean value1)	Associates a value with the specified key.
CharBooleanHashMap	withoutAllKeys(CharIterable keys)	Removes the mappings associated with all the keys, if they exist, from this map.
CharBooleanHashMap	withoutKey(char key)	Removes the mapping associated with the key, if one exists, from this map.
void	writeExternal(ObjectOutput out)

Methods inherited from class org.eclipse.collections.impl.map.mutable.primitive.AbstractMutableBooleanValuesMap

allSatisfy, anySatisfy, appendString, chunk, collect, contains, containsAll, count, detectIfNone, each, forEach, forEachValue, injectInto, isEmpty, noneSatisfy, notEmpty, reject, select, size, toArray, toArray

Methods inherited from class org.eclipse.collections.impl.primitive.AbstractBooleanIterable

asLazy, toBag, toList, toSet

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

allSatisfy, anySatisfy, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, contains, containsAll, containsAll, containsAny, containsAny, containsNone, containsNone, count, detectIfNone, each, flatCollect, forEach, injectInto, noneSatisfy, reduce, reduceIfEmpty, reject, select, toArray, toArray, toBag, toList, toSet

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

forEachValue, tap

Methods inherited from interface org.eclipse.collections.impl.map.primitive.CharKeysMap

isEmpty, notEmpty, size

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

collect, reject, select

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

putPair, withAllKeyValues

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

appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size

Constructor Details

CharBooleanHashMap

public CharBooleanHashMap()

CharBooleanHashMap

public CharBooleanHashMap(int initialCapacity)

CharBooleanHashMap

public CharBooleanHashMap(CharBooleanMap map)

CharBooleanHashMap

@Deprecated
public CharBooleanHashMap(int initialCapacity,
 float loadFactor)

Deprecated.

in 5.1.0.

Method Details

asUnmodifiable

public MutableCharBooleanMap asUnmodifiable()

Description copied from interface: MutableCharBooleanMap

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

Specified by:

asUnmodifiable in interface MutableCharBooleanMap

Returns:

an unmodifiable view of this map

asSynchronized

public MutableCharBooleanMap asSynchronized()

Description copied from interface: MutableCharBooleanMap

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.

Specified by:

asSynchronized in interface MutableCharBooleanMap

Returns:

a synchronized view of this map

toImmutable

public ImmutableCharBooleanMap toImmutable()

Description copied from interface: CharBooleanMap

Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.

Specified by:

toImmutable in interface CharBooleanMap

Returns:

an immutable map that is equivalent to this one

newWithKeysValues

public static CharBooleanHashMap newWithKeysValues(char key1,
 boolean value1)

newWithKeysValues

public static CharBooleanHashMap newWithKeysValues(char key1,
 boolean value1,
 char key2,
 boolean value2)

newWithKeysValues

public static CharBooleanHashMap newWithKeysValues(char key1,
 boolean value1,
 char key2,
 boolean value2,
 char key3,
 boolean value3)

newWithKeysValues

public static CharBooleanHashMap newWithKeysValues(char key1,
 boolean value1,
 char key2,
 boolean value2,
 char key3,
 boolean value3,
 char key4,
 boolean value4)

withKeyValue

public CharBooleanHashMap withKeyValue(char key1,
 boolean value1)

Description copied from interface: MutableCharBooleanMap

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.

Specified by:

withKeyValue in interface MutableCharBooleanMap

Parameters:

key1 - the key

value1 - the value to associate with value

Returns:

this map

See Also:

• MutableCharBooleanMap.put(char, boolean)

withKeysValues

public CharBooleanHashMap withKeysValues(char key1,
 boolean value1,
 char key2,
 boolean value2)

withKeysValues

public CharBooleanHashMap withKeysValues(char key1,
 boolean value1,
 char key2,
 boolean value2,
 char key3,
 boolean value3)

withKeysValues

public CharBooleanHashMap withKeysValues(char key1,
 boolean value1,
 char key2,
 boolean value2,
 char key3,
 boolean value3,
 char key4,
 boolean value4)

withoutKey

public CharBooleanHashMap withoutKey(char key)

Description copied from interface: MutableCharBooleanMap

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

Specified by:

withoutKey in interface MutableCharBooleanMap

Parameters:

key - the key to remove

Returns:

this map

See Also:

• MutableCharBooleanMap.remove(char)

withoutAllKeys

public CharBooleanHashMap withoutAllKeys(CharIterable keys)

Description copied from interface: MutableCharBooleanMap

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

Specified by:

withoutAllKeys in interface MutableCharBooleanMap

Parameters:

keys - the keys to remove

Returns:

this map

See Also:

• MutableCharBooleanMap.remove(char)

compact

public void compact()

Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels.

clear

public void clear()

Description copied from interface: MutableBooleanValuesMap

Removes all entries from this map.

Specified by:

clear in interface MutableBooleanValuesMap

Specified by:

clear in interface MutableCharKeysMap

put

public void put(char key,
 boolean value)

Description copied from interface: MutableCharBooleanMap

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.

Specified by:

put in interface MutableCharBooleanMap

Parameters:

key - the key

value - the value to associate with value

putAll

public void putAll(CharBooleanMap map)

Description copied from interface: MutableCharBooleanMap

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.

Specified by:

putAll in interface MutableCharBooleanMap

Parameters:

map - the map to copy into this map

updateValues

public void updateValues(CharBooleanToBooleanFunction function)

Description copied from interface: MutableCharBooleanMap

Updates the values in-place.

Specified by:

updateValues in interface MutableCharBooleanMap

Parameters:

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

containsKey

public boolean containsKey(char key)

Description copied from interface: CharBooleanMap

Returns whether or not the key is present in the map.

Specified by:

containsKey in interface CharBooleanMap

Specified by:

containsKey in interface CharKeysMap

Parameters:

key - the key

Returns:

if a mapping exists in this map for the key

containsValue

public boolean containsValue(boolean value)

Description copied from interface: BooleanValuesMap

Returns whether or not this map contains the value.

Specified by:

containsValue in interface BooleanValuesMap

Parameters:

value - the value to test

Returns:

if this collection contains the value

get

public boolean get(char key)

Description copied from interface: CharBooleanMap

Retrieves the value associated with the key. If no mapping exists for the key, the default value (usually 0) is returned.

Specified by:

get in interface CharBooleanMap

Parameters:

key - the key

Returns:

the value associated with the key, or the default value if no such mapping exists

getIfAbsent

public boolean getIfAbsent(char key,
 boolean ifAbsent)

Description copied from interface: CharBooleanMap

Retrieves the value associated with the key, returning the specified default value if no such mapping exists.

Specified by:

getIfAbsent in interface CharBooleanMap

Parameters:

key - the key

ifAbsent - the default value to return if no mapping exists for key

Returns:

the value associated with the key, or ifAbsent if no such mapping exists.

getOrThrow

public boolean getOrThrow(char key)

Description copied from interface: CharBooleanMap

Retrieves the value associated with the key, throwing an IllegalStateException if no such mapping exists.

Specified by:

getOrThrow in interface CharBooleanMap

Parameters:

key - the key

Returns:

the value associated with the key

getIfAbsentPut

public boolean getIfAbsentPut(char key,
 boolean value)

Description copied from interface: MutableCharBooleanMap

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

Specified by:

getIfAbsentPut in interface MutableCharBooleanMap

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

public boolean getIfAbsentPut(char key,
 BooleanFunction0 function)

Description copied from interface: MutableCharBooleanMap

Retrieves the value associated with the key if one exists; if it does not, invokes the supplier and associates the result with the key.

Specified by:

getIfAbsentPut in interface MutableCharBooleanMap

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

getIfAbsentPutWith

public <P> boolean getIfAbsentPutWith(char key,
 BooleanFunction<? super P> function,
 P parameter)

Description copied from interface: MutableCharBooleanMap

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.

Specified by:

getIfAbsentPutWith in interface MutableCharBooleanMap

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

getIfAbsentPutWithKey

public boolean getIfAbsentPutWithKey(char key,
 CharToBooleanFunction function)

Description copied from interface: MutableCharBooleanMap

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.

Specified by:

getIfAbsentPutWithKey in interface MutableCharBooleanMap

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

updateValue

public boolean updateValue(char key,
 boolean initialValueIfAbsent,
 BooleanToBooleanFunction function)

Description copied from interface: MutableCharBooleanMap

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.

Specified by:

updateValue in interface MutableCharBooleanMap

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

removeKey

public void removeKey(char key)

Description copied from interface: MutableCharBooleanMap

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

Specified by:

removeKey in interface MutableCharBooleanMap

Specified by:

removeKey in interface MutableCharKeysMap

Parameters:

key - the key to remove

See Also:

• MutableCharBooleanMap.remove(char)

remove

public void remove(char key)

Description copied from interface: MutableCharBooleanMap

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

Specified by:

remove in interface MutableCharBooleanMap

Parameters:

key - the key to remove

See Also:

• MutableCharBooleanMap.removeKey(char)

removeKeyIfAbsent

public boolean removeKeyIfAbsent(char key,
 boolean value)

Description copied from interface: MutableCharBooleanMap

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.

Specified by:

removeKeyIfAbsent in interface MutableCharBooleanMap

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

equals

public boolean equals(Object obj)

Description copied from interface: CharBooleanMap

Follows the same general contract as Map.equals(Object).

Specified by:

equals in interface CharBooleanMap

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: CharBooleanMap

Follows the same general contract as Map.hashCode().

Specified by:

hashCode in interface CharBooleanMap

Overrides:

hashCode in class Object

toString

public String toString()

Description copied from interface: PrimitiveIterable

Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.

 Assert.assertEquals("[]", IntLists.mutable.empty().toString());
 Assert.assertEquals("[1]", IntLists.mutable.with(1).toString());
 Assert.assertEquals("[1, 2, 3]", IntLists.mutable.with(1, 2, 3).toString());
 

Specified by:

toString in interface CharBooleanMap

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class AbstractBooleanIterable

Returns:

a string representation of this PrimitiveIterable

See Also:

• AbstractCollection.toString()

booleanIterator

public MutableBooleanIterator booleanIterator()

Description copied from interface: BooleanIterable

Returns a primitive iterator that can be used to iterate over the BooleanIterable in an imperative style.

Specified by:

booleanIterator in interface BooleanIterable

Specified by:

booleanIterator in interface MutableBooleanValuesMap

forEachKey

public void forEachKey(CharProcedure procedure)

Description copied from interface: CharBooleanMap

Iterates through each key in the map, invoking the procedure for each.

Specified by:

forEachKey in interface CharBooleanMap

Specified by:

forEachKey in interface CharKeysMap

Parameters:

procedure - the procedure to invoke for each key

forEachKeyValue

public void forEachKeyValue(CharBooleanProcedure procedure)

Description copied from interface: CharBooleanMap

Iterates through each key/value pair in the map, invoking the procedure for each.

Specified by:

forEachKeyValue in interface CharBooleanMap

Parameters:

procedure - the procedure to invoke for each key/value pair

select

public CharBooleanHashMap select(CharBooleanPredicate predicate)

Description copied from interface: CharBooleanMap

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

Specified by:

select in interface CharBooleanMap

Specified by:

select in interface MutableCharBooleanMap

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

public CharBooleanHashMap reject(CharBooleanPredicate predicate)

Description copied from interface: CharBooleanMap

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

Specified by:

reject in interface CharBooleanMap

Specified by:

reject in interface MutableCharBooleanMap

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

keysView

public LazyCharIterable keysView()

Description copied from interface: CharBooleanMap

Returns a view of the keys in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the keys returned by the iterable.

Specified by:

keysView in interface CharBooleanMap

Returns:

a view of the keys in this map

keyValuesView

public RichIterable<CharBooleanPair> keyValuesView()

Description copied from interface: CharBooleanMap

Returns a view of the key/value pairs in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the pairs returned by the iterable.

Specified by:

keyValuesView in interface CharBooleanMap

Returns:

a view of the keys in this map

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

keySet

public MutableCharSet keySet()

Description copied from interface: CharBooleanMap

Returns a set containing all the keys in this map. The set is backed by the map, so any modifications to the returned set will affect this map.

Specified by:

keySet in interface CharBooleanMap

Returns:

a mutable set containing the keys in this map

values

public MutableBooleanCollection values()

Description copied from interface: BooleanValuesMap

Returns the values in this map as a separate collection. The returned collection is backed by the map, so any changes made to the returned collection will affect the state of this map.

Specified by:

values in interface BooleanValuesMap

Returns:

the values as a collection backed by this map