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

Class AbstractListAdapter<T>

java.lang.Object

org.eclipse.collections.impl.collection.mutable.AbstractCollectionAdapter<T>

org.eclipse.collections.impl.list.mutable.AbstractListAdapter<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

ArrayListAdapter, ListAdapter, RandomAccessListAdapter

public abstract class AbstractListAdapter<T>
extends AbstractCollectionAdapter<T>
implements MutableList<T>

Constructor Summary

Constructors

Constructor	Description
AbstractListAdapter()

Method Summary

Modifier and Type	Method	Description
void	add(int index, T element)
boolean	addAll(int index, Collection<? extends T> collection)
ParallelListIterable<T>	asParallel(ExecutorService executorService, int batchSize)	Returns a parallel iterable of this ListIterable.
ReverseIterable<T>	asReversed()	Returns a reversed view of this ReversibleIterable.
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.
<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.
<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.
<V> MutableList<T>	distinctBy(Function<? super T,? extends V> function)	Returns a new ListIterable containing the distinct elements in this list.
boolean	equals(Object o)	Follows the same general contract as List.equals(Object).
<V> MutableList<V>	flatCollect(Function<? super T,? extends Iterable<V>> function)	flatCollect is a special case of RichIterable.collect(Function).
T	get(int index)	Returns the item at the specified position in this list iterable.
<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.
int	hashCode()	Follows the same general contract as List.hashCode().
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.
int	lastIndexOf(Object o)	Returns the index of the last occurrence of the specified item in this list, or -1 if this list does not contain the item.
ListIterator<T>	listIterator()
ListIterator<T>	listIterator(int index)
PartitionMutableList<T>	partition(Predicate<? super T> predicate)	Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
<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.
T	remove(int index)
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.
T	set(int index, T element)
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>	tap(Procedure<? super T> procedure)	Executes the Procedure for each element in the iterable and returns this.
MutableStack<T>	toStack()	Converts the OrderedIterable to a mutable MutableStack implementation.
<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 class org.eclipse.collections.impl.collection.mutable.AbstractCollectionAdapter

add, addAll, addAllIterable, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, asLazy, chunk, clear, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, forEachWith, forEachWithIndex, getFirst, getLast, getOnly, groupBy, groupByEach, groupByUniqueKey, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoWith, into, isEmpty, iterator, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, remove, removeAll, removeAllIterable, removeIf, removeIfWith, retainAll, retainAllIterable, select, selectAndRejectWith, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedList, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toString, zip, zipWithIndex

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, replaceAll, retainAll, size, sort, spliterator, toArray, toArray

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

binarySearch, binarySearch, forEachInBoth, getFirst, getLast

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.list.MutableList

asSynchronized, asUnmodifiable, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, collectWithIndex, distinct, distinct, drop, dropWhile, flatCollectWith, newEmpty, partitionWhile, rejectWithIndex, reverseThis, selectWithIndex, shuffleThis, shuffleThis, sortThis, sortThis, sortThisBy, take, takeWhile, toImmutable, toImmutableList, toReversed, with, withAll, without, withoutAll

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

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

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

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, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, 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

Constructor Details

AbstractListAdapter

public AbstractListAdapter()

Method Details

clone

public MutableList<T> clone()

Specified by:

clone in interface MutableList<T>

addAll

public boolean addAll(int index,
 Collection<? extends T> collection)

Specified by:

addAll in interface List<T>

get

public T get(int index)

Description copied from interface: ListIterable

Returns the item at the specified position in this list iterable.

Specified by:

get in interface List<T>

Specified by:

get in interface ListIterable<T>

set

public T set(int index,
 T element)

Specified by:

set in interface List<T>

add

public void add(int index,
 T element)

Specified by:

add in interface List<T>

remove

public T remove(int index)

Specified by:

remove in interface List<T>

indexOf

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

lastIndexOf

public int lastIndexOf(Object o)

Description copied from interface: ListIterable

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

Specified by:

lastIndexOf in interface List<T>

Specified by:

lastIndexOf in interface ListIterable<T>

listIterator

