Package org.eclipse.collections.api.list

Interface MutableList<T>

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>, MultiReaderList<T>

public interface MutableList<T>
extends MutableCollection<T>, List<T>, Cloneable, ListIterable<T>

A MutableList is an extension of java.util.List which provides methods matching the Smalltalk Collection protocol.

Method Summary

Modifier and Type	Method	Description
MutableList<T>	asSynchronized()	Returns a synchronized wrapper backed by this collection.
MutableList<T>	asUnmodifiable()	Returns an unmodifiable view of the list.
MutableList<T>	clone()
default <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.
default 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.
default 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.
default 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.
default 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.
default 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.
default <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.
default 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.
default 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.
default 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.
default <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.
default <V> MutableList<V>	collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function)	Returns a new OrderedIterable using results obtained by applying the specified function to each element and its corresponding index.
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.
<V> MutableList<T>	distinctBy(Function<? super T,? extends V> function)	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.
default <V> MutableList<V>	flatCollect(Function<? super T,? extends Iterable<V>> function)	flatCollect is a special case of RichIterable.collect(Function).
default <P, V> MutableList<V>	flatCollectWith(Function2<? super T,? super P,? extends Iterable<V>> function, P parameter)	Same as flatCollect, only with a Function2 that is passed an extra parameter.
default T	getFirst()	This default override exists because java.util.List added a default getFirst() method in Java 21.
default T	getLast()	This default override exists because java.util.List added a default getLast() method in Java 21.
<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.
default int	indexOf(Object o)	Returns the index of the first occurrence of the specified item in this iterable, or -1 if this iterable does not contain the item.
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.
default MutableList<T>	reject(Predicate<? super T> predicate)	Returns a MutableCollection with all elements that evaluate to false for the specified predicate.
default <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.
default MutableList<T>	rejectWithIndex(ObjectIntPredicate<? super T> predicate)	Returns a new MutableList with all elements of the collection that return false when evaluating the specified predicate which is supplied each element and its relative index.
default MutableList<T>	reverseThis()	Mutates this list by reversing its order and returns the current list as a result.
default 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.
default <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.
default MutableList<T>	selectWithIndex(ObjectIntPredicate<? super T> predicate)	Returns a new MutableList with all elements of the collection that return true when evaluating the specified predicate which is supplied each element and its relative index.
default MutableList<T>	shuffleThis()	Mutates this list by shuffling its elements.
default MutableList<T>	shuffleThis(Random random)	Mutates this list by shuffling its elements using the specified random.
default MutableList<T>	sortThis()	Sorts the internal data structure of this list and returns the list itself as a convenience.
default MutableList<T>	sortThis(Comparator<? super T> comparator)	Sorts the internal data structure of this list and returns the list itself as a convenience.
default <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.
default MutableList<T>	tap(Procedure<? super T> procedure)	Executes the Procedure for each element in the iterable and returns this.
default Object[]	toArray()	Converts this iterable to an array.
default <T1> T1[]	toArray(T1[] a)	Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.
default ImmutableList<T>	toImmutable()	Returns an immutable copy of this list.
default ImmutableList<T>	toImmutableList()	Converts the MutableList to the default ImmutableList implementation.
default MutableList<T>	toReversed()	Returns a new MutableList in reverse order.
default MutableList<T>	with(T element)	This method allows mutable and fixed size collections the ability to add elements to their existing elements.
default 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.
default MutableList<T>	without(T element)	This method allows mutable and fixed size collections the ability to remove elements from their existing elements.
default 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 java.util.Collection

parallelStream, removeIf, stream, toArray

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

forEach, forEachWith

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator

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

asParallel, binarySearch, binarySearch, equals, forEachInBoth, get, hashCode, lastIndexOf, listIterator, listIterator

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

addAllIterable, aggregateBy, aggregateInPlaceBy, countBy, countByEach, countByWith, groupByUniqueKey, injectIntoWith, removeAllIterable, removeIf, removeIfWith, retainAllIterable, selectAndRejectWith, sumByDouble, sumByFloat, sumByInt, sumByLong

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

