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

Class SynchronizedMutableList<T>

java.lang.Object

org.eclipse.collections.impl.collection.AbstractSynchronizedRichIterable<T>

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

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

All Implemented Interfaces:

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

public class SynchronizedMutableList<T>
extends AbstractSynchronizedMutableCollection<T>
implements MutableList<T>, Serializable

A synchronized view of a MutableList. It is imperative that the user manually synchronize on the collection when iterating over it using the standard JDK iterator or JDK 5 for loop, as per Collections.synchronizedCollection(Collection).

See Also:

• MutableList.asSynchronized()
• Serialized Form

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.
LazyIterable<T>	asReversed()	Returns a reversed view of this ReversibleIterable.
MutableList<T>	asSynchronized()	Returns a synchronized wrapper backed by this collection.
MutableList<T>	asUnmodifiable()	Returns an unmodifiable view of the list.
int	binarySearch(T key)	Searches for the specified object using the binary search algorithm.
int	binarySearch(T key, Comparator<? super T> comparator)	Searches for the specified object using the binary search algorithm.
MutableList<T>	clone()
<V> MutableList<V>	collect(Function<? super T,? extends V> function)	Returns a new collection with the results of applying the specified function on 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 collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the 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.
<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.
<V, R extends Collection<V>> R	collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function, R target)	Adds elements to the target Collection using results obtained by applying the specified function to each element and its corresponding index.
<S> boolean	corresponds(OrderedIterable<S> other, Predicate2<? super T,? super S> predicate)	Returns true if both OrderedIterables have the same length and predicate returns true for all corresponding elements e1 of this OrderedIterable and e2 of other.
int	detectIndex(Predicate<? super T> predicate)	Returns the index of the first element of the OrderedIterable for which the predicate evaluates to true.
int	detectLastIndex(Predicate<? super T> predicate)	Returns the index of the last element of the ReversibleIterable for which the predicate evaluates to true.
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.
<V> MutableList<V>	flatCollect(Function<? super T,? extends Iterable<V>> function)	flatCollect is a special case of RichIterable.collect(Function).
void	forEach(int fromIndex, int toIndex, Procedure<? super T> procedure)	Iterates over the section of the iterable covered by the specified inclusive indexes.
<T2> void	forEachInBoth(ListIterable<T2> other, Procedure2<? super T,? super T2> procedure)	Iterates over this ListIterable and the other ListIterable together passing the elements of each list as parameters to the specified procedure.
void	forEachWithIndex(int fromIndex, int toIndex, ObjectIntProcedure<? super T> objectIntProcedure)	Iterates over the section of the iterable covered by the specified inclusive indexes.
T	get(int index)	Returns the item at the specified position in this list iterable.
Optional<T>	getFirstOptional()	Returns the first element of an iterable as an Optional.
Optional<T>	getLastOptional()	Returns the last element of an iterable as an Optional.
<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	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)
MutableList<T>	newEmpty()	Creates a new empty mutable version of the same collection type.
static <E, L extends List<E>> SynchronizedMutableList<E>	of(L list)	This method will take a MutableList and wrap it directly in a SynchronizedMutableList.
static <E, L extends List<E>> SynchronizedMutableList<E>	of(L list, Object lock)	This method will take a MutableList and wrap it directly in a SynchronizedMutableList.
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 all elements of the source collection that return false when evaluating of the predicate.
<P> MutableList<T>	rejectWith(Predicate2<? super T,? super P> predicate, P parameter)	Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
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.
<R extends Collection<T>> R	rejectWithIndex(ObjectIntPredicate<? super T> predicate, R target)	Adds all elements to the target Collection that return false when evaluating the specified predicate which is supplied each element and its relative index.
T	remove(int index)
void	replaceAll(UnaryOperator<T> operator)
void	reverseForEach(Procedure<? super T> procedure)	Evaluates the procedure for each element of the list iterating in reverse order.
void	reverseForEachWithIndex(ObjectIntProcedure<? super T> procedure)	Evaluates the procedure for each element and it's index in reverse order.
MutableList<T>	reverseThis()	Mutates this list by reversing its order and returns the current list as a result.
MutableList<T>	select(Predicate<? super T> predicate)	Returns all elements of the source collection that return true when evaluating the 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)	Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
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.
<R extends Collection<T>> R	selectWithIndex(ObjectIntPredicate<? super T> predicate, R target)	Adds all elements to the target Collection that return true when evaluating the specified predicate which is supplied each element and its relative index.
T	set(int index, T element)
MutableList<T>	shuffleThis()	Mutates this list by shuffling its elements.
MutableList<T>	shuffleThis(Random rnd)	Mutates this list by shuffling its elements using the specified random.
void	sort(Comparator<? super T> comparator)
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.
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.AbstractSynchronizedMutableCollection

