org.eclipse.collections.api.map.primitive

Interface IntShortMap

All Superinterfaces:

PrimitiveIterable, ShortIterable, ShortValuesMap

All Known Subinterfaces:

ImmutableIntShortMap, MutableIntShortMap

public interface IntShortMap
extends ShortValuesMap

This file was automatically generated from template file primitivePrimitiveMap.stg.

Since:

3.0.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(int key) Returns whether or not the key is present in the map.
boolean	equals(Object o) Follows the same general contract as Map.equals(Object).
ShortIntMap	flipUniqueValues() Return the ShortIntMap that is obtained by flipping the direction of this map and making the associations from value to key.
void	forEachKey(IntProcedure procedure) Iterates through each key in the map, invoking the procedure for each.
void	forEachKeyValue(IntShortProcedure procedure) Iterates through each key/value pair in the map, invoking the procedure for each.
short	get(int key) Retrieves the value associated with the key.
short	getIfAbsent(int key, short ifAbsent) Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
short	getOrThrow(int key) Retrieves the value associated with the key, throwing an IllegalStateException if no such mapping exists.
int	hashCode() Follows the same general contract as Map.hashCode().
default <IV> IV	injectIntoKeyValue(IV injectedValue, ObjectIntShortToObjectFunction<? super IV,? extends IV> function) Implements the injectInto pattern with each key/value pair of the map.
MutableIntSet	keySet() Returns a set containing all the keys in this map.
LazyIntIterable	keysView() Returns a view of the keys in this map.
RichIterable<IntShortPair>	keyValuesView() Returns a view of the key/value pairs in this map.
IntShortMap	reject(IntShortPredicate predicate) Return a copy of this map containing only the key/value pairs that do not match the predicate.
IntShortMap	select(IntShortPredicate predicate) Return a copy of this map containing only the key/value pairs that match the predicate.
ImmutableIntShortMap	toImmutable() Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.
String	toString() Follows the same general contract as AbstractMap.toString()

Methods inherited from interface org.eclipse.collections.api.map.primitive.ShortValuesMap

collect, containsValue, forEachValue, reject, select, tap, values

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.PrimitiveIterable

appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size

Method Detail

get

short get(int key)

Retrieves the value associated with the key. If no mapping exists for the key, the default value (usually 0) 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(int key,
                  short ifAbsent)

Retrieves the value associated with the key, returning the specified default value if no such mapping exists.

Parameters:

key - the key

ifAbsent - the default value to return if no mapping exists for key

Returns:

the value associated with the key, or ifAbsent if no such mapping exists.

getOrThrow

short getOrThrow(int key)

Retrieves the value associated with the key, throwing an IllegalStateException 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(int 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

void forEachKey(IntProcedure procedure)

Iterates through each key in the map, invoking the procedure for each.

Parameters:

procedure - the procedure to invoke for each key

forEachKeyValue

void forEachKeyValue(IntShortProcedure procedure)

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,
                                   ObjectIntShortToObjectFunction<? super IV,? extends IV> function)

Implements the injectInto pattern with each key/value pair of the map.

Parameters:

value - to be injected into the map

function - to apply to the injected value and key/value pairs

Returns:

result of injecting the injectedValue into the map

Since:

11.1

keysView

LazyIntIterable 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<IntShortPair> 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

ShortIntMap flipUniqueValues()

Return the ShortIntMap that is obtained by flipping the direction of this map and making the associations from value to key.

Throws:

IllegalStateException - if the ShortIntMap contains duplicate values.

Since:

9.0

select

IntShortMap select(IntShortPredicate predicate)

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

IntShortMap reject(IntShortPredicate predicate)

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

boolean equals(Object o)

Follows the same general contract as Map.equals(Object).

Overrides:

equals in class Object

hashCode

int hashCode()

Follows the same general contract as Map.hashCode().

Overrides:

hashCode in class Object

toString

String toString()

Follows the same general contract as AbstractMap.toString()

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class Object

Returns:

a string representation of this IntShortMap

See Also:

AbstractCollection.toString()

toImmutable

ImmutableIntShortMap 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

MutableIntSet 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