collectWithIndex, corresponds, detectIndex, forEach, forEachWithIndex, forEachWithIndex, getFirstOptional, getLastOptional, max, min, rejectWithIndex, selectWithIndex, toStack, zip, zipWithIndex

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

asReversed, detectLastIndex, reverseForEach, reverseForEachWithIndex

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

aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, isEmpty, makeString, makeString, makeString, makeString, max, maxBy, maxByOptional, maxOptional, maxOptional, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceBy, reduceBy, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toBiMap, toImmutableBag, toImmutableBiMap, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString

Method Details

toArray

default Object[] toArray()

Description copied from interface: RichIterable

Converts this iterable to an array.

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

Specified by:

toArray in interface MutableCollection<T>

Specified by:

toArray in interface RichIterable<T>

See Also:

• Collection.toArray()

toArray

default <T1> T1[] toArray(T1[] a)

Description copied from interface: RichIterable

Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

Specified by:

toArray in interface MutableCollection<T>

Specified by:

toArray in interface RichIterable<T>

See Also:

• Collection.toArray(Object[])

getFirst

default T getFirst()

This default override exists because java.util.List added a default getFirst() method in Java 21.

Specified by:

getFirst in interface ListIterable<T>

Specified by:

getFirst in interface OrderedIterable<T>

Specified by:

getFirst in interface RichIterable<T>

Since:

12.0

getLast

default T getLast()

This default override exists because java.util.List added a default getLast() method in Java 21.

Specified by:

getLast in interface ListIterable<T>

Specified by:

getLast in interface OrderedIterable<T>

Specified by:

getLast in interface RichIterable<T>

Since:

12.0

with

default 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<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>

See Also:

• Collection.add(Object)

without

default 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 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>

See Also:

• Collection.remove(Object)

withAll

default 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<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>

See Also:

• Collection.addAll(Collection)

withoutAll

default 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 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>

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

default 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()));
 

Specified by:

tap in interface ListIterable<T>

Specified by:

tap in interface MutableCollection<T>

Specified by:

tap in interface OrderedIterable<T>

Specified by:

tap in interface ReversibleIterable<T>

Specified by:

tap in interface RichIterable<T>

See Also:

• RichIterable.each(Procedure)
• RichIterable.forEach(Procedure)

select

default 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 OrderedIterable<T>

Specified by:

select in interface ReversibleIterable<T>

Specified by:

select in interface RichIterable<T>

selectWith

default <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 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

default 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 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

default <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 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: 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"));
 

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 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: 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");
 

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 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: 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 OrderedIterable<T>

Specified by:

selectInstancesOf in interface ReversibleIterable<T>

Specified by:

selectInstancesOf in interface RichIterable<T>

collect

default <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 OrderedIterable<T>

Specified by:

collect in interface ReversibleIterable<T>

Specified by:

collect in interface RichIterable<T>

collectWithIndex

default <V> MutableList<V> collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function)

Description copied from interface: OrderedIterable

Returns a new OrderedIterable using results obtained by applying the specified function to each element and its corresponding index.

Specified by:

collectWithIndex in interface ListIterable<T>

Specified by:

collectWithIndex in interface OrderedIterable<T>

Specified by:

collectWithIndex in interface ReversibleIterable<T>

Since:

9.1.

selectWithIndex

default MutableList<T> selectWithIndex(ObjectIntPredicate<? super T> predicate)

Returns a new MutableList with all elements of the collection that return true when evaluating the specified predicate which is supplied each element and its relative index.

Specified by:

selectWithIndex in interface ListIterable<T>

Since:

11.0

rejectWithIndex

default MutableList<T> rejectWithIndex(ObjectIntPredicate<? super T> predicate)

Returns a new MutableList with all elements of the collection that return false when evaluating the specified predicate which is supplied each element and its relative index.

Specified by:

rejectWithIndex in interface ListIterable<T>

Since:

11.0

collectBoolean

default 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());
 

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 OrderedIterable<T>

Specified by:

collectBoolean in interface ReversibleIterable<T>

Specified by:

collectBoolean in interface RichIterable<T>

collectByte

default 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());
 

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 OrderedIterable<T>

Specified by:

collectByte in interface ReversibleIterable<T>

Specified by:

collectByte in interface RichIterable<T>

collectChar

