MutableList (Eclipse Collections

All Superinterfaces:

Cloneable, Collection<T>, InternalIterable<T>, Iterable<T>, List<T>, ListIterable<T>, MutableCollection<T>, OrderedIterable<T>, ReversibleIterable<T>, RichIterable<T>

All Known Subinterfaces:

FixedSizeList<T>

All Known Implementing Classes:

AbstractArrayAdapter, AbstractListAdapter, AbstractMemoryEfficientMutableList, AbstractMutableList, ArrayAdapter, ArrayListAdapter, CompositeFastList, FastList, ListAdapter, MultiReaderFastList, RandomAccessListAdapter, SynchronizedMutableList, UnmodifiableMutableList
```
public interface MutableList<T>
extends MutableCollection<T>, List<T>, Cloneable, ListIterable<T>
```
A MutableList is an implementation of a JCF List which provides methods matching the Smalltalk Collection protocol.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`MutableList<T>`	`asSynchronized()` Returns a synchronized (thread-safe) collection backed by this collection.
`MutableList<T>`	`asUnmodifiable()` Returns an unmodifable view of the list.
`MutableList<T>`	`clone()`
`<V> MutableList<V>`	`collect(Function<? super T,? extends V> function)` Returns a new MutableCollection with the results of applying the specified function to each element of the source collection.
`MutableBooleanList`	`collectBoolean(BooleanFunction<? super T> booleanFunction)` Returns a new primitive `boolean` iterable with the results of applying the specified function on each element of the source collection.
`MutableByteList`	`collectByte(ByteFunction<? super T> byteFunction)` Returns a new primitive `byte` iterable with the results of applying the specified function on each element of the source collection.
`MutableCharList`	`collectChar(CharFunction<? super T> charFunction)` Returns a new primitive `char` iterable with the results of applying the specified function on each element of the source collection.
`MutableDoubleList`	`collectDouble(DoubleFunction<? super T> doubleFunction)` Returns a new primitive `double` iterable with the results of applying the specified function on each element of the source collection.
`MutableFloatList`	`collectFloat(FloatFunction<? super T> floatFunction)` Returns a new primitive `float` iterable with the results of applying the specified function on each element of the source collection.
`<V> MutableList<V>`	`collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function)` 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.
`MutableIntList`	`collectInt(IntFunction<? super T> intFunction)` Returns a new primitive `int` iterable with the results of applying the specified function on each element of the source collection.
`MutableLongList`	`collectLong(LongFunction<? super T> longFunction)` Returns a new primitive `long` iterable with the results of applying the specified function on each element of the source collection.
`MutableShortList`	`collectShort(ShortFunction<? super T> shortFunction)` Returns a new primitive `short` iterable with the results of applying the specified function on each element of the source collection.
`<P,V> MutableList<V>`	`collectWith(Function2<? super T,? super P,? extends V> function, P parameter)` Same as `RichIterable.collect(Function)` with a `Function2` and specified parameter which is passed to the block.
`MutableList<T>`	`distinct()` Returns a new `ListIterable` containing the distinct elements in this list.
`MutableList<T>`	`distinct(HashingStrategy<? super T> hashingStrategy)` Returns a new `ListIterable` containing the distinct elements in this list.
`MutableList<T>`	`drop(int count)` Returns an iterable after skipping the first `count` elements or an empty iterable if the `count` is greater than the length of the iterable.
`MutableList<T>`	`dropWhile(Predicate<? super T> predicate)` Returns the final elements that do not satisfy the Predicate.
`<V> MutableList<V>`	`flatCollect(Function<? super T,? extends Iterable<V>> function)` `flatCollect` is a special case of `RichIterable.collect(Function)`.
`<V> MutableListMultimap<V,T>`	`groupBy(Function<? super T,? extends V> function)` For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
`<V> MutableListMultimap<V,T>`	`groupByEach(Function<? super T,? extends Iterable<V>> function)` Similar to `RichIterable.groupBy(Function)`, except the result of evaluating function will return a collection of keys for each value.
`MutableList<T>`	`newEmpty()` Creates a new empty mutable version of the same collection type.
`PartitionMutableList<T>`	`partition(Predicate<? super T> predicate)` Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
`PartitionMutableList<T>`	`partitionWhile(Predicate<? super T> predicate)` Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
`<P> PartitionMutableList<T>`	`partitionWith(Predicate2<? super T,? super P> predicate, P parameter)` Filters a collection into a PartitionIterable based on the evaluation of the predicate.
`MutableList<T>`	`reject(Predicate<? super T> predicate)` Returns a MutableCollection with all elements that evaluate to false for the specified predicate.
`<P> MutableList<T>`	`rejectWith(Predicate2<? super T,? super P> predicate, P parameter)` Returns a MutableCollection with all elements that evaluate to false for the specified predicate2 and parameter.
`MutableList<T>`	`reverseThis()` Mutates the current list by reversing its order and returns the current list as a result
`MutableList<T>`	`select(Predicate<? super T> predicate)` Returns a MutableCollection with all elements that evaluate to true for the specified predicate.
`<S> MutableList<S>`	`selectInstancesOf(Class<S> clazz)` Returns all elements of the source collection that are instances of the Class `clazz`.
`<P> MutableList<T>`	`selectWith(Predicate2<? super T,? super P> predicate, P parameter)` Returns a MutableCollection with all elements that evaluate to true for the specified predicate2 and parameter.
`MutableList<T>`	`shuffleThis()`
`MutableList<T>`	`shuffleThis(Random rnd)`
`MutableList<T>`	`sortThis()` Sorts the internal data structure of this list and returns the list itself as a convenience.
`MutableList<T>`	`sortThis(Comparator<? super T> comparator)` Sorts the internal data structure of this list and returns the list itself as a convenience.
`<V extends Comparable<? super V>> MutableList<T>`	`sortThisBy(Function<? super T,? extends V> function)` Sorts the internal data structure of this list based on the natural order of the attribute returned by `function`.
`MutableList<T>`	`sortThisByBoolean(BooleanFunction<? super T> function)`
`MutableList<T>`	`sortThisByByte(ByteFunction<? super T> function)`
`MutableList<T>`	`sortThisByChar(CharFunction<? super T> function)`
`MutableList<T>`	`sortThisByDouble(DoubleFunction<? super T> function)`
`MutableList<T>`	`sortThisByFloat(FloatFunction<? super T> function)`
`MutableList<T>`	`sortThisByInt(IntFunction<? super T> function)`
`MutableList<T>`	`sortThisByLong(LongFunction<? super T> function)`
`MutableList<T>`	`sortThisByShort(ShortFunction<? super T> function)`
`MutableList<T>`	`subList(int fromIndex, int toIndex)`
`MutableList<T>`	`take(int count)` 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.
`MutableList<T>`	`takeWhile(Predicate<? super T> predicate)` Returns the initial elements that satisfy the Predicate.
`MutableList<T>`	`tap(Procedure<? super T> procedure)` Executes the Procedure for each element in the iterable and returns `this`.
`ImmutableList<T>`	`toImmutable()` Returns an immutable copy of this list.
`MutableList<T>`	`toReversed()` Returns a new MutableList in reverse order
`MutableList<T>`	`with(T element)` This method allows mutable and fixed size collections the ability to add elements to their existing elements.
`MutableList<T>`	`withAll(Iterable<? extends T> elements)` This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements.
`MutableList<T>`	`without(T element)` This method allows mutable and fixed size collections the ability to remove elements from their existing elements.
`MutableList<T>`	`withoutAll(Iterable<? extends T> elements)` This method allows mutable and fixed size collections the ability to remove multiple elements from their existing elements.
`<S> MutableList<Pair<T,S>>`	`zip(Iterable<S> that)` Returns a `RichIterable` formed from this `RichIterable` and another `RichIterable` by combining corresponding elements in pairs.
`MutableList<Pair<T,Integer>>`	`zipWithIndex()` Zips this `RichIterable` with its indices.

Methods inherited from interface org.eclipse.collections.api.collection.MutableCollection
addAllIterable, aggregateBy, aggregateInPlaceBy, groupByUniqueKey, injectIntoWith, removeAllIterable, removeIf, removeIfWith, retainAllIterable, selectAndRejectWith

Methods inherited from interface java.util.List
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface org.eclipse.collections.api.list.ListIterable
asParallel, binarySearch, binarySearch, equals, get, getFirst, getLast, hashCode, lastIndexOf, listIterator, listIterator, toStack

Methods inherited from interface org.eclipse.collections.api.ordered.ReversibleIterable
asReversed, detectLastIndex, reverseForEach

Methods inherited from interface org.eclipse.collections.api.ordered.OrderedIterable
corresponds, detectIndex, forEach, forEachWithIndex, forEachWithIndex, indexOf

Methods inherited from interface org.eclipse.collections.api.RichIterable
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, each, flatCollect, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, maxBy, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString

Methods inherited from interface org.eclipse.collections.api.InternalIterable
forEach, forEachWith

- Method Detail
  - with
```
MutableList<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 list;
 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>
    
    See Also:
    
    Collection.add(Object)
  - without
```
MutableList<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 contaning 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 list;
 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>
    
    See Also:
    
    Collection.remove(Object)
  - withAll
```
MutableList<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 list;
 list = list.withAll(FastList.newListWith("1", "2"));
 return list;
 
```
    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>
    
    See Also:
    
    Collection.addAll(Collection)
  - withoutAll
```
MutableList<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 contaning 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 list;
 list = list.withoutAll(FastList.newListWith("1", "2"));
 return list;
 
```
    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>
    
    See Also:
    
    Collection.removeAll(Collection)
  - newEmpty
```
MutableList<T> newEmpty()
```
    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>
  - clone
```
MutableList<T> clone()
```
  - tap
```
MutableList<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()
     {
         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), InternalIterable.forEach(Procedure)
  - select
```
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.
```
e.g.
 return people.select(new Predicate<Person>()
 {
     public boolean value(Person person)
     {
         return person.getAddress().getCity().equals("Metuchen");
     }
 });
 
```
    Specified by:
    
    select in interface ListIterable<T>
    
    Specified by:
    
    select in interface MutableCollection<T>
    
    Specified by:
    
    select in interface OrderedIterable<T>
    
    Specified by:
    
    select in interface ReversibleIterable<T>
    
    Specified by:
    
    select in interface RichIterable<T>
  - selectWith
```
<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.
```
e.g.
 return integers.selectWith(PredicatesLite.equal(), Integer.valueOf(5));
 
```
    Specified by:
    
    selectWith in interface ListIterable<T>
    
    Specified by:
    
    selectWith in interface MutableCollection<T>
    
    Specified by:
    
    selectWith in interface OrderedIterable<T>
    
    Specified by:
    
    selectWith in interface ReversibleIterable<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)
  - reject
```
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.
```
e.g.
 return people.reject(new Predicate<Person>()
 {
     public boolean value(Person person)
     {
         return person.person.getLastName().equals("Smith");
     }
 });
 
```
```
e.g.
 return 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 OrderedIterable<T>
    
    Specified by:
    
    reject in interface ReversibleIterable<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
  - rejectWith
```
<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.
 return integers.rejectWith(PredicatesLite.equal(), Integer.valueOf(5));
 
```
    Specified by:
    
    rejectWith in interface ListIterable<T>
    
    Specified by:
    
    rejectWith in interface MutableCollection<T>
    
    Specified by:
    
    rejectWith in interface OrderedIterable<T>
    
    Specified by:
    
    rejectWith in interface ReversibleIterable<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)
  - partition
```
PartitionMutableList<T> partition(Predicate<? super T> predicate)
```
    Description copied from interface: RichIterable
    Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
    Example using a Java 8 lambda expression:
```
 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partition(person -> person.getAddress().getState().getName().equals("New York"));
 
```
    Example using an anonymous inner class:
```
 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partition(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getAddress().getState().getName().equals("New York");
         }
     });
 
