Interface ImmutableOrderedMap<K,​V>

All Superinterfaces:
`ImmutableMapIterable<K,​V>`, `InternalIterable<V>`, `Iterable<V>`, `MapIterable<K,​V>`, `OrderedIterable<V>`, `OrderedMap<K,​V>`, `ReversibleIterable<V>`, `RichIterable<V>`

```public interface ImmutableOrderedMap<K,​V>
extends OrderedMap<K,​V>, ImmutableMapIterable<K,​V>```
• Method Summary

Modifier and Type Method Description
```default <K1,​ V1,​ V2> ImmutableOrderedMap<K1,​V2>``` ```aggregateBy​(Function<? super K,​? extends K1> keyFunction, Function<? super V,​? extends V1> valueFunction, Function0<? extends V2> zeroValueFactory, Function2<? super V2,​? super V1,​? extends V2> nonMutatingAggregator)```
Applies an aggregate function over the map grouping results into a map based on the specific key and value groupBy functions.
```<KK,​ VV> ImmutableOrderedMap<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> ImmutableOrderedMap<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.
`<VV> ImmutableList<VV>` `collect​(Function<? super V,​? extends VV> function)`
Returns a new collection with the results of applying the specified function on each element of the source collection.
```<K2,​ V2> ImmutableOrderedMap<K2,​V2>``` `collect​(Function2<? super K,​? super V,​Pair<K2,​V2>> function)`
For each key and value of the map the function is evaluated.
`ImmutableBooleanList` `collectBoolean​(BooleanFunction<? super V> booleanFunction)`
Returns a new primitive `boolean` iterable with the results of applying the specified function on each element of the source collection.
`ImmutableByteList` `collectByte​(ByteFunction<? super V> byteFunction)`
Returns a new primitive `byte` iterable with the results of applying the specified function on each element of the source collection.
`ImmutableCharList` `collectChar​(CharFunction<? super V> charFunction)`
Returns a new primitive `char` iterable with the results of applying the specified function on each element of the source collection.
`ImmutableDoubleList` `collectDouble​(DoubleFunction<? super V> doubleFunction)`
Returns a new primitive `double` iterable with the results of applying the specified function on each element of the source collection.
`ImmutableFloatList` `collectFloat​(FloatFunction<? super V> floatFunction)`
Returns a new primitive `float` iterable with the results of applying the specified function on each element of the source collection.
`<V1> ImmutableList<V1>` ```collectIf​(Predicate<? super V> predicate, Function<? super V,​? extends V1> function)```
Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate.
`ImmutableIntList` `collectInt​(IntFunction<? super V> intFunction)`
Returns a new primitive `int` iterable with the results of applying the specified function on each element of the source collection.
`ImmutableLongList` `collectLong​(LongFunction<? super V> longFunction)`
Returns a new primitive `long` iterable with the results of applying the specified function on each element of the source collection.
`ImmutableShortList` `collectShort​(ShortFunction<? super V> shortFunction)`
Returns a new primitive `short` iterable with the results of applying the specified function on each element of the source collection.
`<R> ImmutableOrderedMap<K,​R>` `collectValues​(Function2<? super K,​? super V,​? extends R> function)`
For each key and value of the map the function is evaluated.
```<P,​ V1> ImmutableList<V1>``` ```collectWith​(Function2<? super V,​? super P,​? extends V1> function, P parameter)```
Same as `RichIterable.collect(Function)` with a `Function2` and specified parameter which is passed to the block.
`ImmutableList<V>` `distinct()`
Returns a new `OrderedIterable` containing the distinct elements in this iterable.
`ImmutableOrderedMap<K,​V>` `drop​(int count)`
Returns an iterable after skipping the first `count` elements or an empty iterable if the `count` is greater than the length of the iterable.
`ImmutableOrderedMap<K,​V>` `dropWhile​(Predicate<? super V> predicate)`
Returns the final elements that do not satisfy the Predicate.
`<V1> ImmutableList<V1>` `flatCollect​(Function<? super V,​? extends Iterable<V1>> function)`
`flatCollect` is a special case of `RichIterable.collect(Function)`.
```default <P,​ V1> ImmutableList<V1>``` ```flatCollectWith​(Function2<? super V,​? super P,​? extends Iterable<V1>> function, P parameter)```
`ImmutableListMultimap<V,​K>` `flip()`
Given a map from Domain `->` Range return a multimap from Range `->` Domain.
`ImmutableOrderedMap<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> ImmutableListMultimap<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> ImmutableListMultimap<V1,​V>` `groupByEach​(Function<? super V,​? extends Iterable<V1>> function)`
Similar to `RichIterable.groupBy(Function)`, except the result of evaluating function will return a collection of keys for each value.
`<V1> ImmutableOrderedMap<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.
`PartitionImmutableList<V>` `partition​(Predicate<? super V> predicate)`
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
`PartitionImmutableList<V>` `partitionWhile​(Predicate<? super V> predicate)`
Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
`<P> PartitionImmutableList<V>` ```partitionWith​(Predicate2<? super V,​? super P> predicate, P parameter)```
Filters a collection into a PartitionIterable based on the evaluation of the predicate.
`ImmutableList<V>` `reject​(Predicate<? super V> predicate)`
Returns all elements of the source collection that return false when evaluating of the predicate.
`ImmutableOrderedMap<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> ImmutableList<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`.
`ImmutableList<V>` `select​(Predicate<? super V> predicate)`
Returns all elements of the source collection that return true when evaluating the predicate.
`ImmutableOrderedMap<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> ImmutableList<S>` `selectInstancesOf​(Class<S> clazz)`
Returns all elements of the source collection that are instances of the Class `clazz`.
`<P> ImmutableList<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`.
`ImmutableOrderedMap<K,​V>` `take​(int count)`
Returns the first `count` elements of the iterable or all the elements in the iterable if `count` is greater than the length of the iterable.
`ImmutableOrderedMap<K,​V>` `takeWhile​(Predicate<? super V> predicate)`
Returns the initial elements that satisfy the Predicate.
`ImmutableOrderedMap<K,​V>` `tap​(Procedure<? super V> procedure)`
Executes the Procedure for each value of the map and returns `this`.
`ImmutableOrderedMap<K,​V>` `toReversed()`
Returns a new ReversibleIterable in reverse order.
`<S> ImmutableList<Pair<V,​S>>` `zip​(Iterable<S> that)`
Returns a `RichIterable` formed from this `RichIterable` and another `RichIterable` by combining corresponding elements in pairs.
`ImmutableList<Pair<V,​Integer>>` `zipWithIndex()`
Zips this `RichIterable` with its indices.

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