default 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());
 

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 OrderedIterable<T>

Specified by:

collectChar in interface ReversibleIterable<T>

Specified by:

collectChar in interface RichIterable<T>

collectDouble

default 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());
 

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 OrderedIterable<T>

Specified by:

collectDouble in interface ReversibleIterable<T>

Specified by:

collectDouble in interface RichIterable<T>

collectFloat

default 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());
 

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 OrderedIterable<T>

Specified by:

collectFloat in interface ReversibleIterable<T>

Specified by:

collectFloat in interface RichIterable<T>

collectInt

default 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());
 

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 OrderedIterable<T>

Specified by:

collectInt in interface ReversibleIterable<T>

Specified by:

collectInt in interface RichIterable<T>

collectLong

default 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());
 

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 OrderedIterable<T>

Specified by:

collectLong in interface ReversibleIterable<T>

Specified by:

collectLong in interface RichIterable<T>

collectShort

default 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());
 

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 OrderedIterable<T>

Specified by:

collectShort in interface ReversibleIterable<T>

Specified by:

collectShort in interface RichIterable<T>

collectWith

default <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));
 

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 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

default <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 OrderedIterable<T>

Specified by:

collectIf in interface ReversibleIterable<T>

Specified by:

collectIf in interface RichIterable<T>

flatCollect

default <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 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

flatCollectWith

default <P,
V> MutableList<V> flatCollectWith(Function2<? super T,? super P,? extends Iterable<V>> function,
 P parameter)

Description copied from interface: RichIterable

Same as flatCollect, only with a Function2 that is passed an extra parameter.

Specified by:

flatCollectWith in interface ListIterable<T>

Specified by:

flatCollectWith in interface MutableCollection<T>

Specified by:

flatCollectWith in interface OrderedIterable<T>

Specified by:

flatCollectWith in interface ReversibleIterable<T>

Specified by:

flatCollectWith in interface RichIterable<T>

Since:

9.2

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

distinctBy

<V> MutableList<T> distinctBy(Function<? super T,? extends V> function)

Description copied from interface: ListIterable

Returns a new ListIterable containing the distinct elements in this list. The specified function will be used to create a HashingStrategy to unique the elements.

Specified by:

distinctBy in interface ListIterable<T>

Since:

9.0

See Also:

• ListIterable.distinct(HashingStrategy)

sortThis

default MutableList<T> sortThis(Comparator<? super T> comparator)

Sorts the internal data structure of this list and returns the list itself as a convenience.

Since:

10.0 - Added default implementation.

sortThis

default MutableList<T> sortThis()

Sorts the internal data structure of this list and returns the list itself as a convenience.

Since:

10.0 - Added default implementation.

sortThisBy

default <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>

Specified by:

subList in interface ListIterable<T>

See Also:

• List.subList(int, int)

asUnmodifiable

MutableList<T> asUnmodifiable()

Returns an unmodifiable view of the list.

Specified by:

asUnmodifiable in interface MutableCollection<T>

Returns:

an unmodifiable view of this list

See Also:

• Collections.unmodifiableCollection(Collection)

asSynchronized

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>

Returns:

a synchronized view of this collection.

See Also:

• Collections.synchronizedCollection(Collection)

toImmutable

default ImmutableList<T> toImmutable()

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>

groupBy

<V> MutableListMultimap<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);
 

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 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

default 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

default MutableList<T> reverseThis()

Mutates this list by reversing its order and returns the current list as a result.

shuffleThis

default MutableList<T> shuffleThis()

Mutates this list by shuffling its elements.

shuffleThis

default MutableList<T> shuffleThis(Random random)

Mutates this list by shuffling its elements using the specified random.

toImmutableList

default ImmutableList<T> toImmutableList()

Converts the MutableList to the default ImmutableList implementation.

Specified by:

toImmutableList in interface RichIterable<T>

Since:

11.0

indexOf

default int indexOf(Object o)

Description copied from interface: OrderedIterable

Returns the index of the first occurrence of the specified item in this iterable, or -1 if this iterable does not contain the item.

Specified by:

indexOf in interface List<T>

Specified by:

indexOf in interface OrderedIterable<T>

See Also:

• List.indexOf(Object)