Class DoubleCharHashMap
java.lang.Object
org.eclipse.collections.impl.primitive.AbstractCharIterable
org.eclipse.collections.impl.map.mutable.primitive.AbstractMutableCharValuesMap
org.eclipse.collections.impl.map.mutable.primitive.DoubleCharHashMap
- All Implemented Interfaces:
Externalizable,Serializable,CharIterable,CharValuesMap,DoubleCharMap,MutableCharValuesMap,MutableDoubleCharMap,PrimitiveIterable,MutableDoubleKeysMap,DoubleKeysMap
public class DoubleCharHashMap extends AbstractMutableCharValuesMap implements MutableDoubleCharMap, Externalizable, MutableDoubleKeysMap
This file was automatically generated from template file primitivePrimitiveHashMap.stg.
- Since:
- 3.0.
- See Also:
- Serialized Form
-
Constructor Summary
Constructors Constructor Description DoubleCharHashMap()DoubleCharHashMap(int initialCapacity)DoubleCharHashMap(DoubleCharMap map) -
Method Summary
Modifier and Type Method Description charaddToValue(double 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.MutableDoubleCharMapasSynchronized()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.MutableDoubleCharMapasUnmodifiable()Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing anUnsupportedOperationExceptionfor all mutating operations.MutableCharIteratorcharIterator()Returns a primitive iterator that can be used to iterate over the CharIterable in an imperative style.voidclear()Removes all entries from this map.voidcompact()Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels.booleancontainsKey(double key)Returns whether or not the key is present in the map.booleanequals(Object obj)Follows the same general contract asMap.equals(Object).MutableCharDoubleMapflipUniqueValues()Return the CharDoubleMap that is obtained by flipping the direction of this map and making the associations from value to key.voidforEachKey(DoubleProcedure procedure)Iterates through each key in the map, invoking the procedure for each.voidforEachKeyValue(DoubleCharProcedure procedure)Iterates through each key/value pair in the map, invoking the procedure for each.charget(double key)Retrieves the value associated with the key.chargetIfAbsent(double key, char ifAbsent)Retrieves the value associated with the key, returning the specified default value if no such mapping exists.chargetIfAbsentPut(double key, char value)Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.chargetIfAbsentPut(double 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> chargetIfAbsentPutWith(double 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.chargetIfAbsentPutWithKey(double key, DoubleToCharFunction 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.chargetOrThrow(double key)Retrieves the value associated with the key, throwing anIllegalStateExceptionif no such mapping exists.inthashCode()Follows the same general contract asMap.hashCode().<V> VinjectInto(V injectedValue, ObjectCharToObjectFunction<? super V,? extends V> function)MutableDoubleSetkeySet()Returns a set containing all the keys in this map.LazyDoubleIterablekeysView()Returns a view of the keys in this map.RichIterable<DoubleCharPair>keyValuesView()Returns a view of the key/value pairs in this map.static DoubleCharHashMapnewWithKeysValues(double key1, char value1)static DoubleCharHashMapnewWithKeysValues(double key1, char value1, double key2, char value2)static DoubleCharHashMapnewWithKeysValues(double key1, char value1, double key2, char value2, double key3, char value3)static DoubleCharHashMapnewWithKeysValues(double key1, char value1, double key2, char value2, double key3, char value3, double key4, char value4)voidput(double key, char value)Associates a value with the specified key.voidputAll(DoubleCharMap map)Puts all of the key/value mappings from the specified map into this map.voidreadExternal(ObjectInput in)DoubleCharHashMapreject(DoubleCharPredicate predicate)Return a copy of this map containing only the key/value pairs that do not match the predicate.voidremove(double key)Removes the mapping associated with the key, if one exists, from the map.voidremoveKey(double key)Removes the mapping associated with the key, if one exists, from the map.charremoveKeyIfAbsent(double key, char value)Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.DoubleCharHashMapselect(DoubleCharPredicate predicate)Return a copy of this map containing only the key/value pairs that match the predicate.ImmutableDoubleCharMaptoImmutable()Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.StringtoString()Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.charupdateValue(double 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.voidupdateValues(DoubleCharToCharFunction function)Updates the values in-place.MutableCharCollectionvalues()Returns the values in this map as a separate collection.DoubleCharHashMapwithKeysValues(double key1, char value1, double key2, char value2)DoubleCharHashMapwithKeysValues(double key1, char value1, double key2, char value2, double key3, char value3)DoubleCharHashMapwithKeysValues(double key1, char value1, double key2, char value2, double key3, char value3, double key4, char value4)DoubleCharHashMapwithKeyValue(double key1, char value1)Associates a value with the specified key.DoubleCharHashMapwithoutAllKeys(DoubleIterable keys)Removes the mappings associated with all the keys, if they exist, from this map.DoubleCharHashMapwithoutKey(double key)Removes the mapping associated with the key, if one exists, from this map.voidwriteExternal(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, toArrayMethods inherited from class org.eclipse.collections.impl.primitive.AbstractCharIterable
asLazy, average, containsAll, maxIfEmpty, median, minIfEmpty, toBag, toList, toSet, toSortedArray, toSortedListMethods 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, toSortedListMethods inherited from interface org.eclipse.collections.api.map.primitive.CharValuesMap
containsValue, forEachValue, tapMethods inherited from interface org.eclipse.collections.impl.map.primitive.DoubleKeysMap
isEmpty, notEmpty, sizeMethods inherited from interface org.eclipse.collections.api.map.primitive.MutableCharValuesMap
collect, reject, selectMethods inherited from interface org.eclipse.collections.api.map.primitive.MutableDoubleCharMap
putPair, withAllKeyValuesMethods inherited from interface org.eclipse.collections.api.PrimitiveIterable
appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size
-
Constructor Details
-
DoubleCharHashMap
public DoubleCharHashMap() -
DoubleCharHashMap
public DoubleCharHashMap(int initialCapacity) -
DoubleCharHashMap
-
-
Method Details
-
newWithKeysValues
-
newWithKeysValues
public static DoubleCharHashMap newWithKeysValues(double key1, char value1, double key2, char value2) -
newWithKeysValues
public static DoubleCharHashMap newWithKeysValues(double key1, char value1, double key2, char value2, double key3, char value3) -
newWithKeysValues
public static DoubleCharHashMap newWithKeysValues(double key1, char value1, double key2, char value2, double key3, char value3, double key4, char value4) -
equals
Description copied from interface:DoubleCharMapFollows the same general contract asMap.equals(Object).- Specified by:
equalsin interfaceDoubleCharMap- Overrides:
equalsin classObject
-
hashCode
public int hashCode()Description copied from interface:DoubleCharMapFollows the same general contract asMap.hashCode().- Specified by:
hashCodein interfaceDoubleCharMap- Overrides:
hashCodein classObject
-
toString
Description copied from interface:PrimitiveIterableReturns 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:
toStringin interfaceDoubleCharMap- Specified by:
toStringin interfacePrimitiveIterable- Overrides:
toStringin classAbstractCharIterable- Returns:
- a string representation of this PrimitiveIterable
- See Also:
AbstractCollection.toString()
-
charIterator
Description copied from interface:CharIterableReturns a primitive iterator that can be used to iterate over the CharIterable in an imperative style.- Specified by:
charIteratorin interfaceCharIterable- Specified by:
charIteratorin interfaceMutableCharValuesMap
-
injectInto
public <V> V injectInto(V injectedValue, ObjectCharToObjectFunction<? super V,? extends V> function)- Specified by:
injectIntoin interfaceCharIterable
-
clear
public void clear()Description copied from interface:MutableCharValuesMapRemoves all entries from this map.- Specified by:
clearin interfaceMutableCharValuesMap- Specified by:
clearin interfaceMutableDoubleKeysMap
-
put
public void put(double key, char value)Description copied from interface:MutableDoubleCharMapAssociates 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:
putin interfaceMutableDoubleCharMap- Parameters:
key- the keyvalue- the value to associate withvalue
-
putAll
Description copied from interface:MutableDoubleCharMapPuts 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:
putAllin interfaceMutableDoubleCharMap- Parameters:
map- the map to copy into this map
-
updateValues
Description copied from interface:MutableDoubleCharMapUpdates the values in-place.- Specified by:
updateValuesin interfaceMutableDoubleCharMap- Parameters:
function- that takes a key and its value and that returns a new value for this key
-
removeKey
public void removeKey(double key)Description copied from interface:MutableDoubleCharMapRemoves the mapping associated with the key, if one exists, from the map.- Specified by:
removeKeyin interfaceMutableDoubleCharMap- Specified by:
removeKeyin interfaceMutableDoubleKeysMap- Parameters:
key- the key to remove- See Also:
MutableDoubleCharMap.remove(double)
-
remove
public void remove(double key)Description copied from interface:MutableDoubleCharMapRemoves the mapping associated with the key, if one exists, from the map.- Specified by:
removein interfaceMutableDoubleCharMap- Parameters:
key- the key to remove- See Also:
MutableDoubleCharMap.removeKey(double)
-
removeKeyIfAbsent
public char removeKeyIfAbsent(double key, char value)Description copied from interface:MutableDoubleCharMapRemoves 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:
removeKeyIfAbsentin interfaceMutableDoubleCharMap- 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
valueif not
-
getIfAbsentPut
public char getIfAbsentPut(double key, char value)Description copied from interface:MutableDoubleCharMapRetrieves the value associated with the key if one exists; if it does not, associates a value with the key.- Specified by:
getIfAbsentPutin interfaceMutableDoubleCharMap- Parameters:
key- the keyvalue- the value to associate withkeyif no such mapping exists- Returns:
- the value associated with key, if one exists, or
valueif not
-
getIfAbsentPut
Description copied from interface:MutableDoubleCharMapRetrieves 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:
getIfAbsentPutin interfaceMutableDoubleCharMap- 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
functionif not
-
getIfAbsentPutWith
Description copied from interface:MutableDoubleCharMapRetrieves 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:
getIfAbsentPutWithin interfaceMutableDoubleCharMap- 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 specifiedparameterwill be passed as the argument to the function.parameter- the parameter to provide tofunctionif no value exists forkey- Returns:
- the value associated with the key, if one exists, or the result of
invoking
functionwithparameterif not
-
getIfAbsentPutWithKey
Description copied from interface:MutableDoubleCharMapRetrieves 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:
getIfAbsentPutWithKeyin interfaceMutableDoubleCharMap- Parameters:
key- the keyfunction- the function that provides the value if no mapping exists. Thekeywill be passed as the argument to the function.- Returns:
- the value associated with the key, if one exists, or the result of
invoking
functionwithkeyif not
-
addToValue
public char addToValue(double key, char toBeAdded)Description copied from interface:MutableDoubleCharMapIncrements 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:
addToValuein interfaceMutableDoubleCharMap- 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
toBeAddedto the existing value associated withkeyortoBeAddedif one does not
-
updateValue
Description copied from interface:MutableDoubleCharMapUpdates 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:
updateValuein interfaceMutableDoubleCharMap- 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
functionto the value already associated with the key or as a result of applying it toinitialValueIfAbsentand associating the result withkey
-
withKeyValue
Description copied from interface:MutableDoubleCharMapAssociates 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:
withKeyValuein interfaceMutableDoubleCharMap- Parameters:
key1- the keyvalue1- the value to associate withvalue- Returns:
- this map
- See Also:
MutableDoubleCharMap.put(double, char)
-
withKeysValues
-
withKeysValues
public DoubleCharHashMap withKeysValues(double key1, char value1, double key2, char value2, double key3, char value3) -
withKeysValues
public DoubleCharHashMap withKeysValues(double key1, char value1, double key2, char value2, double key3, char value3, double key4, char value4) -
withoutKey
Description copied from interface:MutableDoubleCharMapRemoves the mapping associated with the key, if one exists, from this map.- Specified by:
withoutKeyin interfaceMutableDoubleCharMap- Parameters:
key- the key to remove- Returns:
- this map
- See Also:
MutableDoubleCharMap.remove(double)
-
withoutAllKeys
Description copied from interface:MutableDoubleCharMapRemoves the mappings associated with all the keys, if they exist, from this map.- Specified by:
withoutAllKeysin interfaceMutableDoubleCharMap- Parameters:
keys- the keys to remove- Returns:
- this map
- See Also:
MutableDoubleCharMap.remove(double)
-
asUnmodifiable
Description copied from interface:MutableDoubleCharMapReturns an unmodifiable view of this map, delegating all read-only operations to this map and throwing anUnsupportedOperationExceptionfor all mutating operations. This avoids the overhead of copying the map when callingDoubleCharMap.toImmutable()while still providing immutability.- Specified by:
asUnmodifiablein interfaceMutableDoubleCharMap- Returns:
- an unmodifiable view of this map
-
asSynchronized
Description copied from interface:MutableDoubleCharMapReturns 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:
asSynchronizedin interfaceMutableDoubleCharMap- Returns:
- a synchronized view of this map
-
toImmutable
Description copied from interface:DoubleCharMapReturns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.- Specified by:
toImmutablein interfaceDoubleCharMap- Returns:
- an immutable map that is equivalent to this one
-
get
public char get(double key)Description copied from interface:DoubleCharMapRetrieves the value associated with the key. If no mapping exists for the key, the default value (usually0) is returned.- Specified by:
getin interfaceDoubleCharMap- Parameters:
key- the key- Returns:
- the value associated with the key, or the default value if no such mapping exists
-
getIfAbsent
public char getIfAbsent(double key, char ifAbsent)Description copied from interface:DoubleCharMapRetrieves the value associated with the key, returning the specified default value if no such mapping exists.- Specified by:
getIfAbsentin interfaceDoubleCharMap- Parameters:
key- the keyifAbsent- the default value to return if no mapping exists forkey- Returns:
- the value associated with the key, or
ifAbsentif no such mapping exists.
-
getOrThrow
public char getOrThrow(double key)Description copied from interface:DoubleCharMapRetrieves the value associated with the key, throwing anIllegalStateExceptionif no such mapping exists.- Specified by:
getOrThrowin interfaceDoubleCharMap- Parameters:
key- the key- Returns:
- the value associated with the key
-
containsKey
public boolean containsKey(double key)Description copied from interface:DoubleCharMapReturns whether or not the key is present in the map.- Specified by:
containsKeyin interfaceDoubleCharMap- Specified by:
containsKeyin interfaceDoubleKeysMap- Parameters:
key- the key- Returns:
- if a mapping exists in this map for the key
-
forEachKey
Description copied from interface:DoubleCharMapIterates through each key in the map, invoking the procedure for each.- Specified by:
forEachKeyin interfaceDoubleCharMap- Specified by:
forEachKeyin interfaceDoubleKeysMap- Parameters:
procedure- the procedure to invoke for each key
-
forEachKeyValue
Description copied from interface:DoubleCharMapIterates through each key/value pair in the map, invoking the procedure for each.- Specified by:
forEachKeyValuein interfaceDoubleCharMap- Parameters:
procedure- the procedure to invoke for each key/value pair
-
keysView
Description copied from interface:DoubleCharMapReturns 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:
keysViewin interfaceDoubleCharMap- Returns:
- a view of the keys in this map
-
keyValuesView
Description copied from interface:DoubleCharMapReturns 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:
keyValuesViewin interfaceDoubleCharMap- Returns:
- a view of the keys in this map
-
flipUniqueValues
Description copied from interface:DoubleCharMapReturn the CharDoubleMap that is obtained by flipping the direction of this map and making the associations from value to key.- Specified by:
flipUniqueValuesin interfaceDoubleCharMap- Specified by:
flipUniqueValuesin interfaceMutableDoubleCharMap
-
select
Description copied from interface:DoubleCharMapReturn a copy of this map containing only the key/value pairs that match the predicate.- Specified by:
selectin interfaceDoubleCharMap- Specified by:
selectin interfaceMutableDoubleCharMap- 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:DoubleCharMapReturn a copy of this map containing only the key/value pairs that do not match the predicate.- Specified by:
rejectin interfaceDoubleCharMap- Specified by:
rejectin interfaceMutableDoubleCharMap- 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:
writeExternalin interfaceExternalizable- Throws:
IOException
-
readExternal
- Specified by:
readExternalin interfaceExternalizable- Throws:
IOExceptionClassNotFoundException
-
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:DoubleCharMapReturns 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:
keySetin interfaceDoubleCharMap- Returns:
- a mutable set containing the keys in this map
-
values
Description copied from interface:CharValuesMapReturns 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:
valuesin interfaceCharValuesMap- Returns:
- the values as a collection backed by this map
-