Interface LongShortMap
- All Superinterfaces:
PrimitiveIterable
,ShortIterable
,ShortValuesMap
- All Known Subinterfaces:
ImmutableLongShortMap
,MutableLongShortMap
- All Known Implementing Classes:
LongShortHashMap
,SynchronizedLongShortMap
,UnmodifiableLongShortMap
This file was automatically generated from template file primitivePrimitiveMap.stg.
- Since:
- 3.0.
-
Method Summary
Modifier and TypeMethodDescriptionboolean
containsKey
(long key) Returns whether or not the key is present in the map.boolean
Follows the same general contract asMap.equals(Object)
.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
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()
.default <IV> IV
injectIntoKeyValue
(IV injectedValue, ObjectLongShortToObjectFunction<? super IV, ? extends IV> function) Implements the injectInto pattern with each key/value pair of the map.keySet()
Returns a set containing all the keys in this map.keysView()
Returns a view of the keys in this map.Returns a view of the key/value pairs in this map.reject
(LongShortPredicate predicate) Return a copy of this map containing only the key/value pairs that do not match the predicate.select
(LongShortPredicate predicate) Return a copy of this map containing only the key/value pairs that match the predicate.Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.toString()
Follows the same general contract asAbstractMap.toString()
Methods inherited from interface org.eclipse.collections.api.PrimitiveIterable
appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size
Methods inherited from interface org.eclipse.collections.api.ShortIterable
allSatisfy, anySatisfy, asLazy, average, averageIfEmpty, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, contains, containsAll, containsAll, containsAny, containsAny, containsNone, containsNone, count, detectIfNone, each, flatCollect, forEach, injectInto, injectIntoBoolean, injectIntoByte, injectIntoChar, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, injectIntoShort, max, maxIfEmpty, median, medianIfEmpty, min, minIfEmpty, noneSatisfy, reduce, reduceIfEmpty, reject, select, shortIterator, sum, summaryStatistics, toArray, toArray, toBag, toList, toSet, toSortedArray, toSortedList, toSortedList, toSortedListBy, toSortedListBy
Methods inherited from interface org.eclipse.collections.api.map.primitive.ShortValuesMap
collect, containsValue, forEachValue, reject, select, tap, values
-
Method Details
-
get
short get(long key) Retrieves the value associated with the key. If no mapping exists for the key, the default value (usually0
) is returned.- Parameters:
key
- the key- Returns:
- the value associated with the key, or the default value if no such mapping exists
-
getIfAbsent
short getIfAbsent(long key, short ifAbsent) Retrieves the value associated with the key, returning the specified default value if no such mapping exists.- 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
short getOrThrow(long key) Retrieves the value associated with the key, throwing anIllegalStateException
if no such mapping exists.- Parameters:
key
- the key- Returns:
- the value associated with the key
- Throws:
IllegalStateException
- if no mapping exists for the key
-
containsKey
boolean containsKey(long key) Returns whether or not the key is present in the map.- Parameters:
key
- the key- Returns:
- if a mapping exists in this map for the key
-
forEachKey
Iterates through each key in the map, invoking the procedure for each.- Parameters:
procedure
- the procedure to invoke for each key
-
forEachKeyValue
Iterates through each key/value pair in the map, invoking the procedure for each.- Parameters:
procedure
- the procedure to invoke for each key/value pair
-
injectIntoKeyValue
default <IV> IV injectIntoKeyValue(IV injectedValue, ObjectLongShortToObjectFunction<? super IV, ? extends IV> function) Implements the injectInto pattern with each key/value pair of the map.- Parameters:
value
- to be injected into the mapfunction
- to apply to the injected value and key/value pairs- Returns:
- result of injecting the injectedValue into the map
- Since:
- 11.1
-
keysView
LazyLongIterable keysView()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.- Returns:
- a view of the keys in this map
- Since:
- 5.0
-
keyValuesView
RichIterable<LongShortPair> keyValuesView()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.- Returns:
- a view of the keys in this map
- Since:
- 5.0
-
flipUniqueValues
ShortLongMap flipUniqueValues()Return the ShortLongMap that is obtained by flipping the direction of this map and making the associations from value to key.- Throws:
IllegalStateException
- if the ShortLongMap contains duplicate values.- Since:
- 9.0
-
select
Return a copy of this map containing only the key/value pairs that match the predicate.- 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
Return a copy of this map containing only the key/value pairs that do not match the predicate.- 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
-
equals
Follows the same general contract asMap.equals(Object)
. -
hashCode
int hashCode()Follows the same general contract asMap.hashCode()
. -
toString
String toString()Follows the same general contract asAbstractMap.toString()
- Specified by:
toString
in interfacePrimitiveIterable
- Overrides:
toString
in classObject
- Returns:
- a string representation of this LongShortMap
- See Also:
-
toImmutable
ImmutableLongShortMap toImmutable()Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.- Returns:
- an immutable map that is equivalent to this one
-
keySet
MutableLongSet keySet()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.- Returns:
- a mutable set containing the keys in this map
-