Package org.eclipse.collections.api.map.primitive

Interface ImmutableObjectIntMap<K>

All Superinterfaces:

IntIterable, ObjectIntMap<K>, PrimitiveIterable

All Known Implementing Classes:

AbstractImmutableObjectIntMap

public interface ImmutableObjectIntMap<K>
extends ObjectIntMap<K>

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

Since:

3.0.

Method Summary

Modifier and Type	Method	Description
<V> ImmutableCollection<V>	collect(IntToObjectFunction<? extends V> function)	Returns a new collection with the results of applying the specified function on each element of the source collection.
ImmutableIntObjectMap<K>	flipUniqueValues()	Return the IntObjectMap that is obtained by flipping the direction of this map and making the associations from value to key.
ImmutableObjectIntMap<K>	newWithKeyValue(K key, int value)	Copy this map, associate the value with the key (replacing the value if one already exists for key), and return the copy as new immutable map.
ImmutableObjectIntMap<K>	newWithoutAllKeys(Iterable<? extends K> keys)	Copy this map, remove any associated values with the specified keys (if any exist), and return the copy as a new immutable map.
ImmutableObjectIntMap<K>	newWithoutKey(K key)	Copy this map, remove any associated value with the key (if one exists), and return the copy as a new immutable map.
ImmutableIntCollection	reject(IntPredicate predicate)	Returns a new IntIterable with all of the elements in the IntIterable that return false for the specified predicate.
ImmutableObjectIntMap<K>	reject(ObjectIntPredicate<? super K> predicate)	Return a copy of this map containing only the key/value pairs that do not match the predicate.
ImmutableIntCollection	select(IntPredicate predicate)	Returns a new IntIterable with all of the elements in the IntIterable that return true for the specified predicate.
ImmutableObjectIntMap<K>	select(ObjectIntPredicate<? super K> predicate)	Return a copy of this map containing only the key/value pairs that match the predicate.
default ImmutableObjectIntMap<K>	tap(IntProcedure procedure)

Methods inherited from interface org.eclipse.collections.api.IntIterable

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, intIterator, max, maxIfEmpty, median, medianIfEmpty, min, minIfEmpty, noneSatisfy, reduce, reduceIfEmpty, reject, select, sum, summaryStatistics, toArray, toArray, toBag, toList, toSet, toSortedArray, toSortedList, toSortedList, toSortedListBy, toSortedListBy

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

containsKey, containsValue, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getOrThrow, injectIntoKeyValue, keySet, keysView, keyValuesView, toImmutable, toString, values

Methods inherited from interface org.eclipse.collections.api.PrimitiveIterable

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

Method Details

select

ImmutableObjectIntMap<K> select(ObjectIntPredicate<? super K> predicate)

Description copied from interface: ObjectIntMap

Return a copy of this map containing only the key/value pairs that match the predicate.

Specified by:

select in interface ObjectIntMap<K>

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

ImmutableObjectIntMap<K> reject(ObjectIntPredicate<? super K> predicate)

Description copied from interface: ObjectIntMap

Return a copy of this map containing only the key/value pairs that do not match the predicate.

Specified by:

reject in interface ObjectIntMap<K>

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

select

ImmutableIntCollection select(IntPredicate predicate)

Description copied from interface: IntIterable

Returns a new IntIterable with all of the elements in the IntIterable that return true for the specified predicate.

Specified by:

select in interface IntIterable

reject

ImmutableIntCollection reject(IntPredicate predicate)

Description copied from interface: IntIterable

Returns a new IntIterable with all of the elements in the IntIterable that return false for the specified predicate.

Specified by:

reject in interface IntIterable

tap

default ImmutableObjectIntMap<K> tap(IntProcedure procedure)

Specified by:

tap in interface IntIterable

Specified by:

tap in interface ObjectIntMap<K>

Since:

9.0.

collect

<V> ImmutableCollection<V> collect(IntToObjectFunction<? extends V> function)

Description copied from interface: IntIterable

Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Specified by:

collect in interface IntIterable

newWithKeyValue

ImmutableObjectIntMap<K> newWithKeyValue(K key,
 int value)

Copy this map, associate the value with the key (replacing the value if one already exists for key), and return the copy as new immutable map. A copy is always made even if key is already associated with value.

Parameters:

key - the key to add

value - the value to associate with the key in the copy

Returns:

an immutable copy of this map with value associated with key

newWithoutKey

ImmutableObjectIntMap<K> newWithoutKey(K key)

Copy this map, remove any associated value with the key (if one exists), and return the copy as a new immutable map.

Parameters:

key - the key to remove

Returns:

an immutable copy of this map with key removed

newWithoutAllKeys

ImmutableObjectIntMap<K> newWithoutAllKeys(Iterable<? extends K> keys)

Copy this map, remove any associated values with the specified keys (if any exist), and return the copy as a new immutable map.

Parameters:

keys - the keys to remove

Returns:

an immutable copy of this map with all keys in keys removed

flipUniqueValues

ImmutableIntObjectMap<K> flipUniqueValues()

Description copied from interface: ObjectIntMap

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

Specified by:

flipUniqueValues in interface ObjectIntMap<K>