ImmutableMapIterable (Eclipse Collections

All Superinterfaces:

InternalIterable<K>, java.lang.Iterable<K>, MapIterable<K,V>, RichIterable<K>

All Known Subinterfaces:

ImmutableBiMap<K,V>, ImmutableMap<K,V>, ImmutableOrderedMap<K,V>, ImmutableSortedMap<K,V>

All Known Implementing Classes:

AbstractImmutableBiMap, AbstractImmutableMap, AbstractImmutableSortedMap, ImmutableTreeMap, ImmutableUnifiedMap, ImmutableUnifiedMapWithHashingStrategy
```
public interface ImmutableMapIterable<K,V>
extends MapIterable<K,V>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`<KK,VV> ImmutableMapIterable<KK,VV>`	`aggregateBy(Function<? super V,? extends KK> groupBy, Function0<? extends VV> zeroValueFactory, Function2<? super VV,? super V,? extends VV> nonMutatingAggregator)`	Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function.
`<KK,VV> ImmutableMapIterable<KK,VV>`	`aggregateInPlaceBy(Function<? super V,? extends KK> groupBy, Function0<? extends VV> zeroValueFactory, Procedure2<? super VV,? super V> mutatingAggregator)`	Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function.
`java.util.Map<K,V>`	`castToMap()`
`<K2,V2> ImmutableMapIterable<K2,V2>`	`collect(Function2<? super K,? super V,Pair<K2,V2>> function)`	For each key and value of the map the function is evaluated.
`<R> ImmutableMapIterable<K,R>`	`collectValues(Function2<? super K,? super V,? extends R> function)`	For each key and value of the map the function is evaluated.
`default <V1> ImmutableBag<V1>`	`countBy(Function<? super V,? extends V1> function)`	This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.
`default <V1,P> ImmutableBag<V1>`	`countByWith(Function2<? super V,? super P,? extends V1> function, P parameter)`	This method will count the number of occurrences of each value calculated by applying the function to each element of the collection with the specified parameter as the second argument.
`ImmutableMultimap<V,K>`	`flip()`	Given a map from Domain -> Range return a multimap from Range -> Domain.
`ImmutableMapIterable<V,K>`	`flipUniqueValues()`	Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key.
`<V1> ImmutableMultimap<V1,V>`	`groupBy(Function<? super V,? extends V1> function)`	For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
`<V1> ImmutableMultimap<V1,V>`	`groupByEach(Function<? super V,? extends java.lang.Iterable<V1>> function)`	Similar to `RichIterable.groupBy(Function)`, except the result of evaluating function will return a collection of keys for each value.
`<V1> ImmutableMapIterable<V1,V>`	`groupByUniqueKey(Function<? super V,? extends V1> function)`	For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key.
`ImmutableMapIterable<K,V>`	`newWithAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)`
`ImmutableMapIterable<K,V>`	`newWithAllKeyValues(java.lang.Iterable<? extends Pair<? extends K,? extends V>> keyValues)`
`ImmutableMapIterable<K,V>`	`newWithKeyValue(K key, V value)`
`ImmutableMapIterable<K,V>`	`newWithoutAllKeys(java.lang.Iterable<? extends K> keys)`
`ImmutableMapIterable<K,V>`	`newWithoutKey(K key)`
`PartitionImmutableCollection<V>`	`partition(Predicate<? super V> predicate)`	Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
`ImmutableCollection<V>`	`reject(Predicate<? super V> predicate)`	Returns all elements of the source collection that return false when evaluating of the predicate.
`ImmutableMapIterable<K,V>`	`reject(Predicate2<? super K,? super V> predicate)`	For each key and value of the map the predicate is evaluated, if the result of the evaluation is false, that key and value are returned in a new map.
`<P> ImmutableCollection<V>`	`rejectWith(Predicate2<? super V,? super P> predicate, P parameter)`	Similar to `RichIterable.reject(Predicate)`, except with an evaluation parameter for the second generic argument in `Predicate2`.
`ImmutableCollection<V>`	`select(Predicate<? super V> predicate)`	Returns all elements of the source collection that return true when evaluating the predicate.
`ImmutableMapIterable<K,V>`	`select(Predicate2<? super K,? super V> predicate)`	For each key and value of the map the predicate is evaluated, if the result of the evaluation is true, that key and value are returned in a new map.
`<S> ImmutableCollection<S>`	`selectInstancesOf(java.lang.Class<S> clazz)`	Returns all elements of the source collection that are instances of the Class `clazz`.
`<P> ImmutableCollection<V>`	`selectWith(Predicate2<? super V,? super P> predicate, P parameter)`	Similar to `RichIterable.select(Predicate)`, except with an evaluation parameter for the second generic argument in `Predicate2`.
`ImmutableMapIterable<K,V>`	`tap(Procedure<? super V> procedure)`	Executes the Procedure for each value of the map and returns `this`.
`<S> ImmutableCollection<Pair<V,S>>`	`zip(java.lang.Iterable<S> that)`	Returns a `RichIterable` formed from this `RichIterable` and another `RichIterable` by combining corresponding elements in pairs.
`ImmutableCollection<Pair<V,java.lang.Integer>>`	`zipWithIndex()`	Zips this `RichIterable` with its indices.

Methods inherited from interface org.eclipse.collections.api.InternalIterable
forEach, forEach, forEachWith, forEachWithIndex

Methods inherited from interface java.lang.Iterable
iterator

Methods inherited from interface org.eclipse.collections.api.map.MapIterable
containsKey, containsValue, detect, detectOptional, equals, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, hashCode, ifPresentApply, keysView, keyValuesView, parallelStream, spliterator, stream, toImmutable, toString, valuesView

Methods inherited from interface org.eclipse.collections.api.RichIterable
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collect, collectBoolean, collectBoolean, collectByte, collectByte, collectChar, collectChar, collectDouble, collectDouble, collectFloat, collectFloat, collectIf, collectIf, collectInt, collectInt, collectLong, collectLong, collectShort, collectShort, collectWith, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countBy, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollect, getFirst, getLast, getOnly, groupBy, 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, partitionWith, reduce, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex

- Method Detail
  - castToMap
```
java.util.Map<K,V> castToMap()
```
  - newWithKeyValue
```
ImmutableMapIterable<K,V> newWithKeyValue(K key,
                                          V value)