public ListIterator<T> listIterator()

Specified by:

listIterator in interface List<T>

Specified by:

listIterator in interface ListIterable<T>

See Also:

• List.listIterator()

listIterator

public ListIterator<T> listIterator(int index)

Specified by:

listIterator in interface List<T>

Specified by:

listIterator in interface ListIterable<T>

See Also:

• List.listIterator(int)

distinctBy

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

Specified by:

distinctBy in interface MutableList<T>

Since:

9.0

See Also:

• ListIterable.distinct(HashingStrategy)

sortThisByInt

public MutableList<T> sortThisByInt(IntFunction<? super T> function)

Specified by:

sortThisByInt in interface MutableList<T>

sortThisByBoolean

public MutableList<T> sortThisByBoolean(BooleanFunction<? super T> function)

Specified by:

sortThisByBoolean in interface MutableList<T>

sortThisByChar

public MutableList<T> sortThisByChar(CharFunction<? super T> function)

Specified by:

sortThisByChar in interface MutableList<T>

sortThisByByte

public MutableList<T> sortThisByByte(ByteFunction<? super T> function)

Specified by:

sortThisByByte in interface MutableList<T>

sortThisByShort

public MutableList<T> sortThisByShort(ShortFunction<? super T> function)

Specified by:

sortThisByShort in interface MutableList<T>

sortThisByFloat

public MutableList<T> sortThisByFloat(FloatFunction<? super T> function)

Specified by:

sortThisByFloat in interface MutableList<T>

sortThisByLong

public MutableList<T> sortThisByLong(LongFunction<? super T> function)

Specified by:

sortThisByLong in interface MutableList<T>

sortThisByDouble

public MutableList<T> sortThisByDouble(DoubleFunction<? super T> function)

Specified by:

sortThisByDouble in interface MutableList<T>

subList

public MutableList<T> subList(int fromIndex,
 int toIndex)

Specified by:

subList in interface List<T>

Specified by:

subList in interface ListIterable<T>

Specified by:

subList in interface MutableList<T>

See Also:

• List.subList(int, int)

equals

public boolean equals(Object o)

Description copied from interface: ListIterable

Follows the same general contract as List.equals(Object).

Specified by:

equals in interface Collection<T>

Specified by:

equals in interface List<T>

Specified by:

equals in interface ListIterable<T>

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: ListIterable

Follows the same general contract as List.hashCode().

Specified by:

hashCode in interface Collection<T>

Specified by:

hashCode in interface List<T>

Specified by:

hashCode in interface ListIterable<T>

Overrides:

hashCode in class Object

toStack

public MutableStack<T> toStack()

Description copied from interface: OrderedIterable

Converts the OrderedIterable to a mutable MutableStack implementation.

Specified by:

toStack in interface OrderedIterable<T>

asReversed

public ReverseIterable<T> asReversed()

Description copied from interface: ReversibleIterable

Returns a reversed view of this ReversibleIterable.

Specified by:

asReversed in interface ReversibleIterable<T>

asParallel

public ParallelListIterable<T> asParallel(ExecutorService executorService,
 int batchSize)

Description copied from interface: ListIterable

Returns a parallel iterable of this ListIterable.

Specified by:

asParallel in interface ListIterable<T>

groupBy

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

Example using an anonymous inner class:

 Multimap<String, Person> peopleByLastName =
     people.groupBy(new Function<Person, String>()
     {
         public String valueOf(Person person)
         {
             return person.getLastName();
         }
     });
 

Co-variant example for MutableCollection:

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

Specified by:

groupBy in interface ListIterable<T>

Specified by:

groupBy in interface MutableCollection<T>

Specified by:

groupBy in interface MutableList<T>

Specified by:

groupBy in interface OrderedIterable<T>

Specified by:

groupBy in interface ReversibleIterable<T>

Specified by:

groupBy in interface RichIterable<T>

Overrides:

groupBy in class AbstractCollectionAdapter<T>

groupByEach

public <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 MutableList<T>

Specified by:

groupByEach in interface OrderedIterable<T>

Specified by:

