Class LongShortHashMap
java.lang.Object
org.eclipse.collections.impl.primitive.AbstractShortIterable
org.eclipse.collections.impl.map.mutable.primitive.AbstractMutableShortValuesMap
org.eclipse.collections.impl.map.mutable.primitive.LongShortHashMap
- All Implemented Interfaces:
Externalizable
,Serializable
,LongShortMap
,MutableLongShortMap
,MutableShortValuesMap
,ShortValuesMap
,PrimitiveIterable
,ShortIterable
,MutableLongKeysMap
,LongKeysMap
public class LongShortHashMap extends AbstractMutableShortValuesMap implements MutableLongShortMap, Externalizable, MutableLongKeysMap
This file was automatically generated from template file primitivePrimitiveHashMap.stg.
- Since:
- 3.0.
- See Also:
- Serialized Form
-
Constructor Summary
Constructors Constructor Description LongShortHashMap()
LongShortHashMap(int initialCapacity)
LongShortHashMap(LongShortMap map)
-
Method Summary
Modifier and Type Method Description short
addToValue(long 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.MutableLongShortMap
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.MutableLongShortMap
asUnmodifiable()
Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing anUnsupportedOperationException
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(long key)
Returns whether or not the key is present in the map.boolean
equals(Object obj)
Follows the same general contract asMap.equals(Object)
.MutableShortLongMap
flipUniqueValues()
Return the ShortLongMap that is obtained by flipping the direction of this map and making the associations from value to key.void
forEachKey(LongProcedure procedure)
Iterates through each key in the map, invoking the procedure for each.void
forEachKeyValue(LongShortProcedure procedure)
Iterates through each key/value pair in the map, invoking the procedure for each.short
get(long key)
Retrieves the value associated with the key.short
getIfAbsent(long key, short ifAbsent)
Retrieves the value associated with the key, returning the specified default value if no such mapping exists.short
getIfAbsentPut(long 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(long 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(long 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(long key, LongToShortFunction 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(long 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, ObjectShortToObjectFunction<? super V,? extends V> function)
MutableLongSet
keySet()
Returns a set containing all the keys in this map.LazyLongIterable
keysView()
Returns a view of the keys in this map.RichIterable<LongShortPair>
keyValuesView()
Returns a view of the key/value pairs in this map.static LongShortHashMap
newWithKeysValues(long key1, short value1)
static LongShortHashMap
newWithKeysValues(long key1, short value1, long key2, short value2)
static LongShortHashMap
newWithKeysValues(long key1, short value1, long key2, short value2, long key3, short value3)
static LongShortHashMap
newWithKeysValues(long key1, short value1, long key2, short value2, long key3, short value3, long key4, short value4)
void
put(long key, short value)
Associates a value with the specified key.void
putAll(LongShortMap map)
Puts all of the key/value mappings from the specified map into this map.void
readExternal(ObjectInput in)
LongShortHashMap
reject(LongShortPredicate predicate)
Return a copy of this map containing only the key/value pairs that do not match the predicate.void
remove(long key)
Removes the mapping associated with the key, if one exists, from the map.void
removeKey(long key)
Removes the mapping associated with the key, if one exists, from the map.short
removeKeyIfAbsent(long key, short value)
Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.LongShortHashMap
select(LongShortPredicate 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.ImmutableLongShortMap
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(long 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(LongShortToShortFunction function)
Updates the values in-place.MutableShortCollection
values()
Returns the values in this map as a separate collection.LongShortHashMap
withKeysValues(long key1, short value1, long key2, short value2)
LongShortHashMap
withKeysValues(long key1, short value1, long key2, short value2, long key3, short value3)
LongShortHashMap
withKeysValues(long key1, short value1, long key2, short value2, long key3, short value3, long key4, short value4)
LongShortHashMap
withKeyValue(long key1, short value1)
Associates a value with the specified key.LongShortHashMap
withoutAllKeys(LongIterable keys)
Removes the mappings associated with all the keys, if they exist, from this map.LongShortHashMap
withoutKey(long 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, forEach, forEachValue, isEmpty, max, min, noneSatisfy, notEmpty, reject, select, size, sum, toArray, toArray
Methods inherited from class org.eclipse.collections.impl.primitive.AbstractShortIterable
asLazy, average, containsAll, maxIfEmpty, median, minIfEmpty, toBag, toList, toSet, toSortedArray, toSortedList
Methods inherited from interface org.eclipse.collections.impl.map.primitive.LongKeysMap
isEmpty, notEmpty, size
Methods inherited from interface org.eclipse.collections.api.map.primitive.MutableLongShortMap
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, 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.api.map.primitive.ShortValuesMap
containsValue, forEachValue, tap
-
Constructor Details
-
LongShortHashMap
public LongShortHashMap() -
LongShortHashMap
public LongShortHashMap(int initialCapacity) -
LongShortHashMap
-
-
Method Details
-
newWithKeysValues
-
newWithKeysValues
-
newWithKeysValues
public static LongShortHashMap newWithKeysValues(long key1, short value1, long key2, short value2, long key3, short value3) -
newWithKeysValues
public static LongShortHashMap newWithKeysValues(long key1, short value1, long key2, short value2, long key3, short value3, long key4, short value4) -
equals
Description copied from interface:LongShortMap
Follows the same general contract asMap.equals(Object)
.- Specified by:
equals
in interfaceLongShortMap
- Overrides:
equals
in classObject
-
hashCode
public int hashCode()Description copied from interface:LongShortMap
Follows the same general contract asMap.hashCode()
.- Specified by:
hashCode
in interfaceLongShortMap
- 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 interfaceLongShortMap
- Specified by:
toString
in interfacePrimitiveIterable
- Overrides:
toString
in classAbstractShortIterable
- Returns:
- a string representation of this PrimitiveIterable
- See Also:
AbstractCollection.toString()
-
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 interfaceMutableShortValuesMap
- Specified by:
shortIterator
in interfaceShortIterable
-
injectInto
public <V> V injectInto(V injectedValue, ObjectShortToObjectFunction<? super V,? extends V> function)- Specified by:
injectInto
in interfaceShortIterable
-
clear
public void clear()Description copied from interface:MutableShortValuesMap
Removes all entries from this map.- Specified by:
clear
in interfaceMutableLongKeysMap
- Specified by:
clear
in interfaceMutableShortValuesMap
-
put
public void put(long key, short value)Description copied from interface:MutableLongShortMap
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 interfaceMutableLongShortMap
- Parameters:
key
- the keyvalue
- the value to associate withvalue
-
putAll
Description copied from interface:MutableLongShortMap
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 interfaceMutableLongShortMap
- Parameters:
map
- the map to copy into this map
-
updateValues
Description copied from interface:MutableLongShortMap
Updates the values in-place.- Specified by:
updateValues
in interfaceMutableLongShortMap
- Parameters:
function
- that takes a key and its value and that returns a new value for this key
-
removeKey
public void removeKey(long key)Description copied from interface:MutableLongShortMap
Removes the mapping associated with the key, if one exists, from the map.- Specified by:
removeKey
in interfaceMutableLongKeysMap
- Specified by:
removeKey
in interfaceMutableLongShortMap
- Parameters:
key
- the key to remove- See Also:
MutableLongShortMap.remove(long)
-
remove
public void remove(long key)Description copied from interface:MutableLongShortMap
Removes the mapping associated with the key, if one exists, from the map.- Specified by:
remove
in interfaceMutableLongShortMap
- Parameters:
key
- the key to remove- See Also:
MutableLongShortMap.removeKey(long)
-
removeKeyIfAbsent
public short removeKeyIfAbsent(long key, short value)Description copied from interface:MutableLongShortMap
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 interfaceMutableLongShortMap
- 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 short getIfAbsentPut(long key, short value)Description copied from interface:MutableLongShortMap
Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.- Specified by:
getIfAbsentPut
in interfaceMutableLongShortMap
- 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:MutableLongShortMap
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 interfaceMutableLongShortMap
- 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:MutableLongShortMap
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 interfaceMutableLongShortMap
- 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:MutableLongShortMap
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 interfaceMutableLongShortMap
- 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 short addToValue(long key, short toBeAdded)Description copied from interface:MutableLongShortMap
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 interfaceMutableLongShortMap
- 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:MutableLongShortMap
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 interfaceMutableLongShortMap
- 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:MutableLongShortMap
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 interfaceMutableLongShortMap
- Parameters:
key1
- the keyvalue1
- the value to associate withvalue
- Returns:
- this map
- See Also:
MutableLongShortMap.put(long, short)
-
withKeysValues
-
withKeysValues
public LongShortHashMap withKeysValues(long key1, short value1, long key2, short value2, long key3, short value3) -
withKeysValues
public LongShortHashMap withKeysValues(long key1, short value1, long key2, short value2, long key3, short value3, long key4, short value4) -
withoutKey
Description copied from interface:MutableLongShortMap
Removes the mapping associated with the key, if one exists, from this map.- Specified by:
withoutKey
in interfaceMutableLongShortMap
- Parameters:
key
- the key to remove- Returns:
- this map
- See Also:
MutableLongShortMap.remove(long)
-
withoutAllKeys
Description copied from interface:MutableLongShortMap
Removes the mappings associated with all the keys, if they exist, from this map.- Specified by:
withoutAllKeys
in interfaceMutableLongShortMap
- Parameters:
keys
- the keys to remove- Returns:
- this map
- See Also:
MutableLongShortMap.remove(long)
-
asUnmodifiable
Description copied from interface:MutableLongShortMap
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 callingLongShortMap.toImmutable()
while still providing immutability.- Specified by:
asUnmodifiable
in interfaceMutableLongShortMap
- Returns:
- an unmodifiable view of this map
-
asSynchronized
Description copied from interface:MutableLongShortMap
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 interfaceMutableLongShortMap
- Returns:
- a synchronized view of this map
-
toImmutable
Description copied from interface:LongShortMap
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 interfaceLongShortMap
- Returns:
- an immutable map that is equivalent to this one
-
get
public short get(long key)Description copied from interface:LongShortMap
Retrieves the value associated with the key. If no mapping exists for the key, the default value (usually0
) is returned.- Specified by:
get
in interfaceLongShortMap
- Parameters:
key
- the key- Returns:
- the value associated with the key, or the default value if no such mapping exists
-
getIfAbsent
public short getIfAbsent(long key, short ifAbsent)Description copied from interface:LongShortMap
Retrieves the value associated with the key, returning the specified default value if no such mapping exists.- Specified by:
getIfAbsent
in interfaceLongShortMap
- 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 short getOrThrow(long key)Description copied from interface:LongShortMap
Retrieves the value associated with the key, throwing anIllegalStateException
if no such mapping exists.- Specified by:
getOrThrow
in interfaceLongShortMap
- Parameters:
key
- the key- Returns:
- the value associated with the key
-
containsKey
public boolean containsKey(long key)Description copied from interface:LongShortMap
Returns whether or not the key is present in the map.- Specified by:
containsKey
in interfaceLongKeysMap
- Specified by:
containsKey
in interfaceLongShortMap
- Parameters:
key
- the key- Returns:
- if a mapping exists in this map for the key
-
forEachKey
Description copied from interface:LongShortMap
Iterates through each key in the map, invoking the procedure for each.- Specified by:
forEachKey
in interfaceLongKeysMap
- Specified by:
forEachKey
in interfaceLongShortMap
- Parameters:
procedure
- the procedure to invoke for each key
-
forEachKeyValue
Description copied from interface:LongShortMap
Iterates through each key/value pair in the map, invoking the procedure for each.- Specified by:
forEachKeyValue
in interfaceLongShortMap
- Parameters:
procedure
- the procedure to invoke for each key/value pair
-
keysView
Description copied from interface:LongShortMap
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 interfaceLongShortMap
- Returns:
- a view of the keys in this map
-
keyValuesView
Description copied from interface:LongShortMap
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 interfaceLongShortMap
- Returns:
- a view of the keys in this map
-
flipUniqueValues
Description copied from interface:LongShortMap
Return the ShortLongMap that is obtained by flipping the direction of this map and making the associations from value to key.- Specified by:
flipUniqueValues
in interfaceLongShortMap
- Specified by:
flipUniqueValues
in interfaceMutableLongShortMap
-
select
Description copied from interface:LongShortMap
Return a copy of this map containing only the key/value pairs that match the predicate.- Specified by:
select
in interfaceLongShortMap
- Specified by:
select
in interfaceMutableLongShortMap
- 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:LongShortMap
Return a copy of this map containing only the key/value pairs that do not match the predicate.- Specified by:
reject
in interfaceLongShortMap
- Specified by:
reject
in interfaceMutableLongShortMap
- 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:LongShortMap
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 interfaceLongShortMap
- Returns:
- a mutable set containing the keys in this map
-
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 interfaceShortValuesMap
- Returns:
- the values as a collection backed by this map
-