add, addAll, addAllIterable, aggregateBy, aggregateInPlaceBy, clear, countBy, countByEach, countByWith, groupByUniqueKey, injectIntoWith, remove, removeAll, removeAllIterable, removeIf, removeIfWith, retainAll, retainAllIterable, selectAndRejectWith, sumByDouble, sumByFloat, sumByInt, sumByLong

Methods inherited from class org.eclipse.collections.impl.collection.AbstractSynchronizedRichIterable

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, containsNone, containsNoneIterable, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, equals, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, forEachWith, forEachWithIndex, getFirst, getLast, getOnly, groupBy, groupByEach, groupByUniqueKey, hashCode, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, iterator, makeString, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableList, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, 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, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

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

equals, getFirst, getLast, hashCode

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

flatCollectWith, toImmutableList, with, withAll, without, withoutAll

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

forEachWithIndex, max, min, zip, zipWithIndex

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

Method Details

of

public static <E,
L extends List<E>>
SynchronizedMutableList<E> of(L list)

This method will take a MutableList and wrap it directly in a SynchronizedMutableList. It will take any other non-Eclipse-Collections collection and first adapt it will a ListAdapter, and then return a SynchronizedMutableList that wraps the adapter.

of

public static <E,
L extends List<E>>
SynchronizedMutableList<E> of(L list,
 Object lock)

This method will take a MutableList and wrap it directly in a SynchronizedMutableList. It will take any other non-Eclipse-Collections collection and first adapt it will a ListAdapter, and then return a SynchronizedMutableList that wraps the adapter. Additionally, a developer specifies which lock to use with the collection.

newEmpty

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

Specified by:

newEmpty in interface MutableList<T>

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>

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>

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)

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>

replaceAll

public void replaceAll(UnaryOperator<T> operator)

Specified by:

replaceAll in interface List<T>

Since:

10.0 - Overridden for correctness

sort

public void sort(Comparator<? super T> comparator)

Specified by:

sort in interface List<T>

Since:

10.0 - Overridden for correctness

getFirstOptional

public Optional<T> getFirstOptional()

Description copied from interface: OrderedIterable

Returns the first element of an iterable as an Optional. In the case of a List it is the element at the first index. In the case of any other Collection, it is the first element that would be returned during an iteration. If the iterable is empty, Optional.empty() is returned.

Specified by:

getFirstOptional in interface OrderedIterable<T>

getLastOptional

public Optional<T> getLastOptional()

Description copied from interface: OrderedIterable

Returns the last element of an iterable as an Optional. In the case of a List it is the element at the last index. In the case of any other Collection, it is the last element that would be returned during an iteration. If the iterable is empty, Optional.empty() is returned.

Specified by:

getLastOptional in interface OrderedIterable<T>

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)

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>

binarySearch

public int binarySearch(T key,
 Comparator<? super T> comparator)

Description copied from interface: ListIterable

Searches for the specified object using the binary search algorithm. The list must be sorted into ascending order according to the specified comparator.

Specified by:

binarySearch in interface ListIterable<T>