`castToMap, countBy, countByEach, countByWith, newWithAllKeyValueArguments, newWithAllKeyValues, newWithKeyValue, newWithoutAllKeys, newWithoutKey`

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

`forEach, forEachWith`

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, getOrDefault, hashCode, ifPresentApply, keysView, keyValuesView, parallelStream, spliterator, stream, toString, valuesView`

Methods inherited from interface org.eclipse.collections.api.ordered.OrderedIterable

`collectWithIndex, corresponds, detectIndex, forEach, forEachWithIndex, forEachWithIndex, getFirst, getFirstOptional, getLast, getLastOptional, indexOf, max, min, toStack, zip, zipWithIndex`

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

`toImmutable`

Methods inherited from interface org.eclipse.collections.api.ordered.ReversibleIterable

`asReversed, collectWithIndex, detectLastIndex, reverseForEach, reverseForEachWithIndex`

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, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, makeString, makeString, makeString, max, maxBy, maxByOptional, maxOptional, maxOptional, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, 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`
• Method Details

• tap

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 `ImmutableMapIterable<K,​V>`
Specified by:
`tap` in interface `MapIterable<K,​V>`
Specified by:
`tap` in interface `OrderedIterable<K>`
Specified by:
`tap` in interface `OrderedMap<K,​V>`
Specified by:
`tap` in interface `ReversibleIterable<K>`
Specified by:
`tap` in interface `RichIterable<K>`
`RichIterable.forEach(Procedure)`
• flipUniqueValues

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 `ImmutableMapIterable<K,​V>`
Specified by:
`flipUniqueValues` in interface `MapIterable<K,​V>`
Specified by:
`flipUniqueValues` in interface `OrderedMap<K,​V>`
• flip

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 `ImmutableMapIterable<K,​V>`
Specified by:
`flip` in interface `MapIterable<K,​V>`
Specified by:
`flip` in interface `OrderedMap<K,​V>`
• select

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 `ImmutableMapIterable<K,​V>`
Specified by:
`select` in interface `MapIterable<K,​V>`
Specified by:
`select` in interface `OrderedMap<K,​V>`
• reject

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 `ImmutableMapIterable<K,​V>`
Specified by:
`reject` in interface `MapIterable<K,​V>`
Specified by:
`reject` in interface `OrderedMap<K,​V>`
• collect

