Class CharFloatHashMap
java.lang.Object
org.eclipse.collections.impl.primitive.AbstractFloatIterable
org.eclipse.collections.impl.map.mutable.primitive.AbstractMutableFloatValuesMap
org.eclipse.collections.impl.map.mutable.primitive.CharFloatHashMap
- All Implemented Interfaces:
Externalizable,Serializable,FloatIterable,CharFloatMap,FloatValuesMap,MutableCharFloatMap,MutableFloatValuesMap,PrimitiveIterable,MutableCharKeysMap,CharKeysMap
public class CharFloatHashMap extends AbstractMutableFloatValuesMap implements MutableCharFloatMap, Externalizable, MutableCharKeysMap
This file was automatically generated from template file primitivePrimitiveHashMap.stg.
- Since:
- 3.0.
- See Also:
- Serialized Form
-
Constructor Summary
Constructors Constructor Description CharFloatHashMap()CharFloatHashMap(int initialCapacity)CharFloatHashMap(CharFloatMap map) -
Method Summary
Modifier and Type Method Description floataddToValue(char key, float 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.MutableCharFloatMapasSynchronized()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.MutableCharFloatMapasUnmodifiable()Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing anUnsupportedOperationExceptionfor all mutating operations.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(char key)Returns whether or not the key is present in the map.booleanequals(Object obj)Follows the same general contract asMap.equals(Object).MutableFloatCharMapflipUniqueValues()Return the FloatCharMap that is obtained by flipping the direction of this map and making the associations from value to key.MutableFloatIteratorfloatIterator()Returns a primitive iterator that can be used to iterate over the FloatIterable in an imperative style.voidforEachKey(CharProcedure procedure)Iterates through each key in the map, invoking the procedure for each.voidforEachKeyValue(CharFloatProcedure procedure)Iterates through each key/value pair in the map, invoking the procedure for each.floatget(char key)Retrieves the value associated with the key.floatgetIfAbsent(char key, float ifAbsent)Retrieves the value associated with the key, returning the specified default value if no such mapping exists.floatgetIfAbsentPut(char key, float value)Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.floatgetIfAbsentPut(char key, FloatFunction0 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> floatgetIfAbsentPutWith(char key, FloatFunction<? 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.floatgetIfAbsentPutWithKey(char key, CharToFloatFunction 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.floatgetOrThrow(char 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, ObjectFloatToObjectFunction<? super V,? extends V> function)MutableCharSetkeySet()Returns a set containing all the keys in this map.LazyCharIterablekeysView()Returns a view of the keys in this map.RichIterable<CharFloatPair>keyValuesView()Returns a view of the key/value pairs in this map.static CharFloatHashMapnewWithKeysValues(char key1, float value1)static CharFloatHashMapnewWithKeysValues(char key1, float value1, char key2, float value2)static CharFloatHashMapnewWithKeysValues(char key1, float value1, char key2, float value2, char key3, float value3)static CharFloatHashMapnewWithKeysValues(char key1, float value1, char key2, float value2, char key3, float value3, char key4, float value4)voidput(char key, float value)Associates a value with the specified key.voidputAll(CharFloatMap map)Puts all of the key/value mappings from the specified map into this map.voidreadExternal(ObjectInput in)CharFloatHashMapreject(CharFloatPredicate predicate)Return a copy of this map containing only the key/value pairs that do not match the predicate.voidremove(char key)Removes the mapping associated with the key, if one exists, from the map.voidremoveKey(char key)Removes the mapping associated with the key, if one exists, from the map.floatremoveKeyIfAbsent(char key, float value)Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.CharFloatHashMapselect(CharFloatPredicate predicate)Return a copy of this map containing only the key/value pairs that match the predicate.ImmutableCharFloatMaptoImmutable()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.floatupdateValue(char key, float initialValueIfAbsent, FloatToFloatFunction 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(CharFloatToFloatFunction function)Updates the values in-place.MutableFloatCollectionvalues()Returns the values in this map as a separate collection.CharFloatHashMapwithKeysValues(char key1, float value1, char key2, float value2)CharFloatHashMapwithKeysValues(char key1, float value1, char key2, float value2, char key3, float value3)CharFloatHashMapwithKeysValues(char key1, float value1, char key2, float value2, char key3, float value3, char key4, float value4)CharFloatHashMapwithKeyValue(char key1, float value1)Associates a value with the specified key.CharFloatHashMapwithoutAllKeys(CharIterable keys)Removes the mappings associated with all the keys, if they exist, from this map.CharFloatHashMapwithoutKey(char 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.AbstractMutableFloatValuesMap
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.AbstractFloatIterable
asLazy, average, containsAll, maxIfEmpty, median, minIfEmpty, toBag, toList, toSet, toSortedArray, toSortedListMethods inherited from interface org.eclipse.collections.impl.map.primitive.CharKeysMap
isEmpty, notEmpty, sizeMethods inherited from interface org.eclipse.collections.api.FloatIterable
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.FloatValuesMap
containsValue, forEachValue, tapMethods inherited from interface org.eclipse.collections.api.map.primitive.MutableCharFloatMap
putPair, withAllKeyValuesMethods inherited from interface org.eclipse.collections.api.map.primitive.MutableFloatValuesMap
collect, reject, selectMethods inherited from interface org.eclipse.collections.api.PrimitiveIterable
appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size
-
Constructor Details
-
CharFloatHashMap
public CharFloatHashMap() -
CharFloatHashMap
public CharFloatHashMap(int initialCapacity) -
CharFloatHashMap
-
-
Method Details
-
newWithKeysValues
-
newWithKeysValues
-
newWithKeysValues
public static CharFloatHashMap newWithKeysValues(char key1, float value1, char key2, float value2, char key3, float value3) -
newWithKeysValues
public static CharFloatHashMap newWithKeysValues(char key1, float value1, char key2, float value2, char key3, float value3, char key4, float value4) -
equals
Description copied from interface:CharFloatMapFollows the same general contract asMap.equals(Object).- Specified by:
equalsin interfaceCharFloatMap- Overrides:
equalsin classObject
-
hashCode
public int hashCode()Description copied from interface:CharFloatMapFollows the same general contract asMap.hashCode().- Specified by:
hashCodein interfaceCharFloatMap- 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 interfaceCharFloatMap- Specified by:
toStringin interfacePrimitiveIterable- Overrides:
toStringin classAbstractFloatIterable- Returns:
- a string representation of this PrimitiveIterable
- See Also:
AbstractCollection.toString()
-
floatIterator
Description copied from interface:FloatIterableReturns a primitive iterator that can be used to iterate over the FloatIterable in an imperative style.- Specified by:
floatIteratorin interfaceFloatIterable- Specified by:
floatIteratorin interfaceMutableFloatValuesMap
-
injectInto
public <V> V injectInto(V injectedValue, ObjectFloatToObjectFunction<? super V,? extends V> function)- Specified by:
injectIntoin interfaceFloatIterable
-
clear
public void clear()Description copied from interface:MutableFloatValuesMapRemoves all entries from this map.- Specified by:
clearin interfaceMutableCharKeysMap- Specified by:
clearin interfaceMutableFloatValuesMap
-
put
public void put(char key, float value)Description copied from interface:MutableCharFloatMapAssociates 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 interfaceMutableCharFloatMap- Parameters:
key- the keyvalue- the value to associate withvalue
-
putAll
Description copied from interface:MutableCharFloatMapPuts 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 interfaceMutableCharFloatMap- Parameters:
map- the map to copy into this map
-
updateValues
Description copied from interface:MutableCharFloatMapUpdates the values in-place.- Specified by:
updateValuesin interfaceMutableCharFloatMap- 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:MutableCharFloatMapRemoves the mapping associated with the key, if one exists, from the map.- Specified by:
removeKeyin interfaceMutableCharFloatMap- Specified by:
removeKeyin interfaceMutableCharKeysMap- Parameters:
key- the key to remove- See Also:
MutableCharFloatMap.remove(char)
-
remove
public void remove(char key)Description copied from interface:MutableCharFloatMapRemoves the mapping associated with the key, if one exists, from the map.- Specified by:
removein interfaceMutableCharFloatMap- Parameters:
key- the key to remove- See Also:
MutableCharFloatMap.removeKey(char)
-
removeKeyIfAbsent
public float removeKeyIfAbsent(char key, float value)Description copied from interface:MutableCharFloatMapRemoves 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 interfaceMutableCharFloatMap- 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 float getIfAbsentPut(char key, float value)Description copied from interface:MutableCharFloatMapRetrieves the value associated with the key if one exists; if it does not, associates a value with the key.- Specified by:
getIfAbsentPutin interfaceMutableCharFloatMap- 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:MutableCharFloatMapRetrieves 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 interfaceMutableCharFloatMap- 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:MutableCharFloatMapRetrieves 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 interfaceMutableCharFloatMap- 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:MutableCharFloatMapRetrieves 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 interfaceMutableCharFloatMap- 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 float addToValue(char key, float toBeAdded)Description copied from interface:MutableCharFloatMapIncrements 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 interfaceMutableCharFloatMap- 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:MutableCharFloatMapUpdates 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 interfaceMutableCharFloatMap- 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:MutableCharFloatMapAssociates 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 interfaceMutableCharFloatMap- Parameters:
key1- the keyvalue1- the value to associate withvalue- Returns:
- this map
- See Also:
MutableCharFloatMap.put(char, float)
-
withKeysValues
-
withKeysValues
public CharFloatHashMap withKeysValues(char key1, float value1, char key2, float value2, char key3, float value3) -
withKeysValues
public CharFloatHashMap withKeysValues(char key1, float value1, char key2, float value2, char key3, float value3, char key4, float value4) -
withoutKey
Description copied from interface:MutableCharFloatMapRemoves the mapping associated with the key, if one exists, from this map.- Specified by:
withoutKeyin interfaceMutableCharFloatMap- Parameters:
key- the key to remove- Returns:
- this map
- See Also:
MutableCharFloatMap.remove(char)
-
withoutAllKeys
Description copied from interface:MutableCharFloatMapRemoves the mappings associated with all the keys, if they exist, from this map.- Specified by:
withoutAllKeysin interfaceMutableCharFloatMap- Parameters:
keys- the keys to remove- Returns:
- this map
- See Also:
MutableCharFloatMap.remove(char)
-
asUnmodifiable
Description copied from interface:MutableCharFloatMapReturns 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 callingCharFloatMap.toImmutable()while still providing immutability.- Specified by:
asUnmodifiablein interfaceMutableCharFloatMap- Returns:
- an unmodifiable view of this map
-
asSynchronized
Description copied from interface:MutableCharFloatMapReturns 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 interfaceMutableCharFloatMap- Returns:
- a synchronized view of this map
-
toImmutable
Description copied from interface:CharFloatMapReturns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.- Specified by:
toImmutablein interfaceCharFloatMap- Returns:
- an immutable map that is equivalent to this one
-
get
public float get(char key)Description copied from interface:CharFloatMapRetrieves the value associated with the key. If no mapping exists for the key, the default value (usually0) is returned.- Specified by:
getin interfaceCharFloatMap- Parameters:
key- the key- Returns:
- the value associated with the key, or the default value if no such mapping exists
-
getIfAbsent
public float getIfAbsent(char key, float ifAbsent)Description copied from interface:CharFloatMapRetrieves the value associated with the key, returning the specified default value if no such mapping exists.- Specified by:
getIfAbsentin interfaceCharFloatMap- 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 float getOrThrow(char key)Description copied from interface:CharFloatMapRetrieves the value associated with the key, throwing anIllegalStateExceptionif no such mapping exists.- Specified by:
getOrThrowin interfaceCharFloatMap- Parameters:
key- the key- Returns:
- the value associated with the key
-
containsKey
public boolean containsKey(char key)Description copied from interface:CharFloatMapReturns whether or not the key is present in the map.- Specified by:
containsKeyin interfaceCharFloatMap- Specified by:
containsKeyin interfaceCharKeysMap- Parameters:
key- the key- Returns:
- if a mapping exists in this map for the key
-
forEachKey
Description copied from interface:CharFloatMapIterates through each key in the map, invoking the procedure for each.- Specified by:
forEachKeyin interfaceCharFloatMap- Specified by:
forEachKeyin interfaceCharKeysMap- Parameters:
procedure- the procedure to invoke for each key
-
forEachKeyValue
Description copied from interface:CharFloatMapIterates through each key/value pair in the map, invoking the procedure for each.- Specified by:
forEachKeyValuein interfaceCharFloatMap- Parameters:
procedure- the procedure to invoke for each key/value pair
-
keysView
Description copied from interface:CharFloatMapReturns 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 interfaceCharFloatMap- Returns:
- a view of the keys in this map
-
keyValuesView
Description copied from interface:CharFloatMapReturns 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 interfaceCharFloatMap- Returns:
- a view of the keys in this map
-
flipUniqueValues
Description copied from interface:CharFloatMapReturn the FloatCharMap that is obtained by flipping the direction of this map and making the associations from value to key.- Specified by:
flipUniqueValuesin interfaceCharFloatMap- Specified by:
flipUniqueValuesin interfaceMutableCharFloatMap
-
select
Description copied from interface:CharFloatMapReturn a copy of this map containing only the key/value pairs that match the predicate.- Specified by:
selectin interfaceCharFloatMap- Specified by:
selectin interfaceMutableCharFloatMap- 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:CharFloatMapReturn a copy of this map containing only the key/value pairs that do not match the predicate.- Specified by:
rejectin interfaceCharFloatMap- Specified by:
rejectin interfaceMutableCharFloatMap- 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:CharFloatMapReturns 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 interfaceCharFloatMap- Returns:
- a mutable set containing the keys in this map
-
values
Description copied from interface:FloatValuesMapReturns 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 interfaceFloatValuesMap- Returns:
- the values as a collection backed by this map
-