Package org.eclipse.collections.impl.list.mutable

Class RandomAccessListAdapter<T>

java.lang.Object
org.eclipse.collections.impl.collection.mutable.AbstractCollectionAdapter<T>
org.eclipse.collections.impl.list.mutable.AbstractListAdapter<T>
org.eclipse.collections.impl.list.mutable.RandomAccessListAdapter<T>
All Implemented Interfaces:
Serializable, Cloneable, Iterable<T>, Collection<T>, List<T>, RandomAccess, MutableCollection<T>, InternalIterable<T>, ListIterable<T>, MutableList<T>, OrderedIterable<T>, ReversibleIterable<T>, RichIterable<T>
public final class RandomAccessListAdapter<T> extends AbstractListAdapter<T> implements RandomAccess, Serializable
This class provides a MutableList wrapper around a JDK Collections List interface instance. All of the MutableList interface methods are supported in addition to the JDK List interface methods.

To create a new wrapper around an existing List instance, use the adapt(List) factory method.

See Also:

  • Method Details

    • adapt

      public static <E> MutableList<E> adapt(List<E> list)

    • toImmutable

      public ImmutableList<T> toImmutable()
      Description copied from interface: MutableList
      Returns an immutable copy of this list. If the list is immutable, it returns itself.
      Specified by:
      toImmutable in interface ListIterable<T>
      Specified by:
      toImmutable in interface MutableCollection<T>
      Specified by:
      toImmutable in interface MutableList<T>

    • asUnmodifiable

      public MutableList<T> asUnmodifiable()
      Description copied from interface: MutableList
      Returns an unmodifiable view of the list.
      Specified by:
      asUnmodifiable in interface MutableCollection<T>
      Specified by:
      asUnmodifiable in interface MutableList<T>
      Returns:
      an unmodifiable view of this list
      See Also:

    • asSynchronized

      public MutableList<T> asSynchronized()
      Description copied from interface: MutableCollection
      Returns a synchronized wrapper backed by this collection. This is the equivalent of using Collections.synchronizedCollection(this) only with a return type that supports the full iteration protocols available on MutableCollection. The preferred way of iterating over a synchronized collection is to use the internal iteration methods which are properly synchronized internally. 
        MutableCollection synchedCollection = collection.asSynchronized();
     ...
  synchedCollection.forEach(each -> ... );
  synchedCollection.select(each -> ... );
  synchedCollection.collect(each -> ... );
      If you want to iterate using an imperative style, you must protect external iterators using a synchronized block. This includes explicit iterators as well as JDK 5 style for loops.

      Specified by:
      asSynchronized in interface MutableCollection<T>
      Specified by:
      asSynchronized in interface MutableList<T>
      Returns:
      a synchronized view of this collection.
      See Also:

    • clone

      public MutableList<T> clone()
      Specified by:
      clone in interface MutableList<T>
      Overrides:
      clone in class AbstractListAdapter<T>

    • newEmpty

      @Deprecated public MutableList<T> newEmpty()
      Deprecated.
      use FastList.newList() instead (inlineable)
      Description copied from interface: MutableCollection
      Creates a new empty mutable version of the same collection type. For example, if this instance is a FastList, this method will return a new empty FastList. If the class of this instance is immutable or fixed size (i.e. SingletonList) then a mutable alternative to the class will be provided.
      Specified by:
      newEmpty in interface MutableCollection<T>
      Specified by:
      newEmpty in interface MutableList<T>

    • 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>
      Overrides:
      each in class AbstractCollectionAdapter<T>
      See Also:

    • reverseForEach

      public void reverseForEach(Procedure<? super T> procedure)
      Description copied from interface: ReversibleIterable
      Evaluates the procedure for each element of the list iterating in reverse order. 
      e.g.
 people.reverseForEach(person -> LOGGER.info(person.getName()));
      Specified by:
      reverseForEach in interface ReversibleIterable<T>

    • reverseForEachWithIndex

      public void reverseForEachWithIndex(ObjectIntProcedure<? super T> procedure)
      Description copied from interface: ReversibleIterable
      Evaluates the procedure for each element and it's index in reverse order. 
      e.g.
 people.reverseForEachWithIndex((person, index) ->
         LOGGER.info("Index: " + index + " person: " + person.getName()));
      Specified by:
      reverseForEachWithIndex in interface ReversibleIterable<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>
      Specified by:
      forEachWithIndex in interface OrderedIterable<T>
      Overrides:
      forEachWithIndex in class AbstractCollectionAdapter<T>

    • forEachWithIndex

      public void forEachWithIndex(int fromIndex, int toIndex, ObjectIntProcedure<? super T> objectIntProcedure)
      Description copied from interface: OrderedIterable
      Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive. 
      e.g.
 OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally)
 people.forEachWithIndex(0, 1, new ObjectIntProcedure<Person>()
 {
     public void value(Person person, int index)
     {
          LOGGER.info(person.getName());
     }
 });

      This code would output ted and mary's names.

      Specified by:
      forEachWithIndex in interface OrderedIterable<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>
      Overrides:
      detect in class AbstractCollectionAdapter<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>
      Overrides:
      detectIfNone in class AbstractCollectionAdapter<T>

    • detectIndex

      public int detectIndex(Predicate<? super T> predicate)
      Description copied from interface: OrderedIterable
      Returns the index of the first element of the OrderedIterable for which the predicate evaluates to true. Returns -1 if no element evaluates true for the predicate.
      Specified by:
      detectIndex in interface OrderedIterable<T>

    • detectLastIndex

      public int detectLastIndex(Predicate<? super T> predicate)
      Description copied from interface: ReversibleIterable
      Returns the index of the last element of the ReversibleIterable for which the predicate evaluates to true. Returns -1 if no element evaluates true for the predicate.
      Specified by:
      detectLastIndex in interface ReversibleIterable<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>
      Overrides:
      count in class AbstractCollectionAdapter<T>

    • corresponds

      public <S> boolean corresponds(OrderedIterable<S> other, Predicate2<? super T,? super S> predicate)
      Description copied from interface: OrderedIterable
      Returns true if both OrderedIterables have the same length and predicate returns true for all corresponding elements e1 of this OrderedIterable and e2 of other. The predicate is evaluated for each element at the same position of each OrderedIterable in a forward iteration order. This is a short circuit pattern.
      Specified by:
      corresponds in interface OrderedIterable<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>
      Overrides:
      anySatisfy in class AbstractCollectionAdapter<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>
      Overrides:
      allSatisfy in class AbstractCollectionAdapter<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>
      Overrides:
      noneSatisfy in class AbstractCollectionAdapter<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>
      Overrides:
      injectInto in class AbstractCollectionAdapter<T>

    • forEach

      public void forEach(int fromIndex, int toIndex, Procedure<? super T> procedure)
      Description copied from interface: OrderedIterable
      Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive. 
      e.g.
 OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally)
 people.forEach(0, 1, new Procedure<Person>()
 {
     public void value(Person person)
     {
          LOGGER.info(person.getName());
     }
 });

      This code would output ted and mary's names.

      Specified by:
      forEach in interface OrderedIterable<T>

    • sort

      public void sort(Comparator<? super T> comparator)
      Specified by:
      sort in interface List<T>

    • sortThis

      public RandomAccessListAdapter<T> sortThis(Comparator<? super T> comparator)
      Description copied from interface: MutableList
      Sorts the internal data structure of this list and returns the list itself as a convenience.
      Specified by:
      sortThis in interface MutableList<T>

    • sortThis

      public RandomAccessListAdapter<T> sortThis()
      Description copied from interface: MutableList
      Sorts the internal data structure of this list and returns the list itself as a convenience.
      Specified by:
      sortThis in interface MutableList<T>

    • with

      public RandomAccessListAdapter<T> with(T element)
      Description copied from interface: MutableCollection
      This method allows mutable and fixed size collections the ability to add elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new element to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken: 
       MutableCollection<String> list = list.with("1");
 list = list.with("2");
 return list;
      In the case of FixedSizeCollection a new instance of MutableCollection will be returned by with, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling add on itself.
      Specified by:
      with in interface MutableCollection<T>
      Specified by:
      with in interface MutableList<T>
      See Also:

    • with

      public RandomAccessListAdapter<T> with(T element1, T element2)

    • with

      public RandomAccessListAdapter<T> with(T element1, T element2, T element3)

    • with

      public RandomAccessListAdapter<T> with(T... elements)

    • without

      public RandomAccessListAdapter<T> without(T element)
      Description copied from interface: MutableCollection
      This method allows mutable and fixed size collections the ability to remove elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned containing the elements that would be left from the original collection after calling remove. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken: 
       MutableCollection<String> list = list.without("1");
 list = list.without("2");
 return list;
      In the case of FixedSizeCollection a new instance of MutableCollection will be returned by without, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling remove on itself.
      Specified by:
      without in interface MutableCollection<T>
      Specified by:
      without in interface MutableList<T>
      See Also:

    • withAll

      public RandomAccessListAdapter<T> withAll(Iterable<? extends T> elements)
      Description copied from interface: MutableCollection
      This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new elements to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken: 
       MutableCollection<String> list = list.withAll(FastList.newListWith("1", "2"));
      In the case of FixedSizeCollection a new instance of MutableCollection will be returned by withAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling addAll on itself.
      Specified by:
      withAll in interface MutableCollection<T>
      Specified by:
      withAll in interface MutableList<T>
      See Also:

    • withoutAll

      public RandomAccessListAdapter<T> withoutAll(Iterable<? extends T> elements)
      Description copied from interface: MutableCollection
      This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned containing the elements that would be left from the original collection after calling removeAll. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken: 
       MutableCollection<String> list = list.withoutAll(FastList.newListWith("1", "2"));
      In the case of FixedSizeCollection a new instance of MutableCollection will be returned by withoutAll, and any variables that previously referenced the original collection will need to be redirected to reference the new instance. For other MutableCollection types you will replace the reference to collection with the same collection, since the instance will return "this" after calling removeAll on itself.
      Specified by:
      withoutAll in interface MutableCollection<T>
      Specified by:
      withoutAll in interface MutableList<T>
      See Also:

    • select

      public MutableList<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 ListIterable<T>
      Specified by:
      select in interface MutableCollection<T>
      Specified by:
      select in interface MutableList<T>
      Specified by:
      select in interface OrderedIterable<T>
      Specified by:
      select in interface ReversibleIterable<T>
      Specified by:
      select in interface RichIterable<T>
      Overrides:
      select in class AbstractListAdapter<T>

    • reject

      public MutableList<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 ListIterable<T>
      Specified by:
      reject in interface MutableCollection<T>
      Specified by:
      reject in interface MutableList<T>
      Specified by:
      reject in interface OrderedIterable<T>
      Specified by:
      reject in interface ReversibleIterable<T>
      Specified by:
      reject in interface RichIterable<T>
      Overrides:
      reject in class AbstractListAdapter<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

    • partition

      public PartitionMutableList<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 ListIterable<T>
      Specified by:
      partition in interface MutableCollection<T>
      Specified by:
      partition in interface MutableList<T>
      Specified by:
      partition in interface OrderedIterable<T>
      Specified by:
      partition in interface ReversibleIterable<T>
      Specified by:
      partition in interface RichIterable<T>
      Overrides:
      partition in class AbstractListAdapter<T>

    • partitionWith

      public <P> PartitionMutableList<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 ListIterable<T>
      Specified by:
      partitionWith in interface MutableCollection<T>
      Specified by:
      partitionWith in interface MutableList<T>
      Specified by:
      partitionWith in interface OrderedIterable<T>
      Specified by:
      partitionWith in interface ReversibleIterable<T>
      Specified by:
      partitionWith in interface RichIterable<T>
      Overrides:
      partitionWith in class AbstractListAdapter<T>

    • selectInstancesOf

      public <S> MutableList<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 ListIterable<T>
      Specified by:
      selectInstancesOf in interface MutableCollection<T>
      Specified by:
      selectInstancesOf in interface MutableList<T>
      Specified by:
      selectInstancesOf in interface OrderedIterable<T>
      Specified by:
      selectInstancesOf in interface ReversibleIterable<T>
      Specified by:
      selectInstancesOf in interface RichIterable<T>
      Overrides:
      selectInstancesOf in class AbstractListAdapter<T>

    • collect

      public <V> MutableList<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 ListIterable<T>
      Specified by:
      collect in interface MutableCollection<T>
      Specified by:
      collect in interface MutableList<T>
      Specified by:
      collect in interface OrderedIterable<T>
      Specified by:
      collect in interface ReversibleIterable<T>
      Specified by:
      collect in interface RichIterable<T>
      Overrides:
      collect in class AbstractListAdapter<T>

    • collectBoolean

      public MutableBooleanList 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 ListIterable<T>
      Specified by:
      collectBoolean in interface MutableCollection<T>
      Specified by:
      collectBoolean in interface MutableList<T>
      Specified by:
      collectBoolean in interface OrderedIterable<T>
      Specified by:
      collectBoolean in interface ReversibleIterable<T>
      Specified by:
      collectBoolean in interface RichIterable<T>
      Overrides:
      collectBoolean in class AbstractListAdapter<T>

    • collectByte

      public MutableByteList 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 ListIterable<T>
      Specified by:
      collectByte in interface MutableCollection<T>
      Specified by:
      collectByte in interface MutableList<T>
      Specified by:
      collectByte in interface OrderedIterable<T>
      Specified by:
      collectByte in interface ReversibleIterable<T>
      Specified by:
      collectByte in interface RichIterable<T>
      Overrides:
      collectByte in class AbstractListAdapter<T>

    • collectChar

      public MutableCharList 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 ListIterable<T>
      Specified by:
      collectChar in interface MutableCollection<T>
      Specified by:
      collectChar in interface MutableList<T>
      Specified by:
      collectChar in interface OrderedIterable<T>
      Specified by:
      collectChar in interface ReversibleIterable<T>
      Specified by:
      collectChar in interface RichIterable<T>
      Overrides:
      collectChar in class AbstractListAdapter<T>

    • collectDouble

      public MutableDoubleList 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 ListIterable<T>
      Specified by:
      collectDouble in interface MutableCollection<T>
      Specified by:
      collectDouble in interface MutableList<T>
      Specified by:
      collectDouble in interface OrderedIterable<T>
      Specified by:
      collectDouble in interface ReversibleIterable<T>
      Specified by:
      collectDouble in interface RichIterable<T>
      Overrides:
      collectDouble in class AbstractListAdapter<T>

    • collectFloat

      public MutableFloatList 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 ListIterable<T>
      Specified by:
      collectFloat in interface MutableCollection<T>
      Specified by:
      collectFloat in interface MutableList<T>
      Specified by:
      collectFloat in interface OrderedIterable<T>
      Specified by:
      collectFloat in interface ReversibleIterable<T>
      Specified by:
      collectFloat in interface RichIterable<T>
      Overrides:
      collectFloat in class AbstractListAdapter<T>

    • collectInt

      public MutableIntList 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 ListIterable<T>
      Specified by:
      collectInt in interface MutableCollection<T>
      Specified by:
      collectInt in interface MutableList<T>
      Specified by:
      collectInt in interface OrderedIterable<T>
      Specified by:
      collectInt in interface ReversibleIterable<T>
      Specified by:
      collectInt in interface RichIterable<T>
      Overrides:
      collectInt in class AbstractListAdapter<T>

    • collectLong

      public MutableLongList 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 ListIterable<T>
      Specified by:
      collectLong in interface MutableCollection<T>
      Specified by:
      collectLong in interface MutableList<T>
      Specified by:
      collectLong in interface OrderedIterable<T>
      Specified by:
      collectLong in interface ReversibleIterable<T>
      Specified by:
      collectLong in interface RichIterable<T>
      Overrides:
      collectLong in class AbstractListAdapter<T>

    • collectShort

      public MutableShortList 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 ListIterable<T>
      Specified by:
      collectShort in interface MutableCollection<T>
      Specified by:
      collectShort in interface MutableList<T>
      Specified by:
      collectShort in interface OrderedIterable<T>
      Specified by:
      collectShort in interface ReversibleIterable<T>
      Specified by:
      collectShort in interface RichIterable<T>
      Overrides:
      collectShort in class AbstractListAdapter<T>

    • flatCollect

      public <V> MutableList<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 ListIterable<T>
      Specified by:
      flatCollect in interface MutableCollection<T>
      Specified by:
      flatCollect in interface MutableList<T>
      Specified by:
      flatCollect in interface OrderedIterable<T>
      Specified by:
      flatCollect in interface ReversibleIterable<T>
      Specified by:
      flatCollect in interface RichIterable<T>
      Overrides:
      flatCollect in class AbstractListAdapter<T>
      Parameters:
      function - The Function to apply
      Returns:
      a new flattened collection produced by applying the given function

    • collectIf

      public <V> MutableList<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 ListIterable<T>
      Specified by:
      collectIf in interface MutableCollection<T>
      Specified by:
      collectIf in interface MutableList<T>
      Specified by:
      collectIf in interface OrderedIterable<T>
      Specified by:
      collectIf in interface ReversibleIterable<T>
      Specified by:
      collectIf in interface RichIterable<T>
      Overrides:
      collectIf in class AbstractListAdapter<T>

    • groupBy

      public <V> FastListMultimap<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 ListIterable<T>
      Specified by:
      groupBy in interface MutableCollection<T>
      Specified by:
      groupBy in interface MutableList<T>
      Specified by:
      groupBy in interface OrderedIterable<T>
      Specified by:
      groupBy in interface ReversibleIterable<T>
      Specified by:
      groupBy in interface RichIterable<T>
      Overrides:
      groupBy in class AbstractListAdapter<T>

    • groupByEach

      public <V> FastListMultimap<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 ListIterable<T>
      Specified by:
      groupByEach in interface MutableCollection<T>
      Specified by:
      groupByEach in interface MutableList<T>
      Specified by:
      groupByEach in interface OrderedIterable<T>
      Specified by:
      groupByEach in interface ReversibleIterable<T>
      Specified by:
      groupByEach in interface RichIterable<T>
      Overrides:
      groupByEach in class AbstractListAdapter<T>

    • selectWith

      public <P> MutableList<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 ListIterable<T>
      Specified by:
      selectWith in interface MutableCollection<T>
      Specified by:
      selectWith in interface MutableList<T>
      Specified by:
      selectWith in interface OrderedIterable<T>
      Specified by:
      selectWith in interface ReversibleIterable<T>
      Specified by:
      selectWith in interface RichIterable<T>
      Overrides:
      selectWith in class AbstractListAdapter<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:

    • rejectWith

      public <P> MutableList<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 ListIterable<T>
      Specified by:
      rejectWith in interface MutableCollection<T>
      Specified by:
      rejectWith in interface MutableList<T>
      Specified by:
      rejectWith in interface OrderedIterable<T>
      Specified by:
      rejectWith in interface ReversibleIterable<T>
      Specified by:
      rejectWith in interface RichIterable<T>
      Overrides:
      rejectWith in class AbstractListAdapter<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:

    • collectWith

      public <P, V> MutableList<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 ListIterable<T>
      Specified by:
      collectWith in interface MutableCollection<T>
      Specified by:
      collectWith in interface MutableList<T>
      Specified by:
      collectWith in interface OrderedIterable<T>
      Specified by:
      collectWith in interface ReversibleIterable<T>
      Specified by:
      collectWith in interface RichIterable<T>
      Overrides:
      collectWith in class AbstractListAdapter<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:

    • distinct

      public MutableList<T> distinct()
      Description copied from interface: MutableList
      Returns a new ListIterable containing the distinct elements in this list.
      Specified by:
      distinct in interface ListIterable<T>
      Specified by:
      distinct in interface MutableList<T>
      Specified by:
      distinct in interface OrderedIterable<T>
      Specified by:
      distinct in interface ReversibleIterable<T>
      Returns:
      ListIterable of distinct elements

    • distinct

      public MutableList<T> distinct(HashingStrategy<? super T> hashingStrategy)
      Description copied from interface: MutableList
      Returns a new ListIterable containing the distinct elements in this list. Takes HashingStrategy.
      Specified by:
      distinct in interface ListIterable<T>
      Specified by:
      distinct in interface MutableList<T>
      Returns:
      ListIterable of distinct elements

    • zip

      public <S> MutableList<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 ListIterable<T>
      Specified by:
      zip in interface MutableCollection<T>
      Specified by:
      zip in interface MutableList<T>
      Specified by:
      zip in interface OrderedIterable<T>
      Specified by:
      zip in interface ReversibleIterable<T>
      Specified by:
      zip in interface RichIterable<T>
      Overrides:
      zip in class AbstractListAdapter<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.

    • zipWithIndex

      public MutableList<Pair<T,Integer>> zipWithIndex()
      Description copied from interface: RichIterable
      Zips this RichIterable with its indices.
      Specified by:
      zipWithIndex in interface ListIterable<T>
      Specified by:
      zipWithIndex in interface MutableCollection<T>
      Specified by:
      zipWithIndex in interface MutableList<T>
      Specified by:
      zipWithIndex in interface OrderedIterable<T>
      Specified by:
      zipWithIndex in interface ReversibleIterable<T>
      Specified by:
      zipWithIndex in interface RichIterable<T>
      Overrides:
      zipWithIndex in class AbstractListAdapter<T>
      Returns:
      A new RichIterable containing pairs consisting of all elements of this RichIterable paired with their index. Indices start at 0.
      See Also:

    • take

      public MutableList<T> take(int count)
      Description copied from interface: ReversibleIterable
      Returns the first count elements of the iterable or all the elements in the iterable if count is greater than the length of the iterable.
      Specified by:
      take in interface ListIterable<T>
      Specified by:
      take in interface MutableList<T>
      Specified by:
      take in interface ReversibleIterable<T>
      Parameters:
      count - the number of items to take.

    • takeWhile

      public MutableList<T> takeWhile(Predicate<? super T> predicate)
      Description copied from interface: ListIterable
      Returns the initial elements that satisfy the Predicate. Short circuits at the first element which does not satisfy the Predicate.
      Specified by:
      takeWhile in interface ListIterable<T>
      Specified by:
      takeWhile in interface MutableList<T>
      Specified by:
      takeWhile in interface OrderedIterable<T>
      Specified by:
      takeWhile in interface ReversibleIterable<T>

    • drop

      public MutableList<T> drop(int count)
      Description copied from interface: ReversibleIterable
      Returns an iterable after skipping the first count elements or an empty iterable if the count is greater than the length of the iterable.
      Specified by:
      drop in interface ListIterable<T>
      Specified by:
      drop in interface MutableList<T>
      Specified by:
      drop in interface ReversibleIterable<T>
      Parameters:
      count - the number of items to drop.

    • dropWhile

      public MutableList<T> dropWhile(Predicate<? super T> predicate)
      Description copied from interface: ListIterable
      Returns the final elements that do not satisfy the Predicate. Short circuits at the first element which does satisfy the Predicate.
      Specified by:
      dropWhile in interface ListIterable<T>
      Specified by:
      dropWhile in interface MutableList<T>
      Specified by:
      dropWhile in interface OrderedIterable<T>
      Specified by:
      dropWhile in interface ReversibleIterable<T>

    • partitionWhile

      public PartitionMutableList<T> partitionWhile(Predicate<? super T> predicate)
      Description copied from interface: ListIterable
      Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements. Short circuits at the first element which does satisfy the Predicate.
      Specified by:
      partitionWhile in interface ListIterable<T>
      Specified by:
      partitionWhile in interface MutableList<T>
      Specified by:
      partitionWhile in interface OrderedIterable<T>
      Specified by:
      partitionWhile in interface ReversibleIterable<T>