org.eclipse.collections.api.map

Interface MutableMapIterable<K,V>

All Superinterfaces:

InternalIterable<V>, Iterable<V>, Map<K,V>, MapIterable<K,V>, RichIterable<V>

All Known Subinterfaces:

ConcurrentMutableMap<K,V>, FixedSizeMap<K,V>, MutableBiMap<K,V>, MutableMap<K,V>, MutableOrderedMap<K,V>, MutableSortedMap<K,V>

All Known Implementing Classes:

AbstractMutableMap, AbstractMutableMapIterable, AbstractMutableSortedMap, AbstractSynchronizedMapIterable, ConcurrentHashMap, ConcurrentHashMapUnsafe, ConcurrentMutableHashMap, HashBiMap, MapAdapter, SortedMapAdapter, SynchronizedBiMap, SynchronizedMutableMap, SynchronizedSortedMap, TreeSortedMap, UnifiedMap, UnifiedMapWithHashingStrategy, UnmodifiableBiMap, UnmodifiableMutableMap, UnmodifiableTreeMap

public interface MutableMapIterable<K,V>
extends MapIterable<K,V>, Map<K,V>

Since:

6.0

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
default V	add(Pair<K,V> keyValuePair) This method allows mutable map the ability to add an element in the form of Pair.
<KK,VV> MutableMap<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> MutableMap<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.
MutableMapIterable<K,V>	asSynchronized() Returns a synchronized (thread-safe) map backed by the specified map.
MutableMapIterable<K,V>	asUnmodifiable() Returns an unmodifiable view of this map.
<K2,V2> MutableMapIterable<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> MutableMapIterable<K,R>	collectValues(Function2<? super K,? super V,? extends R> function) For each key and value of the map the function is evaluated.
MutableMultimap<V,K>	flip() Given a map from Domain -> Range return a multimap from Range -> Domain.
MutableMapIterable<V,K>	flipUniqueValues() Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key.
V	getIfAbsentPut(K key, Function0<? extends V> function) Get and return the value in the Map at the specified key.
V	getIfAbsentPut(K key, V value) Get and return the value in the Map at the specified key.
<P> V	getIfAbsentPutWith(K key, Function<? super P,? extends V> function, P parameter) Get and return the value in the Map at the specified key.
V	getIfAbsentPutWithKey(K key, Function<? super K,? extends V> function) Get and return the value in the Map at the specified key.
<V1> MutableMultimap<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> MutableMultimap<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> MutableMapIterable<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.
MutableMapIterable<K,V>	newEmpty() Creates a new instance of the same type, using the default capacity and growth parameters.
PartitionMutableCollection<V>	partition(Predicate<? super V> predicate) Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
MutableCollection<V>	reject(Predicate<? super V> predicate) Returns all elements of the source collection that return false when evaluating of the predicate.
MutableMapIterable<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> MutableCollection<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.
V	removeKey(K key) Remove an entry from the map at the specified key.
MutableCollection<V>	select(Predicate<? super V> predicate) Returns all elements of the source collection that return true when evaluating the predicate.
MutableMapIterable<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> MutableCollection<S>	selectInstancesOf(Class<S> clazz) Returns all elements of the source collection that are instances of the Class clazz.
<P> MutableCollection<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.
<V1> MutableObjectDoubleMap<V1>	sumByDouble(Function<? super V,? extends V1> groupBy, DoubleFunction<? super V> function) Groups and sums the values using the two specified functions.
<V1> MutableObjectDoubleMap<V1>	sumByFloat(Function<? super V,? extends V1> groupBy, FloatFunction<? super V> function) Groups and sums the values using the two specified functions.
<V1> MutableObjectLongMap<V1>	sumByInt(Function<? super V,? extends V1> groupBy, IntFunction<? super V> function) Groups and sums the values using the two specified functions.
<V1> MutableObjectLongMap<V1>	sumByLong(Function<? super V,? extends V1> groupBy, LongFunction<? super V> function) Groups and sums the values using the two specified functions.
MutableMapIterable<K,V>	tap(Procedure<? super V> procedure) Executes the Procedure for each value of the map and returns this.
ImmutableMapIterable<K,V>	toImmutable() Returns an immutable copy of this map.
V	updateValue(K key, Function0<? extends V> factory, Function<? super V,? extends V> function) Looks up the value associated with key, applies the function to it, and replaces the value.
<P> V	updateValueWith(K key, Function0<? extends V> factory, Function2<? super V,? super P,? extends V> function, P parameter) Same as updateValue(Object, Function0, Function) with a Function2 and specified parameter which is passed to the function.
MutableMapIterable<K,V>	withAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs) Convenience var-args version of withAllKeyValues
MutableMapIterable<K,V>	withAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues) This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements.
MutableMapIterable<K,V>	withKeyValue(K key, V value) This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements.
MutableMapIterable<K,V>	withoutAllKeys(Iterable<? extends K> keys) This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements.
MutableMapIterable<K,V>	withoutKey(K key) This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements.
<S> MutableCollection<Pair<V,S>>	zip(Iterable<S> that) Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs.
MutableCollection<Pair<V,Integer>>	zipWithIndex() Zips this RichIterable with its indices.

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, 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, 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, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, partitionWith, reduce, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, 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

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