See Also:

• Collections.binarySearch(List, Object, Comparator)

binarySearch

public int binarySearch(T key)

Description copied from interface: ListIterable

Searches for the specified object using the binary search algorithm. The elements in this list must implement Comparable and the list must be sorted into ascending order.

Specified by:

binarySearch in interface ListIterable<T>

See Also:

• Collections.binarySearch(List, Object)

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)

distinct

public MutableList<T> distinct()

Description copied from interface: MutableList

Returns a new ListIterable containing the distinct elements in this list.

Specified by:

distinct in interface ListIterable<T>

Specified by:

distinct in interface MutableList<T>

Specified by:

distinct in interface OrderedIterable<T>

Specified by:

distinct in interface ReversibleIterable<T>

Returns:

ListIterable of distinct elements

distinct

public MutableList<T> distinct(HashingStrategy<? super T> hashingStrategy)

Description copied from interface: MutableList

Returns a new ListIterable containing the distinct elements in this list. Takes HashingStrategy.

Specified by:

distinct in interface ListIterable<T>

Specified by:

distinct in interface MutableList<T>

Returns:

ListIterable of distinct elements

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)

corresponds

public <S> boolean corresponds(OrderedIterable<S> other,
 Predicate2<? super T,? super S> predicate)

Description copied from interface: OrderedIterable

Returns true if both OrderedIterables have the same length and predicate returns true for all corresponding elements e1 of this OrderedIterable and e2 of other. The predicate is evaluated for each element at the same position of each OrderedIterable in a forward iteration order. This is a short circuit pattern.

Specified by:

corresponds in interface OrderedIterable<T>

forEachInBoth

public <T2> void forEachInBoth(ListIterable<T2> other,
 Procedure2<? super T,? super T2> procedure)

Description copied from interface: ListIterable

Iterates over this ListIterable and the other ListIterable together passing the elements of each list as parameters to the specified procedure.

Specified by:

forEachInBoth in interface ListIterable<T>

forEach

public void forEach(int fromIndex,
 int toIndex,
 Procedure<? super T> procedure)

Description copied from interface: OrderedIterable

Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive.

e.g.
 OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally)
 people.forEach(0, 1, new Procedure<Person>()
 {
     public void value(Person person)
     {
          LOGGER.info(person.getName());
     }
 });
 

This code would output ted and mary's names.

Specified by:

forEach in interface OrderedIterable<T>

takeWhile

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

Description copied from interface: ListIterable

Returns the initial elements that satisfy the Predicate. Short circuits at the first element which does not satisfy the Predicate.

Specified by:

takeWhile in interface ListIterable<T>

Specified by:

takeWhile in interface MutableList<T>

Specified by:

takeWhile in interface OrderedIterable<T>

Specified by:

takeWhile in interface ReversibleIterable<T>

forEachWithIndex

public void forEachWithIndex(int fromIndex,
 int toIndex,
 ObjectIntProcedure<? super T> objectIntProcedure)

Description copied from interface: OrderedIterable

Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive.

e.g.
 OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally)
 people.forEachWithIndex(0, 1, new ObjectIntProcedure<Person>()
 {
     public void value(Person person, int index)
     {
          LOGGER.info(person.getName());
     }
 });
 

This code would output ted and mary's names.

Specified by:

forEachWithIndex in interface OrderedIterable<T>

dropWhile

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

Description copied from interface: ListIterable

Returns the final elements that do not satisfy the Predicate. Short circuits at the first element which does satisfy the Predicate.

Specified by:

dropWhile in interface ListIterable<T>

Specified by:

dropWhile in interface MutableList<T>

Specified by:

dropWhile in interface OrderedIterable<T>

Specified by:

dropWhile in interface ReversibleIterable<T>

partitionWhile

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

Description copied from interface: ListIterable

Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements. Short circuits at the first element which does satisfy the Predicate.

Specified by:

partitionWhile in interface ListIterable<T>

