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

Class CharShortHashMap

java.lang.Object

org.eclipse.collections.impl.primitive.AbstractShortIterable

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

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

All Implemented Interfaces:

Externalizable, Serializable, CharShortMap, MutableCharShortMap, MutableShortValuesMap, ShortValuesMap, PrimitiveIterable, ShortIterable, MutableCharKeysMap, CharKeysMap

public class CharShortHashMap
extends AbstractMutableShortValuesMap
implements MutableCharShortMap, Externalizable, MutableCharKeysMap

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

Since:

3.0.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CharShortHashMap()
CharShortHashMap(int initialCapacity)
CharShortHashMap(CharShortMap map)

Method Summary

Modifier and Type	Method	Description
short	addToValue(char key, short 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.
MutableCharShortMap	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.
MutableCharShortMap	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).
MutableShortCharMap	flipUniqueValues()	Return the ShortCharMap 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(CharShortProcedure procedure)	Iterates through each key/value pair in the map, invoking the procedure for each.
short	get(char key)	Retrieves the value associated with the key.
short	getAndPut(char key, short putValue, short defaultValue)	Retrieves the value associated with the key if one exists; associates a putValue with the key.
short	getIfAbsent(char key, short ifAbsent)	Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
short	getIfAbsentPut(char key, short value)	Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.
short	getIfAbsentPut(char key, ShortFunction0 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> short	getIfAbsentPutWith(char key, ShortFunction<? 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.
short	getIfAbsentPutWithKey(char key, CharToShortFunction 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.
short	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, ObjectShortToObjectFunction<? 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<CharShortPair>	keyValuesView()	Returns a view of the key/value pairs in this map.
static CharShortHashMap	newWithKeysValues(char key1, short value1)
static CharShortHashMap	newWithKeysValues(char key1, short value1, char key2, short value2)
static CharShortHashMap	newWithKeysValues(char key1, short value1, char key2, short value2, char key3, short value3)
static CharShortHashMap	newWithKeysValues(char key1, short value1, char key2, short value2, char key3, short value3, char key4, short value4)
void	put(char key, short value)	Associates a value with the specified key.
void	putAll(CharShortMap map)	Puts all of the key/value mappings from the specified map into this map.
void	readExternal(ObjectInput in)
CharShortHashMap	reject(CharShortPredicate 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.
short	removeKeyIfAbsent(char key, short value)	Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.
CharShortHashMap	select(CharShortPredicate predicate)	Return a copy of this map containing only the key/value pairs that match the predicate.
MutableShortIterator	shortIterator()	Returns a primitive iterator that can be used to iterate over the ShortIterable in an imperative style.
ImmutableCharShortMap	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.
short	updateValue(char key, short initialValueIfAbsent, ShortToShortFunction 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(CharShortToShortFunction function)	Updates the values in-place.
MutableShortCollection	values()	Returns the values in this map as a separate collection.
CharShortHashMap	withKeysValues(char key1, short value1, char key2, short value2)
CharShortHashMap	withKeysValues(char key1, short value1, char key2, short value2, char key3, short value3)
CharShortHashMap	withKeysValues(char key1, short value1, char key2, short value2, char key3, short value3, char key4, short value4)
CharShortHashMap	withKeyValue(char key1, short value1)	Associates a value with the specified key.
CharShortHashMap	withoutAllKeys(CharIterable keys)	Removes the mappings associated with all the keys, if they exist, from this map.
CharShortHashMap	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.AbstractMutableShortValuesMap

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

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

injectIntoKeyValue

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

putPair, withAllKeyValues

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

collect, reject, select

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

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

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

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

containsValue, forEachValue, tap

Constructor Details

CharShortHashMap

public CharShortHashMap()

CharShortHashMap

public CharShortHashMap(int initialCapacity)

CharShortHashMap

public CharShortHashMap(CharShortMap map)

Method Details

newWithKeysValues

public static CharShortHashMap newWithKeysValues(char key1,
 short value1)

newWithKeysValues

public static CharShortHashMap newWithKeysValues(char key1,
 short value1,
 char key2,
 short value2)

newWithKeysValues

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

newWithKeysValues

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

equals

public boolean equals(Object obj)

Description copied from interface: CharShortMap

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

Specified by:

equals in interface CharShortMap

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: CharShortMap

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

Specified by:

hashCode in interface CharShortMap

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 CharShortMap

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class AbstractShortIterable

Returns:

a string representation of this PrimitiveIterable

See Also:

• AbstractCollection.toString()

shortIterator

public MutableShortIterator shortIterator()

Description copied from interface: ShortIterable

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

Specified by:

shortIterator in interface MutableShortValuesMap

Specified by:

shortIterator in interface ShortIterable

injectInto

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

Specified by:

injectInto in interface ShortIterable

clear

public void clear()

Description copied from interface: MutableShortValuesMap

Removes all entries from this map.

Specified by:

clear in interface MutableCharKeysMap

Specified by:

clear in interface MutableShortValuesMap

put

public void put(char key,
 short value)

Description copied from interface: MutableCharShortMap

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 MutableCharShortMap

Parameters:

key - the key

value - the value to associate with value

putAll

public void putAll(CharShortMap map)

Description copied from interface: MutableCharShortMap

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 MutableCharShortMap

Parameters:

map - the map to copy into this map

updateValues

public void updateValues(CharShortToShortFunction function)

Description copied from interface: MutableCharShortMap

Updates the values in-place.

Specified by:

updateValues in interface MutableCharShortMap

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

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

Specified by:

removeKey in interface MutableCharKeysMap

Specified by:

removeKey in interface MutableCharShortMap

Parameters:

key - the key to remove

See Also:

• MutableCharShortMap.remove(char)

remove

public void remove(char key)

Description copied from interface: MutableCharShortMap

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

Specified by:

remove in interface MutableCharShortMap

Parameters:

key - the key to remove

See Also:

• MutableCharShortMap.removeKey(char)

removeKeyIfAbsent

public short removeKeyIfAbsent(char key,
 short value)

Description copied from interface: MutableCharShortMap

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 MutableCharShortMap

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

Description copied from interface: MutableCharShortMap

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 MutableCharShortMap

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

Description copied from interface: MutableCharShortMap

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

Specified by:

getAndPut in interface MutableCharShortMap

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 short getIfAbsentPut(char key,
 ShortFunction0 function)

Description copied from interface: MutableCharShortMap

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 MutableCharShortMap

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

Description copied from interface: MutableCharShortMap

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 MutableCharShortMap

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

Description copied from interface: MutableCharShortMap

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 MutableCharShortMap

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

Description copied from interface: MutableCharShortMap

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 MutableCharShortMap

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

Description copied from interface: MutableCharShortMap

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 MutableCharShortMap

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 CharShortHashMap withKeyValue(char key1,
 short value1)

Description copied from interface: MutableCharShortMap

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 MutableCharShortMap

Parameters:

key1 - the key

value1 - the value to associate with value

Returns:

this map

See Also:

• MutableCharShortMap.put(char, short)

withKeysValues

public CharShortHashMap withKeysValues(char key1,
 short value1,
 char key2,
 short value2)

withKeysValues

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

withKeysValues

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

withoutKey

public CharShortHashMap withoutKey(char key)

Description copied from interface: MutableCharShortMap

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

Specified by:

withoutKey in interface MutableCharShortMap

Parameters:

key - the key to remove

Returns:

this map

See Also:

• MutableCharShortMap.remove(char)

withoutAllKeys

public CharShortHashMap withoutAllKeys(CharIterable keys)

Description copied from interface: MutableCharShortMap

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

Specified by:

withoutAllKeys in interface MutableCharShortMap

Parameters:

keys - the keys to remove

Returns:

this map

See Also:

• MutableCharShortMap.remove(char)

asUnmodifiable

public MutableCharShortMap asUnmodifiable()

Description copied from interface: MutableCharShortMap

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

Specified by:

asUnmodifiable in interface MutableCharShortMap

Returns:

an unmodifiable view of this map

asSynchronized

public MutableCharShortMap asSynchronized()

Description copied from interface: MutableCharShortMap

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 MutableCharShortMap

Returns:

a synchronized view of this map

toImmutable

public ImmutableCharShortMap toImmutable()

Description copied from interface: CharShortMap

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 CharShortMap

Returns:

an immutable map that is equivalent to this one

get

public short get(char key)

Description copied from interface: CharShortMap

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 CharShortMap

Parameters:

key - the key

Returns:

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

getIfAbsent

public short getIfAbsent(char key,
 short ifAbsent)

Description copied from interface: CharShortMap

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

Specified by:

getIfAbsent in interface CharShortMap

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

Description copied from interface: CharShortMap

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

Specified by:

getOrThrow in interface CharShortMap

Parameters:

key - the key

Returns:

the value associated with the key

containsKey

public boolean containsKey(char key)

Description copied from interface: CharShortMap

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

Specified by:

containsKey in interface CharKeysMap

Specified by:

containsKey in interface CharShortMap

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

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

Specified by:

forEachKey in interface CharKeysMap

Specified by:

forEachKey in interface CharShortMap

Parameters:

procedure - the procedure to invoke for each key

forEachKeyValue

public void forEachKeyValue(CharShortProcedure procedure)

Description copied from interface: CharShortMap

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

Specified by:

forEachKeyValue in interface CharShortMap

Parameters:

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

keysView

public LazyCharIterable keysView()

Description copied from interface: CharShortMap

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 CharShortMap

Returns:

a view of the keys in this map

keyValuesView

public RichIterable<CharShortPair> keyValuesView()

Description copied from interface: CharShortMap

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 CharShortMap

Returns:

a view of the keys in this map

flipUniqueValues

public MutableShortCharMap flipUniqueValues()

Description copied from interface: CharShortMap

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

Specified by:

flipUniqueValues in interface CharShortMap

Specified by:

flipUniqueValues in interface MutableCharShortMap

select

public CharShortHashMap select(CharShortPredicate predicate)

Description copied from interface: CharShortMap

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

Specified by:

select in interface CharShortMap

Specified by:

select in interface MutableCharShortMap

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 CharShortHashMap reject(CharShortPredicate predicate)

Description copied from interface: CharShortMap

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

Specified by:

reject in interface CharShortMap

Specified by:

reject in interface MutableCharShortMap

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

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 CharShortMap

Returns:

a mutable set containing the keys in this map

values

public MutableShortCollection values()

Description copied from interface: ShortValuesMap

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 ShortValuesMap

Returns:

the values as a collection backed by this map