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

Interface ImmutableShortObjectMap<V>

All Superinterfaces:

ImmutablePrimitiveObjectMap<V>, InternalIterable<V>, Iterable<V>, PrimitiveObjectMap<V>, RichIterable<V>, ShortObjectMap<V>

All Known Implementing Classes:

AbstractImmutableShortObjectMap

public interface ImmutableShortObjectMap<V>
extends ShortObjectMap<V>, ImmutablePrimitiveObjectMap<V>

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

Since:

3.0.

Method Summary

Modifier and Type	Method	Description
ImmutableObjectShortMap<V>	flipUniqueValues()	Return the ObjectShortMap that is obtained by flipping the direction of this map and making the associations from value to key.
ImmutableShortObjectMap<V>	newWithKeyValue(short key, V 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.
ImmutableShortObjectMap<V>	newWithoutAllKeys(ShortIterable keys)	Copy this map, remove any associated values with the specified keys (if any exist), and return the copy as a new immutable map.
ImmutableShortObjectMap<V>	newWithoutKey(short key)	Copy this map, remove any associated value with the key (if one exists), and return the copy as a new immutable map.
ImmutableShortObjectMap<V>	reject(ShortObjectPredicate<? super V> predicate)	Return a copy of this map containing only the key/value pairs that do not match the predicate.
ImmutableShortObjectMap<V>	select(ShortObjectPredicate<? super V> predicate)	Return a copy of this map containing only the key/value pairs that match the predicate.
ImmutableShortObjectMap<V>	tap(Procedure<? super V> procedure)	Executes the Procedure for each element in the iterable and returns this.

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

aggregateBy, aggregateInPlaceBy, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, flatCollect, flatCollectWith, groupBy, groupByEach, groupByUniqueKey, partition, partitionWith, reject, rejectWith, select, selectInstancesOf, selectWith, sumByDouble, sumByFloat, sumByInt, sumByLong, zip, zipWithIndex

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

forEach, forEachWith, forEachWithIndex

Methods inherited from interface java.lang.Iterable

iterator

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

containsValue, equals, forEachValue, hashCode, parallelStream, spliterator, stream, toString, values

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

aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsBy, count, countBy, countBy, countByEach, countByEach, countByWith, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getFirst, getLast, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex

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

containsKey, forEachKey, forEachKeyValue, get, getIfAbsent, keySet, keysView, keyValuesView, toImmutable

Method Details

tap

ImmutableShortObjectMap<V> tap(Procedure<? super V> procedure)

Description copied from interface: RichIterable

Executes the Procedure for each element in the iterable and returns this.

Example using a Java 8 lambda expression:

 RichIterable<Person> tapped =
     people.tap(person -> LOGGER.info(person.getName()));
 

Example using an anonymous inner class:

 RichIterable<Person> tapped =
     people.tap(new Procedure<Person>()
     {
         public void value(Person person)
         {
             LOGGER.info(person.getName());
         }
     });
 

Specified by:

tap in interface RichIterable<V>

Specified by:

tap in interface ShortObjectMap<V>

See Also:

RichIterable.each(Procedure), RichIterable.forEach(Procedure)

select

ImmutableShortObjectMap<V> select(ShortObjectPredicate<? super V> predicate)

Description copied from interface: ShortObjectMap

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

Specified by:

select in interface ShortObjectMap<V>

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

ImmutableShortObjectMap<V> reject(ShortObjectPredicate<? super V> predicate)

Description copied from interface: ShortObjectMap

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

Specified by:

reject in interface ShortObjectMap<V>

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

newWithKeyValue

ImmutableShortObjectMap<V> newWithKeyValue(short key, V 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

ImmutableShortObjectMap<V> newWithoutKey(short 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

ImmutableShortObjectMap<V> newWithoutAllKeys(ShortIterable 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

ImmutableObjectShortMap<V> flipUniqueValues()

Description copied from interface: ShortObjectMap

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

Specified by:

flipUniqueValues in interface ShortObjectMap<V>