```
    Specified by:
    
    partition in interface ListIterable<T>
    
    Specified by:
    
    partition in interface MutableCollection<T>
    
    Specified by:
    
    partition in interface OrderedIterable<T>
    
    Specified by:
    
    partition in interface ReversibleIterable<T>
    
    Specified by:
    
    partition in interface RichIterable<T>
  - partitionWith
```
<P> PartitionMutableList<T> partitionWith(Predicate2<? super T,? super P> predicate,
                                          P parameter)
```
    Description copied from interface: RichIterable
    Filters a collection into a PartitionIterable based on the evaluation of the predicate.
    Example using a Java 8 lambda expression:
```
 PartitionIterable<Person>> newYorkersAndNonNewYorkers =
     people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
 
```
    Example using an anonymous inner class:
```
 PartitionIterable<Person>> newYorkersAndNonNewYorkers =
     people.partitionWith(new Predicate2<Person, String>()
     {
         public boolean accept(Person person, String state)
         {
             return person.getAddress().getState().getName().equals(state);
         }
     }, "New York");
 
```
    Specified by:
    
    partitionWith in interface ListIterable<T>
    
    Specified by:
    
    partitionWith in interface MutableCollection<T>
    
    Specified by:
    
    partitionWith in interface OrderedIterable<T>
    
    Specified by:
    
    partitionWith in interface ReversibleIterable<T>
    
    Specified by:
    
    partitionWith in interface RichIterable<T>
  - selectInstancesOf
```
<S> MutableList<S> selectInstancesOf(Class<S> clazz)
```
    Description copied from interface: RichIterable
    
    Returns all elements of the source collection that are instances of the Class clazz.
    
    Specified by:
    
    selectInstancesOf in interface ListIterable<T>
    
    Specified by:
    
    selectInstancesOf in interface MutableCollection<T>
    
    Specified by:
    
    selectInstancesOf in interface OrderedIterable<T>
    
    Specified by:
    
    selectInstancesOf in interface ReversibleIterable<T>
    
    Specified by:
    
    selectInstancesOf in interface RichIterable<T>
  - collect
```
<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.
```
e.g.
 return people.collect(new Function<Person, String>()
 {
     public String value(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 });
 
```
    Specified by:
    
    collect in interface ListIterable<T>
    
    Specified by:
    
    collect in interface MutableCollection<T>
    
    Specified by:
    
    collect in interface OrderedIterable<T>
    
    Specified by:
    
    collect in interface ReversibleIterable<T>
    
    Specified by:
    
    collect in interface RichIterable<T>
  - collectBoolean