groupByEach in interface ReversibleIterable<T>

Specified by:

groupByEach in interface RichIterable<T>

Overrides:

groupByEach in class AbstractCollectionAdapter<T>

tap

public 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<Person>()
     {
         public void value(Person person)
         {
             LOGGER.info(person.getName());
         }
     });
 

Specified by:

tap in interface ListIterable<T>

Specified by:

tap in interface MutableCollection<T>

Specified by:

tap in interface MutableList<T>

Specified by:

tap in interface OrderedIterable<T>

Specified by:

tap in interface ReversibleIterable<T>

Specified by:

tap in interface RichIterable<T>

Overrides:

tap in class AbstractCollectionAdapter<T>

See Also:

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

select

public MutableList<T> select(Predicate<? super T> predicate)

Description copied from interface: MutableCollection

Returns a MutableCollection with all elements that evaluate to true for the specified predicate.

 MutableCollection<Integer> livesInLondon =
     people.select(person -> person.getAddress().getCity().equals("London"));
 

Specified by:

select in interface ListIterable<T>

Specified by:

select in interface MutableCollection<T>

Specified by:

select in interface MutableList<T>

Specified by:

select in interface OrderedIterable<T>

Specified by:

select in interface ReversibleIterable<T>

Specified by:

select in interface RichIterable<T>

Overrides:

select in class AbstractCollectionAdapter<T>

reject

public MutableList<T> reject(Predicate<? super T> predicate)

Description copied from interface: MutableCollection

Returns a MutableCollection with all elements that evaluate to false for the specified predicate.

 MutableCollection<Person> notSmiths =
     people.reject(person -> person.person.getLastName().equals("Smith"));
 

Using the Predicates factory:

 MutableCollection<Person> notSmiths = people.reject(Predicates.attributeEqual("lastName", "Smith"));
 

Specified by:

reject in interface ListIterable<T>

Specified by:

reject in interface MutableCollection<T>

Specified by:

reject in interface MutableList<T>

Specified by:

reject in interface OrderedIterable<T>

Specified by:

reject in interface ReversibleIterable<T>

Specified by:

reject in interface RichIterable<T>

Overrides:

reject in class AbstractCollectionAdapter<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

selectInstancesOf

public <S> MutableList<S> selectInstancesOf(Class<S> clazz)

Description copied from interface: MutableCollection

Returns all elements of the source collection that are instances of the Class clazz.

 RichIterable<Integer> integers =
     List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
 

Co-variant example for MutableCollection:

 MutableCollection<Integer> integers =
     List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
 

Specified by:

selectInstancesOf in interface ListIterable<T>

Specified by:

selectInstancesOf in interface MutableCollection<T>

Specified by:

selectInstancesOf in interface MutableList<T>

Specified by:

selectInstancesOf in interface OrderedIterable<T>

Specified by:

selectInstancesOf in interface ReversibleIterable<T>

Specified by:

selectInstancesOf in interface RichIterable<T>

Overrides:

selectInstancesOf in class AbstractCollectionAdapter<T>

collect

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

Description copied from interface: MutableCollection

Returns a new MutableCollection with the results of applying the specified function to each element of the source collection.

 MutableCollection<String> names =
     people.collect(person -> person.getFirstName() + " " + person.getLastName());
 

Specified by:

collect in interface ListIterable<T>

Specified by:

collect in interface MutableCollection<T>

Specified by:

collect in interface MutableList<T>

Specified by:

collect in interface OrderedIterable<T>

Specified by:

collect in interface ReversibleIterable<T>

Specified by:

collect in interface RichIterable<T>

Overrides:

collect in class AbstractCollectionAdapter<T>

flatCollect

public <V> MutableList<V> flatCollect(Function<? super T,? extends Iterable<V>> function)

Description copied from interface: MutableCollection

flatCollect is a special case of RichIterable.collect(Function). With collect, when the Function returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.

Consider the following example where we have a Person class, and each Person has a list of Address objects. Take the following Function:

 Function<Person, List<Address>> addressFunction = Person::getAddresses;
 RichIterable<Person> people = ...;
 