Specified by:

partitionWhile in interface MutableList<T>

Specified by:

partitionWhile in interface OrderedIterable<T>

Specified by:

partitionWhile in interface ReversibleIterable<T>

detectIndex

public int detectIndex(Predicate<? super T> predicate)

Description copied from interface: OrderedIterable

Returns the index of the first element of the OrderedIterable for which the predicate evaluates to true. Returns -1 if no element evaluates true for the predicate.

Specified by:

detectIndex in interface OrderedIterable<T>

detectLastIndex

public int detectLastIndex(Predicate<? super T> predicate)

Description copied from interface: ReversibleIterable

Returns the index of the last element of the ReversibleIterable for which the predicate evaluates to true. Returns -1 if no element evaluates true for the predicate.

Specified by:

detectLastIndex in interface ReversibleIterable<T>

take

public MutableList<T> take(int count)

Description copied from interface: ReversibleIterable

Returns the first count elements of the iterable or all the elements in the iterable if count is greater than the length of the iterable.

Specified by:

take in interface ListIterable<T>

Specified by:

take in interface MutableList<T>

Specified by:

take in interface ReversibleIterable<T>

Parameters:

count - the number of items to take.

drop

public MutableList<T> drop(int count)

Description copied from interface: ReversibleIterable

Returns an iterable after skipping the first count elements or an empty iterable if the count is greater than the length of the iterable.

Specified by:

drop in interface ListIterable<T>

Specified by:

drop in interface MutableList<T>

Specified by:

drop in interface ReversibleIterable<T>

Parameters:

count - the number of items to drop.

reverseForEach

public void reverseForEach(Procedure<? super T> procedure)

Description copied from interface: ReversibleIterable

Evaluates the procedure for each element of the list iterating in reverse order.

e.g.
 people.reverseForEach(person -> LOGGER.info(person.getName()));
 

Specified by:

reverseForEach in interface ReversibleIterable<T>

reverseForEachWithIndex

public void reverseForEachWithIndex(ObjectIntProcedure<? super T> procedure)

Description copied from interface: ReversibleIterable

Evaluates the procedure for each element and it's index in reverse order.

e.g.
 people.reverseForEachWithIndex((person, index) ->
         LOGGER.info("Index: " + index + " person: " + person.getName()));
 

Specified by:

reverseForEachWithIndex in interface ReversibleIterable<T>

sortThis

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

Description copied from interface: MutableList

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

Specified by:

sortThis in interface MutableList<T>

sortThis

public MutableList<T> sortThis()

Description copied from interface: MutableList

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

Specified by:

sortThis in interface MutableList<T>

sortThisBy

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

Description copied from interface: MutableList

Sorts the internal data structure of this list based on the natural order of the attribute returned by function.

Specified by:

sortThisBy in interface MutableList<T>

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>

reverseThis

public MutableList<T> reverseThis()

Description copied from interface: MutableList

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

Specified by:

reverseThis in interface MutableList<T>

shuffleThis

public MutableList<T> shuffleThis()

Description copied from interface: MutableList

Mutates this list by shuffling its elements.

Specified by:

shuffleThis in interface MutableList<T>

shuffleThis

public MutableList<T> shuffleThis(Random rnd)

Description copied from interface: MutableList

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

Specified by:

shuffleThis in interface MutableList<T>

asReversed

public LazyIterable<T> asReversed()

Description copied from interface: ReversibleIterable

Returns a reversed view of this ReversibleIterable.

Specified by:

asReversed in interface ReversibleIterable<T>

toReversed

public MutableList<T> toReversed()

Description copied from interface: MutableList

Returns a new MutableList in reverse order.

Specified by:

toReversed in interface ListIterable<T>

Specified by:

toReversed in interface MutableList<T>

Specified by:

toReversed in interface ReversibleIterable<T>

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>

toImmutable

public ImmutableList<T> toImmutable()

Description copied from interface: MutableList