<K2,​ V2> ImmutableOrderedMap<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 `ImmutableMapIterable<K,​V>`
Specified by:
`collect` in interface `MapIterable<K,​V>`
Specified by:
`collect` in interface `OrderedMap<K,​V>`
• collectValues

<R> ImmutableOrderedMap<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 `ImmutableMapIterable<K,​V>`
Specified by:
`collectValues` in interface `MapIterable<K,​V>`
Specified by:
`collectValues` in interface `OrderedMap<K,​V>`
• toReversed

toReversed()
Description copied from interface: `ReversibleIterable`
Returns a new ReversibleIterable in reverse order.
Specified by:
`toReversed` in interface `OrderedMap<K,​V>`
Specified by:
`toReversed` in interface `ReversibleIterable<K>`
• take

take​(int count)
Description copied from interface: `ReversibleIterable`
Returns the first `count` elements of the iterable or all the elements in the iterable if `count` is greater than the length of the iterable.
Specified by:
`take` in interface `OrderedMap<K,​V>`
Specified by:
`take` in interface `ReversibleIterable<K>`
Parameters:
`count` - the number of items to take.
• takeWhile

takeWhile​(Predicate<? super V> predicate)
Description copied from interface: `ReversibleIterable`
Returns the initial elements that satisfy the Predicate. Short circuits at the first element which does not satisfy the Predicate.
Specified by:
`takeWhile` in interface `OrderedIterable<K>`
Specified by:
`takeWhile` in interface `OrderedMap<K,​V>`
Specified by:
`takeWhile` in interface `ReversibleIterable<K>`
• drop

drop​(int count)
Description copied from interface: `ReversibleIterable`
Returns an iterable after skipping the first `count` elements or an empty iterable if the `count` is greater than the length of the iterable.
Specified by:
`drop` in interface `OrderedMap<K,​V>`
Specified by:
`drop` in interface `ReversibleIterable<K>`
Parameters:
`count` - the number of items to drop.
• dropWhile

dropWhile​(Predicate<? super V> predicate)
Description copied from interface: `ReversibleIterable`
Returns the final elements that do not satisfy the Predicate. Short circuits at the first element which does satisfy the Predicate.
Specified by:
`dropWhile` in interface `OrderedIterable<K>`
Specified by:
`dropWhile` in interface `OrderedMap<K,​V>`
Specified by:
`dropWhile` in interface `ReversibleIterable<K>`
• partitionWhile

partitionWhile​(Predicate<? super V> predicate)
Description copied from interface: `OrderedIterable`
Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements. Short circuits at the first element which does satisfy the Predicate.
Specified by:
`partitionWhile` in interface `OrderedIterable<K>`
Specified by:
`partitionWhile` in interface `OrderedMap<K,​V>`
Specified by:
`partitionWhile` in interface `ReversibleIterable<K>`
• distinct

distinct()
Description copied from interface: `OrderedIterable`
Returns a new `OrderedIterable` containing the distinct elements in this iterable.

Conceptually similar to `RichIterable.toSet()`.`RichIterable.toList()` but retains the original order. If an element appears multiple times in this iterable, the first one will be copied into the result.