Using collect returns a collection of collections of addresses.

 RichIterable<List<Address>> addresses = people.collect(addressFunction);
 

Using flatCollect returns a single flattened list of addresses.

 RichIterable<Address> addresses = people.flatCollect(addressFunction);
 

Co-variant example for MutableCollection:

 Function<Person, List<Address>> addressFunction = Person::getAddresses;
 MutableCollection<Person> people = ...;
 MutableCollection<List<Address>> addresses = people.collect(addressFunction);
 MutableCollection<Address> addresses = people.flatCollect(addressFunction);
 

Specified by:

flatCollect in interface ListIterable<T>

Specified by:

flatCollect in interface MutableCollection<T>

Specified by:

flatCollect in interface MutableList<T>

Specified by:

flatCollect in interface OrderedIterable<T>

Specified by:

flatCollect in interface ReversibleIterable<T>

Specified by:

flatCollect in interface RichIterable<T>

Overrides:

flatCollect in class AbstractCollectionAdapter<T>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

collectIf

public <V> MutableList<V> collectIf(Predicate<? super T> predicate,
 Function<? super T,? extends V> function)

Description copied from interface: MutableCollection

Returns a new MutableCollection with the results of applying the specified function to each element of the source collection, but only for elements that evaluate to true for the specified predicate.

 MutableCollection<String> collected =
     Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
 

Specified by:

collectIf in interface ListIterable<T>

Specified by:

collectIf in interface MutableCollection<T>

Specified by:

collectIf in interface MutableList<T>

Specified by:

collectIf in interface OrderedIterable<T>

Specified by:

collectIf in interface ReversibleIterable<T>

Specified by:

collectIf in interface RichIterable<T>

Overrides:

collectIf in class AbstractCollectionAdapter<T>

partition

public PartitionMutableList<T> partition(Predicate<? super T> predicate)

Description copied from interface: MutableCollection

Filters a collection into a PartitionedIterable based on the evaluation of the predicate.

Example using a Java 8 lambda expression:

 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partition(person -> person.getAddress().getState().getName().equals("New York"));
 

Example using an anonymous inner class:

 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partition(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getAddress().getState().getName().equals("New York");
         }
     });
 

Co-variant example for MutableCollection:

 PartitionMutableCollection<Person> newYorkersAndNonNewYorkers =
     people.partition(person -> person.getAddress().getState().getName().equals("New York"));
 

Specified by:

partition in interface ListIterable<T>

Specified by:

partition in interface MutableCollection<T>

Specified by:

partition in interface MutableList<T>

Specified by:

partition in interface OrderedIterable<T>

Specified by:

partition in interface ReversibleIterable<T>

Specified by:

partition in interface RichIterable<T>

Overrides:

partition in class AbstractCollectionAdapter<T>

partitionWith

public <P> PartitionMutableList<T> partitionWith(Predicate2<? super T,? super P> predicate,
 P parameter)

Description copied from interface: MutableCollection

Filters a collection into a PartitionIterable based on the evaluation of the predicate.

Example using a Java 8 lambda expression:

 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
 

Example using an anonymous inner class:

 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partitionWith(new Predicate2<Person, String>()
     {
         public boolean accept(Person person, String state)
         {
             return person.getAddress().getState().getName().equals(state);
         }
     }, "New York");
 

Co-variant example for MutableCollection:

 PartitionMutableCollection<Person> newYorkersAndNonNewYorkers =
     people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
 

Specified by:

partitionWith in interface ListIterable<T>

Specified by:

partitionWith in interface MutableCollection<T>

Specified by:

partitionWith in interface MutableList<T>

Specified by:

partitionWith in interface OrderedIterable<T>

Specified by:

partitionWith in interface ReversibleIterable<T>

Specified by:

partitionWith in interface RichIterable<T>

Overrides:

partitionWith in class AbstractCollectionAdapter<T>

selectWith

public <P> MutableList<T> selectWith(Predicate2<? super T,? super P> predicate,
 P parameter)

Description copied from interface: MutableCollection