```
MutableBooleanList collectBoolean(BooleanFunction<? super T> booleanFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
    Example using a Java 8 lambda expression:
```
 BooleanIterable licenses =
     people.collectBoolean(person -> person.hasDrivingLicense());
 
```
    Example using an anonymous inner class:
```
 BooleanIterable licenses =
     people.collectBoolean(new BooleanFunction<Person>()
     {
         public boolean booleanValueOf(Person person)
         {
             return person.hasDrivingLicense();
         }
     });
 
```
    Specified by:
    
    collectBoolean in interface ListIterable<T>
    
    Specified by:
    
    collectBoolean in interface MutableCollection<T>
    
    Specified by:
    
    collectBoolean in interface OrderedIterable<T>
    
    Specified by:
    
    collectBoolean in interface ReversibleIterable<T>
    
    Specified by:
    
    collectBoolean in interface RichIterable<T>
  - collectByte
```
MutableByteList collectByte(ByteFunction<? super T> byteFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
    Example using a Java 8 lambda expression:
```
 ByteIterable bytes =
     people.collectByte(person -> person.getCode());
 
```
    Example using an anonymous inner class:
```
 ByteIterable bytes =
     people.collectByte(new ByteFunction<Person>()
     {
         public byte byteValueOf(Person person)
         {
             return person.getCode();
         }
     });
 
```
    Specified by:
    
    collectByte in interface ListIterable<T>
    
    Specified by:
    
    collectByte in interface MutableCollection<T>
    
    Specified by:
    
    collectByte in interface OrderedIterable<T>
    
    Specified by:
    
    collectByte in interface ReversibleIterable<T>
    
    Specified by:
    
    collectByte in interface RichIterable<T>
  - collectChar
```
MutableCharList collectChar(CharFunction<? super T> charFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
    Example using a Java 8 lambda expression:
```
 CharIterable chars =
     people.collectChar(person -> person.getMiddleInitial());
 
```
    Example using an anonymous inner class:
```
 CharIterable chars =
     people.collectChar(new CharFunction<Person>()
     {
         public char charValueOf(Person person)
         {
             return person.getMiddleInitial();
         }
     });
 
```
    Specified by:
    
    collectChar in interface ListIterable<T>
    
    Specified by:
    
    collectChar in interface MutableCollection<T>
    
    Specified by:
    
    collectChar in interface OrderedIterable<T>
    
    Specified by:
    
    collectChar in interface ReversibleIterable<T>
    
    Specified by:
    
    collectChar in interface RichIterable<T>
  - collectDouble
```
MutableDoubleList collectDouble(DoubleFunction<? super T> doubleFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
    Example using a Java 8 lambda expression:
```
 DoubleIterable doubles =
     people.collectDouble(person -> person.getMilesFromNorthPole());
 
```
    Example using an anonymous inner class:
```
 DoubleIterable doubles =
     people.collectDouble(new DoubleFunction<Person>()
     {
         public double doubleValueOf(Person person)
         {
             return person.getMilesFromNorthPole();
         }
     });
 
```
    Specified by:
    
    collectDouble in interface ListIterable<T>
    
    Specified by:
    
    collectDouble in interface MutableCollection<T>
    
    Specified by:
    
    collectDouble in interface OrderedIterable<T>
    
    Specified by:
    
    collectDouble in interface ReversibleIterable<T>
    
    Specified by:
    
    collectDouble in interface RichIterable<T>
  - collectFloat
```
MutableFloatList collectFloat(FloatFunction<? super T> floatFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
    Example using a Java 8 lambda expression:
```
 FloatIterable floats =
     people.collectFloat(person -> person.getHeightInInches());
 
```
    Example using an anonymous inner class:
```
 FloatIterable floats =
     people.collectFloat(new FloatFunction<Person>()
     {
         public float floatValueOf(Person person)
         {
             return person.getHeightInInches();
         }
     });
 
```
    Specified by:
    
    collectFloat in interface ListIterable<T>
    
    Specified by:
    
    collectFloat in interface MutableCollection<T>
    
    Specified by:
    
    collectFloat in interface OrderedIterable<T>
    
    Specified by:
    
    collectFloat in interface ReversibleIterable<T>
    
    Specified by:
    
    collectFloat in interface RichIterable<T>
  - collectInt
```
MutableIntList collectInt(IntFunction<? super T> intFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
    Example using a Java 8 lambda expression:
```
 IntIterable ints =
     people.collectInt(person -> person.getAge());
 
```
    Example using an anonymous inner class:
```
 IntIterable ints =
     people.collectInt(new IntFunction<Person>()
     {
         public int intValueOf(Person person)
         {
             return person.getAge();
         }
     });
 
```
    Specified by:
    
    collectInt in interface ListIterable<T>
    
    Specified by:
    
    collectInt in interface MutableCollection<T>
    
    Specified by:
    
    collectInt in interface OrderedIterable<T>
    
    Specified by:
    
    collectInt in interface ReversibleIterable<T>
    
    Specified by:
    
    collectInt in interface RichIterable<T>
  - collectLong
```
MutableLongList collectLong(LongFunction<? super T> longFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
    Example using a Java 8 lambda expression:
```
 LongIterable longs =
     people.collectLong(person -> person.getGuid());
 
```
    Example using an anonymous inner class:
```
 LongIterable longs =
     people.collectLong(new LongFunction<Person>()
     {
         public long longValueOf(Person person)
         {
             return person.getGuid();
         }
     });
 
```
    Specified by:
    
    collectLong in interface ListIterable<T>
    
    Specified by:
    
    collectLong in interface MutableCollection<T>
    
    Specified by:
    
    collectLong in interface OrderedIterable<T>
    
    Specified by:
    
    collectLong in interface ReversibleIterable<T>
    
    Specified by:
    
    collectLong in interface RichIterable<T>
  - collectShort
```
MutableShortList collectShort(ShortFunction<? super T> shortFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
    Example using a Java 8 lambda expression:
```
 ShortIterable shorts =
     people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
 
```
    Example using an anonymous inner class:
```
 ShortIterable shorts =
     people.collectShort(new ShortFunction<Person>()
     {
         public short shortValueOf(Person person)
         {
             return person.getNumberOfJunkMailItemsReceivedPerMonth();
         }
     });
 
```
    Specified by:
    
    collectShort in interface ListIterable<T>
    
    Specified by:
    
    collectShort in interface MutableCollection<T>
    
    Specified by:
    
    collectShort in interface OrderedIterable<T>
    
    Specified by:
    
    collectShort in interface ReversibleIterable<T>
    
    Specified by:
    
    collectShort in interface RichIterable<T>
  - collectWith
```
<P,V> MutableList<V> collectWith(Function2<? super T,? super P,? extends V> function,
                                 P parameter)
```
    Description copied from interface: RichIterable
    Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.
    Example using a Java 8 lambda expression:
```
 RichIterable<Integer> integers =
     Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
 
```
    Example using an anonymous inner class:
```
 Function2<Integer, Integer, Integer> addParameterFunction =
     new Function2<Integer, Integer, Integer>()
     {
         public Integer value(Integer each, Integer parameter)
         {
             return each + parameter;
         }
     };
 RichIterable<Integer> integers =
     Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
 
```
    Specified by:
    
    collectWith in interface ListIterable<T>
    
    Specified by:
    
    collectWith in interface MutableCollection<T>
    
    Specified by:
    
    collectWith in interface OrderedIterable<T>
    
    Specified by:
    
    collectWith in interface ReversibleIterable<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)
  - collectIf
```
<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.
```
e.g.
 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 OrderedIterable<T>
    
    Specified by:
    
    collectIf in interface ReversibleIterable<T>
    
    Specified by:
    
    collectIf in interface RichIterable<T>
  - flatCollect
```
<V> MutableList<V> flatCollect(Function<? super T,? extends Iterable<V>> function)
```
    Description copied from interface: RichIterable
    flatCollect is a special case of RichIterable.collect(Function). With collect, when the Function returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.
    Consider the following example where we have a Person class, and each Person has a list of Address objects. Take the following Function:
```
 Function<Person, List<Address>> addressFunction = Person::getAddresses;
 MutableList<Person> people = ...;
 
```
    Using collect returns a collection of collections of addresses.
```
 MutableList<List<Address>> addresses = people.collect(addressFunction);
 
```
    Using flatCollect returns a single flattened list of addresses.
```
 MutableList<Address> addresses = people.flatCollect(addressFunction);
 
```
    Specified by:
    
    flatCollect in interface ListIterable<T>
    
    Specified by:
    
    flatCollect in interface MutableCollection<T>
    
    Specified by:
    
    flatCollect in interface OrderedIterable<T>
    
    Specified by:
    
    flatCollect in interface ReversibleIterable<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
  - distinct
```
MutableList<T> distinct()
```
    Returns a new ListIterable containing the distinct elements in this list.
    
    Specified by:
    
    distinct in interface ListIterable<T>
    
    Specified by:
    
    distinct in interface OrderedIterable<T>
    
    Specified by:
    
    distinct in interface ReversibleIterable<T>
    
    Returns:
    
    ListIterable of distinct elements
    
    Since:
    
    7.0
  - distinct
```
MutableList<T> distinct(HashingStrategy<? super T> hashingStrategy)
```
    Returns a new ListIterable containing the distinct elements in this list. Takes HashingStrategy.
    
    Specified by:
    
    distinct in interface ListIterable<T>
    
    Returns:
    
    ListIterable of distinct elements
    
    Since:
    
    7.0
  - sortThis
```
MutableList<T> sortThis(Comparator<? super T> comparator)
```
    Sorts the internal data structure of this list and returns the list itself as a convenience.
  - sortThis
```
MutableList<T> sortThis()
```
    Sorts the internal data structure of this list and returns the list itself as a convenience.
  - sortThisBy
```
<V extends Comparable<? super V>> MutableList<T> sortThisBy(Function<? super T,? extends V> function)
```
    Sorts the internal data structure of this list based on the natural order of the attribute returned by function.
  - sortThisByInt
```
MutableList<T> sortThisByInt(IntFunction<? super T> function)
```
    Since:
    
    6.0
  - sortThisByBoolean
```
MutableList<T> sortThisByBoolean(BooleanFunction<? super T> function)
```
    Since:
    
    6.0
  - sortThisByChar
```
MutableList<T> sortThisByChar(CharFunction<? super T> function)
```
    Since:
    
    6.0
  - sortThisByByte
```
MutableList<T> sortThisByByte(ByteFunction<? super T> function)
```
    Since:
    
    6.0
  - sortThisByShort
```
MutableList<T> sortThisByShort(ShortFunction<? super T> function)
```
    Since:
    
    6.0
  - sortThisByFloat
```
MutableList<T> sortThisByFloat(FloatFunction<? super T> function)
```
    Since:
    
    6.0
  - sortThisByLong
```
MutableList<T> sortThisByLong(LongFunction<? super T> function)
```
    Since:
    
    6.0
  - sortThisByDouble
```
MutableList<T> sortThisByDouble(DoubleFunction<? super T> function)
```
    Since:
    
    6.0
  - subList
```
MutableList<T> subList(int fromIndex,
                       int toIndex)
```
    Specified by:
    
    subList in interface List<T>
  - asUnmodifiable
```
MutableList<T> asUnmodifiable()
```
    Returns an unmodifable view of the list. The returned list will be Serializable if this list is Serializable.
    
    Specified by:
    
    asUnmodifiable in interface MutableCollection<T>
    
    Returns:
    
    an unmodifiable view of this list
  - asSynchronized
```
MutableList<T> asSynchronized()
```
    Description copied from interface: MutableCollection
    Returns a synchronized (thread-safe) collection backed by this collection. In order to guarantee serial access, it is critical that all access to the backing collection is accomplished through the returned collection.
    It is imperative that the user manually synchronize on the returned collection when iterating over it using the standard JDK iterator or JDK 5 for loop.
```
  MutableCollection collection = myCollection.asSynchronized();
     ...
  synchronized(collection)
  {
      Iterator i = c.iterator(); // Must be in the synchronized block
      while (i.hasNext())
         foo(i.next());
  }
 
```
    Failure to follow this advice may result in non-deterministic behavior.
    The preferred way of iterating over a synchronized collection is to use the collection.forEach() method which is properly synchronized internally.
```
  MutableCollection collection = myCollection.asSynchronized();
     ...
  collection.forEach(new Procedure()
  {
      public void value(Object each)
      {
          ...
      }
  });
 
```
    The returned collection does not pass the hashCode and equals operations through to the backing collection, but relies on Object's equals and hashCode methods. This is necessary to preserve the contracts of these operations in the case that the backing collection is a set or a list.
    The returned collection will be serializable if this collection is serializable.
    Specified by:
    
    asSynchronized in interface MutableCollection<T>
    
    Returns:
    
    a synchronized view of this collection.
  - toImmutable
```
ImmutableList<T> toImmutable()
```
    Returns an immutable copy of this list. If the list is immutable, it returns itself. The returned list will be Serializable if this list is Serializable.
    
    Specified by:
    
    toImmutable in interface ListIterable<T>
    
    Specified by:
    
    toImmutable in interface MutableCollection<T>
  - groupBy
```
<V> MutableListMultimap<V,T> groupBy(Function<? super T,? extends V> function)
```
    Description copied from interface: RichIterable
    For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
    Example using a Java 8 method reference:
```
 Multimap<String, Person> peopleByLastName =
     people.groupBy(Person::getLastName);
 
```
    Example using an anonymous inner class:
```
 Multimap<String, Person> peopleByLastName =
     people.groupBy(new Function<Person, String>()
     {
         public String value(Person person)
         {
             return person.getLastName();
         }
     });
 
```
    Specified by:
    
    groupBy in interface ListIterable<T>
    
    Specified by:
    
    groupBy in interface MutableCollection<T>
    
    Specified by:
    
    groupBy in interface OrderedIterable<T>
    
    Specified by:
    
    groupBy in interface ReversibleIterable<T>
    
    Specified by:
    
    groupBy in interface RichIterable<T>
  - groupByEach
```
<V> MutableListMultimap<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 OrderedIterable<T>
    
    Specified by:
    
    groupByEach in interface ReversibleIterable<T>
    
    Specified by:
    
    groupByEach in interface RichIterable<T>
  - zip
```
<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 OrderedIterable<T>
    
    Specified by:
    
    zip in interface ReversibleIterable<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.
  - zipWithIndex
```
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 OrderedIterable<T>
    
    Specified by:
    
    zipWithIndex in interface ReversibleIterable<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)
  - take
```
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 ReversibleIterable<T>
    
    Parameters:
    
    count - the number of items to take.
  - takeWhile
```
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 OrderedIterable<T>
    
    Specified by:
    
    takeWhile in interface ReversibleIterable<T>
  - drop
```
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 ReversibleIterable<T>
    
    Parameters:
    
    count - the number of items to drop.
  - dropWhile
```
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 OrderedIterable<T>
    
    Specified by:
    
    dropWhile in interface ReversibleIterable<T>
  - partitionWhile
```
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 OrderedIterable<T>
    
    Specified by:
    
    partitionWhile in interface ReversibleIterable<T>
  - toReversed
```
MutableList<T> toReversed()
```
    Returns a new MutableList in reverse order
    
    Specified by:
    
    toReversed in interface ListIterable<T>
    
    Specified by:
    
    toReversed in interface ReversibleIterable<T>
  - reverseThis
```
MutableList<T> reverseThis()
```
    Mutates the current list by reversing its order and returns the current list as a result
  - shuffleThis
```
MutableList<T> shuffleThis()
```
  - shuffleThis
```
MutableList<T> shuffleThis(Random rnd)
```

Interface MutableList<T>

Method Summary

Methods inherited from interface org.eclipse.collections.api.collection.MutableCollection

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface org.eclipse.collections.api.list.ListIterable

Methods inherited from interface org.eclipse.collections.api.ordered.ReversibleIterable

Methods inherited from interface org.eclipse.collections.api.ordered.OrderedIterable

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

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

Method Detail

with

without

withAll

withoutAll

newEmpty

clone

tap

select

selectWith

reject

rejectWith

partition

partitionWith

selectInstancesOf

collect

collectBoolean

collectByte

collectChar

collectDouble

collectFloat

collectInt

collectLong

collectShort

collectWith

collectIf

flatCollect

distinct

distinct

sortThis

sortThis

sortThisBy

sortThisByInt

sortThisByBoolean

sortThisByChar

sortThisByByte

sortThisByShort

sortThisByFloat

sortThisByLong

sortThisByDouble

subList

asUnmodifiable

asSynchronized

toImmutable

groupBy

groupByEach

zip

zipWithIndex

take

takeWhile

drop

dropWhile

partitionWhile

toReversed

reverseThis

shuffleThis

shuffleThis