Specified by:
`distinct` in interface `OrderedIterable<K>`
Specified by:
`distinct` in interface `OrderedMap<K,​V>`
Specified by:
`distinct` in interface `ReversibleIterable<K>`
Returns:
`OrderedIterable` of distinct elements
• select

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 =
```

Example using an anonymous inner class:

``` RichIterable<Person> selected =
people.select(new Predicate<Person>()
{
public boolean accept(Person person)
{
}
});
```
Specified by:
`select` in interface `ImmutableMapIterable<K,​V>`
Specified by:
`select` in interface `OrderedIterable<K>`
Specified by:
`select` in interface `OrderedMap<K,​V>`
Specified by:
`select` in interface `ReversibleIterable<K>`
Specified by:
`select` in interface `RichIterable<K>`
• selectWith

<P>  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 `ImmutableMapIterable<K,​V>`
Specified by:
`selectWith` in interface `OrderedIterable<K>`
Specified by:
`selectWith` in interface `OrderedMap<K,​V>`
Specified by:
`selectWith` in interface `ReversibleIterable<K>`
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`
`RichIterable.select(Predicate)`
• reject

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 `ImmutableMapIterable<K,​V>`
Specified by:
`reject` in interface `OrderedIterable<K>`
Specified by:
`reject` in interface `OrderedMap<K,​V>`
Specified by:
`reject` in interface `ReversibleIterable<K>`
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>  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 `ImmutableMapIterable<K,​V>`
Specified by:
`rejectWith` in interface `OrderedIterable<K>`
Specified by:
`rejectWith` in interface `OrderedMap<K,​V>`
Specified by:
`rejectWith` in interface `ReversibleIterable<K>`
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`
`RichIterable.select(Predicate)`
• partition

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)
{
}
});
```
Specified by:
`partition` in interface `ImmutableMapIterable<K,​V>`
Specified by:
`partition` in interface `OrderedIterable<K>`
Specified by:
`partition` in interface `OrderedMap<K,​V>`
Specified by:
`partition` in interface `ReversibleIterable<K>`
Specified by:
`partition` in interface `RichIterable<K>`
• partitionWith

<P>  partitionWith​(Predicate2<? super V,​? super P> predicate, P parameter)
Description copied from interface: `RichIterable`
Filters a collection into a PartitionIterable based on the evaluation of the predicate.

Example using a Java 8 lambda expression:

``` PartitionIterable<Person> newYorkersAndNonNewYorkers =
people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
```

Example using an anonymous inner class:

``` PartitionIterable<Person> newYorkersAndNonNewYorkers =
people.partitionWith(new Predicate2<Person, String>()
{
public boolean accept(Person person, String state)
{
}
}, "New York");
```
Specified by:
`partitionWith` in interface `OrderedIterable<K>`
Specified by:
`partitionWith` in interface `OrderedMap<K,​V>`
Specified by:
`partitionWith` in interface `ReversibleIterable<K>`
Specified by:
`partitionWith` in interface `RichIterable<K>`
• collectBoolean

ImmutableBooleanList collectBoolean​(BooleanFunction<? super V> booleanFunction)
Description copied from interface: `RichIterable`
Returns a new primitive `boolean` iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

``` BooleanIterable licenses =
```

Example using an anonymous inner class:

``` BooleanIterable licenses =
people.collectBoolean(new BooleanFunction<Person>()
{
public boolean booleanValueOf(Person person)
{
}
});
```
Specified by:
`collectBoolean` in interface `OrderedIterable<K>`
Specified by:
`collectBoolean` in interface `OrderedMap<K,​V>`
Specified by:
`collectBoolean` in interface `ReversibleIterable<K>`
Specified by:
`collectBoolean` in interface `RichIterable<K>`
• collectByte

ImmutableByteList collectByte​(ByteFunction<? super V> byteFunction)
Description copied from interface: `RichIterable`
Returns a new primitive `byte` iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

``` ByteIterable bytes =
people.collectByte(person -> person.getCode());
```

Example using an anonymous inner class:

``` ByteIterable bytes =
people.collectByte(new ByteFunction<Person>()
{
public byte byteValueOf(Person person)
{
return person.getCode();
}
});
```
Specified by:
`collectByte` in interface `OrderedIterable<K>`
Specified by:
`collectByte` in interface `OrderedMap<K,​V>`
Specified by:
`collectByte` in interface `ReversibleIterable<K>`
Specified by:
`collectByte` in interface `RichIterable<K>`
• collectChar

ImmutableCharList collectChar​(CharFunction<? super V> charFunction)
Description copied from interface: `RichIterable`
Returns a new primitive `char` iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

``` CharIterable chars =
people.collectChar(person -> person.getMiddleInitial());
```

Example using an anonymous inner class:

