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 anUnsupportedOperationException
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 asMap.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
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 anIllegalStateException
if no such mapping exists.int
hashCode()
Follows the same general contract asMap.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, forEach, forEachValue, isEmpty, max, min, noneSatisfy, notEmpty, reject, select, size, sum, toArray, toArray
Methods inherited from class org.eclipse.collections.impl.primitive.AbstractCharIterable
asLazy, average, containsAll, maxIfEmpty, median, minIfEmpty, toBag, toList, toSet, toSortedArray, toSortedList
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, count, detectIfNone, each, flatCollect, forEach, max, maxIfEmpty, median, medianIfEmpty, min, minIfEmpty, noneSatisfy, reduce, reduceIfEmpty, reject, select, sum, summaryStatistics, toArray, toArray, toBag, toList, toSet, toSortedArray, toSortedList
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
-
-
Method Details
-
newWithKeysValues
-
newWithKeysValues
-
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
Description copied from interface:CharCharMap
Follows the same general contract asMap.equals(Object)
.- Specified by:
equals
in interfaceCharCharMap
- Overrides:
equals
in classObject
-
hashCode
public int hashCode()Description copied from interface:CharCharMap
Follows the same general contract asMap.hashCode()
.- Specified by:
hashCode
in interfaceCharCharMap
- Overrides:
hashCode
in classObject
-
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 interfaceCharCharMap
- Specified by:
toString
in interfacePrimitiveIterable
- Overrides:
toString
in classAbstractCharIterable
- Returns:
- a string representation of this PrimitiveIterable
- See Also:
AbstractCollection.toString()
-
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 interfaceCharIterable
- Specified by:
charIterator
in interfaceMutableCharValuesMap
-
injectInto
public <V> V injectInto(V injectedValue, ObjectCharToObjectFunction<? super V,? extends V> function)- Specified by:
injectInto
in interfaceCharIterable
-
clear
public void clear()Description copied from interface:MutableCharValuesMap
Removes all entries from this map.- Specified by:
clear
in interfaceMutableCharKeysMap
- Specified by:
clear
in interfaceMutableCharValuesMap
-
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 withvalue
.- Specified by:
put
in interfaceMutableCharCharMap
- Parameters:
key
- the keyvalue
- the value to associate withvalue
-
putAll
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 inmap
.- Specified by:
putAll
in interfaceMutableCharCharMap
- Parameters:
map
- the map to copy into this map
-
updateValues
Description copied from interface:MutableCharCharMap
Updates the values in-place.- Specified by:
updateValues
in interfaceMutableCharCharMap
- 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 interfaceMutableCharCharMap
- Specified by:
removeKey
in interfaceMutableCharKeysMap
- 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 interfaceMutableCharCharMap
- 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 interfaceMutableCharCharMap
- Parameters:
key
- the key to removevalue
- 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 interfaceMutableCharCharMap
- Parameters:
key
- the keyvalue
- the value to associate withkey
if no such mapping exists- Returns:
- the value associated with key, if one exists, or
value
if not
-
getIfAbsentPut
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 interfaceMutableCharCharMap
- Parameters:
key
- the keyfunction
- the supplier that provides the value if no mapping exists forkey
- Returns:
- the value associated with the key, if one exists, or the result of
invoking
function
if not
-
getIfAbsentPutWith
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 interfaceMutableCharCharMap
- Type Parameters:
P
- the type of the value function'sparameter
- Parameters:
key
- the keyfunction
- the function that provides the value if no mapping exists. The specifiedparameter
will be passed as the argument to the function.parameter
- the parameter to provide tofunction
if no value exists forkey
- Returns:
- the value associated with the key, if one exists, or the result of
invoking
function
withparameter
if not
-
getIfAbsentPutWithKey
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 interfaceMutableCharCharMap
- Parameters:
key
- the keyfunction
- the function that provides the value if no mapping exists. Thekey
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
withkey
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 interfaceMutableCharCharMap
- Parameters:
key
- the keytoBeAdded
- 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 withkey
ortoBeAdded
if one does not
-
updateValue
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 interfaceMutableCharCharMap
- Parameters:
key
- the keyinitialValueIfAbsent
- the initial value to supply to the function if no mapping exists for the keyfunction
- 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 toinitialValueIfAbsent
and associating the result withkey
-
withKeyValue
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 withvalue
.- Specified by:
withKeyValue
in interfaceMutableCharCharMap
- Parameters:
key1
- the keyvalue1
- the value to associate withvalue
- Returns:
- this map
- See Also:
MutableCharCharMap.put(char, char)
-
withKeysValues
-
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
Description copied from interface:MutableCharCharMap
Removes the mapping associated with the key, if one exists, from this map.- Specified by:
withoutKey
in interfaceMutableCharCharMap
- Parameters:
key
- the key to remove- Returns:
- this map
- See Also:
MutableCharCharMap.remove(char)
-
withoutAllKeys
Description copied from interface:MutableCharCharMap
Removes the mappings associated with all the keys, if they exist, from this map.- Specified by:
withoutAllKeys
in interfaceMutableCharCharMap
- Parameters:
keys
- the keys to remove- Returns:
- this map
- See Also:
MutableCharCharMap.remove(char)
-
asUnmodifiable
Description copied from interface:MutableCharCharMap
Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing anUnsupportedOperationException
for all mutating operations. This avoids the overhead of copying the map when callingCharCharMap.toImmutable()
while still providing immutability.- Specified by:
asUnmodifiable
in interfaceMutableCharCharMap
- Returns:
- an unmodifiable view of this map
-
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 interfaceMutableCharCharMap
- Returns:
- a synchronized view of this map
-
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 interfaceCharCharMap
- 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 (usually0
) is returned.- Specified by:
get
in interfaceCharCharMap
- 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 interfaceCharCharMap
- Parameters:
key
- the keyifAbsent
- the default value to return if no mapping exists forkey
- 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 anIllegalStateException
if no such mapping exists.- Specified by:
getOrThrow
in interfaceCharCharMap
- 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 interfaceCharCharMap
- Specified by:
containsKey
in interfaceCharKeysMap
- Parameters:
key
- the key- Returns:
- if a mapping exists in this map for the key
-
forEachKey
Description copied from interface:CharCharMap
Iterates through each key in the map, invoking the procedure for each.- Specified by:
forEachKey
in interfaceCharCharMap
- Specified by:
forEachKey
in interfaceCharKeysMap
- Parameters:
procedure
- the procedure to invoke for each key
-
forEachKeyValue
Description copied from interface:CharCharMap
Iterates through each key/value pair in the map, invoking the procedure for each.- Specified by:
forEachKeyValue
in interfaceCharCharMap
- Parameters:
procedure
- the procedure to invoke for each key/value pair
-
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 interfaceCharCharMap
- Returns:
- a view of the keys in this map
-
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 interfaceCharCharMap
- Returns:
- a view of the keys in this map
-
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 interfaceCharCharMap
- Specified by:
flipUniqueValues
in interfaceMutableCharCharMap
-
select
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 interfaceCharCharMap
- Specified by:
select
in interfaceMutableCharCharMap
- 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
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 interfaceCharCharMap
- Specified by:
reject
in interfaceMutableCharCharMap
- 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
- Specified by:
writeExternal
in interfaceExternalizable
- Throws:
IOException
-
readExternal
- Specified by:
readExternal
in interfaceExternalizable
- 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
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 interfaceCharCharMap
- Returns:
- a mutable set containing the keys in this map
-
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 interfaceCharValuesMap
- Returns:
- the values as a collection backed by this map
-