```
  - newWithAllKeyValues
```
ImmutableMapIterable<K,V> newWithAllKeyValues(java.lang.Iterable<? extends Pair<? extends K,? extends V>> keyValues)
```
  - newWithAllKeyValueArguments
```
ImmutableMapIterable<K,V> newWithAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)
```
  - newWithoutKey
```
ImmutableMapIterable<K,V> newWithoutKey(K key)
```
  - newWithoutAllKeys
```
ImmutableMapIterable<K,V> newWithoutAllKeys(java.lang.Iterable<? extends K> keys)
```
  - tap
```
ImmutableMapIterable<K,V> tap(Procedure<? super V> procedure)
```
    Description copied from interface: MapIterable
    Executes the Procedure for each value of the map and returns this.
```
 return peopleByCity.tap(person -> LOGGER.info(person.getName()));
 
```
    Specified by:
    
    tap in interface MapIterable<K,V>
    
    Specified by:
    
    tap in interface RichIterable<K>
    
    See Also:
    
    InternalIterable.forEach(Procedure)
  - flipUniqueValues
```
ImmutableMapIterable<V,K> flipUniqueValues()
```
    Description copied from interface: MapIterable
    Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key.
```
     MapIterable<Integer, String> map = this.newMapWithKeysValues(1, "1", 2, "2", 3, "3");
     MapIterable<String, Integer> result = map.flipUniqueValues();
     Assert.assertTrue(result.equals(UnifiedMap.newWithKeysValues("1", 1, "2", 2, "3", 3)));
 
