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

Class CharLongHashMap

java.lang.Object

org.eclipse.collections.impl.primitive.AbstractLongIterable

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

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

All Implemented Interfaces:

Externalizable, Serializable, LongIterable, CharLongMap, LongValuesMap, MutableCharLongMap, MutableLongValuesMap, PrimitiveIterable, MutableCharKeysMap, CharKeysMap

public class CharLongHashMap
extends AbstractMutableLongValuesMap
implements MutableCharLongMap, Externalizable, MutableCharKeysMap

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

Since:

3.0.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CharLongHashMap()
CharLongHashMap(int initialCapacity)
CharLongHashMap(CharLongMap map)

Method Summary

Modifier and Type	Method	Description
long	addToValue(char key, long 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.
MutableCharLongMap	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.
MutableCharLongMap	asUnmodifiable()	Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an UnsupportedOperationException for all mutating operations.
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).
MutableLongCharMap	flipUniqueValues()	Return the LongCharMap 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(CharLongProcedure procedure)	Iterates through each key/value pair in the map, invoking the procedure for each.
long	get(char key)	Retrieves the value associated with the key.
long	getAndPut(char key, long putValue, long defaultValue)	Retrieves the value associated with the key if one exists; associates a putValue with the key.
long	getIfAbsent(char key, long ifAbsent)	Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
long	getIfAbsentPut(char key, long value)	Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.
long	getIfAbsentPut(char key, LongFunction0 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> long	getIfAbsentPutWith(char key, LongFunction<? 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.
long	getIfAbsentPutWithKey(char key, CharToLongFunction 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.
long	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, ObjectLongToObjectFunction<? 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<CharLongPair>	keyValuesView()	Returns a view of the key/value pairs in this map.
MutableLongIterator	longIterator()	Returns a primitive iterator that can be used to iterate over the LongIterable in an imperative style.
static CharLongHashMap	newWithKeysValues(char key1, long value1)
static CharLongHashMap	newWithKeysValues(char key1, long value1, char key2, long value2)
static CharLongHashMap	newWithKeysValues(char key1, long value1, char key2, long value2, char key3, long value3)
static CharLongHashMap	newWithKeysValues(char key1, long value1, char key2, long value2, char key3, long value3, char key4, long value4)
void	put(char key, long value)	Associates a value with the specified key.
void	putAll(CharLongMap map)	Puts all of the key/value mappings from the specified map into this map.
void	readExternal(ObjectInput in)
CharLongHashMap	reject(CharLongPredicate 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.
long	removeKeyIfAbsent(char key, long value)	Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.
CharLongHashMap	select(CharLongPredicate predicate)	Return a copy of this map containing only the key/value pairs that match the predicate.
ImmutableCharLongMap	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.
long	updateValue(char key, long initialValueIfAbsent, LongToLongFunction 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(CharLongToLongFunction function)	Updates the values in-place.
MutableLongCollection	values()	Returns the values in this map as a separate collection.
CharLongHashMap	withKeysValues(char key1, long value1, char key2, long value2)
CharLongHashMap	withKeysValues(char key1, long value1, char key2, long value2, char key3, long value3)
CharLongHashMap	withKeysValues(char key1, long value1, char key2, long value2, char key3, long value3, char key4, long value4)
CharLongHashMap	withKeyValue(char key1, long value1)	Associates a value with the specified key.
CharLongHashMap	withoutAllKeys(CharIterable keys)	Removes the mappings associated with all the keys, if they exist, from this map.
CharLongHashMap	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.AbstractMutableLongValuesMap

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.AbstractLongIterable

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

isEmpty, notEmpty, size

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

injectIntoKeyValue

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

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.LongValuesMap

containsValue, forEachValue, tap

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

putPair, withAllKeyValues

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

collect, reject, select

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

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

Constructor Details

CharLongHashMap

public CharLongHashMap()

CharLongHashMap

public CharLongHashMap(int initialCapacity)

CharLongHashMap

public CharLongHashMap(CharLongMap map)

Method Details

newWithKeysValues

public static CharLongHashMap newWithKeysValues(char key1,
 long value1)

newWithKeysValues

public static CharLongHashMap newWithKeysValues(char key1,
 long value1,
 char key2,
 long value2)

newWithKeysValues

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

newWithKeysValues

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

equals

public boolean equals(Object obj)

Description copied from interface: CharLongMap

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

Specified by:

equals in interface CharLongMap

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: CharLongMap

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

Specified by:

hashCode in interface CharLongMap

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 CharLongMap

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class AbstractLongIterable

Returns:

a string representation of this PrimitiveIterable

See Also:

• AbstractCollection.toString()

longIterator

public MutableLongIterator longIterator()

Description copied from interface: LongIterable

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

Specified by:

longIterator in interface LongIterable

Specified by:

longIterator in interface MutableLongValuesMap

injectInto

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

Specified by:

injectInto in interface LongIterable

clear

public void clear()

Description copied from interface: MutableLongValuesMap

Removes all entries from this map.

Specified by:

clear in interface MutableCharKeysMap

Specified by:

clear in interface MutableLongValuesMap

put

public void put(char key,
 long value)

Description copied from interface: MutableCharLongMap

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 MutableCharLongMap

Parameters:

key - the key

value - the value to associate with value

putAll

public void putAll(CharLongMap map)

Description copied from interface: MutableCharLongMap

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 MutableCharLongMap

Parameters:

map - the map to copy into this map

updateValues

public void updateValues(CharLongToLongFunction function)

Description copied from interface: MutableCharLongMap

Updates the values in-place.

Specified by:

updateValues in interface MutableCharLongMap

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: MutableCharLongMap

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

Specified by:

removeKey in interface MutableCharKeysMap

Specified by:

removeKey in interface MutableCharLongMap

Parameters:

key - the key to remove

See Also:

• MutableCharLongMap.remove(char)

remove

public void remove(char key)

Description copied from interface: MutableCharLongMap

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

Specified by:

remove in interface MutableCharLongMap

Parameters:

key - the key to remove

See Also:

• MutableCharLongMap.removeKey(char)

removeKeyIfAbsent

public long removeKeyIfAbsent(char key,
 long value)

Description copied from interface: MutableCharLongMap

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 MutableCharLongMap

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

Description copied from interface: MutableCharLongMap

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 MutableCharLongMap

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

Description copied from interface: MutableCharLongMap

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

Specified by:

getAndPut in interface MutableCharLongMap

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 long getIfAbsentPut(char key,
 LongFunction0 function)

Description copied from interface: MutableCharLongMap

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 MutableCharLongMap

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

Description copied from interface: MutableCharLongMap

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 MutableCharLongMap

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

Description copied from interface: MutableCharLongMap

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 MutableCharLongMap

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

Description copied from interface: MutableCharLongMap

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 MutableCharLongMap

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 long updateValue(char key,
 long initialValueIfAbsent,
 LongToLongFunction function)

Description copied from interface: MutableCharLongMap

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 MutableCharLongMap

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 CharLongHashMap withKeyValue(char key1,
 long value1)

Description copied from interface: MutableCharLongMap

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 MutableCharLongMap

Parameters:

key1 - the key

value1 - the value to associate with value

Returns:

this map

See Also:

• MutableCharLongMap.put(char, long)

withKeysValues

public CharLongHashMap withKeysValues(char key1,
 long value1,
 char key2,
 long value2)

withKeysValues

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

withKeysValues

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

withoutKey

public CharLongHashMap withoutKey(char key)

Description copied from interface: MutableCharLongMap

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

Specified by:

withoutKey in interface MutableCharLongMap

Parameters:

key - the key to remove

Returns:

this map

See Also:

• MutableCharLongMap.remove(char)

withoutAllKeys

public CharLongHashMap withoutAllKeys(CharIterable keys)

Description copied from interface: MutableCharLongMap

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

Specified by:

withoutAllKeys in interface MutableCharLongMap

Parameters:

keys - the keys to remove

Returns:

this map

See Also:

• MutableCharLongMap.remove(char)

asUnmodifiable

public MutableCharLongMap asUnmodifiable()

Description copied from interface: MutableCharLongMap

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

Specified by:

asUnmodifiable in interface MutableCharLongMap

Returns:

an unmodifiable view of this map

asSynchronized

public MutableCharLongMap asSynchronized()

Description copied from interface: MutableCharLongMap

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 MutableCharLongMap

Returns:

a synchronized view of this map

toImmutable

public ImmutableCharLongMap toImmutable()

Description copied from interface: CharLongMap

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 CharLongMap

Returns:

an immutable map that is equivalent to this one

get

public long get(char key)

Description copied from interface: CharLongMap

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 CharLongMap

Parameters:

key - the key

Returns:

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

getIfAbsent

public long getIfAbsent(char key,
 long ifAbsent)

Description copied from interface: CharLongMap

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

Specified by:

getIfAbsent in interface CharLongMap

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

Description copied from interface: CharLongMap

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

Specified by:

getOrThrow in interface CharLongMap

Parameters:

key - the key

Returns:

the value associated with the key

containsKey

public boolean containsKey(char key)

Description copied from interface: CharLongMap

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

Specified by:

containsKey in interface CharKeysMap

Specified by:

containsKey in interface CharLongMap

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: CharLongMap

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

Specified by:

forEachKey in interface CharKeysMap

Specified by:

forEachKey in interface CharLongMap

Parameters:

procedure - the procedure to invoke for each key

forEachKeyValue

public void forEachKeyValue(CharLongProcedure procedure)

Description copied from interface: CharLongMap

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

Specified by:

forEachKeyValue in interface CharLongMap

Parameters:

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

keysView

public LazyCharIterable keysView()

Description copied from interface: CharLongMap

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 CharLongMap

Returns:

a view of the keys in this map

keyValuesView

public RichIterable<CharLongPair> keyValuesView()

Description copied from interface: CharLongMap

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 CharLongMap

Returns:

a view of the keys in this map

flipUniqueValues

public MutableLongCharMap flipUniqueValues()

Description copied from interface: CharLongMap

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

Specified by:

flipUniqueValues in interface CharLongMap

Specified by:

flipUniqueValues in interface MutableCharLongMap

select

public CharLongHashMap select(CharLongPredicate predicate)

Description copied from interface: CharLongMap

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

Specified by:

select in interface CharLongMap

Specified by:

select in interface MutableCharLongMap

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 CharLongHashMap reject(CharLongPredicate predicate)

Description copied from interface: CharLongMap

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

Specified by:

reject in interface CharLongMap

Specified by:

reject in interface MutableCharLongMap

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: CharLongMap

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 CharLongMap

Returns:

a mutable set containing the keys in this map

values

public MutableLongCollection values()

Description copied from interface: LongValuesMap

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 LongValuesMap

Returns:

the values as a collection backed by this map