``` CharIterable chars =
people.collectChar(new CharFunction<Person>()
{
public char charValueOf(Person person)
{
return person.getMiddleInitial();
}
});
```
Specified by:
`collectChar` in interface `OrderedIterable<K>`
Specified by:
`collectChar` in interface `OrderedMap<K,​V>`
Specified by:
`collectChar` in interface `ReversibleIterable<K>`
Specified by:
`collectChar` in interface `RichIterable<K>`
• collectDouble

ImmutableDoubleList collectDouble​(DoubleFunction<? super V> doubleFunction)
Description copied from interface: `RichIterable`
Returns a new primitive `double` iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

``` DoubleIterable doubles =
people.collectDouble(person -> person.getMilesFromNorthPole());
```

Example using an anonymous inner class:

``` DoubleIterable doubles =
people.collectDouble(new DoubleFunction<Person>()
{
public double doubleValueOf(Person person)
{
return person.getMilesFromNorthPole();
}
});
```
Specified by:
`collectDouble` in interface `OrderedIterable<K>`
Specified by:
`collectDouble` in interface `OrderedMap<K,​V>`
Specified by:
`collectDouble` in interface `ReversibleIterable<K>`
Specified by:
`collectDouble` in interface `RichIterable<K>`
• collectFloat

ImmutableFloatList collectFloat​(FloatFunction<? super V> floatFunction)
Description copied from interface: `RichIterable`
Returns a new primitive `float` iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

``` FloatIterable floats =
people.collectFloat(person -> person.getHeightInInches());
```

Example using an anonymous inner class:

``` FloatIterable floats =
people.collectFloat(new FloatFunction<Person>()
{
public float floatValueOf(Person person)
{
return person.getHeightInInches();
}
});
```
Specified by:
`collectFloat` in interface `OrderedIterable<K>`
Specified by:
`collectFloat` in interface `OrderedMap<K,​V>`
Specified by:
`collectFloat` in interface `ReversibleIterable<K>`
Specified by:
`collectFloat` in interface `RichIterable<K>`
• collectInt

ImmutableIntList collectInt​(IntFunction<? super V> intFunction)
Description copied from interface: `RichIterable`
Returns a new primitive `int` iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

``` IntIterable ints =
people.collectInt(person -> person.getAge());
```

Example using an anonymous inner class:

``` IntIterable ints =
people.collectInt(new IntFunction<Person>()
{
public int intValueOf(Person person)
{
return person.getAge();
}
});
```
Specified by:
`collectInt` in interface `OrderedIterable<K>`
Specified by:
`collectInt` in interface `OrderedMap<K,​V>`
Specified by:
`collectInt` in interface `ReversibleIterable<K>`
Specified by:
`collectInt` in interface `RichIterable<K>`
• collectLong

ImmutableLongList collectLong​(LongFunction<? super V> longFunction)
Description copied from interface: `RichIterable`
Returns a new primitive `long` iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

``` LongIterable longs =
people.collectLong(person -> person.getGuid());
```

Example using an anonymous inner class:

``` LongIterable longs =
people.collectLong(new LongFunction<Person>()
{
public long longValueOf(Person person)
{
return person.getGuid();
}
});
```
Specified by:
`collectLong` in interface `OrderedIterable<K>`
Specified by:
`collectLong` in interface `OrderedMap<K,​V>`
Specified by:
`collectLong` in interface `ReversibleIterable<K>`
Specified by:
`collectLong` in interface `RichIterable<K>`
• collectShort

ImmutableShortList collectShort​(ShortFunction<? super V> shortFunction)
Description copied from interface: `RichIterable`
Returns a new primitive `short` iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

``` ShortIterable shorts =
```

Example using an anonymous inner class:

``` ShortIterable shorts =
people.collectShort(new ShortFunction<Person>()
{
public short shortValueOf(Person person)
{
}
});
```
Specified by:
`collectShort` in interface `OrderedIterable<K>`
Specified by:
`collectShort` in interface `OrderedMap<K,​V>`
Specified by:
`collectShort` in interface `ReversibleIterable<K>`
Specified by:
`collectShort` in interface `RichIterable<K>`
• zip

