Package org.eclipse.collections.impl

Class AbstractRichIterable<T>

java.lang.Object
org.eclipse.collections.impl.AbstractRichIterable<T>
All Implemented Interfaces:
Iterable<T>, InternalIterable<T>, RichIterable<T>
Direct Known Subclasses:
AbstractBag, AbstractImmutableCollection, AbstractLazyIterable, AbstractMapIterable, AbstractMutableCollection
public abstract class AbstractRichIterable<T> extends Object implements RichIterable<T>

  • Constructor Details

    • AbstractRichIterable

      public AbstractRichIterable()

  • Method Details

    • contains

      public boolean contains(Object object)
      Description copied from interface: RichIterable
      Returns true if the iterable has an element which responds true to element.equals(object).
      Specified by:
      contains in interface RichIterable<T>

    • containsAllIterable

      public boolean containsAllIterable(Iterable<?> source)
      Description copied from interface: RichIterable
      Returns true if all elements in source are contained in this collection.
      Specified by:
      containsAllIterable in interface RichIterable<T>

    • containsAllArguments

      public boolean containsAllArguments(Object... elements)
      Description copied from interface: RichIterable
      Returns true if all elements in the specified var arg array are contained in this collection.
      Specified by:
      containsAllArguments in interface RichIterable<T>

    • toArray

      public Object[] toArray()
      Description copied from interface: RichIterable
      Converts this iterable to an array.
      Specified by:
      toArray in interface RichIterable<T>
      See Also:

    • toArray

      public <E> E[] toArray(E[] array)
      Description copied from interface: RichIterable
      Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.
      Specified by:
      toArray in interface RichIterable<T>
      See Also:

    • isEmpty

      public boolean isEmpty()
      Description copied from interface: RichIterable
      Returns true if this iterable has zero items.
      Specified by:
      isEmpty in interface RichIterable<T>

    • toList

      public MutableList<T> toList()
      Description copied from interface: RichIterable
      Converts the collection to a MutableList implementation.
      Specified by:
      toList in interface RichIterable<T>

    • toSortedListBy

      public <V extends Comparable<? super V>> MutableList<T> toSortedListBy(Function<? super T,? extends V> function)
      Description copied from interface: RichIterable
      Converts the collection to a MutableList implementation and sorts it based on the natural order of the attribute returned by function.
      Specified by:
      toSortedListBy in interface RichIterable<T>

    • toSortedSet

      public MutableSortedSet<T> toSortedSet()
      Description copied from interface: RichIterable
      Converts the collection to a MutableSortedSet implementation and sorts it using the natural order of the elements.
      Specified by:
      toSortedSet in interface RichIterable<T>

    • toSortedSet

      public MutableSortedSet<T> toSortedSet(Comparator<? super T> comparator)
      Description copied from interface: RichIterable
      Converts the collection to a MutableSortedSet implementation and sorts it using the specified comparator.
      Specified by:
      toSortedSet in interface RichIterable<T>

    • toSortedSetBy

      public <V extends Comparable<? super V>> MutableSortedSet<T> toSortedSetBy(Function<? super T,? extends V> function)
      Description copied from interface: RichIterable
      Converts the collection to a MutableSortedSet implementation and sorts it based on the natural order of the attribute returned by function.
      Specified by:
      toSortedSetBy in interface RichIterable<T>

    • toSet

      public MutableSet<T> toSet()
      Description copied from interface: RichIterable
      Converts the collection to a MutableSet implementation.
      Specified by:
      toSet in interface RichIterable<T>

    • toBag

      public MutableBag<T> toBag()
      Description copied from interface: RichIterable
      Converts the collection to the default MutableBag implementation.
      Specified by:
      toBag in interface RichIterable<T>

    • toSortedBag

      public MutableSortedBag<T> toSortedBag()
      Description copied from interface: RichIterable
      Converts the collection to a MutableSortedBag implementation and sorts it using the natural order of the elements.
      Specified by:
      toSortedBag in interface RichIterable<T>

    • toSortedBag

      public MutableSortedBag<T> toSortedBag(Comparator<? super T> comparator)
      Description copied from interface: RichIterable
      Converts the collection to the MutableSortedBag implementation and sorts it using the specified comparator.
      Specified by:
      toSortedBag in interface RichIterable<T>

    • toSortedBagBy

      public <V extends Comparable<? super V>> MutableSortedBag<T> toSortedBagBy(Function<? super T,? extends V> function)
      Description copied from interface: RichIterable
      Converts the collection to a MutableSortedBag implementation and sorts it based on the natural order of the attribute returned by function.
      Specified by:
      toSortedBagBy in interface RichIterable<T>

    • toMap

      public <K, V> MutableMap<K,V> toMap(Function<? super T,? extends K> keyFunction, Function<? super T,? extends V> valueFunction)
      Description copied from interface: RichIterable
      Converts the collection to a MutableMap implementation using the specified key and value functions.
      Specified by:
      toMap in interface RichIterable<T>

    • toSortedMap

      public <K, V> MutableSortedMap<K,V> toSortedMap(Function<? super T,? extends K> keyFunction, Function<? super T,? extends V> valueFunction)
      Description copied from interface: RichIterable
      Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the key elements' natural ordering.
      Specified by:
      toSortedMap in interface RichIterable<T>

    • toSortedMap

      public <K, V> MutableSortedMap<K,V> toSortedMap(Comparator<? super K> comparator, Function<? super T,? extends K> keyFunction, Function<? super T,? extends V> valueFunction)
      Description copied from interface: RichIterable
      Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the given comparator.
      Specified by:
      toSortedMap in interface RichIterable<T>

    • toSortedMapBy

      public <KK extends Comparable<? super KK>, NK, NV> MutableSortedMap<NK,NV> toSortedMapBy(Function<? super NK,KK> sortBy, Function<? super T,? extends NK> keyFunction, Function<? super T,? extends NV> valueFunction)
      Description copied from interface: RichIterable
      Converts the collection to a MutableSortedMap implementation using the specified key and value functions and sorts it based on the natural order of the attribute returned by sortBy function.
      Specified by:
      toSortedMapBy in interface RichIterable<T>

    • toBiMap

      public <K, V> MutableBiMap<K,V> toBiMap(Function<? super T,? extends K> keyFunction, Function<? super T,? extends V> valueFunction)
      Description copied from interface: RichIterable
      Converts the collection to a BiMap implementation using the specified key and value functions.
      Specified by:
      toBiMap in interface RichIterable<T>

    • select

      public <R extends Collection<T>> R select(Predicate<? super T> predicate, R target)
      Description copied from interface: RichIterable
      Same as the select method with one parameter but uses the specified target collection for the results.

      Example using a Java 8 lambda expression: 

       MutableList<Person> selected =
     people.select(person -> person.person.getLastName().equals("Smith"), Lists.mutable.empty());

      Example using an anonymous inner class: 

       MutableList<Person> selected =
     people.select(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.person.getLastName().equals("Smith");
         }
     }, Lists.mutable.empty());

      Specified by:
      select in interface RichIterable<T>
      Parameters:
      predicate - a Predicate to use as the select criteria
      target - the Collection to append to for all elements in this RichIterable that meet select criteria predicate
      Returns:
      target, which contains appended elements as a result of the select criteria
      See Also:

    • selectWith

      public <P, R extends Collection<T>> R selectWith(Predicate2<? super T,? super P> predicate, P parameter, R target)
      Description copied from interface: RichIterable
      Similar to RichIterable.select(Predicate, Collection), 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: 

       MutableList<Person> selected =
     people.selectWith((Person person, Integer age) -> person.getAge()>= age, Integer.valueOf(18), Lists.mutable.empty());

      Example using an anonymous inner class: 

       MutableList<Person> selected =
     people.selectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge()>= age;
         }
     }, Integer.valueOf(18), Lists.mutable.empty());
      Specified by:
      selectWith in interface RichIterable<T>
      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
      target - the Collection to append to for all elements in this RichIterable that meet select criteria predicate
      Returns:
      targetCollection, which contains appended elements as a result of the select criteria
      See Also:

    • reject

      public <R extends Collection<T>> R reject(Predicate<? super T> predicate, R target)
      Description copied from interface: RichIterable
      Same as the reject method with one parameter but uses the specified target collection for the results.

      Example using a Java 8 lambda expression: 

       MutableList<Person> rejected =
     people.reject(person -> person.person.getLastName().equals("Smith"), Lists.mutable.empty());

      Example using an anonymous inner class: 

       MutableList<Person> rejected =
     people.reject(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.person.getLastName().equals("Smith");
         }
     }, Lists.mutable.empty());
      Specified by:
      reject in interface RichIterable<T>
      Parameters:
      predicate - a Predicate to use as the reject criteria
      target - the Collection to append to for all elements in this RichIterable that cause Predicate#accept(Object) method to evaluate to false
      Returns:
      target, which contains appended elements as a result of the reject criteria

    • rejectWith

      public <P, R extends Collection<T>> R rejectWith(Predicate2<? super T,? super P> predicate, P parameter, R target)
      Description copied from interface: RichIterable
      Similar to RichIterable.reject(Predicate, Collection), 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: 

       MutableList<Person> rejected =
     people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18), Lists.mutable.empty());

      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), Lists.mutable.empty());
      Specified by:
      rejectWith in interface RichIterable<T>
      Parameters:
      predicate - a Predicate2 to use as the reject criteria
      parameter - a parameter to pass in for evaluation of the second argument P in predicate
      target - the Collection to append to for all elements in this RichIterable that cause Predicate#accept(Object) method to evaluate to false
      Returns:
      targetCollection, which contains appended elements as a result of the reject criteria
      See Also:

    • collect

      public <V, R extends Collection<V>> R collect(Function<? super T,? extends V> function, R target)
      Description copied from interface: RichIterable
      Same as RichIterable.collect(Function), except that the results are gathered into the specified target collection.

      Example using a Java 8 lambda expression: 

       MutableList<String> names =
     people.collect(person -> person.getFirstName() + " " + person.getLastName(), Lists.mutable.empty());

      Example using an anonymous inner class: 

       MutableList<String> names =
     people.collect(new Function<Person, String>()
     {
         public String valueOf(Person person)
         {
             return person.getFirstName() + " " + person.getLastName();
         }
     }, Lists.mutable.empty());
      Specified by:
      collect in interface RichIterable<T>
      Parameters:
      function - a Function to use as the collect transformation function
      target - the Collection to append to for all elements in this RichIterable that meet select criteria function
      Returns:
      target, which contains appended elements as a result of the collect transformation
      See Also:

    • collectWith

      public <P, V, R extends Collection<V>> R collectWith(Function2<? super T,? super P,? extends V> function, P parameter, R target)
      Description copied from interface: RichIterable
      Same as collectWith but with a targetCollection parameter to gather the results.

      Example using a Java 8 lambda expression: 

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

      Example using an anonymous inner class: 

       Function2<Integer, Integer, Integer> addParameterFunction =
     new Function2<Integer, Integer, Integer>()
     {
         public Integer value(final Integer each, final Integer parameter)
         {
             return each + parameter;
         }
     };
 MutableSet<Integer> integers =
     Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1), Sets.mutable.empty());
      Specified by:
      collectWith in interface RichIterable<T>
      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
      target - the Collection to append to for all elements in this RichIterable that meet select criteria function
      Returns:
      targetCollection, which contains appended elements as a result of the collect transformation

    • collectIf

      public <V, R extends Collection<V>> R collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function, R target)
      Description copied from interface: RichIterable
      Same as the collectIf method with two parameters but uses the specified target collection for the results.
      Specified by:
      collectIf in interface RichIterable<T>
      Parameters:
      predicate - a Predicate to use as the select criteria
      function - a Function to use as the collect transformation function
      target - the Collection to append to for all elements in this RichIterable that meet the collect criteria predicate
      Returns:
      targetCollection, which contains appended elements as a result of the collect criteria and transformation
      See Also:

    • detectWithIfNone

      public <P> T detectWithIfNone(Predicate2<? super T,? super P> predicate, P parameter, Function0<? extends T> function)
      Description copied from interface: RichIterable
      Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or returns the value of evaluating the specified function.
      Specified by:
      detectWithIfNone in interface RichIterable<T>

    • min

      public T min(Comparator<? super T> comparator)
      Description copied from interface: RichIterable
      Returns the minimum element out of this container based on the comparator.
      Specified by:
      min in interface RichIterable<T>

    • max

      public T max(Comparator<? super T> comparator)
      Description copied from interface: RichIterable
      Returns the maximum element out of this container based on the comparator.
      Specified by:
      max in interface RichIterable<T>

    • min

      public T min()
      Description copied from interface: RichIterable
      Returns the minimum element out of this container based on the natural order.
      Specified by:
      min in interface RichIterable<T>

    • max

      public T max()
      Description copied from interface: RichIterable
      Returns the maximum element out of this container based on the natural order.
      Specified by:
      max in interface RichIterable<T>

    • minBy

      public <V extends Comparable<? super V>> T minBy(Function<? super T,? extends V> function)
      Description copied from interface: RichIterable
      Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.
      Specified by:
      minBy in interface RichIterable<T>

    • maxBy

      public <V extends Comparable<? super V>> T maxBy(Function<? super T,? extends V> function)
      Description copied from interface: RichIterable
      Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.
      Specified by:
      maxBy in interface RichIterable<T>

    • asLazy

      public LazyIterable<T> asLazy()
      Description copied from interface: RichIterable
      Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).
      Specified by:
      asLazy in interface RichIterable<T>

    • flatCollect

      public <V, R extends Collection<V>> R flatCollect(Function<? super T,? extends Iterable<V>> function, R target)
      Description copied from interface: RichIterable
      Same as flatCollect, only the results are collected into the target collection.
      Specified by:
      flatCollect in interface RichIterable<T>
      Parameters:
      function - The Function to apply
      target - The collection into which results should be added.
      Returns:
      target, which will contain a flattened collection of results produced by applying the given function
      See Also:

    • detect

      public T detect(Predicate<? super T> predicate)
      Description copied from interface: RichIterable
      Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true. This method is commonly called find.

      Example using a Java 8 lambda expression: 

       Person person =
     people.detect(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));

      Example using an anonymous inner class: 

       Person person =
     people.detect(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getFirstName().equals("John") && person.getLastName().equals("Smith");
         }
     });
      Specified by:
      detect in interface RichIterable<T>

    • detectWith

      public <P> T detectWith(Predicate2<? super T,? super P> predicate, P parameter)
      Description copied from interface: RichIterable
      Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true.

      Example using a Java 8 lambda expression: 

       Person person =
     people.detectWith((person, fullName) -> person.getFullName().equals(fullName), "John Smith");

      Example using an anonymous inner class: 

       Person person =
     people.detectWith(new Predicate2<Person, String>()
     {
         public boolean accept(Person person, String fullName)
         {
             return person.getFullName().equals(fullName);
         }
     }, "John Smith");
      Specified by:
      detectWith in interface RichIterable<T>

    • detectOptional

      public Optional<T> detectOptional(Predicate<? super T> predicate)
      Description copied from interface: RichIterable
      Returns the first element of the iterable for which the predicate evaluates to true as an Optional. This method is commonly called find.

      Example using a Java 8 lambda expression: 

       Person person =
     people.detectOptional(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));

      Specified by:
      detectOptional in interface RichIterable<T>

    • detectWithOptional

      public <P> Optional<T> detectWithOptional(Predicate2<? super T,? super P> predicate, P parameter)
      Description copied from interface: RichIterable
      Returns the first element that evaluates to true for the specified predicate2 and parameter as an Optional.

      Example using a Java 8 lambda expression: 

       Optional<Person> person =
     people.detectWithOptional((person, fullName) -> person.getFullName().equals(fullName), "John Smith");

      Specified by:
      detectWithOptional in interface RichIterable<T>

    • anySatisfy

      public boolean anySatisfy(Predicate<? super T> predicate)
      Description copied from interface: RichIterable
      Returns true if the predicate evaluates to true for any element of the iterable. Returns false if the iterable is empty, or if no element returned true when evaluating the predicate.
      Specified by:
      anySatisfy in interface RichIterable<T>

    • allSatisfy

      public boolean allSatisfy(Predicate<? super T> predicate)
      Description copied from interface: RichIterable
      Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty. Otherwise, returns false.
      Specified by:
      allSatisfy in interface RichIterable<T>

    • noneSatisfy

      public boolean noneSatisfy(Predicate<? super T> predicate)
      Description copied from interface: RichIterable
      Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty. Otherwise, returns false.
      Specified by:
      noneSatisfy in interface RichIterable<T>

    • anySatisfyWith

      public <P> boolean anySatisfyWith(Predicate2<? super T,? super P> predicate, P parameter)
      Description copied from interface: RichIterable
      Returns true if the predicate evaluates to true for any element of the collection, or return false. Returns false if the collection is empty.
      Specified by:
      anySatisfyWith in interface RichIterable<T>

    • allSatisfyWith

      public <P> boolean allSatisfyWith(Predicate2<? super T,? super P> predicate, P parameter)
      Description copied from interface: RichIterable
      Returns true if the predicate evaluates to true for every element of the collection, or returns false.
      Specified by:
      allSatisfyWith in interface RichIterable<T>

    • noneSatisfyWith

      public <P> boolean noneSatisfyWith(Predicate2<? super T,? super P> predicate, P parameter)
      Description copied from interface: RichIterable
      Returns true if the predicate evaluates to false for every element of the collection, or return false. Returns true if the collection is empty.
      Specified by:
      noneSatisfyWith in interface RichIterable<T>

    • count

      public int count(Predicate<? super T> predicate)
      Description copied from interface: RichIterable
      Return the total number of elements that answer true to the specified predicate.

      Example using a Java 8 lambda expression: 

       int count =
     people.count(person -> person.getAddress().getState().getName().equals("New York"));

      Example using an anonymous inner class: 

       int count =
     people.count(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getAddress().getState().getName().equals("New York");
         }
     });
      Specified by:
      count in interface RichIterable<T>

    • countWith

      public <P> int countWith(Predicate2<? super T,? super P> predicate, P parameter)
      Description copied from interface: RichIterable
      Returns the total number of elements that evaluate to true for the specified predicate. 
      e.g.
 return lastNames.countWith(Predicates2.equal(), "Smith");
      Specified by:
      countWith in interface RichIterable<T>

    • injectInto

      public <IV> IV injectInto(IV injectedValue, Function2<? super IV,? super T,? extends IV> function)
      Description copied from interface: RichIterable
      Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. This method is commonly called fold or sometimes reduce.
      Specified by:
      injectInto in interface RichIterable<T>

    • injectInto

      public int injectInto(int injectedValue, IntObjectToIntFunction<? super T> function)
      Description copied from interface: RichIterable
      Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
      Specified by:
      injectInto in interface RichIterable<T>

    • injectInto

      public long injectInto(long injectedValue, LongObjectToLongFunction<? super T> function)
      Description copied from interface: RichIterable
      Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
      Specified by:
      injectInto in interface RichIterable<T>

    • injectInto

      public double injectInto(double injectedValue, DoubleObjectToDoubleFunction<? super T> function)
      Description copied from interface: RichIterable
      Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
      Specified by:
      injectInto in interface RichIterable<T>

    • into

      public <R extends Collection<T>> R into(R target)
      Description copied from interface: RichIterable
      Adds all the elements in this iterable to the specific target Collection.
      Specified by:
      into in interface RichIterable<T>

    • injectInto

      public float injectInto(float injectedValue, FloatObjectToFloatFunction<? super T> function)
      Description copied from interface: RichIterable
      Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
      Specified by:
      injectInto in interface RichIterable<T>

    • sumOfInt

      public long sumOfInt(IntFunction<? super T> function)
      Description copied from interface: RichIterable
      Returns the final long result of evaluating function for each element of the iterable and adding the results together.
      Specified by:
      sumOfInt in interface RichIterable<T>

    • sumOfFloat

      public double sumOfFloat(FloatFunction<? super T> function)
      Description copied from interface: RichIterable
      Returns the final double result of evaluating function for each element of the iterable and adding the results together. It uses Kahan summation algorithm to reduce numerical error.
      Specified by:
      sumOfFloat in interface RichIterable<T>

    • sumOfLong

      public long sumOfLong(LongFunction<? super T> function)
      Description copied from interface: RichIterable
      Returns the final long result of evaluating function for each element of the iterable and adding the results together.
      Specified by:
      sumOfLong in interface RichIterable<T>

    • sumOfDouble

      public double sumOfDouble(DoubleFunction<? super T> function)
      Description copied from interface: RichIterable
      Returns the final double result of evaluating function for each element of the iterable and adding the results together. It uses Kahan summation algorithm to reduce numerical error.
      Specified by:
      sumOfDouble in interface RichIterable<T>

    • forEachWithIndex

      public void forEachWithIndex(ObjectIntProcedure<? super T> objectIntProcedure)
      Description copied from interface: InternalIterable
      Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure.

      Example using a Java 8 lambda: 

       people.forEachWithIndex((Person person, int index) -> LOGGER.info("Index: " + index + " person: " + person.getName()));

      Example using an anonymous inner class: 

       people.forEachWithIndex(new ObjectIntProcedure<Person>()
 {
     public void value(Person person, int index)
     {
         LOGGER.info("Index: " + index + " person: " + person.getName());
     }
 });
      Specified by:
      forEachWithIndex in interface InternalIterable<T>

    • forEach

      public final void forEach(Procedure<? super T> procedure)
      Description copied from interface: InternalIterable
      The procedure is executed for each element in the iterable.

      Example using a Java 8 lambda: 

       people.forEach(Procedures.cast(person -> LOGGER.info(person.getName())));

      Example using an anonymous inner class: 

       people.forEach(new Procedure<Person>()
 {
     public void value(Person person)
     {
         LOGGER.info(person.getName());
     }
 });
      NOTE: This method started to conflict with Iterable.forEach(java.util.function.Consumer) since Java 1.8. It is recommended to use RichIterable.each(Procedure) instead to avoid casting to Procedure.
      Specified by:
      forEach in interface InternalIterable<T>
      Specified by:
      forEach in interface RichIterable<T>
      See Also:

    • forEachWith

      public <P> void forEachWith(Procedure2<? super T,? super P> procedure, P parameter)
      Description copied from interface: InternalIterable
      The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.

      Example using a Java 8 lambda: 

       people.forEachWith((Person person, Person other) ->
     {
         if (person.isRelatedTo(other))
         {
              LOGGER.info(person.getName());
         }
     }, fred);

      Example using an anonymous inner class: 

       people.forEachWith(new Procedure2<Person, Person>()
 {
     public void value(Person person, Person other)
     {
         if (person.isRelatedTo(other))
         {
              LOGGER.info(person.getName());
         }
     }
 }, fred);
      Specified by:
      forEachWith in interface InternalIterable<T>

    • zip

      public <S, R extends Collection<Pair<T, S>>> R zip(Iterable<S> that, R target)
      Description copied from interface: RichIterable
      Same as RichIterable.zip(Iterable) but uses target for output.
      Specified by:
      zip in interface RichIterable<T>

    • zipWithIndex

      public <R extends Collection<Pair<T, Integer>>> R zipWithIndex(R target)
      Description copied from interface: RichIterable
      Same as RichIterable.zipWithIndex() but uses target for output.
      Specified by:
      zipWithIndex in interface RichIterable<T>

    • toString

      public String toString()
      Returns a string with the elements of the iterable separated by commas with spaces and enclosed in square brackets. 
       Assert.assertEquals("[]", Lists.mutable.empty().toString());
 Assert.assertEquals("[1]", Lists.mutable.with(1).toString());
 Assert.assertEquals("[1, 2, 3]", Lists.mutable.with(1, 2, 3).toString());
      Specified by:
      toString in interface RichIterable<T>
      Overrides:
      toString in class Object
      Returns:
      a string representation of this collection.
      See Also:

    • appendString

      public void appendString(Appendable appendable, String separator)
      Description copied from interface: RichIterable
      Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString(String).
      Specified by:
      appendString in interface RichIterable<T>

    • appendString

      public void appendString(Appendable appendable, String start, String separator, String end)
      Description copied from interface: RichIterable
      Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString(String, String, String).
      Specified by:
      appendString in interface RichIterable<T>

    • containsAll

      public boolean containsAll(Collection<?> collection)
      Description copied from interface: RichIterable
      Returns true if all elements in source are contained in this collection.
      Specified by:
      containsAll in interface RichIterable<T>
      See Also:

    • countByEach

      public <V> Bag<V> countByEach(Function<? super T,? extends Iterable<V>> function)
      Description copied from interface: RichIterable
      This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.
      Specified by:
      countByEach in interface RichIterable<T>
      Since:
      10.0.0

    • groupBy

      public <V, R extends MutableMultimap<V, T>> R groupBy(Function<? super T,? extends V> function, R target)
      Description copied from interface: RichIterable
      Same as RichIterable.groupBy(Function), except that the results are gathered into the specified target multimap.

      Example using a Java 8 method reference: 

       FastListMultimap<String, Person> peopleByLastName =
     people.groupBy(Person::getLastName, new FastListMultimap<String, Person>());

      Example using an anonymous inner class: 

       FastListMultimap<String, Person> peopleByLastName =
     people.groupBy(new Function<Person, String>()
     {
         public String valueOf(Person person)
         {
             return person.getLastName();
         }
     }, new FastListMultimap<String, Person>());
      Specified by:
      groupBy in interface RichIterable<T>

    • groupByEach

      public <V, R extends MutableMultimap<V, T>> R groupByEach(Function<? super T,? extends Iterable<V>> function, R target)
      Description copied from interface: RichIterable
      Same as RichIterable.groupByEach(Function), except that the results are gathered into the specified target multimap.
      Specified by:
      groupByEach in interface RichIterable<T>

    • groupByUniqueKey

      public <V, R extends MutableMapIterable<V, T>> R groupByUniqueKey(Function<? super T,? extends V> function, R target)
      Description copied from interface: RichIterable
      Same as RichIterable.groupByUniqueKey(Function), except that the results are gathered into the specified target map.
      Specified by:
      groupByUniqueKey in interface RichIterable<T>
      See Also: