Class AbstractCollectionAdapter<T>

java.lang.Object
org.eclipse.collections.impl.collection.mutable.AbstractCollectionAdapter<T>
All Implemented Interfaces:
Iterable<T>, Collection<T>, MutableCollection<T>, InternalIterable<T>, RichIterable<T>
Direct Known Subclasses:
AbstractListAdapter, CollectionAdapter, SetAdapter, SortedSetAdapter

public abstract class AbstractCollectionAdapter<T>
extends Object
implements MutableCollection<T>
  • Constructor Details

  • Method Details

    • notEmpty

      public boolean notEmpty()
      Description copied from interface: RichIterable
      The English equivalent of !this.isEmpty()
      Specified by:
      notEmpty in interface RichIterable<T>
    • getFirst

      public T getFirst()
      Description copied from interface: RichIterable
      Returns the first element of an iterable. In the case of a List it is the element at the first index. In the case of any other Collection, it is the first element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.

      The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the first element could be any element from the Set.

      Specified by:
      getFirst in interface RichIterable<T>
    • getLast

      public T getLast()
      Description copied from interface: RichIterable
      Returns the last element of an iterable. In the case of a List it is the element at the last index. In the case of any other Collection, it is the last element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.

      The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the last element could be any element from the Set.

      Specified by:
      getLast in interface RichIterable<T>
    • getOnly

      public T getOnly()
      Description copied from interface: RichIterable
      Returns the element if the iterable has exactly one element. Otherwise, throw IllegalStateException.
      Specified by:
      getOnly in interface RichIterable<T>
      Returns:
      an element of an iterable.
    • tap

      public MutableCollection<T> tap​(Procedure<? super T> procedure)
      Description copied from interface: RichIterable
      Executes the Procedure for each element in the iterable and returns this.

      Example using a Java 8 lambda expression:

       RichIterable<Person> tapped =
           people.tap(person -> LOGGER.info(person.getName()));
       

      Example using an anonymous inner class:

       RichIterable<Person> tapped =
           people.tap(new Procedure<Person>()
           {
               public void value(Person person)
               {
                   LOGGER.info(person.getName());
               }
           });
       
      Specified by:
      tap in interface MutableCollection<T>
      Specified by:
      tap in interface RichIterable<T>
      See Also:
      RichIterable.each(Procedure), RichIterable.forEach(Procedure)
    • each

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

      Example using a Java 8 lambda expression:

       people.each(person -> LOGGER.info(person.getName()));
       

      Example using an anonymous inner class:

       people.each(new Procedure<Person>()
       {
           public void value(Person person)
           {
               LOGGER.info(person.getName());
           }
       });
       
      This method is a variant of InternalIterable.forEach(Procedure) that has a signature conflict with Iterable.forEach(java.util.function.Consumer).
      Specified by:
      each in interface RichIterable<T>
      See Also:
      InternalIterable.forEach(Procedure), Iterable.forEach(java.util.function.Consumer)
    • 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>
    • removeIf

      public boolean removeIf​(Predicate<? super T> predicate)
      Description copied from interface: MutableCollection
      Removes all elements in the collection that evaluate to true for the specified predicate.
      e.g.
       return lastNames.removeIf(Predicates.isNull());
       
      Specified by:
      removeIf in interface MutableCollection<T>
    • removeIfWith

      public <P> boolean removeIfWith​(Predicate2<? super T,​? super P> predicate, P parameter)
      Description copied from interface: MutableCollection
      Removes all elements in the collection that evaluate to true for the specified predicate2 and parameter.
       return lastNames.removeIfWith(Predicates2.isNull(), null);
       
      Specified by:
      removeIfWith in interface MutableCollection<T>
    • 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>
    • detectIfNone

      public T detectIfNone​(Predicate<? super T> predicate, Function0<? extends T> function)
      Description copied from interface: RichIterable
      Returns the first element of the iterable for which the predicate evaluates to true. If no element matches the predicate, then returns the value of applying the specified function.
      Specified by:
      detectIfNone in interface RichIterable<T>
    • 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>
    • 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>
    • 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>
    • 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>
    • 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>
    • sumByInt

      public <V> MutableObjectLongMap<V> sumByInt​(Function<? super T,​? extends V> groupBy, IntFunction<? super T> function)
      Description copied from interface: RichIterable
      Groups and sums the values using the two specified functions.
      Specified by:
      sumByInt in interface MutableCollection<T>
      Specified by:
      sumByInt in interface RichIterable<T>
    • sumByFloat

      public <V> MutableObjectDoubleMap<V> sumByFloat​(Function<? super T,​? extends V> groupBy, FloatFunction<? super T> function)
      Description copied from interface: RichIterable
      Groups and sums the values using the two specified functions.
      Specified by:
      sumByFloat in interface MutableCollection<T>
      Specified by:
      sumByFloat in interface RichIterable<T>
    • sumByLong

      public <V> MutableObjectLongMap<V> sumByLong​(Function<? super T,​? extends V> groupBy, LongFunction<? super T> function)
      Description copied from interface: RichIterable
      Groups and sums the values using the two specified functions.
      Specified by:
      sumByLong in interface MutableCollection<T>
      Specified by:
      sumByLong in interface RichIterable<T>
    • sumByDouble

      public <V> MutableObjectDoubleMap<V> sumByDouble​(Function<? super T,​? extends V> groupBy, DoubleFunction<? super T> function)
      Description copied from interface: RichIterable
      Groups and sums the values using the two specified functions.
      Specified by:
      sumByDouble in interface MutableCollection<T>
      Specified by:
      sumByDouble in interface RichIterable<T>
    • select

      public MutableCollection<T> select​(Predicate<? super T> predicate)
      Description copied from interface: MutableCollection
      Returns a MutableCollection with all elements that evaluate to true for the specified predicate.
       MutableCollection<Integer> livesInLondon =
           people.select(person -> person.getAddress().getCity().equals("London"));
       
      Specified by:
      select in interface MutableCollection<T>
      Specified by:
      select 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:
      RichIterable.select(Predicate)
    • reject

      public MutableCollection<T> reject​(Predicate<? super T> predicate)
      Description copied from interface: MutableCollection
      Returns a MutableCollection with all elements that evaluate to false for the specified predicate.
       MutableCollection<Person> notSmiths =
           people.reject(person -> person.person.getLastName().equals("Smith"));
       
      Using the Predicates factory:
       MutableCollection<Person> notSmiths = people.reject(Predicates.attributeEqual("lastName", "Smith"));
       
      Specified by:
      reject in interface MutableCollection<T>
      Specified by:
      reject in interface RichIterable<T>
      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
    • 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
    • selectInstancesOf

      public <S> MutableCollection<S> selectInstancesOf​(Class<S> clazz)
      Description copied from interface: MutableCollection
      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);
       
      Co-variant example for MutableCollection:
       MutableCollection<Integer> integers =
           List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
       
      Specified by:
      selectInstancesOf in interface MutableCollection<T>
      Specified by:
      selectInstancesOf in interface RichIterable<T>
    • collect

      public <V> MutableCollection<V> collect​(Function<? super T,​? extends V> function)
      Description copied from interface: MutableCollection
      Returns a new MutableCollection with the results of applying the specified function to each element of the source collection.
       MutableCollection<String> names =
           people.collect(person -> person.getFirstName() + " " + person.getLastName());
       
      Specified by:
      collect in interface MutableCollection<T>
      Specified by:
      collect in interface RichIterable<T>
    • collectBoolean

      public MutableBooleanCollection collectBoolean​(BooleanFunction<? super T> booleanFunction)
      Description copied from interface: MutableCollection
      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();
               }
           });
       
      Co-variant example for MutableCollection:
       MutableBooleanCollection licenses =
           people.collectBoolean(person -> person.hasDrivingLicense());
       
      Specified by:
      collectBoolean in interface MutableCollection<T>
      Specified by:
      collectBoolean in interface RichIterable<T>
    • collectBoolean

      public <R extends MutableBooleanCollection> R collectBoolean​(BooleanFunction<? super T> booleanFunction, R target)
      Description copied from interface: RichIterable
      Same as RichIterable.collectBoolean(BooleanFunction), except that the results are gathered into the specified target collection.

      Example using a Java 8 lambda expression:

       BooleanArrayList licenses =
           people.collectBoolean(person -> person.hasDrivingLicense(), new BooleanArrayList());
       

      Example using an anonymous inner class:

       BooleanArrayList licenses =
           people.collectBoolean(new BooleanFunction<Person>()
           {
               public boolean booleanValueOf(Person person)
               {
                   return person.hasDrivingLicense();
               }
           }, new BooleanArrayList());
       
      Specified by:
      collectBoolean in interface RichIterable<T>
      Parameters:
      booleanFunction - a BooleanFunction to use as the collect transformation function
      target - the MutableBooleanCollection to append to for all elements in this RichIterable
      Returns:
      target, which contains appended elements as a result of the collect transformation
    • collectByte

      public MutableByteCollection collectByte​(ByteFunction<? super T> byteFunction)
      Description copied from interface: MutableCollection
      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();
               }
           });
       
      Co-variant example for MutableCollection:
       MutableByteCollection bytes =
           people.collectByte(person -> person.getCode());
       
      Specified by:
      collectByte in interface MutableCollection<T>
      Specified by:
      collectByte in interface RichIterable<T>
    • collectByte

      public <R extends MutableByteCollection> R collectByte​(ByteFunction<? super T> byteFunction, R target)
      Description copied from interface: RichIterable
      Same as RichIterable.collectByte(ByteFunction), except that the results are gathered into the specified target collection.

      Example using a Java 8 lambda expression:

       ByteArrayList bytes =
           people.collectByte(person -> person.getCode(), new ByteArrayList());
       

      Example using an anonymous inner class:

       ByteArrayList bytes =
           people.collectByte(new ByteFunction<Person>()
           {
               public byte byteValueOf(Person person)
               {
                   return person.getCode();
               }
           }, new ByteArrayList());
       
      Specified by:
      collectByte in interface RichIterable<T>
      Parameters:
      byteFunction - a ByteFunction to use as the collect transformation function
      target - the MutableByteCollection to append to for all elements in this RichIterable
      Returns:
      target, which contains appended elements as a result of the collect transformation
    • collectChar

      public MutableCharCollection collectChar​(CharFunction<? super T> charFunction)
      Description copied from interface: MutableCollection
      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();
               }
           });
       
      Co-variant example for MutableCollection:
       MutableCharCollection chars =
           people.collectChar(person -> person.getMiddleInitial());
       
      Specified by:
      collectChar in interface MutableCollection<T>
      Specified by:
      collectChar in interface RichIterable<T>
    • collectChar

      public <R extends MutableCharCollection> R collectChar​(CharFunction<? super T> charFunction, R target)
      Description copied from interface: RichIterable
      Same as RichIterable.collectChar(CharFunction), except that the results are gathered into the specified target collection.

      Example using a Java 8 lambda expression:

       CharArrayList chars =
           people.collectChar(person -> person.getMiddleInitial(), new CharArrayList());
       

      Example using an anonymous inner class:

       CharArrayList chars =
           people.collectChar(new CharFunction<Person>()
           {
               public char charValueOf(Person person)
               {
                   return person.getMiddleInitial();
               }
           }, new CharArrayList());
       
      Specified by:
      collectChar in interface RichIterable<T>
      Parameters:
      charFunction - a CharFunction to use as the collect transformation function
      target - the MutableCharCollection to append to for all elements in this RichIterable
      Returns:
      target, which contains appended elements as a result of the collect transformation
    • collectDouble

      public MutableDoubleCollection collectDouble​(DoubleFunction<? super T> doubleFunction)
      Description copied from interface: MutableCollection
      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();
               }
           });
       
      Co-variant example for MutableCollection:
       MutableDoubleCollection doubles =
           people.collectDouble(person -> person.getMilesFromNorthPole());
       
      Specified by:
      collectDouble in interface MutableCollection<T>
      Specified by:
      collectDouble in interface RichIterable<T>
    • collectDouble

      public <R extends MutableDoubleCollection> R collectDouble​(DoubleFunction<? super T> doubleFunction, R target)
      Description copied from interface: RichIterable
      Same as RichIterable.collectDouble(DoubleFunction), except that the results are gathered into the specified target collection.

      Example using a Java 8 lambda expression:

       DoubleArrayList doubles =
           people.collectDouble(person -> person.getMilesFromNorthPole(), new DoubleArrayList());
       

      Example using an anonymous inner class:

       DoubleArrayList doubles =
           people.collectDouble(new DoubleFunction<Person>()
           {
               public double doubleValueOf(Person person)
               {
                   return person.getMilesFromNorthPole();
               }
           }, new DoubleArrayList());
       
      Specified by:
      collectDouble in interface RichIterable<T>
      Parameters:
      doubleFunction - a DoubleFunction to use as the collect transformation function
      target - the MutableDoubleCollection to append to for all elements in this RichIterable
      Returns:
      target, which contains appended elements as a result of the collect transformation
    • collectFloat

      public MutableFloatCollection collectFloat​(FloatFunction<? super T> floatFunction)
      Description copied from interface: MutableCollection
      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();
               }
           });
       
      Co-variant example for MutableCollection:
       MutableFloatCollection floats =
           people.collectFloat(person -> person.getHeightInInches());
       
      Specified by:
      collectFloat in interface MutableCollection<T>
      Specified by:
      collectFloat in interface RichIterable<T>
    • collectFloat

      public <R extends MutableFloatCollection> R collectFloat​(FloatFunction<? super T> floatFunction, R target)
      Description copied from interface: RichIterable
      Same as RichIterable.collectFloat(FloatFunction), except that the results are gathered into the specified target collection.

      Example using a Java 8 lambda expression:

       FloatArrayList floats =
           people.collectFloat(person -> person.getHeightInInches(), new FloatArrayList());
       

      Example using an anonymous inner class:

       FloatArrayList floats =
           people.collectFloat(new FloatFunction<Person>()
           {
               public float floatValueOf(Person person)
               {
                   return person.getHeightInInches();
               }
           }, new FloatArrayList());
       
      Specified by:
      collectFloat in interface RichIterable<T>
      Parameters:
      floatFunction - a FloatFunction to use as the collect transformation function
      target - the MutableFloatCollection to append to for all elements in this RichIterable
      Returns:
      target, which contains appended elements as a result of the collect transformation
    • collectInt

      public MutableIntCollection collectInt​(IntFunction<? super T> intFunction)
      Description copied from interface: MutableCollection
      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();
               }
           });
       
      Co-variant example for MutableCollection:
       MutableIntCollection ints =
           people.collectInt(person -> person.getAge());
       
      Specified by:
      collectInt in interface MutableCollection<T>
      Specified by:
      collectInt in interface RichIterable<T>
    • collectInt

      public <R extends MutableIntCollection> R collectInt​(IntFunction<? super T> intFunction, R target)
      Description copied from interface: RichIterable
      Same as RichIterable.collectInt(IntFunction), except that the results are gathered into the specified target collection.

      Example using a Java 8 lambda expression:

       IntArrayList ints =
           people.collectInt(person -> person.getAge(), new IntArrayList());
       

      Example using an anonymous inner class:

       IntArrayList ints =
           people.collectInt(new IntFunction<Person>()
           {
               public int intValueOf(Person person)
               {
                   return person.getAge();
               }
           }, new IntArrayList());
       
      Specified by:
      collectInt in interface RichIterable<T>
      Parameters:
      intFunction - a IntFunction to use as the collect transformation function
      target - the MutableIntCollection to append to for all elements in this RichIterable
      Returns:
      target, which contains appended elements as a result of the collect transformation
    • collectLong

      public MutableLongCollection collectLong​(LongFunction<? super T> longFunction)
      Description copied from interface: MutableCollection
      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();
               }
           });
       
      Co-variant example for MutableCollection:
       MutableLongCollection longs =
           people.collectLong(person -> person.getGuid());
       
      Specified by:
      collectLong in interface MutableCollection<T>
      Specified by:
      collectLong in interface RichIterable<T>
    • collectLong

      public <R extends MutableLongCollection> R collectLong​(LongFunction<? super T> longFunction, R target)
      Description copied from interface: RichIterable
      Same as RichIterable.collectLong(LongFunction), except that the results are gathered into the specified target collection.

      Example using a Java 8 lambda expression:

       LongArrayList longs =
           people.collectLong(person -> person.getGuid(), new LongArrayList());
       

      Example using an anonymous inner class:

       LongArrayList longs =
           people.collectLong(new LongFunction<Person>()
           {
               public long longValueOf(Person person)
               {
                   return person.getGuid();
               }
           }, new LongArrayList());
       
      Specified by:
      collectLong in interface RichIterable<T>
      Parameters:
      longFunction - a LongFunction to use as the collect transformation function
      target - the MutableLongCollection to append to for all elements in this RichIterable
      Returns:
      target, which contains appended elements as a result of the collect transformation
    • collectShort

      public MutableShortCollection collectShort​(ShortFunction<? super T> shortFunction)
      Description copied from interface: MutableCollection
      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();
               }
           });
       
      Co-variant example for MutableCollection:
       MutableShortCollection shorts =
           people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
       
      Specified by:
      collectShort in interface MutableCollection<T>
      Specified by:
      collectShort in interface RichIterable<T>
    • collectShort

      public <R extends MutableShortCollection> R collectShort​(ShortFunction<? super T> shortFunction, R target)
      Description copied from interface: RichIterable
      Same as RichIterable.collectShort(ShortFunction), except that the results are gathered into the specified target collection.

      Example using a Java 8 lambda expression:

       ShortArrayList shorts =
           people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth, new ShortArrayList());
       

      Example using an anonymous inner class:

       ShortArrayList shorts =
           people.collectShort(new ShortFunction<Person>()
           {
               public short shortValueOf(Person person)
               {
                   return person.getNumberOfJunkMailItemsReceivedPerMonth;
               }
           }, new ShortArrayList());
       
      Specified by:
      collectShort in interface RichIterable<T>
      Parameters:
      shortFunction - a ShortFunction to use as the collect transformation function
      target - the MutableShortCollection to append to for all elements in this RichIterable
      Returns:
      target, which contains appended elements as a result of the collect transformation
    • 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:
      RichIterable.collect(Function)
    • flatCollect

      public <V> MutableCollection<V> flatCollect​(Function<? super T,​? extends Iterable<V>> function)
      Description copied from interface: MutableCollection
      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);
       
      Co-variant example for MutableCollection:
       Function<Person, List<Address>> addressFunction = Person::getAddresses;
       MutableCollection<Person> people = ...;
       MutableCollection<List<Address>> addresses = people.collect(addressFunction);
       MutableCollection<Address> addresses = people.flatCollect(addressFunction);
       
      Specified by:
      flatCollect in interface MutableCollection<T>
      Specified by:
      flatCollect in interface RichIterable<T>
      Parameters:
      function - The Function to apply
      Returns:
      a new flattened collection produced by applying the given function
    • 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:
      RichIterable.flatCollect(Function)
    • collectIf

      public <V> MutableCollection<V> collectIf​(Predicate<? super T> predicate, Function<? super T,​? extends V> function)
      Description copied from interface: MutableCollection
      Returns a new MutableCollection with the results of applying the specified function to each element of the source collection, but only for elements that evaluate to true for the specified predicate.
       MutableCollection<String> collected =
           Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
       
      Specified by:
      collectIf in interface MutableCollection<T>
      Specified by:
      collectIf in interface RichIterable<T>
    • 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:
      RichIterable.collectIf(Predicate, Function)
    • selectAndRejectWith

      public <P> Twin<MutableList<T>> selectAndRejectWith​(Predicate2<? super T,​? super P> predicate, P parameter)
      Description copied from interface: MutableCollection
      Filters a collection into two separate collections based on a predicate returned via a Pair.
      e.g.
       return lastNames.selectAndRejectWith(Predicates2.lessThan(), "Mason");
       
      Specified by:
      selectAndRejectWith in interface MutableCollection<T>
    • partition

      public PartitionMutableCollection<T> partition​(Predicate<? super T> predicate)
      Description copied from interface: MutableCollection
      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");
               }
           });
       
      Co-variant example for MutableCollection:
       PartitionMutableCollection<Person> newYorkersAndNonNewYorkers =
           people.partition(person -> person.getAddress().getState().getName().equals("New York"));
       
      Specified by:
      partition in interface MutableCollection<T>
      Specified by:
      partition in interface RichIterable<T>
    • partitionWith

      public <P> PartitionMutableCollection<T> partitionWith​(Predicate2<? super T,​? super P> predicate, P parameter)
      Description copied from interface: MutableCollection
      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");
       
      Co-variant example for MutableCollection:
       PartitionMutableCollection<Person> newYorkersAndNonNewYorkers =
           people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
       
      Specified by:
      partitionWith in interface MutableCollection<T>
      Specified by:
      partitionWith in interface RichIterable<T>
    • size

      public int size()
      Description copied from interface: RichIterable
      Returns the number of items in this iterable.
      Specified by:
      size in interface Collection<T>
      Specified by:
      size in interface RichIterable<T>
    • isEmpty

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

      public boolean contains​(Object o)
      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 Collection<T>
      Specified by:
      contains in interface RichIterable<T>
    • iterator

      public Iterator<T> iterator()
      Specified by:
      iterator in interface Collection<T>
      Specified by:
      iterator in interface Iterable<T>
    • toArray

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

      public <E> E[] toArray​(E[] a)
      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 Collection<T>
      Specified by:
      toArray in interface RichIterable<T>
      See Also:
      Collection.toArray(Object[])
    • add

      public boolean add​(T o)
      Specified by:
      add in interface Collection<T>
    • remove

      public boolean remove​(Object o)
      Specified by:
      remove in interface Collection<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 Collection<T>
      Specified by:
      containsAll in interface RichIterable<T>
      See Also:
      Collection.containsAll(Collection)
    • 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>
    • addAll

      public boolean addAll​(Collection<? extends T> collection)
      Specified by:
      addAll in interface Collection<T>
    • addAllIterable

      public boolean addAllIterable​(Iterable<? extends T> iterable)
      Specified by:
      addAllIterable in interface MutableCollection<T>
      See Also:
      Collection.addAll(Collection)
    • removeAll

      public boolean removeAll​(Collection<?> collection)
      Specified by:
      removeAll in interface Collection<T>
    • removeAllIterable

      public boolean removeAllIterable​(Iterable<?> iterable)
      Specified by:
      removeAllIterable in interface MutableCollection<T>
      See Also:
      Collection.removeAll(Collection)
    • retainAll

      public boolean retainAll​(Collection<?> collection)
      Specified by:
      retainAll in interface Collection<T>
    • retainAllIterable

      public boolean retainAllIterable​(Iterable<?> iterable)
      Specified by:
      retainAllIterable in interface MutableCollection<T>
      See Also:
      Collection.retainAll(Collection)
    • clear

      public void clear()
      Specified by:
      clear in interface Collection<T>
    • 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>
    • selectWith

      public <P> MutableCollection<T> selectWith​(Predicate2<? super T,​? super P> predicate, P parameter)
      Description copied from interface: MutableCollection
      Returns a MutableCollection with all elements that evaluate to true for the specified predicate2 and parameter.
       MutableCollection<Integer> fives =
           integers.selectWith(Predicates2.equal(), Integer.valueOf(5));
       
      Specified by:
      selectWith in interface MutableCollection<T>
      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
      See Also:
      RichIterable.select(Predicate)
    • selectWith

      public <P,​ R extends Collection<T>> R selectWith​(Predicate2<? super T,​? super P> predicate, P parameter, R targetCollection)
      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
      targetCollection - 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:
      RichIterable.select(Predicate), RichIterable.select(Predicate, Collection)
    • rejectWith

      public <P> MutableCollection<T> rejectWith​(Predicate2<? super T,​? super P> predicate, P parameter)
      Description copied from interface: MutableCollection
      Returns a MutableCollection with all elements that evaluate to false for the specified predicate2 and parameter.
      e.g.
       MutableCollection<Integer> selected =
           integers.rejectWith(Predicates2.equal(), Integer.valueOf(5));
       
      Specified by:
      rejectWith in interface MutableCollection<T>
      Specified by:
      rejectWith 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
      See Also:
      RichIterable.select(Predicate)
    • rejectWith

      public <P,​ R extends Collection<T>> R rejectWith​(Predicate2<? super T,​? super P> predicate, P parameter, R targetCollection)
      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
      targetCollection - 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:
      RichIterable.reject(Predicate), RichIterable.reject(Predicate, Collection)
    • collectWith

      public <P,​ V> MutableCollection<V> collectWith​(Function2<? super T,​? super P,​? extends V> function, P parameter)
      Description copied from interface: MutableCollection
      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));
       
      Co-variant example for MutableCollection:
       MutableCollection<Integer> integers =
           Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
       
      Specified by:
      collectWith in interface MutableCollection<T>
      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
      Returns:
      A new RichIterable that contains the transformed elements returned by Function2.value(Object, Object)
      See Also:
      RichIterable.collect(Function)
    • collectWith

      public <P,​ A,​ R extends Collection<A>> R collectWith​(Function2<? super T,​? super P,​? extends A> function, P parameter, R targetCollection)
      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
      targetCollection - 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
    • injectIntoWith

      public <IV,​ P> IV injectIntoWith​(IV injectValue, Function3<? super IV,​? super T,​? super P,​? extends IV> function, P parameter)
      Description copied from interface: MutableCollection
      Returns the final result of evaluating function using each element of the iterable, the previous evaluation result and 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. The parameter value is always used as the third parameter to the function call.
      Specified by:
      injectIntoWith in interface MutableCollection<T>
      See Also:
      RichIterable.injectInto(Object, Function2)
    • 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>
    • toList

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

      public MutableList<T> toSortedList​(Comparator<? super T> comparator)
      Description copied from interface: RichIterable
      Converts the collection to a MutableList implementation and sorts it using the specified comparator.
      Specified by:
      toSortedList 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>
    • toMap

      public <K,​ V,​ R extends Map<K,​ V>> R toMap​(Function<? super T,​? extends K> keyFunction, Function<? super T,​? extends V> valueFunction, R target)
      Description copied from interface: RichIterable
      Same as RichIterable.toMap(Function, Function), except that the results are gathered into the specified target map.
      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>,​ K,​ V> MutableSortedMap<K,​V> toSortedMapBy​(Function<? super K,​KK> sortBy, 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 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>
    • 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>
    • 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>
    • 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>
    • toString

      public String toString()
      Description copied from interface: RichIterable
      Returns a string with the elements of this 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 RichIterable
      See Also:
      AbstractCollection.toString()
    • 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>
    • groupBy

      public <V> MutableMultimap<V,​T> groupBy​(Function<? super T,​? extends V> function)
      Description copied from interface: MutableCollection
      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();
               }
           });
       
      Co-variant example for MutableCollection:
       MutableMultimap<String, Person> peopleByLastName =
           people.groupBy(Person::getLastName);
       
      Specified by:
      groupBy in interface MutableCollection<T>
      Specified by:
      groupBy in interface RichIterable<T>
    • 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> MutableMultimap<V,​T> groupByEach​(Function<? super T,​? extends Iterable<V>> 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 MutableCollection<T>
      Specified by:
      groupByEach 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> MutableMap<V,​T> groupByUniqueKey​(Function<? super T,​? extends V> 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 MutableCollection<T>
      Specified by:
      groupByUniqueKey in interface RichIterable<T>
      See Also:
      RichIterable.groupBy(Function)
    • 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:
      RichIterable.groupByUniqueKey(Function)
    • zip

      public <S> MutableCollection<Pair<T,​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 MutableCollection<T>
      Specified by:
      zip in interface RichIterable<T>
      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.
    • 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 MutableCollection<Pair<T,​Integer>> zipWithIndex()
      Description copied from interface: RichIterable
      Zips this RichIterable with its indices.
      Specified by:
      zipWithIndex in interface MutableCollection<T>
      Specified by:
      zipWithIndex in interface RichIterable<T>
      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)
    • 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>
    • chunk

      public RichIterable<RichIterable<T>> chunk​(int size)
      Description copied from interface: RichIterable
      Partitions elements in fixed size chunks.
      Specified by:
      chunk in interface RichIterable<T>
      Parameters:
      size - the number of elements per chunk
      Returns:
      A RichIterable containing RichIterables of size size, except the last will be truncated if the elements don't divide evenly.
    • aggregateInPlaceBy

      public <K,​ V> MutableMap<K,​V> aggregateInPlaceBy​(Function<? super T,​? extends K> groupBy, Function0<? extends V> zeroValueFactory, Procedure2<? super V,​? super T> 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 MutableCollection<T>
      Specified by:
      aggregateInPlaceBy in interface RichIterable<T>