<S> ImmutableList<Pair<V,​S>> zip​(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 `RichIterable`s is longer than the other, its remaining elements are ignored.
Specified by:
`zip` in interface `ImmutableMapIterable<K,​V>`
Specified by:
`zip` in interface `OrderedIterable<K>`
Specified by:
`zip` in interface `OrderedMap<K,​V>`
Specified by:
`zip` in interface `ReversibleIterable<K>`
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

zipWithIndex()
Description copied from interface: `RichIterable`
Zips this `RichIterable` with its indices.
Specified by:
`zipWithIndex` in interface `ImmutableMapIterable<K,​V>`
Specified by:
`zipWithIndex` in interface `OrderedIterable<K>`
Specified by:
`zipWithIndex` in interface `OrderedMap<K,​V>`
Specified by:
`zipWithIndex` in interface `ReversibleIterable<K>`
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.
`RichIterable.zip(Iterable)`
• collect

<VV> ImmutableList<VV> collect​(Function<? super V,​? extends VV> function)
Description copied from interface: `RichIterable`
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.

Example using a Java 8 lambda expression:

``` RichIterable<String> names =
people.collect(person -> person.getFirstName() + " " + person.getLastName());
```

Example using an anonymous inner class:

``` RichIterable<String> names =
people.collect(new Function<Person, String>()
{
public String valueOf(Person person)
{
return person.getFirstName() + " " + person.getLastName();
}
});
```
Specified by:
`collect` in interface `OrderedIterable<K>`
Specified by:
`collect` in interface `OrderedMap<K,​V>`
Specified by:
`collect` in interface `ReversibleIterable<K>`
Specified by:
`collect` in interface `RichIterable<K>`
• collectWith

<P,​ V1> ImmutableList<V1> collectWith​(Function2<? super V,​? super P,​? extends V1> function, P parameter)
Description copied from interface: `RichIterable`
Same as `RichIterable.collect(Function)` with a `Function2` and specified parameter which is passed to the block.

Example using a Java 8 lambda expression:

``` RichIterable<Integer> integers =
Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
```

Example using an anonymous inner class:

``` Function2<Integer, Integer, Integer> addParameterFunction =
new Function2<Integer, Integer, Integer>()
{
public Integer value(Integer each, Integer parameter)
{
return each + parameter;
}
};
RichIterable<Integer> integers =
Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
```
Specified by:
`collectWith` in interface `OrderedIterable<K>`
Specified by:
`collectWith` in interface `OrderedMap<K,​V>`
Specified by:
`collectWith` in interface `ReversibleIterable<K>`
Specified by:
`collectWith` in interface `RichIterable<K>`
Parameters:
`function` - A `Function2` to use as the collect transformation function
`parameter` - A parameter to pass in for evaluation of the second argument `P` in `function`
Returns:
A new `RichIterable` that contains the transformed elements returned by `Function2.value(Object, Object)`
`RichIterable.collect(Function)`
• collectIf

<V1> ImmutableList<V1> collectIf​(Predicate<? super V> predicate, Function<? super V,​? extends V1> function)
Description copied from interface: `RichIterable`
Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate. This is the the optimized equivalent of calling iterable.select(predicate).collect(function).

Example using a Java 8 lambda and method reference:

``` RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(e -> e != null, Object::toString);
```

Example using Predicates factory:

``` RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString());
```
Specified by:
`collectIf` in interface `OrderedIterable<K>`
Specified by:
`collectIf` in interface `OrderedMap<K,​V>`
Specified by:
`collectIf` in interface `ReversibleIterable<K>`
Specified by:
`collectIf` in interface `RichIterable<K>`
• selectInstancesOf

<S>  selectInstancesOf​(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 `ImmutableMapIterable<K,​V>`
Specified by:
`selectInstancesOf` in interface `OrderedIterable<K>`
Specified by:
`selectInstancesOf` in interface `OrderedMap<K,​V>`
Specified by:
`selectInstancesOf` in interface `ReversibleIterable<K>`
Specified by:
`selectInstancesOf` in interface `RichIterable<K>`
• flatCollect

<V1> ImmutableList<V1> flatCollect​(Function<? super V,​? extends Iterable<V1>> function)
Description copied from interface: `RichIterable`
`flatCollect` is a special case of `RichIterable.collect(Function)`. With `collect`, when the `Function` returns a collection, the result is a collection of collections. `flatCollect` outputs a single "flattened" collection instead. This method is commonly called flatMap.

Consider the following example where we have a `Person` class, and each `Person` has a list of `Address` objects. Take the following `Function`:

``` Function<Person, List<Address>> addressFunction = Person::getAddresses;
RichIterable<Person> people = ...;
```
Using `collect` returns a collection of collections of addresses.
``` RichIterable<List<Address>> addresses = people.collect(addressFunction);
```
Using `flatCollect` returns a single flattened list of addresses.
``` RichIterable<Address> addresses = people.flatCollect(addressFunction);
```
Specified by:
`flatCollect` in interface `OrderedIterable<K>`
Specified by:
`flatCollect` in interface `OrderedMap<K,​V>`
Specified by:
`flatCollect` in interface `ReversibleIterable<K>`
Specified by:
`flatCollect` in interface `RichIterable<K>`
Parameters:
`function` - The `Function` to apply
Returns:
a new flattened collection produced by applying the given `function`
• flatCollectWith

default <P,​ V1> ImmutableList<V1> flatCollectWith​(Function2<? super V,​? super P,​? extends Iterable<V1>> function, P parameter)
Specified by:
`flatCollectWith` in interface `OrderedIterable<K>`
Specified by:
`flatCollectWith` in interface `OrderedMap<K,​V>`
Specified by:
`flatCollectWith` in interface `ReversibleIterable<K>`
Specified by:
`flatCollectWith` in interface `RichIterable<K>`
Since:
9.2
• groupBy

<V1> ImmutableListMultimap<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 `ImmutableMapIterable<K,​V>`
Specified by:
`groupBy` in interface `OrderedIterable<K>`
Specified by:
`groupBy` in interface `OrderedMap<K,​V>`
Specified by:
`groupBy` in interface `ReversibleIterable<K>`
Specified by:
`groupBy` in interface `RichIterable<K>`
• groupByEach

<V1> ImmutableListMultimap<V1,​V> groupByEach​(Function<? super V,​? extends 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 `ImmutableMapIterable<K,​V>`
Specified by:
`groupByEach` in interface `OrderedIterable<K>`
Specified by:
`groupByEach` in interface `OrderedMap<K,​V>`
Specified by:
`groupByEach` in interface `ReversibleIterable<K>`
Specified by:
`groupByEach` in interface `RichIterable<K>`
• groupByUniqueKey

<V1> ImmutableOrderedMap<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 `ImmutableMapIterable<K,​V>`
Specified by:
`groupByUniqueKey` in interface `OrderedMap<K,​V>`
Specified by:
`groupByUniqueKey` in interface `RichIterable<K>`
`RichIterable.groupBy(Function)`
• aggregateInPlaceBy

<KK,​ VV> ImmutableOrderedMap<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 `ImmutableMapIterable<K,​V>`
Specified by:
`aggregateInPlaceBy` in interface `RichIterable<K>`
• aggregateBy

<KK,​ VV> ImmutableOrderedMap<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 `ImmutableMapIterable<K,​V>`
Specified by:
`aggregateBy` in interface `RichIterable<K>`
• aggregateBy

default <K1,​ V1,​ V2> ImmutableOrderedMap<K1,​V2> aggregateBy​(Function<? super K,​? extends K1> keyFunction, Function<? super V,​? extends V1> valueFunction, Function0<? extends V2> zeroValueFactory, Function2<? super V2,​? super V1,​? extends V2> nonMutatingAggregator)
Description copied from interface: `MapIterable`
Applies an aggregate function over the map grouping results into a map based on the specific key and value groupBy functions. 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.
``` MapIterable<String, Interval> map = Maps.mutable.with("oneToFive", Interval.fromTo(1, 5), "sixToNine", Interval.fromTo(6, 9));

MapIterable<String, Long> result = map.aggregateBy(
eachKey -> {
return eachKey.equals("oneToFive")  ? "lessThanSix" : "greaterOrEqualsToSix";
},
each -> each.sumOfInt(Integer::intValue),
() -> 0L,
(argument1, argument2) -> argument1 + argument2);

MapIterable<String, Long> expected =
Maps.mutable.with("lessThanSix", Interval.fromTo(1, 5).sumOfInt(Integer::intValue),
"greaterOrEqualsToSix", Interval.fromTo(6, 9).sumOfInt(Integer::intValue));
Assert.assertEquals(expected, result);
```
Specified by:
`aggregateBy` in interface `ImmutableMapIterable<K,​V>`
Specified by:
`aggregateBy` in interface `MapIterable<K,​V>`