Returns an immutable copy of this list. If the list is immutable, it returns itself.

Specified by:

toImmutable in interface ListIterable<T>

Specified by:

toImmutable in interface MutableCollection<T>

Specified by:

toImmutable in interface MutableList<T>

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

See Also:

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

select

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

Description copied from interface: RichIterable

Returns all elements of the source collection that return true when evaluating the predicate. This method is also commonly called filter.

Example using a Java 8 lambda expression:

 RichIterable<Person> selected =
     people.select(person -> person.getAddress().getCity().equals("London"));
 

Example using an anonymous inner class:

 RichIterable<Person> selected =
     people.select(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return 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 AbstractSynchronizedMutableCollection<T>

selectWith

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

Description copied from interface: RichIterable

Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.

E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

Example using a Java 8 lambda expression:

 RichIterable<Person> selected =
     people.selectWith((Person person, Integer age) -> person.getAge()>= age, Integer.valueOf(18));
 

Example using an anonymous inner class:

 RichIterable<Person> selected =
     people.selectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge()>= age;
         }
     }, Integer.valueOf(18));
 

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

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

Description copied from interface: RichIterable

Returns all elements of the source collection that return false when evaluating of the predicate. This method is also sometimes called filterNot and is the equivalent of calling iterable.select(Predicates.not(predicate)).

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

 RichIterable<Person> rejected =
     people.reject(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.person.getLastName().equals("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 AbstractSynchronizedMutableCollection<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

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

Description copied from interface: RichIterable

Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.

E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

Example using a Java 8 lambda expression:

 RichIterable<Person> rejected =
     people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18));
 

Example using an anonymous inner class:

 MutableList<Person> rejected =
     people.rejectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge() < age;
         }
     }, Integer.valueOf(18));
 

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

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

partitionWith

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

selectInstancesOf

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

 RichIterable<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 AbstractSynchronizedMutableCollection<T>

collectBoolean

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

Specified by:

collectBoolean in interface OrderedIterable<T>

Specified by:

collectBoolean in interface ReversibleIterable<T>

Specified by:

collectBoolean in interface RichIterable<T>

Overrides:

collectBoolean in class AbstractSynchronizedMutableCollection<T>

collectByte

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

Specified by:

collectByte in interface OrderedIterable<T>

Specified by:

collectByte in interface ReversibleIterable<T>

Specified by:

collectByte in interface RichIterable<T>

Overrides:

collectByte in class AbstractSynchronizedMutableCollection<T>

collectChar

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

Specified by:

collectChar in interface OrderedIterable<T>

Specified by:

collectChar in interface ReversibleIterable<T>

Specified by:

collectChar in interface RichIterable<T>

Overrides:

collectChar in class AbstractSynchronizedMutableCollection<T>

collectDouble

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

Specified by:

collectDouble in interface OrderedIterable<T>

Specified by:

collectDouble in interface ReversibleIterable<T>

Specified by:

collectDouble in interface RichIterable<T>

Overrides:

collectDouble in class AbstractSynchronizedMutableCollection<T>

collectFloat

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

Specified by:

collectFloat in interface OrderedIterable<T>

Specified by:

collectFloat in interface ReversibleIterable<T>

Specified by:

collectFloat in interface RichIterable<T>

Overrides:

collectFloat in class AbstractSynchronizedMutableCollection<T>

collectInt

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

Specified by:

collectInt in interface OrderedIterable<T>

Specified by:

collectInt in interface ReversibleIterable<T>

Specified by:

collectInt in interface RichIterable<T>

Overrides:

collectInt in class AbstractSynchronizedMutableCollection<T>

collectLong

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

Specified by:

collectLong in interface OrderedIterable<T>

Specified by:

collectLong in interface ReversibleIterable<T>

Specified by:

collectLong in interface RichIterable<T>

Overrides:

collectLong in class AbstractSynchronizedMutableCollection<T>

collectShort

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

Specified by:

collectShort in interface OrderedIterable<T>