```
    Specified by:
    
    flipUniqueValues in interface MapIterable<K,V>
  - flip
```
ImmutableMultimap<V,K> flip()
```
    Description copied from interface: MapIterable
    
    Given a map from Domain -> Range return a multimap from Range -> Domain. We chose the name 'flip' rather than 'invert' or 'transpose' since this method does not have the property of applying twice returns the original.
    Since the keys in the input are unique, the values in the output are unique, so the return type should be a SetMultimap. However since SetMultimap and SortedSetMultimap don't inherit from one another, SetMultimap here does not allow SortedMapIterable to have a SortedSetMultimap return. Thus we compromise and call this Multimap, even though all implementations will be a SetMultimap or SortedSetMultimap.
    
    Specified by:
    
    flip in interface MapIterable<K,V>
  - select
```
ImmutableMapIterable<K,V> select(Predicate2<? super K,? super V> predicate)
```
    Description copied from interface: MapIterable
    For each key and value of the map the predicate is evaluated, if the result of the evaluation is true, that key and value are returned in a new map.
```
 MapIterable<City, Person> selected =
     peopleByCity.select((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
 
```
    Specified by:
    
    select in interface MapIterable<K,V>
  - reject
```
ImmutableMapIterable<K,V> reject(Predicate2<? super K,? super V> predicate)
```
    Description copied from interface: MapIterable
    For each key and value of the map the predicate is evaluated, if the result of the evaluation is false, that key and value are returned in a new map.
```
 MapIterable<City, Person> rejected =
     peopleByCity.reject((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
 
```
    Specified by:
    
    reject in interface MapIterable<K,V>
  - collect
```
<K2,V2> ImmutableMapIterable<K2,V2> collect(Function2<? super K,? super V,Pair<K2,V2>> function)
```
    Description copied from interface: MapIterable
    For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values.
```
 MapIterable<String, String> collected =
     peopleByCity.collect((City city, Person person) -> Pair.of(city.getCountry(), person.getAddress().getCity()));
 
```
    Specified by:
    
    collect in interface MapIterable<K,V>
  - collectValues
```
<R> ImmutableMapIterable<K,R> collectValues(Function2<? super K,? super V,? extends R> function)
```
    Description copied from interface: MapIterable
    For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values.
```
 MapIterable<City, String> collected =
     peopleByCity.collectValues((City city, Person person) -> person.getFirstName() + " " + person.getLastName());
 
```
    Specified by:
    
    collectValues in interface MapIterable<K,V>
  - select
```
ImmutableCollection<V> select(Predicate<? super V> predicate)
```
    Description copied from interface: RichIterable
    Returns all elements of the source collection that return true when evaluating the predicate. This method is also commonly called filter.
    Example using a Java 8 lambda expression:
```
 RichIterable<Person> selected =
     people.select(person -> person.getAddress().getCity().equals("London"));
 
```
    Example using an anonymous inner class:
```
 RichIterable<Person> selected =
     people.select(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getAddress().getCity().equals("London");
         }
     });
```
    Specified by:
    
    select in interface RichIterable<K>
  - selectWith
```
<P> ImmutableCollection<V> selectWith(Predicate2<? super V,? super P> predicate,
                                      P parameter)
```
    Description copied from interface: RichIterable
    Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
    E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years
    Example using a Java 8 lambda expression:
```
 RichIterable<Person> selected =
     people.selectWith((Person person, Integer age) -> person.getAge() >= age, Integer.valueOf(18));
 
```
    Example using an anonymous inner class:
```
 RichIterable<Person> selected =
     people.selectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge() >= age;
         }
     }, Integer.valueOf(18));
 
```
    Specified by:
    
    selectWith in interface RichIterable<K>
    
    Parameters:
    
    predicate - a Predicate2 to use as the select criteria
    
    parameter - a parameter to pass in for evaluation of the second argument P in predicate
    
    See Also:
    
    RichIterable.select(Predicate)
  - reject
```
ImmutableCollection<V> reject(Predicate<? super V> predicate)
```
    Description copied from interface: RichIterable
    Returns all elements of the source collection that return false when evaluating of the predicate. This method is also sometimes called filterNot and is the equivalent of calling iterable.select(Predicates.not(predicate)).
    Example using a Java 8 lambda expression:
```
 RichIterable<Person> rejected =
     people.reject(person -> person.person.getLastName().equals("Smith"));
 
```
    Example using an anonymous inner class:
```
 RichIterable<Person> rejected =
     people.reject(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.person.getLastName().equals("Smith");
         }
     });
 
```
    Specified by:
    
    reject in interface RichIterable<K>
    
    Parameters:
    
    predicate - a Predicate to use as the reject criteria
    
    Returns:
    
    a RichIterable that contains elements that cause Predicate.accept(Object) method to evaluate to false
  - rejectWith
```
<P> ImmutableCollection<V> rejectWith(Predicate2<? super V,? super P> predicate,
                                      P parameter)
```
    Description copied from interface: RichIterable
    Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
    E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years
    Example using a Java 8 lambda expression:
```
 RichIterable<Person> rejected =
     people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18));
 
```
    Example using an anonymous inner class:
```
 MutableList<Person> rejected =
     people.rejectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge() < age;
         }
     }, Integer.valueOf(18));
 
```
    Specified by:
    
    rejectWith in interface RichIterable<K>
    
    Parameters:
    
    predicate - a Predicate2 to use as the select criteria
    
    parameter - a parameter to pass in for evaluation of the second argument P in predicate
    
    See Also:
    
    RichIterable.select(Predicate)
  - partition
```
PartitionImmutableCollection<V> partition(Predicate<? super V> predicate)
```
    Description copied from interface: RichIterable
    Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
    Example using a Java 8 lambda expression:
```
 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partition(person -> person.getAddress().getState().getName().equals("New York"));
 
```
    Example using an anonymous inner class:
```
 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partition(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getAddress().getState().getName().equals("New York");
         }
     });
 
```
    Specified by:
    
    partition in interface RichIterable<K>
  - selectInstancesOf
```
<S> ImmutableCollection<S> selectInstancesOf(java.lang.Class<S> clazz)
```
    Description copied from interface: RichIterable
    Returns all elements of the source collection that are instances of the Class clazz.
```
 RichIterable<Integer> integers =
     List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
 
