PrimitiveObjectMap (Eclipse Collections

All Superinterfaces:

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

All Known Subinterfaces:

ByteObjectMap<V>, CharObjectMap<V>, DoubleObjectMap<V>, FloatObjectMap<V>, ImmutableByteObjectMap<V>, ImmutableCharObjectMap<V>, ImmutableDoubleObjectMap<V>, ImmutableFloatObjectMap<V>, ImmutableIntObjectMap<V>, ImmutableLongObjectMap<V>, ImmutablePrimitiveObjectMap<V>, ImmutableShortObjectMap<V>, IntObjectMap<V>, LongObjectMap<V>, MutableByteObjectMap<V>, MutableCharObjectMap<V>, MutableDoubleObjectMap<V>, MutableFloatObjectMap<V>, MutableIntObjectMap<V>, MutableLongObjectMap<V>, MutablePrimitiveObjectMap<V>, MutableShortObjectMap<V>, ShortObjectMap<V>

All Known Implementing Classes:

AbstractImmutableByteObjectMap, AbstractImmutableCharObjectMap, AbstractImmutableDoubleObjectMap, AbstractImmutableFloatObjectMap, AbstractImmutableIntObjectMap, AbstractImmutableLongObjectMap, AbstractImmutableShortObjectMap, ByteObjectHashMap, CharObjectHashMap, DoubleObjectHashMap, FloatObjectHashMap, IntObjectHashMap, LongObjectHashMap, ShortObjectHashMap, SynchronizedByteObjectMap, SynchronizedCharObjectMap, SynchronizedDoubleObjectMap, SynchronizedFloatObjectMap, SynchronizedIntObjectMap, SynchronizedLongObjectMap, SynchronizedShortObjectMap, UnmodifiableByteObjectMap, UnmodifiableCharObjectMap, UnmodifiableDoubleObjectMap, UnmodifiableFloatObjectMap, UnmodifiableIntObjectMap, UnmodifiableLongObjectMap, UnmodifiableShortObjectMap
```
public interface PrimitiveObjectMap<V>
extends RichIterable<V>
```
Since:

8.0.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method	Description
`<VV> Bag<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.
`BooleanBag`	`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.
`ByteBag`	`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.
`CharBag`	`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.
`DoubleBag`	`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.
`FloatBag`	`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.
`<VV> Bag<VV>`	`collectIf(Predicate<? super V> predicate, 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, but only for those elements which return true upon evaluation of the predicate.
`IntBag`	`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.
`LongBag`	`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.
`ShortBag`	`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.
`<P,VV> Bag<VV>`	`collectWith(Function2<? super V,? super P,? extends VV> function, P parameter)`	Same as `RichIterable.collect(Function)` with a `Function2` and specified parameter which is passed to the block.
`boolean`	`containsValue(java.lang.Object value)`
`boolean`	`equals(java.lang.Object o)`	Follows the same general contract as `Map.equals(Object)`.
`<VV> Bag<VV>`	`flatCollect(Function<? super V,? extends java.lang.Iterable<VV>> function)`	`flatCollect` is a special case of `RichIterable.collect(Function)`.
`void`	`forEachValue(Procedure<? super V> procedure)`
`<VV> BagMultimap<VV,V>`	`groupBy(Function<? super V,? extends VV> 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.
`<VV> BagMultimap<VV,V>`	`groupByEach(Function<? super V,? extends java.lang.Iterable<VV>> function)`	Similar to `RichIterable.groupBy(Function)`, except the result of evaluating function will return a collection of keys for each value.
`<VV> UnsortedMapIterable<VV,V>`	`groupByUniqueKey(Function<? super V,? extends VV> 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.
`int`	`hashCode()`	Follows the same general contract as `Map.hashCode()`.
`default java.util.stream.Stream<V>`	`parallelStream()`
`PartitionBag<V>`	`partition(Predicate<? super V> predicate)`	Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
`<P> PartitionBag<V>`	`partitionWith(Predicate2<? super V,? super P> predicate, P parameter)`	Filters a collection into a PartitionIterable based on the evaluation of the predicate.
`Bag<V>`	`reject(Predicate<? super V> predicate)`	Returns all elements of the source collection that return false when evaluating of the predicate.
`<P> Bag<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`.
`Bag<V>`	`select(Predicate<? super V> predicate)`	Returns all elements of the source collection that return true when evaluating the predicate.
`<S> Bag<S>`	`selectInstancesOf(java.lang.Class<S> clazz)`	Returns all elements of the source collection that are instances of the Class `clazz`.
`<P> Bag<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`.
`default java.util.Spliterator<V>`	`spliterator()`
`default java.util.stream.Stream<V>`	`stream()`
`java.lang.String`	`toString()`	Returns a string with the keys and values of this map separated by commas with spaces and enclosed in curly braces.
`java.util.Collection<V>`	`values()`
`<S> Bag<Pair<V,S>>`	`zip(java.lang.Iterable<S> that)`	Deprecated. in 6.0. Use `OrderedIterable.zip(Iterable)` instead.
`UnsortedSetIterable<Pair<V,java.lang.Integer>>`	`zipWithIndex()`	Deprecated. in 6.0. Use `OrderedIterable.zipWithIndex()` instead.

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

- Method Detail
  - containsValue
```
boolean containsValue(java.lang.Object value)
```
  - forEachValue
```
void forEachValue(Procedure<? super V> procedure)
```
  - equals
```
boolean equals(java.lang.Object o)
```
    Follows the same general contract as Map.equals(Object).
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
int hashCode()
```
    Follows the same general contract as Map.hashCode().
    
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
java.lang.String toString()
```
    Returns a string with the keys and values of this map separated by commas with spaces and enclosed in curly braces. Each key and value is separated by an equals sign.
```
 Assert.assertEquals(
     "{1=1, 2=2, 3=3}",
     IntObjectMaps.mutable.empty().withKeyValue(1, 1).withKeyValue(2, 2).withKeyValue(3, 3).toString());
 
```
    Specified by:
    
    toString in interface RichIterable<V>
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a string representation of this PrimitiveObjectMap
    
    See Also:
    
    AbstractMap.toString()
  - values
```
java.util.Collection<V> values()
```
  - select
```
Bag<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> Bag<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
```
Bag<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> Bag<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
```
PartitionBag<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>
  - partitionWith
```
<P> PartitionBag<V> 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)
         {
             return person.getAddress().getState().getName().equals(state);
         }
     }, "New York");
 