forEach, forEachWith, forEachWithIndex

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

add

default V add(Pair<K,V> keyValuePair)

This method allows mutable map the ability to add an element in the form of Pair.

See Also:

Map.put(Object, Object)

removeKey

V removeKey(K key)

Remove an entry from the map at the specified key.

Returns:

The value removed from entry at key, or null if not found.

See Also:

Map.remove(Object)

getIfAbsentPut

V getIfAbsentPut(K key,
                 Function0<? extends V> function)

Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map at the key, return the result of evaluating the specified Function0, and put that value in the map at the specified key.

getIfAbsentPut

V getIfAbsentPut(K key,
                 V value)

Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map at the key, return the specified value, and put that value in the map at the specified key.

Since:

5.0

getIfAbsentPutWithKey

V getIfAbsentPutWithKey(K key,
                        Function<? super K,? extends V> function)

Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map for that key return the result of evaluating the specified Function using the specified key, and put that value in the map at the specified key.

getIfAbsentPutWith

<P> V getIfAbsentPutWith(K key,
                         Function<? super P,? extends V> function,
                         P parameter)

Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map for that key return the result of evaluating the specified Function using the specified parameter, and put that value in the map at the specified key.

updateValue

V updateValue(K key,
              Function0<? extends V> factory,
              Function<? super V,? extends V> function)

Looks up the value associated with key, applies the function to it, and replaces the value. If there is no value associated with key, starts it off with a value supplied by factory.

updateValueWith

<P> V updateValueWith(K key,
                      Function0<? extends V> factory,
                      Function2<? super V,? super P,? extends V> function,
                      P parameter)

Same as updateValue(Object, Function0, Function) with a Function2 and specified parameter which is passed to the function.

withKeyValue

MutableMapIterable<K,V> withKeyValue(K key,
                                     V value)

This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original plus the additional key and value. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:

 map = map.withKeyValue("new key", "new value");
 

In the case of FixedSizeMap, a new instance will be returned by withKeyValue, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling put on themselves.

See Also:

Map.put(Object, Object)

withAllKeyValues

MutableMapIterable<K,V> withAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues)

This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original plus all of the additional keys and values. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:

 map = map.withAllKeyValues(FastList.newListWith(PairImpl.of("new key", "new value")));
 

In the case of FixedSizeMap, a new instance will be returned by withAllKeyValues, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling put on themselves.

See Also:

Map.put(Object, Object)

withAllKeyValueArguments

MutableMapIterable<K,V> withAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)

Convenience var-args version of withAllKeyValues

See Also:

withAllKeyValues(Iterable)

withoutKey

MutableMapIterable<K,V> withoutKey(K key)

This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original minus the key and value to be removed. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:

 map = map.withoutKey("key");
 

In the case of FixedSizeMap, a new instance will be returned by withoutKey, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling remove on themselves.

See Also:

Map.remove(Object)

withoutAllKeys

MutableMapIterable<K,V> withoutAllKeys(Iterable<? extends K> keys)

This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original minus all of the keys and values to be removed. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:

 map = map.withoutAllKeys(FastList.newListWith("key1", "key2"));
 

In the case of FixedSizeMap, a new instance will be returned by withoutAllKeys, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling remove on themselves.

See Also:

Map.remove(Object)

newEmpty

MutableMapIterable<K,V> newEmpty()

Creates a new instance of the same type, using the default capacity and growth parameters.

asUnmodifiable

MutableMapIterable<K,V> asUnmodifiable()

Returns an unmodifiable view of this map. This method allows modules to provide users with "read-only" access to internal maps. Any query operations on the returned map that "read through" to this map and attempt to modify the returned map, whether direct or via its iterator, result in an UnsupportedOperationException. The returned map will be Serializable if this map is Serializable.

Returns:

an unmodifiable view of this map.

asSynchronized

MutableMapIterable<K,V> asSynchronized()

Returns a synchronized (thread-safe) map backed by the specified map. In order to guarantee serial access, it is critical that all access to the backing map is accomplished through the returned map.

It is imperative that the user manually synchronize on the returned map when iterating over any of its collection views:

  MutableMap map = myMutableMap.asSynchronized();
      ...
  Set set = map.keySet();  // Needn't be in synchronized block
      ...
  synchronized(map)
  {  // Synchronizing on map, not set!
      Iterator i = s.iterator(); // Must be in synchronized block
      while (i.hasNext())
          foo(i.next());
  }
 