```
    Specified by:
    
    selectInstancesOf in interface RichIterable<K>
  - countBy
```
default <V1> ImmutableBag<V1> countBy(Function<? super V,? extends V1> function)
```
    Description copied from interface: RichIterable
    
    This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.
    
    Specified by:
    
    countBy in interface RichIterable<K>
    
    Since:
    
    9.0
  - countByWith
```
default <V1,P> ImmutableBag<V1> countByWith(Function2<? super V,? super P,? extends V1> function,
                                            P parameter)
```
    Description copied from interface: RichIterable
    
    This method will count the number of occurrences of each value calculated by applying the function to each element of the collection with the specified parameter as the second argument.
    
    Specified by:
    
    countByWith in interface RichIterable<K>
    
    Since:
    
    9.0
  - groupBy
```
<V1> ImmutableMultimap<V1,V> groupBy(Function<? super V,? extends V1> function)
```
    Description copied from interface: RichIterable
    For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
    Example using a Java 8 method reference:
```
 Multimap<String, Person> peopleByLastName =
     people.groupBy(Person::getLastName);
 
```
    Example using an anonymous inner class:
```
 Multimap<String, Person> peopleByLastName =
     people.groupBy(new Function<Person, String>()
     {
         public String valueOf(Person person)
         {
             return person.getLastName();
         }
     });
 
```
    Specified by:
    
    groupBy in interface RichIterable<K>
  - groupByEach
```
<V1> ImmutableMultimap<V1,V> groupByEach(Function<? super V,? extends java.lang.Iterable<V1>> function)
```
    Description copied from interface: RichIterable
    
    Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
    
    Specified by:
    
    groupByEach in interface RichIterable<K>
  - groupByUniqueKey
```
<V1> ImmutableMapIterable<V1,V> groupByUniqueKey(Function<? super V,? extends V1> function)
```
    Description copied from interface: RichIterable
    
    For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown.
    
    Specified by:
    
    groupByUniqueKey in interface RichIterable<K>
    
    See Also:
    
    RichIterable.groupBy(Function)
  - zip
```
<S> ImmutableCollection<Pair<V,S>> zip(java.lang.Iterable<S> that)
```
    Description copied from interface: RichIterable
    
    Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs. If one of the two RichIterables is longer than the other, its remaining elements are ignored.
    
    Specified by:
    
    zip in interface RichIterable<K>
    
    Type Parameters:
    
    S - the type of the second half of the returned pairs
    
    Parameters:
    
    that - The RichIterable providing the second half of each result pair
    
    Returns:
    
    A new RichIterable containing pairs consisting of corresponding elements of this RichIterable and that. The length of the returned RichIterable is the minimum of the lengths of this RichIterable and that.
  - zipWithIndex
```
ImmutableCollection<Pair<V,java.lang.Integer>> zipWithIndex()
```
    Description copied from interface: RichIterable
    
    Zips this RichIterable with its indices.
    
    Specified by:
    
    zipWithIndex in interface RichIterable<K>
    
    Returns:
    
    A new RichIterable containing pairs consisting of all elements of this RichIterable paired with their index. Indices start at 0.
    
    See Also:
    
    RichIterable.zip(Iterable)
  - aggregateInPlaceBy
```
<KK,VV> ImmutableMapIterable<KK,VV> aggregateInPlaceBy(Function<? super V,? extends KK> groupBy,
                                                       Function0<? extends VV> zeroValueFactory,
                                                       Procedure2<? super VV,? super V> mutatingAggregator)
```
    Description copied from interface: RichIterable
    
    Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function. Aggregate results are required to be mutable as they will be changed in place by the procedure. A second function specifies the initial "zero" aggregate value to work with (i.e. new AtomicInteger(0)).
    
    Specified by:
    
    aggregateInPlaceBy in interface RichIterable<K>
  - aggregateBy
```
<KK,VV> ImmutableMapIterable<KK,VV> aggregateBy(Function<? super V,? extends KK> groupBy,
                                                Function0<? extends VV> zeroValueFactory,
                                                Function2<? super VV,? super V,? extends VV> nonMutatingAggregator)
```
    Description copied from interface: RichIterable
    
    Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function. Aggregate results are allowed to be immutable as they will be replaced in place in the map. A second function specifies the initial "zero" aggregate value to work with (i.e. Integer.valueOf(0)).
    
    Specified by:
    
    aggregateBy in interface RichIterable<K>

Interface ImmutableMapIterable<K,V>

Method Summary

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

Methods inherited from interface java.lang.Iterable

Methods inherited from interface org.eclipse.collections.api.map.MapIterable

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

Method Detail

castToMap

newWithKeyValue

newWithAllKeyValues

newWithAllKeyValueArguments

newWithoutKey

newWithoutAllKeys

tap

flipUniqueValues

flip

select

reject

collect

collectValues

select

selectWith

reject

rejectWith

partition

selectInstancesOf

countBy

countByWith

groupBy

groupByEach

groupByUniqueKey

zip

zipWithIndex

aggregateInPlaceBy

aggregateBy