Specified by:

collectShort in interface ReversibleIterable<T>

Specified by:

collectShort in interface RichIterable<T>

Overrides:

collectShort in class AbstractSynchronizedMutableCollection<T>

collect

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

Description copied from interface: RichIterable

Returns a new collection 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:

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

Example using an anonymous inner class:

 RichIterable<String> names =
     people.collect(new Function<Person, String>()
     {
         public String valueOf(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 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 AbstractSynchronizedMutableCollection<T>

collectWithIndex

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

Specified by:

collectWithIndex in interface OrderedIterable<T>

Specified by:

collectWithIndex in interface ReversibleIterable<T>

Since:

9.1.

collectWithIndex

public <V,
R extends Collection<V>> R collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function,
 R target)

Description copied from interface: OrderedIterable

Adds elements to the target Collection using results obtained by applying the specified function to each element and its corresponding index.

Specified by:

collectWithIndex in interface OrderedIterable<T>

Since:

9.1.

selectWithIndex

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

Description copied from interface: MutableList

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>

Specified by:

selectWithIndex in interface MutableList<T>

Since:

11.0.

rejectWithIndex

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

Description copied from interface: MutableList

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>

Specified by:

rejectWithIndex in interface MutableList<T>

Since:

11.0.

selectWithIndex

public <R extends Collection<T>> R selectWithIndex(ObjectIntPredicate<? super T> predicate,
 R target)

Description copied from interface: OrderedIterable

Adds all elements to the target Collection that return true when evaluating the specified predicate which is supplied each element and its relative index.

Specified by:

selectWithIndex in interface OrderedIterable<T>

Since:

11.0.

rejectWithIndex

public <R extends Collection<T>> R rejectWithIndex(ObjectIntPredicate<? super T> predicate,
 R target)

Description copied from interface: OrderedIterable

Adds all elements to the target Collection that return false when evaluating the specified predicate which is supplied each element and its relative index.

Specified by:

rejectWithIndex in interface OrderedIterable<T>

Since:

11.0.

collectWith

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

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

Description copied from interface: RichIterable

Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate. This is the optimized equivalent of calling iterable.select(predicate).collect(function).

Example using a Java 8 lambda and method reference:

 RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(e -> e != null, Object::toString);
 

Example using Predicates factory:

 RichIterable<String> strings = Lists.mutable.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 AbstractSynchronizedMutableCollection<T>

flatCollect

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

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

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

groupBy

public <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 valueOf(Person person)
         {
             return 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 AbstractSynchronizedMutableCollection<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 AbstractSynchronizedMutableCollection<T>

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

asUnmodifiable

public MutableList<T> asUnmodifiable()

Description copied from interface: MutableList

Returns an unmodifiable view of the list.

Specified by:

asUnmodifiable in interface MutableCollection<T>

Specified by:

asUnmodifiable in interface MutableList<T>

Returns:

an unmodifiable view of this list

See Also:

• Collections.unmodifiableCollection(Collection)

asSynchronized

public MutableList<T> asSynchronized()

Description copied from interface: MutableCollection

Returns a synchronized wrapper backed by this collection. This is the equivalent of using Collections.synchronizedCollection(this) only with a return type that supports the full iteration protocols available on MutableCollection. The preferred way of iterating over a synchronized collection is to use the internal iteration methods which are properly synchronized internally.

  MutableCollection synchedCollection = collection.asSynchronized();
     ...
  synchedCollection.forEach(each -> ... );
  synchedCollection.select(each -> ... );
  synchedCollection.collect(each -> ... );
 

If you want to iterate using an imperative style, you must protect external iterators using a synchronized block. This includes explicit iterators as well as JDK 5 style for loops.

Specified by:

asSynchronized in interface MutableCollection<T>

Specified by:

asSynchronized in interface MutableList<T>

Returns:

a synchronized view of this collection.

See Also:

• Collections.synchronizedCollection(Collection)