```
    Specified by:
    
    partitionWith in interface RichIterable<V>
  - selectInstancesOf
```
<S> Bag<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<V>
  - collect
```
<VV> Bag<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 RichIterable<V>
  - collectBoolean
```
BooleanBag 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 =
     people.collectBoolean(person -> person.hasDrivingLicense());
 
```
    Example using an anonymous inner class:
```
 BooleanIterable licenses =
     people.collectBoolean(new BooleanFunction<Person>()
     {
         public boolean booleanValueOf(Person person)
         {
             return person.hasDrivingLicense();
         }
     });
 
```
    Specified by:
    
    collectBoolean in interface RichIterable<V>
  - collectByte
```
ByteBag 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 RichIterable<V>
  - collectChar
```
CharBag 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 RichIterable<V>
  - collectDouble
```
DoubleBag 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 RichIterable<V>
  - collectFloat
```
FloatBag 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 RichIterable<V>
  - collectInt
```
IntBag 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 RichIterable<V>
  - collectLong
```
LongBag 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 RichIterable<V>
  - collectShort
```
ShortBag 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 =
     people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
 
```
    Example using an anonymous inner class:
```
 ShortIterable shorts =
     people.collectShort(new ShortFunction<Person>()
     {
         public short shortValueOf(Person person)
         {
             return person.getNumberOfJunkMailItemsReceivedPerMonth();
         }
     });
 
```
    Specified by:
    
    collectShort in interface RichIterable<V>
  - collectWith
```
<P,VV> Bag<VV> collectWith(Function2<? super V,? super P,? extends VV> 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 RichIterable<V>
    
    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)
    
    See Also:
    
    RichIterable.collect(Function)
  - collectIf
```
<VV> Bag<VV> collectIf(Predicate<? super V> predicate,
                       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, 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 RichIterable<V>
  - flatCollect
```
<VV> Bag<VV> flatCollect(Function<? super V,? extends java.lang.Iterable<VV>> 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 RichIterable<V>
    
    Parameters:
    
    function - The Function to apply
    
    Returns:
    
    a new flattened collection produced by applying the given function
  - groupBy
```
<VV> BagMultimap<VV,V> groupBy(Function<? super V,? extends VV> 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
```
<VV> BagMultimap<VV,V> groupByEach(Function<? super V,? extends java.lang.Iterable<VV>> 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
```
<VV> UnsortedMapIterable<VV,V> groupByUniqueKey(Function<? super V,? extends VV> 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
```
@Deprecated
<S> Bag<Pair<V,S>> zip(java.lang.Iterable<S> that)
```
    Deprecated. in 6.0. Use OrderedIterable.zip(Iterable) instead.
    
    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
```
@Deprecated
UnsortedSetIterable<Pair<V,java.lang.Integer>> zipWithIndex()
```
    Deprecated. in 6.0. Use OrderedIterable.zipWithIndex() instead.
    
    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)
  - stream
```
default java.util.stream.Stream<V> stream()
```
    Since:
    
    9.0
  - parallelStream
```
default java.util.stream.Stream<V> parallelStream()
```
    Since:
    
    9.0
  - spliterator
```
default java.util.Spliterator<V> spliterator()
```
    Specified by:
    
    spliterator in interface java.lang.Iterable<V>
    
    Since:
    
    9.0

Interface PrimitiveObjectMap<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.RichIterable

Method Detail

containsValue

forEachValue

equals

hashCode

toString

values

select

selectWith

reject

rejectWith

partition

partitionWith

selectInstancesOf

collect

collectBoolean

collectByte

collectChar

collectDouble

collectFloat

collectInt

collectLong

collectShort

collectWith

collectIf

flatCollect

groupBy

groupByEach

groupByUniqueKey

zip

zipWithIndex

stream

parallelStream

spliterator