Returns a MutableCollection with all elements that evaluate to true for the specified predicate2 and parameter.

 MutableCollection<Integer> fives =
     integers.selectWith(Predicates2.equal(), Integer.valueOf(5));
 

Specified by:

selectWith in interface ListIterable<T>

Specified by:

selectWith in interface MutableCollection<T>

Specified by:

selectWith in interface MutableList<T>

Specified by:

selectWith in interface OrderedIterable<T>

Specified by:

selectWith in interface ReversibleIterable<T>

Specified by:

selectWith in interface RichIterable<T>

Overrides:

selectWith in class AbstractCollectionAdapter<T>

Parameters:

predicate - a Predicate2 to use as the select criteria

parameter - a parameter to pass in for evaluation of the second argument P in predicate

See Also:

• RichIterable.select(Predicate)

rejectWith

public <P> MutableList<T> rejectWith(Predicate2<? super T,? super P> predicate,
 P parameter)

Description copied from interface: MutableCollection

Returns a MutableCollection with all elements that evaluate to false for the specified predicate2 and parameter.

e.g.
 MutableCollection<Integer> selected =
     integers.rejectWith(Predicates2.equal(), Integer.valueOf(5));
 

Specified by:

rejectWith in interface ListIterable<T>

Specified by:

rejectWith in interface MutableCollection<T>

Specified by:

rejectWith in interface MutableList<T>

Specified by:

rejectWith in interface OrderedIterable<T>

Specified by:

rejectWith in interface ReversibleIterable<T>

Specified by:

rejectWith in interface RichIterable<T>

Overrides:

rejectWith in class AbstractCollectionAdapter<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)

collectWith

public <P,
V> MutableList<V> collectWith(Function2<? super T,? super P,? extends V> function,
 P parameter)

Description copied from interface: MutableCollection

Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

 Function2<Integer, Integer, Integer> addParameterFunction =
     new Function2<Integer, Integer, Integer>()
     {
         public Integer value(Integer each, Integer parameter)
         {
             return each + parameter;
         }
     };
 RichIterable<Integer> integers =
     Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
 

Co-variant example for MutableCollection:

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

Specified by:

collectWith in interface ListIterable<T>

Specified by:

collectWith in interface MutableCollection<T>

Specified by:

collectWith in interface MutableList<T>

Specified by:

collectWith in interface OrderedIterable<T>

Specified by:

collectWith in interface ReversibleIterable<T>

Specified by:

collectWith in interface RichIterable<T>

Overrides:

collectWith in class AbstractCollectionAdapter<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)

zip

public <S> MutableList<Pair<T,S>> zip(Iterable<S> that)

Description copied from interface: RichIterable

Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs. If one of the two RichIterables is longer than the other, its remaining elements are ignored.

Specified by:

zip in interface ListIterable<T>

Specified by:

zip in interface MutableCollection<T>

Specified by:

zip in interface MutableList<T>

Specified by:

zip in interface OrderedIterable<T>

Specified by:

zip in interface ReversibleIterable<T>

Specified by:

zip in interface RichIterable<T>

Overrides:

zip in class AbstractCollectionAdapter<T>

Type Parameters:

S - the type of the second half of the returned pairs

Parameters:

that - The RichIterable providing the second half of each result pair

Returns:

A new RichIterable containing pairs consisting of corresponding elements of this RichIterable and that. The length of the returned RichIterable is the minimum of the lengths of this RichIterable and that.

zipWithIndex

public MutableList<Pair<T,Integer>> zipWithIndex()

Description copied from interface: RichIterable

Zips this RichIterable with its indices.

Specified by:

zipWithIndex in interface ListIterable<T>

Specified by:

zipWithIndex in interface MutableCollection<T>

Specified by:

zipWithIndex in interface MutableList<T>

Specified by:

zipWithIndex in interface OrderedIterable<T>

Specified by:

zipWithIndex in interface ReversibleIterable<T>

Specified by:

zipWithIndex in interface RichIterable<T>

Overrides:

zipWithIndex in class AbstractCollectionAdapter<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)