Failure to follow this advice may result in non-deterministic behavior.

The preferred way of iterating over a synchronized collection is to use the collection.forEach() method which is properly synchronized internally.

  MutableMap map = myMutableMap.asSynchronized();
      ...
  Set set = map.keySet();  // Needn't be in synchronized block
     ...
  Iterate.forEach(set, new Procedure()
  {
      public void value(Object each)
      {
          ...
      }
  });
 

The returned map will be serializable if the specified map is serializable.

toImmutable

ImmutableMapIterable<K,V> toImmutable()

Returns an immutable copy of this map. If the map is immutable, it returns itself.

Specified by:

toImmutable in interface MapIterable<K,V>

tap

MutableMapIterable<K,V> tap(Procedure<? super V> procedure)

Description copied from interface: MapIterable

Executes the Procedure for each value of the map and returns this.

e.g.
 return peopleByCity.tap(new Procedure()
 {
     public void value(Person person)
     {
         LOGGER.info(person.getName());
     }
 });
 

Specified by:

tap in interface MapIterable<K,V>

Specified by:

tap in interface RichIterable<V>

See Also:

InternalIterable.forEach(Procedure)

flipUniqueValues

MutableMapIterable<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 map = this.newMapWithKeysValues(1, "1", 2, "2", 3, "3");
     MapIterable result = map.flipUniqueValues();
     Assert.assertTrue(result.equals(UnifiedMap.newWithKeysValues("1", 1, "2", 2, "3", 3)));
 

Specified by:

flipUniqueValues in interface MapIterable<K,V>

flip

MutableMultimap<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

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

e.g.
 peopleByCity.select(new Predicate2<City, Person>()
 {
     public boolean accept(City city, Person person)
     {
         return city.getName().equals("Anytown") && person.getLastName().equals("Smith");
     }
 });
 

Specified by:

select in interface MapIterable<K,V>

reject

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

e.g.
 peopleByCity.reject(new Predicate2<City, Person>()
 {
     public boolean accept(City city, Person person)
     {
         return city.getName().equals("Anytown") && person.getLastName().equals("Smith");
     }
 });
 

Specified by:

reject in interface MapIterable<K,V>

collect

<K2,V2> MutableMapIterable<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.

e.g.
 peopleByCity.collect(new Function2<City, Person, String>()
 {
     public String value(City city, Person person)
     {
         return Pair.of(city.getCountry(), person.getAddress().getCity());
     }
 });
 

Specified by:

collect in interface MapIterable<K,V>

collectValues

<R> MutableMapIterable<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.

e.g.
 peopleByCity.collectValues(new Function2<City, Person, String>()
 {
     public String value(City city, Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 });
 

Specified by:

collectValues in interface MapIterable<K,V>

select

MutableCollection<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<V>

selectWith

<P> MutableCollection<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<V>

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

MutableCollection<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<V>

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> MutableCollection<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<V>

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

PartitionMutableCollection<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<V>

selectInstancesOf

<S> MutableCollection<S> selectInstancesOf(Class<S> clazz)

Description copied from interface: RichIterable

Returns all elements of the source collection that are instances of the Class clazz.

Specified by:

selectInstancesOf in interface RichIterable<V>

sumByInt

<V1> MutableObjectLongMap<V1> sumByInt(Function<? super V,? extends V1> groupBy,
                                       IntFunction<? super V> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByInt in interface RichIterable<V>

sumByFloat

<V1> MutableObjectDoubleMap<V1> sumByFloat(Function<? super V,? extends V1> groupBy,
                                           FloatFunction<? super V> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByFloat in interface RichIterable<V>

sumByLong

<V1> MutableObjectLongMap<V1> sumByLong(Function<? super V,? extends V1> groupBy,
                                        LongFunction<? super V> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByLong in interface RichIterable<V>

sumByDouble

<V1> MutableObjectDoubleMap<V1> sumByDouble(Function<? super V,? extends V1> groupBy,
                                            DoubleFunction<? super V> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByDouble in interface RichIterable<V>

groupBy

<V1> MutableMultimap<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<V>

groupByEach

<V1> MutableMultimap<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 RichIterable<V>

groupByUniqueKey

<V1> MutableMapIterable<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<V>

See Also:

RichIterable.groupBy(Function)

zip

<S> MutableCollection<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 RichIterables is longer than the other, its remaining elements are ignored.

Specified by:

zip in interface RichIterable<V>

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

MutableCollection<Pair<V,Integer>> zipWithIndex()

Description copied from interface: RichIterable

Zips this RichIterable with its indices.

Specified by:

zipWithIndex in interface RichIterable<V>

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> MutableMap<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<V>

aggregateBy

<KK,VV> MutableMap<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<V>