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

Class CharCharHashMap

java.lang.Object

org.eclipse.collections.impl.primitive.AbstractCharIterable

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

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

All Implemented Interfaces:

Externalizable, Serializable, CharIterable, CharCharMap, CharValuesMap, MutableCharCharMap, MutableCharValuesMap, PrimitiveIterable, MutableCharKeysMap, CharKeysMap

public class CharCharHashMap
extends AbstractMutableCharValuesMap
implements MutableCharCharMap, Externalizable, MutableCharKeysMap

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

Since:

3.0.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CharCharHashMap()
CharCharHashMap(int initialCapacity)
CharCharHashMap(CharCharMap map)

Method Summary

Modifier and Type	Method	Description
char	addToValue(char key, char 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.
MutableCharCharMap	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.
MutableCharCharMap	asUnmodifiable()	Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an UnsupportedOperationException for all mutating operations.
MutableCharIterator	charIterator()	Returns a primitive iterator that can be used to iterate over the CharIterable 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	equals(Object obj)	Follows the same general contract as Map.equals(Object).
MutableCharCharMap	flipUniqueValues()	Return the CharCharMap that is obtained by flipping the direction of this map and making the associations from value to key.
void	forEachKey(CharProcedure procedure)	Iterates through each key in the map, invoking the procedure for each.
void	forEachKeyValue(CharCharProcedure procedure)	Iterates through each key/value pair in the map, invoking the procedure for each.
char	get(char key)	Retrieves the value associated with the key.
char	getAndPut(char key, char putValue, char defaultValue)	Retrieves the value associated with the key if one exists; associates a putValue with the key.
char	getIfAbsent(char key, char ifAbsent)	Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
char	getIfAbsentPut(char key, char value)	Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.
char	getIfAbsentPut(char key, CharFunction0 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> char	getIfAbsentPutWith(char key, CharFunction<? 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.
char	getIfAbsentPutWithKey(char key, CharToCharFunction 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.
char	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().
<V> V	injectInto(V injectedValue, ObjectCharToObjectFunction<? super V,? extends V> function)
MutableCharSet	keySet()	Returns a set containing all the keys in this map.
LazyCharIterable	keysView()	Returns a view of the keys in this map.
RichIterable<CharCharPair>	keyValuesView()	Returns a view of the key/value pairs in this map.
static CharCharHashMap	newWithKeysValues(char key1, char value1)
static CharCharHashMap	newWithKeysValues(char key1, char value1, char key2, char value2)
static CharCharHashMap	newWithKeysValues(char key1, char value1, char key2, char value2, char key3, char value3)
static CharCharHashMap	newWithKeysValues(char key1, char value1, char key2, char value2, char key3, char value3, char key4, char value4)
void	put(char key, char value)	Associates a value with the specified key.
void	putAll(CharCharMap map)	Puts all of the key/value mappings from the specified map into this map.
void	readExternal(ObjectInput in)
CharCharHashMap	reject(CharCharPredicate 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.
char	removeKeyIfAbsent(char key, char value)	Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.
CharCharHashMap	select(CharCharPredicate predicate)	Return a copy of this map containing only the key/value pairs that match the predicate.
ImmutableCharCharMap	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.
char	updateValue(char key, char initialValueIfAbsent, CharToCharFunction 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(CharCharToCharFunction function)	Updates the values in-place.
MutableCharCollection	values()	Returns the values in this map as a separate collection.
CharCharHashMap	withKeysValues(char key1, char value1, char key2, char value2)
CharCharHashMap	withKeysValues(char key1, char value1, char key2, char value2, char key3, char value3)
CharCharHashMap	withKeysValues(char key1, char value1, char key2, char value2, char key3, char value3, char key4, char value4)
CharCharHashMap	withKeyValue(char key1, char value1)	Associates a value with the specified key.
CharCharHashMap	withoutAllKeys(CharIterable keys)	Removes the mappings associated with all the keys, if they exist, from this map.
CharCharHashMap	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.AbstractMutableCharValuesMap

allSatisfy, anySatisfy, appendString, chunk, collect, contains, containsAll, containsValue, count, detectIfNone, each, forEachValue, isEmpty, max, min, notEmpty, reject, select, size, sum, toArray, toArray

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

asLazy, average, maxIfEmpty, median, minIfEmpty, toBag, toList, toSet, toSortedArray, toSortedList

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

injectIntoKeyValue

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

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, 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.impl.map.primitive.CharKeysMap

isEmpty, notEmpty, size

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

containsValue, forEachValue, tap

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

putPair, withAllKeyValues

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

collect, reject, select

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

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

Constructor Details

CharCharHashMap

public CharCharHashMap()

CharCharHashMap

public CharCharHashMap(int initialCapacity)

CharCharHashMap

public CharCharHashMap(CharCharMap map)

Method Details

newWithKeysValues

public static CharCharHashMap newWithKeysValues(char key1,
 char value1)

newWithKeysValues

public static CharCharHashMap newWithKeysValues(char key1,
 char value1,
 char key2,
 char value2)

newWithKeysValues

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

newWithKeysValues

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

equals

public boolean equals(Object obj)

Description copied from interface: CharCharMap

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

Specified by:

equals in interface CharCharMap

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: CharCharMap

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

Specified by:

hashCode in interface CharCharMap

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 CharCharMap

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class AbstractCharIterable

Returns:

a string representation of this PrimitiveIterable

See Also:

• AbstractCollection.toString()

charIterator

public MutableCharIterator charIterator()

Description copied from interface: CharIterable

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

Specified by:

charIterator in interface CharIterable

Specified by:

charIterator in interface MutableCharValuesMap

injectInto

public <V> V injectInto(V injectedValue,
 ObjectCharToObjectFunction<? super V,? extends V> function)

Specified by:

injectInto in interface CharIterable

clear

public void clear()

Description copied from interface: MutableCharValuesMap

Removes all entries from this map.

Specified by:

clear in interface MutableCharKeysMap

Specified by:

clear in interface MutableCharValuesMap

put

public void put(char key,
 char value)

Description copied from interface: MutableCharCharMap

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 MutableCharCharMap

Parameters:

key - the key

value - the value to associate with value

putAll

public void putAll(CharCharMap map)

Description copied from interface: MutableCharCharMap

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 MutableCharCharMap

Parameters:

map - the map to copy into this map

updateValues

public void updateValues(CharCharToCharFunction function)

Description copied from interface: MutableCharCharMap

Updates the values in-place.

Specified by:

updateValues in interface MutableCharCharMap

Parameters:

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

removeKey

public void removeKey(char key)

Description copied from interface: MutableCharCharMap

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

Specified by:

removeKey in interface MutableCharCharMap

Specified by:

removeKey in interface MutableCharKeysMap

Parameters:

key - the key to remove

See Also:

• MutableCharCharMap.remove(char)

remove

public void remove(char key)

Description copied from interface: MutableCharCharMap

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

Specified by:

remove in interface MutableCharCharMap

Parameters:

key - the key to remove

See Also:

• MutableCharCharMap.removeKey(char)

removeKeyIfAbsent

public char removeKeyIfAbsent(char key,
 char value)

Description copied from interface: MutableCharCharMap

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 MutableCharCharMap

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

getIfAbsentPut

public char getIfAbsentPut(char key,
 char value)

Description copied from interface: MutableCharCharMap

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 MutableCharCharMap

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

getAndPut

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

Description copied from interface: MutableCharCharMap

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

Specified by:

getAndPut in interface MutableCharCharMap

Parameters:

key - the key

putValue - the value to associate with key if no such mapping exists

defaultValue - the value to return if no mapping associated with key exists

Returns:

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

getIfAbsentPut

public char getIfAbsentPut(char key,
 CharFunction0 function)

Description copied from interface: MutableCharCharMap

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 MutableCharCharMap

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> char getIfAbsentPutWith(char key,
 CharFunction<? super P> function,
 P parameter)

Description copied from interface: MutableCharCharMap

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 MutableCharCharMap

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 char getIfAbsentPutWithKey(char key,
 CharToCharFunction function)

Description copied from interface: MutableCharCharMap

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 MutableCharCharMap

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

addToValue

public char addToValue(char key,
 char toBeAdded)

Description copied from interface: MutableCharCharMap

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.

Specified by:

addToValue in interface MutableCharCharMap

Parameters:

key - the key

toBeAdded - 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 toBeAdded to the existing value associated with key or toBeAdded if one does not

updateValue

public char updateValue(char key,
 char initialValueIfAbsent,
 CharToCharFunction function)

Description copied from interface: MutableCharCharMap

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 MutableCharCharMap

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

withKeyValue

public CharCharHashMap withKeyValue(char key1,
 char value1)

Description copied from interface: MutableCharCharMap

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 MutableCharCharMap

Parameters:

key1 - the key

value1 - the value to associate with value

Returns:

this map

See Also:

• MutableCharCharMap.put(char, char)

withKeysValues

public CharCharHashMap withKeysValues(char key1,
 char value1,
 char key2,
 char value2)

withKeysValues

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

withKeysValues

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

withoutKey

public CharCharHashMap withoutKey(char key)

Description copied from interface: MutableCharCharMap

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

Specified by:

withoutKey in interface MutableCharCharMap

Parameters:

key - the key to remove

Returns:

this map

See Also:

• MutableCharCharMap.remove(char)

withoutAllKeys

public CharCharHashMap withoutAllKeys(CharIterable keys)

Description copied from interface: MutableCharCharMap

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

Specified by:

withoutAllKeys in interface MutableCharCharMap

Parameters:

keys - the keys to remove

Returns:

this map

See Also:

• MutableCharCharMap.remove(char)

asUnmodifiable

public MutableCharCharMap asUnmodifiable()

Description copied from interface: MutableCharCharMap

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

Specified by:

asUnmodifiable in interface MutableCharCharMap

Returns:

an unmodifiable view of this map

asSynchronized

public MutableCharCharMap asSynchronized()

Description copied from interface: MutableCharCharMap

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 MutableCharCharMap

Returns:

a synchronized view of this map

toImmutable

public ImmutableCharCharMap toImmutable()

Description copied from interface: CharCharMap

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 CharCharMap

Returns:

an immutable map that is equivalent to this one

get

public char get(char key)

Description copied from interface: CharCharMap

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 CharCharMap

Parameters:

key - the key

Returns:

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

getIfAbsent

public char getIfAbsent(char key,
 char ifAbsent)

Description copied from interface: CharCharMap

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

Specified by:

getIfAbsent in interface CharCharMap

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 char getOrThrow(char key)

Description copied from interface: CharCharMap

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

Specified by:

getOrThrow in interface CharCharMap

Parameters:

key - the key

Returns:

the value associated with the key

containsKey

public boolean containsKey(char key)

Description copied from interface: CharCharMap

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

Specified by:

containsKey in interface CharCharMap

Specified by:

containsKey in interface CharKeysMap

Parameters:

key - the key

Returns:

if a mapping exists in this map for the key

forEachKey

public void forEachKey(CharProcedure procedure)

Description copied from interface: CharCharMap

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

Specified by:

forEachKey in interface CharCharMap

Specified by:

forEachKey in interface CharKeysMap

Parameters:

procedure - the procedure to invoke for each key

forEachKeyValue

public void forEachKeyValue(CharCharProcedure procedure)

Description copied from interface: CharCharMap

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

Specified by:

forEachKeyValue in interface CharCharMap

Parameters:

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

keysView

public LazyCharIterable keysView()

Description copied from interface: CharCharMap

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 CharCharMap

Returns:

a view of the keys in this map

keyValuesView

public RichIterable<CharCharPair> keyValuesView()

Description copied from interface: CharCharMap

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 CharCharMap

Returns:

a view of the keys in this map

flipUniqueValues

public MutableCharCharMap flipUniqueValues()

Description copied from interface: CharCharMap

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

Specified by:

flipUniqueValues in interface CharCharMap

Specified by:

flipUniqueValues in interface MutableCharCharMap

select

public CharCharHashMap select(CharCharPredicate predicate)

Description copied from interface: CharCharMap

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

Specified by:

select in interface CharCharMap

Specified by:

select in interface MutableCharCharMap

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 CharCharHashMap reject(CharCharPredicate predicate)

Description copied from interface: CharCharMap

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

Specified by:

reject in interface CharCharMap

Specified by:

reject in interface MutableCharCharMap

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

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

compact

public void compact()

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

keySet

public MutableCharSet keySet()

Description copied from interface: CharCharMap

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 CharCharMap

Returns:

a mutable set containing the keys in this map

values

public MutableCharCollection values()

Description copied from interface: CharValuesMap

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 CharValuesMap

Returns:

the values as a collection backed by this map