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

Class IntCharHashMap

java.lang.Object

org.eclipse.collections.impl.primitive.AbstractCharIterable

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

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

All Implemented Interfaces:

Externalizable, Serializable, CharIterable, CharValuesMap, IntCharMap, MutableCharValuesMap, MutableIntCharMap, PrimitiveIterable, MutableIntKeysMap, IntKeysMap

public class IntCharHashMap
extends AbstractMutableCharValuesMap
implements MutableIntCharMap, Externalizable, MutableIntKeysMap

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

Since:

3.0.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
IntCharHashMap()
IntCharHashMap(int initialCapacity)
IntCharHashMap(IntCharMap map)

Method Summary

Modifier and Type	Method	Description
char	addToValue(int 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.
MutableIntCharMap	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.
MutableIntCharMap	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(int 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).
MutableCharIntMap	flipUniqueValues()	Return the CharIntMap that is obtained by flipping the direction of this map and making the associations from value to key.
void	forEachKey(IntProcedure procedure)	Iterates through each key in the map, invoking the procedure for each.
void	forEachKeyValue(IntCharProcedure procedure)	Iterates through each key/value pair in the map, invoking the procedure for each.
char	get(int key)	Retrieves the value associated with the key.
char	getAndPut(int key, char putValue, char defaultValue)	Retrieves the value associated with the key if one exists; associates a putValue with the key.
char	getIfAbsent(int key, char ifAbsent)	Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
char	getIfAbsentPut(int 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(int 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(int 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(int key, IntToCharFunction 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(int 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)
MutableIntSet	keySet()	Returns a set containing all the keys in this map.
LazyIntIterable	keysView()	Returns a view of the keys in this map.
RichIterable<IntCharPair>	keyValuesView()	Returns a view of the key/value pairs in this map.
static IntCharHashMap	newWithKeysValues(int key1, char value1)
static IntCharHashMap	newWithKeysValues(int key1, char value1, int key2, char value2)
static IntCharHashMap	newWithKeysValues(int key1, char value1, int key2, char value2, int key3, char value3)
static IntCharHashMap	newWithKeysValues(int key1, char value1, int key2, char value2, int key3, char value3, int key4, char value4)
void	put(int key, char value)	Associates a value with the specified key.
void	putAll(IntCharMap map)	Puts all of the key/value mappings from the specified map into this map.
void	readExternal(ObjectInput in)
IntCharHashMap	reject(IntCharPredicate predicate)	Return a copy of this map containing only the key/value pairs that do not match the predicate.
void	remove(int key)	Removes the mapping associated with the key, if one exists, from the map.
void	removeKey(int key)	Removes the mapping associated with the key, if one exists, from the map.
char	removeKeyIfAbsent(int key, char value)	Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.
IntCharHashMap	select(IntCharPredicate predicate)	Return a copy of this map containing only the key/value pairs that match the predicate.
ImmutableIntCharMap	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(int 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(IntCharToCharFunction function)	Updates the values in-place.
MutableCharCollection	values()	Returns the values in this map as a separate collection.
IntCharHashMap	withKeysValues(int key1, char value1, int key2, char value2)
IntCharHashMap	withKeysValues(int key1, char value1, int key2, char value2, int key3, char value3)
IntCharHashMap	withKeysValues(int key1, char value1, int key2, char value2, int key3, char value3, int key4, char value4)
IntCharHashMap	withKeyValue(int key1, char value1)	Associates a value with the specified key.
IntCharHashMap	withoutAllKeys(IntIterable keys)	Removes the mappings associated with all the keys, if they exist, from this map.
IntCharHashMap	withoutKey(int 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.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.api.map.primitive.CharValuesMap

containsValue, forEachValue, tap

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

injectIntoKeyValue

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

isEmpty, notEmpty, size

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

collect, reject, select

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

putPair, withAllKeyValues

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

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

Constructor Details

IntCharHashMap

public IntCharHashMap()

IntCharHashMap

public IntCharHashMap(int initialCapacity)

IntCharHashMap

public IntCharHashMap(IntCharMap map)

Method Details

newWithKeysValues

public static IntCharHashMap newWithKeysValues(int key1,
 char value1)

newWithKeysValues

public static IntCharHashMap newWithKeysValues(int key1,
 char value1,
 int key2,
 char value2)

newWithKeysValues

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

newWithKeysValues

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

equals

public boolean equals(Object obj)

Description copied from interface: IntCharMap

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

Specified by:

equals in interface IntCharMap

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: IntCharMap

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

Specified by:

hashCode in interface IntCharMap

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 IntCharMap

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 MutableCharValuesMap

Specified by:

clear in interface MutableIntKeysMap

put

public void put(int key,
 char value)

Description copied from interface: MutableIntCharMap

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 MutableIntCharMap

Parameters:

key - the key

value - the value to associate with value

putAll

public void putAll(IntCharMap map)

Description copied from interface: MutableIntCharMap

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 MutableIntCharMap

Parameters:

map - the map to copy into this map

updateValues

public void updateValues(IntCharToCharFunction function)

Description copied from interface: MutableIntCharMap

Updates the values in-place.

Specified by:

updateValues in interface MutableIntCharMap

Parameters:

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

removeKey

public void removeKey(int key)

Description copied from interface: MutableIntCharMap

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

Specified by:

removeKey in interface MutableIntCharMap

Specified by:

removeKey in interface MutableIntKeysMap

Parameters:

key - the key to remove

See Also:

• MutableIntCharMap.remove(int)

remove

public void remove(int key)

Description copied from interface: MutableIntCharMap

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

Specified by:

remove in interface MutableIntCharMap

Parameters:

key - the key to remove

See Also:

• MutableIntCharMap.removeKey(int)

removeKeyIfAbsent

public char removeKeyIfAbsent(int key,
 char value)

Description copied from interface: MutableIntCharMap

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 MutableIntCharMap

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(int key,
 char value)

Description copied from interface: MutableIntCharMap

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 MutableIntCharMap

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(int key,
 char putValue,
 char defaultValue)

Description copied from interface: MutableIntCharMap

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

Specified by:

getAndPut in interface MutableIntCharMap

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(int key,
 CharFunction0 function)

Description copied from interface: MutableIntCharMap

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 MutableIntCharMap

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

Description copied from interface: MutableIntCharMap

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 MutableIntCharMap

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(int key,
 IntToCharFunction function)

Description copied from interface: MutableIntCharMap

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 MutableIntCharMap

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(int key,
 char toBeAdded)

Description copied from interface: MutableIntCharMap

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 MutableIntCharMap

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

Description copied from interface: MutableIntCharMap

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 MutableIntCharMap

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 IntCharHashMap withKeyValue(int key1,
 char value1)

Description copied from interface: MutableIntCharMap

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 MutableIntCharMap

Parameters:

key1 - the key

value1 - the value to associate with value

Returns:

this map

See Also:

• MutableIntCharMap.put(int, char)

withKeysValues

public IntCharHashMap withKeysValues(int key1,
 char value1,
 int key2,
 char value2)

withKeysValues

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

withKeysValues

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

withoutKey

public IntCharHashMap withoutKey(int key)

Description copied from interface: MutableIntCharMap

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

Specified by:

withoutKey in interface MutableIntCharMap

Parameters:

key - the key to remove

Returns:

this map

See Also:

• MutableIntCharMap.remove(int)

withoutAllKeys

public IntCharHashMap withoutAllKeys(IntIterable keys)

Description copied from interface: MutableIntCharMap

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

Specified by:

withoutAllKeys in interface MutableIntCharMap

Parameters:

keys - the keys to remove

Returns:

this map

See Also:

• MutableIntCharMap.remove(int)

asUnmodifiable

public MutableIntCharMap asUnmodifiable()

Description copied from interface: MutableIntCharMap

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

Specified by:

asUnmodifiable in interface MutableIntCharMap

Returns:

an unmodifiable view of this map

asSynchronized

public MutableIntCharMap asSynchronized()

Description copied from interface: MutableIntCharMap

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 MutableIntCharMap

Returns:

a synchronized view of this map

toImmutable

public ImmutableIntCharMap toImmutable()

Description copied from interface: IntCharMap

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 IntCharMap

Returns:

an immutable map that is equivalent to this one

get

public char get(int key)

Description copied from interface: IntCharMap

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 IntCharMap

Parameters:

key - the key

Returns:

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

getIfAbsent

public char getIfAbsent(int key,
 char ifAbsent)

Description copied from interface: IntCharMap

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

Specified by:

getIfAbsent in interface IntCharMap

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(int key)

Description copied from interface: IntCharMap

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

Specified by:

getOrThrow in interface IntCharMap

Parameters:

key - the key

Returns:

the value associated with the key

containsKey

public boolean containsKey(int key)

Description copied from interface: IntCharMap

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

Specified by:

containsKey in interface IntCharMap

Specified by:

containsKey in interface IntKeysMap

Parameters:

key - the key

Returns:

if a mapping exists in this map for the key

forEachKey

public void forEachKey(IntProcedure procedure)

Description copied from interface: IntCharMap

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

Specified by:

forEachKey in interface IntCharMap

Specified by:

forEachKey in interface IntKeysMap

Parameters:

procedure - the procedure to invoke for each key

forEachKeyValue

public void forEachKeyValue(IntCharProcedure procedure)

Description copied from interface: IntCharMap

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

Specified by:

forEachKeyValue in interface IntCharMap

Parameters:

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

keysView

public LazyIntIterable keysView()

Description copied from interface: IntCharMap

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 IntCharMap

Returns:

a view of the keys in this map

keyValuesView

public RichIterable<IntCharPair> keyValuesView()

Description copied from interface: IntCharMap

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 IntCharMap

Returns:

a view of the keys in this map

flipUniqueValues

public MutableCharIntMap flipUniqueValues()

Description copied from interface: IntCharMap

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

Specified by:

flipUniqueValues in interface IntCharMap

Specified by:

flipUniqueValues in interface MutableIntCharMap

select

public IntCharHashMap select(IntCharPredicate predicate)

Description copied from interface: IntCharMap

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

Specified by:

select in interface IntCharMap

Specified by:

select in interface MutableIntCharMap

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 IntCharHashMap reject(IntCharPredicate predicate)

Description copied from interface: IntCharMap

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

Specified by:

reject in interface IntCharMap

Specified by:

reject in interface MutableIntCharMap

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 MutableIntSet keySet()

Description copied from interface: IntCharMap

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 IntCharMap

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