org.eclipse.collections.impl.list.mutable

Class FastList<T>

java.lang.Object

org.eclipse.collections.impl.AbstractRichIterable<T>

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

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

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

All Implemented Interfaces:

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

@NotThreadSafe
public class FastList<T>
extends AbstractMutableList<T>
implements Externalizable, RandomAccess, BatchIterable<T>

FastList is an attempt to provide the same functionality as ArrayList without the support for concurrent modification exceptions. It also attempts to correct the problem with subclassing ArrayList in that the data elements are protected, not private. It is this issue that caused this class to be created in the first place. The intent was to provide optimized internal iterators which use direct access against the array of items, which is currently not possible by subclassing ArrayList.

An empty FastList created by calling the default constructor starts with a shared reference to a static empty array (DEFAULT_SIZED_EMPTY_ARRAY). This makes empty FastLists very memory efficient. The first call to add will lazily create an array of size 10.

An empty FastList created by calling the pre-size constructor with a value of 0 (new FastList(0)) starts with a shared reference to a static empty array (ZERO_SIZED_ARRAY). This makes FastLists presized to 0 very memory efficient as well. The first call to add will lazily create an array of size 1.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FastList()
FastList(Collection<? extends T> source)
FastList(int initialCapacity)

Method Summary

Modifier and Type	Method and Description
void	add(int index, T element)
boolean	add(T newItem)
boolean	addAll(Collection<? extends T> source)
boolean	addAll(int index, Collection<? extends T> source)
boolean	allSatisfy(Predicate<? super T> predicate) Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty.
<P> boolean	allSatisfyWith(Predicate2<? super T,? super P> predicate, P parameter) Returns true if the predicate evaluates to true for every element of the collection, or returns false.
boolean	anySatisfy(Predicate<? super T> predicate) Returns true if the predicate evaluates to true for any element of the iterable.
<P> boolean	anySatisfyWith(Predicate2<? super T,? super P> predicate, P parameter) Returns true if the predicate evaluates to true for any element of the collection, or return false.
void	appendString(Appendable appendable, String start, String separator, String end) Prints a string representation of this collection onto the given Appendable.
void	batchForEach(Procedure<? super T> procedure, int sectionIndex, int sectionCount)
void	clear()
FastList<T>	clone()
<V> FastList<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,R extends Collection<V>> R	collect(Function<? super T,? extends V> function, R target) Same as RichIterable.collect(Function), except that the results are gathered into the specified target 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.
<R extends MutableBooleanCollection> R	collectBoolean(BooleanFunction<? super T> booleanFunction, R target) Same as RichIterable.collectBoolean(BooleanFunction), except that the results are gathered into the specified target 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.
<R extends MutableByteCollection> R	collectByte(ByteFunction<? super T> byteFunction, R target) Same as RichIterable.collectByte(ByteFunction), except that the results are gathered into the specified target 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.
<R extends MutableCharCollection> R	collectChar(CharFunction<? super T> charFunction, R target) Same as RichIterable.collectChar(CharFunction), except that the results are gathered into the specified target 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.
<R extends MutableDoubleCollection> R	collectDouble(DoubleFunction<? super T> doubleFunction, R target) Same as RichIterable.collectDouble(DoubleFunction), except that the results are gathered into the specified target 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.
<R extends MutableFloatCollection> R	collectFloat(FloatFunction<? super T> floatFunction, R target) Same as RichIterable.collectFloat(FloatFunction), except that the results are gathered into the specified target collection.
<V> FastList<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.
<V,R extends Collection<V>> R	collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function, R target) Same as the collectIf method with two parameters but uses the specified target collection for the results.
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.
<R extends MutableIntCollection> R	collectInt(IntFunction<? super T> intFunction, R target) Same as RichIterable.collectInt(IntFunction), except that the results are gathered into the specified target 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.
<R extends MutableLongCollection> R	collectLong(LongFunction<? super T> longFunction, R target) Same as RichIterable.collectLong(LongFunction), except that the results are gathered into the specified target 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.
<R extends MutableShortCollection> R	collectShort(ShortFunction<? super T> shortFunction, R target) Same as RichIterable.collectShort(ShortFunction), except that the results are gathered into the specified target collection.
<P,V> FastList<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.
<P,V,R extends Collection<V>> R	collectWith(Function2<? super T,? super P,? extends V> function, P parameter, R target) Same as collectWith but with a targetCollection parameter to gather the results.
boolean	containsAll(Collection<?> source) Returns true if all elements in source are contained in this collection.
boolean	containsAllArguments(Object... source) Returns true if all elements in the specified var arg array are contained in this collection.
<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	count(Predicate<? super T> predicate) Return the total number of elements that answer true to the specified predicate.
<P> int	countWith(Predicate2<? super T,? super P> predicate, P parameter) Returns the total number of elements that evaluate to true for the specified predicate.
T	detect(Predicate<? super T> predicate) Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true.
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.
Optional<T>	detectOptional(Predicate<? super T> predicate) Returns the first element of the iterable for which the predicate evaluates to true as an Optional.
<P> T	detectWith(Predicate2<? super T,? super P> predicate, P parameter) Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true.
<P> Optional<T>	detectWithOptional(Predicate2<? super T,? super P> predicate, P parameter) Returns the first element that evaluates to true for the specified predicate2 and parameter as an Optional.
MutableList<T>	distinct() Returns a new ListIterable containing the distinct elements in this list.
MutableList<T>	distinct(HashingStrategy<? super T> hashingStrategy) Returns a new ListIterable containing the distinct elements in this list.
MutableList<T>	drop(int count) Returns an iterable after skipping the first count elements or an empty iterable if the count is greater than the length of the iterable.
MutableList<T>	dropWhile(Predicate<? super T> predicate) Returns the final elements that do not satisfy the Predicate.
void	each(Procedure<? super T> procedure) The procedure is executed for each element in the iterable.
void	ensureCapacity(int minCapacity)
boolean	equals(Object that) Follows the same general contract as List.equals(Object).
boolean	fastListEquals(FastList<?> that)
<V> FastList<V>	flatCollect(Function<? super T,? extends Iterable<V>> function) flatCollect is a special case of RichIterable.collect(Function).
<V,R extends Collection<V>> R	flatCollect(Function<? super T,? extends Iterable<V>> function, R target) Same as flatCollect, only the results are collected into the target collection.
void	forEach(int from, int to, Procedure<? super T> procedure) Iterates over the section of the iterable covered by the specified inclusive indexes.
void	forEachIf(Predicate<? super T> predicate, Procedure<? super T> procedure)
<P> void	forEachWith(Procedure2<? super T,? super P> procedure, P parameter) The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.
void	forEachWithIndex(int from, int to, ObjectIntProcedure<? super T> objectIntProcedure) Iterates over the section of the iterable covered by the specified inclusive indexes.
void	forEachWithIndex(ObjectIntProcedure<? super T> objectIntProcedure) Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure.
T	get(int index) Returns the item at the specified position in this list iterable.
int	getBatchCount(int batchSize)
T	getFirst() Returns the first element of an iterable.
T	getLast() Returns the last element of an iterable.
<V> FastListMultimap<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,R extends MutableMultimap<V,T>> R	groupBy(Function<? super T,? extends V> function, R target) Same as RichIterable.groupBy(Function), except that the results are gathered into the specified target multimap.
<V> FastListMultimap<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.
<V,R extends MutableMultimap<V,T>> R	groupByEach(Function<? super T,? extends Iterable<V>> function, R target) Same as RichIterable.groupByEach(Function), except that the results are gathered into the specified target multimap.
<K> MutableMap<K,T>	groupByUniqueKey(Function<? super T,? extends K> function) For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key.
<K,R extends MutableMap<K,T>> R	groupByUniqueKey(Function<? super T,? extends K> function, R target) Same as RichIterable.groupByUniqueKey(Function), except that the results are gathered into the specified target map.
int	hashCode() Follows the same general contract as List.hashCode().
int	indexOf(Object object) Returns the index of the first occurrence of the specified item in this iterable, or -1 if this iterable does not contain the item.
double	injectInto(double injectedValue, DoubleObjectToDoubleFunction<? super T> function) Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
float	injectInto(float injectedValue, FloatObjectToFloatFunction<? super T> function) Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
int	injectInto(int injectedValue, IntObjectToIntFunction<? super T> function) Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
<IV> IV	injectInto(IV injectedValue, Function2<? super IV,? super T,? extends IV> function) Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
long	injectInto(long injectedValue, LongObjectToLongFunction<? super T> function) Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
<IV,P> IV	injectIntoWith(IV injectValue, Function3<? super IV,? super T,? super P,? extends IV> function, P parameter)
int	lastIndexOf(Object object) Returns the index of the last occurrence of the specified item in this list, or -1 if this list does not contain the item.
T	max() Returns the maximum element out of this container based on the natural order.
T	max(Comparator<? super T> comparator) Returns the maximum element out of this container based on the comparator.
<V extends Comparable<? super V>> T	maxBy(Function<? super T,? extends V> function) Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.
T	min() Returns the minimum element out of this container based on the natural order.
T	min(Comparator<? super T> comparator) Returns the minimum element out of this container based on the comparator.
<V extends Comparable<? super V>> T	minBy(Function<? super T,? extends V> function) Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.
static <E> FastList<E>	newList()
static <E> FastList<E>	newList(int initialCapacity)
static <E> FastList<E>	newList(Iterable<? extends E> source)
static <E> FastList<E>	newListWith(E... elements) Creates a new list using the passed elements argument as the backing store.
static <E> FastList<E>	newWithNValues(int size, Function0<E> factory) Creates a new FastList pre-sized to the specified size filled with default values generated by the specified function.
boolean	noneSatisfy(Predicate<? super T> predicate) Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty.
<P> boolean	noneSatisfyWith(Predicate2<? super T,? super P> predicate, P parameter) Returns true if the predicate evaluates to false for every element of the collection, or return false.
PartitionFastList<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> PartitionFastList<T>	partitionWith(Predicate2<? super T,? super P> predicate, P parameter) Filters a collection into a PartitionIterable based on the evaluation of the predicate.
void	readExternal(ObjectInput in)
Optional<T>	reduce(BinaryOperator<T> accumulator) This method produces the equivalent result as Stream.reduce(BinaryOperator).
<R,A> R	reduceInPlace(Collector<? super T,A,R> collector) This method produces the equivalent result as Stream.collect(Collector).
<R> R	reduceInPlace(Supplier<R> supplier, BiConsumer<R,? super T> accumulator) This method produces the equivalent result as Stream.collect(Supplier, BiConsumer, BiConsumer).
FastList<T>	reject(Predicate<? super T> predicate) Returns a MutableCollection with all elements that evaluate to false for the specified predicate.
<R extends Collection<T>> R	reject(Predicate<? super T> predicate, R target) Same as the reject method with one parameter but uses the specified target collection for the results.
<P> FastList<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.
<P,R extends Collection<T>> R	rejectWith(Predicate2<? super T,? super P> predicate, P parameter, R target) Similar to RichIterable.reject(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
T	remove(int index)
boolean	remove(Object object)
boolean	removeIf(Predicate<? super T> predicate) Removes all elements in the collection that evaluate to true for the specified predicate.
<P> boolean	removeIfWith(Predicate2<? super T,? super P> predicate, P parameter) Removes all elements in the collection that evaluate to true for the specified predicate2 and parameter.
FastList<T>	reverseThis() Mutates this list by reversing its order and returns the current list as a result.
FastList<T>	select(Predicate<? super T> predicate) Returns a MutableCollection with all elements that evaluate to true for the specified predicate.
<R extends Collection<T>> R	select(Predicate<? super T> predicate, R target) Same as the select method with one parameter but uses the specified target collection for the results.
<P> Twin<MutableList<T>>	selectAndRejectWith(Predicate2<? super T,? super P> predicate, P parameter) Filters a collection into two separate collections based on a predicate returned via a Pair.
<S> FastList<S>	selectInstancesOf(Class<S> clazz) Returns all elements of the source collection that are instances of the Class clazz.
<P> FastList<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.
<P,R extends Collection<T>> R	selectWith(Predicate2<? super T,? super P> predicate, P parameter, R target) Similar to RichIterable.select(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
T	set(int index, T element)
int	size() Returns the number of items in this iterable.
FastList<T>	sortThis() Sorts the internal data structure of this list and returns the list itself as a convenience.
FastList<T>	sortThis(Comparator<? super T> comparator) Sorts the internal data structure of this list and returns the list itself as a convenience.
Spliterator<T>	spliterator()
<V> MutableObjectDoubleMap<V>	sumByDouble(Function<? super T,? extends V> groupBy, DoubleFunction<? super T> function) Groups and sums the values using the two specified functions.
<V> MutableObjectDoubleMap<V>	sumByFloat(Function<? super T,? extends V> groupBy, FloatFunction<? super T> function) Groups and sums the values using the two specified functions.
<V> MutableObjectLongMap<V>	sumByInt(Function<? super T,? extends V> groupBy, IntFunction<? super T> function) Groups and sums the values using the two specified functions.
<V> MutableObjectLongMap<V>	sumByLong(Function<? super T,? extends V> groupBy, LongFunction<? super T> function) Groups and sums the values using the two specified functions.
DoubleSummaryStatistics	summarizeDouble(DoubleFunction<? super T> function) Returns the result of summarizing the value returned from applying the DoubleFunction to each element of the iterable.
DoubleSummaryStatistics	summarizeFloat(FloatFunction<? super T> function) Returns the result of summarizing the value returned from applying the FloatFunction to each element of the iterable.
IntSummaryStatistics	summarizeInt(IntFunction<? super T> function) Returns the result of summarizing the value returned from applying the IntFunction to each element of the iterable.
LongSummaryStatistics	summarizeLong(LongFunction<? super T> function) Returns the result of summarizing the value returned from applying the LongFunction to each element of the iterable.
double	sumOfDouble(DoubleFunction<? super T> function) Returns the final double result of evaluating function for each element of the iterable and adding the results together.
double	sumOfFloat(FloatFunction<? super T> function) Returns the final double result of evaluating function for each element of the iterable and adding the results together.
long	sumOfInt(IntFunction<? super T> function) Returns the final long result of evaluating function for each element of the iterable and adding the results together.
long	sumOfLong(LongFunction<? super T> function) Returns the final long result of evaluating function for each element of the iterable and adding the results together.
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.
Object[]	toArray() Converts this iterable to an array.
<E> E[]	toArray(E[] array) Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.
<E> E[]	toArray(E[] array, int sourceFromIndex, int sourceToIndex, int destinationIndex)
<E> E[]	toArray(int sourceFromIndex, int sourceToIndex)
FastList<T>	toList() Converts the collection to a MutableList implementation.
FastList<T>	toSortedList() Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.
FastList<T>	toSortedList(Comparator<? super T> comparator) Converts the collection to a MutableList implementation and sorts it using the specified comparator.
T[]	toTypedArray(Class<T> clazz)
void	trimToSize()
boolean	trimToSizeIfGreaterThanPercent(double loadFactor) Express load factor as 0.25 to trim a collection with more than 25% excess capacity
FastList<T>	with(T... elements)
FastList<T>	with(T element1, T element2)
FastList<T>	with(T element1, T element2, T element3)
FastList<T>	withArrayCopy(T[] elements, int begin, int length)
static <E> FastList<E>	wrapCopy(E... array)
void	writeExternal(ObjectOutput out)

Methods inherited from class org.eclipse.collections.impl.list.mutable.AbstractMutableList

appendString, asParallel, asReversed, asSynchronized, asUnmodifiable, binarySearch, chunk, contains, iterator, listIterator, listIterator, newEmpty, removeAll, retainAll, reverseForEach, shuffleThis, shuffleThis, sortThisBy, sortThisByBoolean, sortThisByByte, sortThisByChar, sortThisByDouble, sortThisByFloat, sortThisByInt, sortThisByLong, sortThisByShort, subList, tap, toImmutable, toReversed, toSet, toStack, with, withAll, without, withoutAll, zip, zip, zipWithIndex, zipWithIndex

Methods inherited from class org.eclipse.collections.impl.collection.mutable.AbstractMutableCollection

addAllIterable, aggregateBy, aggregateInPlaceBy, removeAllIterable, retainAllIterable

Methods inherited from class org.eclipse.collections.impl.AbstractRichIterable

asLazy, containsAllIterable, detectIfNone, detectWithIfNone, forEach, into, isEmpty, toBag, toMap, toSortedBag, toSortedBag, toSortedBagBy, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.collections.impl.parallel.BatchIterable

forEach

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

addAllIterable, aggregateBy, aggregateInPlaceBy, removeAllIterable, retainAllIterable

Methods inherited from interface java.util.List

isEmpty, replaceAll, sort

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

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

binarySearch

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

appendString, asLazy, containsAllIterable, detectIfNone, detectWithIfNone, getOnly, into, isEmpty, makeString, makeString, makeString, notEmpty, toBag, toMap, toSortedBag, toSortedBag, toSortedBagBy, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString

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

forEach

Constructor Detail

FastList

public FastList()

FastList

public FastList(int initialCapacity)

FastList

public FastList(Collection<? extends T> source)

Method Detail

newList

public static <E> FastList<E> newList()

wrapCopy

public static <E> FastList<E> wrapCopy(E... array)

newList

public static <E> FastList<E> newList(int initialCapacity)

newList

public static <E> FastList<E> newList(Iterable<? extends E> source)

newListWith

public static <E> FastList<E> newListWith(E... elements)

Creates a new list using the passed elements argument as the backing store.

!!! WARNING: This method uses the passed in array, so can be very unsafe if the original array is held onto anywhere else. !!!

newWithNValues

public static <E> FastList<E> newWithNValues(int size,
                                             Function0<E> factory)

Creates a new FastList pre-sized to the specified size filled with default values generated by the specified function.

Since:

3.0

clone

public FastList<T> clone()

Specified by:

clone in interface MutableList<T>

Overrides:

clone in class AbstractMutableList<T>

clear

public void clear()

Specified by:

clear in interface Collection<T>

Specified by:

clear in interface List<T>

forEach

public void forEach(int from,
                    int to,
                    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 = FastList.newListWith(ted, mary, bob, sally)
 people.forEach(0, 1, new Procedure()
 {
     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>

Overrides:

forEach in class AbstractMutableList<T>

forEachWithIndex

public void forEachWithIndex(int from,
                             int to,
                             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 = FastList.newListWith(ted, mary, bob, sally)
 people.forEachWithIndex(0, 1, new ObjectIntProcedure()
 {
     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>

Overrides:

forEachWithIndex in class AbstractMutableList<T>

batchForEach

public void batchForEach(Procedure<? super T> procedure,
                         int sectionIndex,
                         int sectionCount)

Specified by:

batchForEach in interface BatchIterable<T>

getBatchCount

public int getBatchCount(int batchSize)

Specified by:

getBatchCount in interface BatchIterable<T>

toArray

public <E> E[] toArray(E[] array,
                       int sourceFromIndex,
                       int sourceToIndex,
                       int destinationIndex)

toArray

public <E> E[] toArray(int sourceFromIndex,
                       int sourceToIndex)

sortThis

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

Overrides:

sortThis in class AbstractMutableList<T>

sortThis

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

Overrides:

sortThis in class AbstractMutableList<T>

reverseThis

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

Overrides:

reverseThis in class AbstractMutableList<T>

addAll

public boolean addAll(Collection<? extends T> source)

Specified by:

addAll in interface Collection<T>

Specified by:

addAll in interface List<T>

Overrides:

addAll in class AbstractMutableCollection<T>

containsAll

public boolean containsAll(Collection<?> source)

Description copied from interface: RichIterable

Returns true if all elements in source are contained in this collection.

Specified by:

containsAll in interface Collection<T>

Specified by:

containsAll in interface List<T>

Specified by:

containsAll in interface RichIterable<T>

Overrides:

containsAll in class AbstractMutableList<T>

See Also:

Collection.containsAll(Collection)

containsAllArguments

public boolean containsAllArguments(Object... source)

Description copied from interface: RichIterable

Returns true if all elements in the specified var arg array are contained in this collection.

Specified by:

containsAllArguments in interface RichIterable<T>

Overrides:

containsAllArguments in class AbstractRichIterable<T>

toArray

public <E> E[] toArray(E[] array)

Description copied from interface: RichIterable

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

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

Specified by:

toArray in interface RichIterable<T>

Overrides:

toArray in class AbstractRichIterable<T>

See Also:

Collection.toArray(Object[])

toArray

public Object[] toArray()

Description copied from interface: RichIterable

Converts this iterable to an array.

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

Specified by:

toArray in interface RichIterable<T>

Overrides:

toArray in class AbstractRichIterable<T>

See Also:

Collection.toArray()

toTypedArray

public T[] toTypedArray(Class<T> clazz)

set

public T set(int index,
             T element)

Specified by:

set in interface List<T>

indexOf

public int indexOf(Object object)

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>

Overrides:

indexOf in class AbstractMutableList<T>

See Also:

List.indexOf(Object)

lastIndexOf

public int lastIndexOf(Object object)

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>

Overrides:

lastIndexOf in class AbstractMutableList<T>

spliterator

public Spliterator<T> spliterator()

Specified by:

spliterator in interface Iterable<T>

Specified by:

spliterator in interface Collection<T>

Specified by:

spliterator in interface List<T>

Since:

8.1

trimToSize

public void trimToSize()

trimToSizeIfGreaterThanPercent

public boolean trimToSizeIfGreaterThanPercent(double loadFactor)

Express load factor as 0.25 to trim a collection with more than 25% excess capacity

ensureCapacity

public void ensureCapacity(int minCapacity)

with

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

with

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

with

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

withArrayCopy

public FastList<T> withArrayCopy(T[] elements,
                                 int begin,
                                 int length)

getFirst

public T getFirst()

Description copied from interface: RichIterable

Returns the first element of an iterable. 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, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.

The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the first element could be any element from the Set.

Specified by:

getFirst in interface ListIterable<T>

Specified by:

getFirst in interface OrderedIterable<T>

Specified by:

getFirst in interface RichIterable<T>

Overrides:

getFirst in class AbstractMutableList<T>

getLast

public T getLast()

Description copied from interface: RichIterable

Returns the last element of an iterable. 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, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.

The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the last element could be any element from the Set.

Specified by:

getLast in interface ListIterable<T>

Specified by:

getLast in interface OrderedIterable<T>

Specified by:

getLast in interface RichIterable<T>

Overrides:

getLast in class AbstractMutableList<T>

groupBy

public <V> FastListMultimap<V,T> groupBy(Function<? super T,? extends V> function)

Description copied from interface: MutableCollection

For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.

Example using a Java 8 method reference:

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

Example using an anonymous inner class:

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

Co-variant example for MutableCollection:

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

Specified by:

groupBy in interface MutableCollection<T>

Specified by:

groupBy in interface ListIterable<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 AbstractMutableList<T>

groupBy

public <V,R extends MutableMultimap<V,T>> R groupBy(Function<? super T,? extends V> function,
                                                    R target)

Description copied from interface: RichIterable

Same as RichIterable.groupBy(Function), except that the results are gathered into the specified target multimap.

Example using a Java 8 method reference:

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

Example using an anonymous inner class:

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

Specified by:

groupBy in interface RichIterable<T>

Overrides:

groupBy in class AbstractRichIterable<T>

groupByEach

public <V> FastListMultimap<V,T> groupByEach(Function<? super T,? extends Iterable<V>> function)

Description copied from interface: RichIterable

Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.

Specified by:

groupByEach in interface MutableCollection<T>

Specified by:

groupByEach in interface ListIterable<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 AbstractMutableList<T>

groupByEach

public <V,R extends MutableMultimap<V,T>> R groupByEach(Function<? super T,? extends Iterable<V>> function,
                                                        R target)

Description copied from interface: RichIterable

Same as RichIterable.groupByEach(Function), except that the results are gathered into the specified target multimap.

Specified by:

groupByEach in interface RichIterable<T>

Overrides:

groupByEach in class AbstractRichIterable<T>

groupByUniqueKey

public <K> MutableMap<K,T> groupByUniqueKey(Function<? super T,? extends K> function)

Description copied from interface: RichIterable

For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown.

Specified by:

groupByUniqueKey in interface MutableCollection<T>

Specified by:

groupByUniqueKey in interface RichIterable<T>

Overrides:

groupByUniqueKey in class AbstractMutableList<T>

See Also:

RichIterable.groupBy(Function)

groupByUniqueKey

public <K,R extends MutableMap<K,T>> R groupByUniqueKey(Function<? super T,? extends K> function,
                                                        R target)

Description copied from interface: RichIterable

Same as RichIterable.groupByUniqueKey(Function), except that the results are gathered into the specified target map.

Specified by:

groupByUniqueKey in interface RichIterable<T>

Overrides:

groupByUniqueKey in class AbstractRichIterable<T>

See Also:

RichIterable.groupByUniqueKey(Function)

appendString

public void appendString(Appendable appendable,
                         String start,
                         String separator,
                         String end)

Description copied from interface: RichIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString(String, String, String).

Specified by:

appendString in interface RichIterable<T>

Overrides:

appendString in class AbstractMutableList<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>

Overrides:

take in class AbstractMutableList<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>

Overrides:

drop in class AbstractMutableList<T>

Parameters:

count - the number of items to drop.

partition

public PartitionFastList<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 MutableCollection<T>

Specified by:

partition in interface ListIterable<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 AbstractMutableList<T>

partitionWith

public <P> PartitionFastList<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 MutableCollection<T>

Specified by:

partitionWith in interface ListIterable<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 AbstractMutableList<T>

each

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

Description copied from interface: RichIterable

The procedure is executed for each element in the iterable.

Example using a Java 8 lambda expression:

 people.each(person -> LOGGER.info(person.getName()));
 

Example using an anonymous inner class:

 people.each(new Procedure()
 {
     public void value(Person person)
     {
         LOGGER.info(person.getName());
     }
 });
 

This method is a variant of InternalIterable.forEach(Procedure) that has a signature conflict with Iterable.forEach(java.util.function.Consumer).

Specified by:

each in interface RichIterable<T>

Overrides:

each in class AbstractMutableList<T>

See Also:

InternalIterable.forEach(Procedure), Iterable.forEach(java.util.function.Consumer)

forEachIf

public void forEachIf(Predicate<? super T> predicate,
                      Procedure<? super T> procedure)

forEachWithIndex

public void forEachWithIndex(ObjectIntProcedure<? super T> objectIntProcedure)

Description copied from interface: InternalIterable

Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure.

Example using a Java 8 lambda:

 people.forEachWithIndex((Person person, int index) -> LOGGER.info("Index: " + index + " person: " + person.getName()));
 

Example using an anonymous inner class:

 people.forEachWithIndex(new ObjectIntProcedure()
 {
     public void value(Person person, int index)
     {
         LOGGER.info("Index: " + index + " person: " + person.getName());
     }
 });
 

Specified by:

forEachWithIndex in interface InternalIterable<T>

Specified by:

forEachWithIndex in interface OrderedIterable<T>

Overrides:

forEachWithIndex in class AbstractMutableList<T>

forEachWith

public <P> void forEachWith(Procedure2<? super T,? super P> procedure,
                            P parameter)

Description copied from interface: InternalIterable

The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.

Example using a Java 8 lambda:

 people.forEachWith((Person person, Person other) ->
     {
         if (person.isRelatedTo(other))
         {
              LOGGER.info(person.getName());
         }
     }, fred);
 

Example using an anonymous inner class:

 people.forEachWith(new Procedure2()
 {
     public void value(Person person, Person other)
     {
         if (person.isRelatedTo(other))
         {
              LOGGER.info(person.getName());
         }
     }
 }, fred);
 

Specified by:

forEachWith in interface InternalIterable<T>

Overrides:

forEachWith in class AbstractMutableList<T>

select

public FastList<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 MutableCollection<T>

Specified by:

select in interface ListIterable<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 AbstractMutableList<T>

select

public <R extends Collection<T>> R select(Predicate<? super T> predicate,
                                          R target)

Description copied from interface: RichIterable

Same as the select method with one parameter but uses the specified target collection for the results.

Example using a Java 8 lambda expression:

 MutableList<Person> selected =
     people.select(person -> person.person.getLastName().equals("Smith"), Lists.mutable.empty());
 

Example using an anonymous inner class:

 MutableList<Person> selected =
     people.select(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.person.getLastName().equals("Smith");
         }
     }, Lists.mutable.empty());
 

Specified by:

select in interface RichIterable<T>

Overrides:

select in class AbstractMutableList<T>

Parameters:

predicate - a Predicate to use as the select criteria

target - the Collection to append to for all elements in this RichIterable that meet select criteria predicate

Returns:

target, which contains appended elements as a result of the select criteria

See Also:

RichIterable.select(Predicate)

selectWith

public <P> FastList<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 MutableCollection<T>

Specified by:

selectWith in interface ListIterable<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 AbstractMutableList<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)

selectWith

public <P,R extends Collection<T>> R selectWith(Predicate2<? super T,? super P> predicate,
                                                P parameter,
                                                R target)

Description copied from interface: RichIterable

Similar to RichIterable.select(Predicate, Collection), 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:

 MutableList<Person> selected =
     people.selectWith((Person person, Integer age) -> person.getAge() >= age, Integer.valueOf(18), Lists.mutable.empty());
 

Example using an anonymous inner class:

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

Specified by:

selectWith in interface RichIterable<T>

Overrides:

selectWith in class AbstractMutableList<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

target - the Collection to append to for all elements in this RichIterable that meet select criteria predicate

Returns:

targetCollection, which contains appended elements as a result of the select criteria

See Also:

RichIterable.select(Predicate), RichIterable.select(Predicate, Collection)

reject

public FastList<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 MutableCollection<T>

Specified by:

reject in interface ListIterable<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 AbstractMutableList<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

reject

public <R extends Collection<T>> R reject(Predicate<? super T> predicate,
                                          R target)

Description copied from interface: RichIterable

Same as the reject method with one parameter but uses the specified target collection for the results.

Example using a Java 8 lambda expression:

 MutableList<Person> rejected =
     people.reject(person -> person.person.getLastName().equals("Smith"), Lists.mutable.empty());
 

Example using an anonymous inner class:

 MutableList<Person> rejected =
     people.reject(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.person.getLastName().equals("Smith");
         }
     }, Lists.mutable.empty());
 

Specified by:

reject in interface RichIterable<T>

Overrides:

reject in class AbstractMutableList<T>

Parameters:

predicate - a Predicate to use as the reject criteria

target - the Collection to append to for all elements in this RichIterable that cause Predicate#accept(Object) method to evaluate to false

Returns:

target, which contains appended elements as a result of the reject criteria

rejectWith

public <P> FastList<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 MutableCollection<T>

Specified by:

rejectWith in interface ListIterable<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 AbstractMutableList<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,R extends Collection<T>> R rejectWith(Predicate2<? super T,? super P> predicate,
                                                P parameter,
                                                R target)

Description copied from interface: RichIterable

Similar to RichIterable.reject(Predicate, Collection), 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:

 MutableList<Person> rejected =
     people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18), Lists.mutable.empty());
 

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), Lists.mutable.empty());
 

Specified by:

rejectWith in interface RichIterable<T>

Overrides:

rejectWith in class AbstractMutableList<T>

Parameters:

predicate - a Predicate2 to use as the reject criteria

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

target - the Collection to append to for all elements in this RichIterable that cause Predicate#accept(Object) method to evaluate to false

Returns:

targetCollection, which contains appended elements as a result of the reject criteria

See Also:

RichIterable.reject(Predicate), RichIterable.reject(Predicate, Collection)

selectAndRejectWith

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

Description copied from interface: MutableCollection

Filters a collection into two separate collections based on a predicate returned via a Pair.

e.g.
 return lastNames.selectAndRejectWith(Predicates2.lessThan(), "Mason");
 

Specified by:

selectAndRejectWith in interface MutableCollection<T>

Overrides:

selectAndRejectWith in class AbstractMutableList<T>

selectInstancesOf

public <S> FastList<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 MutableCollection<T>

Specified by:

selectInstancesOf in interface ListIterable<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 AbstractMutableList<T>

removeIf

public boolean removeIf(Predicate<? super T> predicate)

Description copied from interface: MutableCollection

Removes all elements in the collection that evaluate to true for the specified predicate.

e.g.
 return lastNames.removeIf(Predicates.isNull());
 

Specified by:

removeIf in interface MutableCollection<T>

Overrides:

removeIf in class AbstractMutableList<T>

removeIfWith

public <P> boolean removeIfWith(Predicate2<? super T,? super P> predicate,
                                P parameter)

Description copied from interface: MutableCollection

Removes all elements in the collection that evaluate to true for the specified predicate2 and parameter.

 return lastNames.removeIfWith(Predicates2.isNull(), null);
 

Specified by:

removeIfWith in interface MutableCollection<T>

Overrides:

removeIfWith in class AbstractMutableList<T>

collect

public <V> FastList<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 MutableCollection<T>

Specified by:

collect in interface ListIterable<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 AbstractMutableList<T>

collectBoolean

public MutableBooleanList collectBoolean(BooleanFunction<? super T> booleanFunction)

Description copied from interface: MutableCollection

Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

 BooleanIterable licenses =
     people.collectBoolean(person -> person.hasDrivingLicense());
 

Example using an anonymous inner class:

 BooleanIterable licenses =
     people.collectBoolean(new BooleanFunction<Person>()
     {
         public boolean booleanValueOf(Person person)
         {
             return person.hasDrivingLicense();
         }
     });
 

Co-variant example for MutableCollecton:

 MutableBooleanCollection licenses =
     people.collectBoolean(person -> person.hasDrivingLicense());
 

Specified by:

collectBoolean in interface MutableCollection<T>

Specified by:

collectBoolean in interface ListIterable<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 AbstractMutableList<T>

collectBoolean

public <R extends MutableBooleanCollection> R collectBoolean(BooleanFunction<? super T> booleanFunction,
                                                             R target)

Description copied from interface: RichIterable

Same as RichIterable.collectBoolean(BooleanFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 BooleanArrayList licenses =
     people.collectBoolean(person -> person.hasDrivingLicense(), new BooleanArrayList());
 

Example using an anonymous inner class:

 BooleanArrayList licenses =
     people.collectBoolean(new BooleanFunction<Person>()
     {
         public boolean booleanValueOf(Person person)
         {
             return person.hasDrivingLicense();
         }
     }, new BooleanArrayList());
 

Specified by:

collectBoolean in interface RichIterable<T>

Overrides:

collectBoolean in class AbstractRichIterable<T>

Parameters:

booleanFunction - a BooleanFunction to use as the collect transformation function

target - the MutableBooleanCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

collectByte

public MutableByteList collectByte(ByteFunction<? super T> byteFunction)

Description copied from interface: MutableCollection

Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

 ByteIterable bytes =
     people.collectByte(person -> person.getCode());
 

Example using an anonymous inner class:

 ByteIterable bytes =
     people.collectByte(new ByteFunction<Person>()
     {
         public byte byteValueOf(Person person)
         {
             return person.getCode();
         }
     });
 

Co-variant example for MutableCollection:

 MutableByteCollection bytes =
     people.collectByte(person -> person.getCode());
 

Specified by:

collectByte in interface MutableCollection<T>

Specified by:

collectByte in interface ListIterable<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 AbstractMutableList<T>

collectByte

public <R extends MutableByteCollection> R collectByte(ByteFunction<? super T> byteFunction,
                                                       R target)

Description copied from interface: RichIterable

Same as RichIterable.collectByte(ByteFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 ByteArrayList bytes =
     people.collectByte(person -> person.getCode(), new ByteArrayList());
 

Example using an anonymous inner class:

 ByteArrayList bytes =
     people.collectByte(new ByteFunction<Person>()
     {
         public byte byteValueOf(Person person)
         {
             return person.getCode();
         }
     }, new ByteArrayList());
 

Specified by:

collectByte in interface RichIterable<T>

Overrides:

collectByte in class AbstractRichIterable<T>

Parameters:

byteFunction - a ByteFunction to use as the collect transformation function

target - the MutableByteCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

collectChar

public MutableCharList collectChar(CharFunction<? super T> charFunction)

Description copied from interface: MutableCollection

Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

 CharIterable chars =
     people.collectChar(person -> person.getMiddleInitial());
 

Example using an anonymous inner class:

 CharIterable chars =
     people.collectChar(new CharFunction<Person>()
     {
         public char charValueOf(Person person)
         {
             return person.getMiddleInitial();
         }
     });
 

Co-variant example for MutableCollection:

 MutableCharCollection chars =
     people.collectChar(person -> person.getMiddleInitial());
 

Specified by:

collectChar in interface MutableCollection<T>

Specified by:

collectChar in interface ListIterable<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 AbstractMutableList<T>

collectChar

public <R extends MutableCharCollection> R collectChar(CharFunction<? super T> charFunction,
                                                       R target)

Description copied from interface: RichIterable

Same as RichIterable.collectChar(CharFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 CharArrayList chars =
     people.collectChar(person -> person.getMiddleInitial(), new CharArrayList());
 

Example using an anonymous inner class:

 CharArrayList chars =
     people.collectChar(new CharFunction<Person>()
     {
         public char charValueOf(Person person)
         {
             return person.getMiddleInitial();
         }
     }, new CharArrayList());
 

Specified by:

collectChar in interface RichIterable<T>

Overrides:

collectChar in class AbstractRichIterable<T>

Parameters:

charFunction - a CharFunction to use as the collect transformation function

target - the MutableCharCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

collectDouble

public MutableDoubleList collectDouble(DoubleFunction<? super T> doubleFunction)

Description copied from interface: MutableCollection

Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

 DoubleIterable doubles =
     people.collectDouble(person -> person.getMilesFromNorthPole());
 

Example using an anonymous inner class:

 DoubleIterable doubles =
     people.collectDouble(new DoubleFunction<Person>()
     {
         public double doubleValueOf(Person person)
         {
             return person.getMilesFromNorthPole();
         }
     });
 

Co-variant example for MutableCollection:

 MutableDoubleCollection doubles =
     people.collectDouble(person -> person.getMilesFromNorthPole());
 

Specified by:

collectDouble in interface MutableCollection<T>

Specified by:

collectDouble in interface ListIterable<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 AbstractMutableList<T>

collectDouble

public <R extends MutableDoubleCollection> R collectDouble(DoubleFunction<? super T> doubleFunction,
                                                           R target)

Description copied from interface: RichIterable

Same as RichIterable.collectDouble(DoubleFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 DoubleArrayList doubles =
     people.collectDouble(person -> person.getMilesFromNorthPole(), new DoubleArrayList());
 

Example using an anonymous inner class:

 DoubleArrayList doubles =
     people.collectDouble(new DoubleFunction<Person>()
     {
         public double doubleValueOf(Person person)
         {
             return person.getMilesFromNorthPole();
         }
     }, new DoubleArrayList());
 

Specified by:

collectDouble in interface RichIterable<T>

Overrides:

collectDouble in class AbstractRichIterable<T>

Parameters:

doubleFunction - a DoubleFunction to use as the collect transformation function

target - the MutableDoubleCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

collectFloat

public MutableFloatList collectFloat(FloatFunction<? super T> floatFunction)

Description copied from interface: MutableCollection

Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

 FloatIterable floats =
     people.collectFloat(person -> person.getHeightInInches());
 

Example using an anonymous inner class:

 FloatIterable floats =
     people.collectFloat(new FloatFunction<Person>()
     {
         public float floatValueOf(Person person)
         {
             return person.getHeightInInches();
         }
     });
 

Co-variant example for MutableCollection:

 MutableFloatCollection floats =
     people.collectFloat(person -> person.getHeightInInches());
 

Specified by:

collectFloat in interface MutableCollection<T>

Specified by:

collectFloat in interface ListIterable<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 AbstractMutableList<T>

collectFloat

public <R extends MutableFloatCollection> R collectFloat(FloatFunction<? super T> floatFunction,
                                                         R target)

Description copied from interface: RichIterable

Same as RichIterable.collectFloat(FloatFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 FloatArrayList floats =
     people.collectFloat(person -> person.getHeightInInches(), new FloatArrayList());
 

Example using an anonymous inner class:

 FloatArrayList floats =
     people.collectFloat(new FloatFunction<Person>()
     {
         public float floatValueOf(Person person)
         {
             return person.getHeightInInches();
         }
     }, new FloatArrayList());
 

Specified by:

collectFloat in interface RichIterable<T>

Overrides:

collectFloat in class AbstractRichIterable<T>

Parameters:

floatFunction - a FloatFunction to use as the collect transformation function

target - the MutableFloatCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

collectInt

public MutableIntList collectInt(IntFunction<? super T> intFunction)

Description copied from interface: MutableCollection

Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

 IntIterable ints =
     people.collectInt(person -> person.getAge());
 

Example using an anonymous inner class:

 IntIterable ints =
     people.collectInt(new IntFunction<Person>()
     {
         public int intValueOf(Person person)
         {
             return person.getAge();
         }
     });
 

Co-variant example for MutableCollection:

 MutableIntCollection ints =
     people.collectInt(person -> person.getAge());
 

Specified by:

collectInt in interface MutableCollection<T>

Specified by:

collectInt in interface ListIterable<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 AbstractMutableList<T>

collectInt

public <R extends MutableIntCollection> R collectInt(IntFunction<? super T> intFunction,
                                                     R target)

Description copied from interface: RichIterable

Same as RichIterable.collectInt(IntFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 IntArrayList ints =
     people.collectInt(person -> person.getAge(), new IntArrayList());
 

Example using an anonymous inner class:

 IntArrayList ints =
     people.collectInt(new IntFunction<Person>()
     {
         public int intValueOf(Person person)
         {
             return person.getAge();
         }
     }, new IntArrayList());
 

Specified by:

collectInt in interface RichIterable<T>

Overrides:

collectInt in class AbstractRichIterable<T>

Parameters:

intFunction - a IntFunction to use as the collect transformation function

target - the MutableIntCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

collectLong

public MutableLongList collectLong(LongFunction<? super T> longFunction)

Description copied from interface: MutableCollection

Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

 LongIterable longs =
     people.collectLong(person -> person.getGuid());
 

Example using an anonymous inner class:

 LongIterable longs =
     people.collectLong(new LongFunction<Person>()
     {
         public long longValueOf(Person person)
         {
             return person.getGuid();
         }
     });
 

Co-variant example for MutableCollection:

 MutableLongCollection longs =
     people.collectLong(person -> person.getGuid());
 

Specified by:

collectLong in interface MutableCollection<T>

Specified by:

collectLong in interface ListIterable<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 AbstractMutableList<T>

collectLong

public <R extends MutableLongCollection> R collectLong(LongFunction<? super T> longFunction,
                                                       R target)

Description copied from interface: RichIterable

Same as RichIterable.collectLong(LongFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 LongArrayList longs =
     people.collectLong(person -> person.getGuid(), new LongArrayList());
 

Example using an anonymous inner class:

 LongArrayList longs =
     people.collectLong(new LongFunction<Person>()
     {
         public long longValueOf(Person person)
         {
             return person.getGuid();
         }
     }, new LongArrayList());
 

Specified by:

collectLong in interface RichIterable<T>

Overrides:

collectLong in class AbstractRichIterable<T>

Parameters:

longFunction - a LongFunction to use as the collect transformation function

target - the MutableLongCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

collectShort

public MutableShortList collectShort(ShortFunction<? super T> shortFunction)

Description copied from interface: MutableCollection

Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

 ShortIterable shorts =
     people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
 

Example using an anonymous inner class:

 ShortIterable shorts =
     people.collectShort(new ShortFunction<Person>()
     {
         public short shortValueOf(Person person)
         {
             return person.getNumberOfJunkMailItemsReceivedPerMonth();
         }
     });
 

Co-variant example for MutableCollection:

 MutableShortCollection shorts =
     people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
 

Specified by:

collectShort in interface MutableCollection<T>

Specified by:

collectShort in interface ListIterable<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 AbstractMutableList<T>

collectShort

public <R extends MutableShortCollection> R collectShort(ShortFunction<? super T> shortFunction,
                                                         R target)

Description copied from interface: RichIterable

Same as RichIterable.collectShort(ShortFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 ShortArrayList shorts =
     people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth, new ShortArrayList());
 

Example using an anonymous inner class:

 ShortArrayList shorts =
     people.collectShort(new ShortFunction<Person>()
     {
         public short shortValueOf(Person person)
         {
             return person.getNumberOfJunkMailItemsReceivedPerMonth;
         }
     }, new ShortArrayList());
 

Specified by:

collectShort in interface RichIterable<T>

Overrides:

collectShort in class AbstractRichIterable<T>

Parameters:

shortFunction - a ShortFunction to use as the collect transformation function

target - the MutableShortCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

collect

public <V,R extends Collection<V>> R collect(Function<? super T,? extends V> function,
                                             R target)

Description copied from interface: RichIterable

Same as RichIterable.collect(Function), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 MutableList<String> names =
     people.collect(person -> person.getFirstName() + " " + person.getLastName(), Lists.mutable.empty());
 

Example using an anonymous inner class:

 MutableList<String> names =
     people.collect(new Function<Person, String>()
     {
         public String valueOf(Person person)
         {
             return person.getFirstName() + " " + person.getLastName();
         }
     }, Lists.mutable.empty());
 

Specified by:

collect in interface RichIterable<T>

Overrides:

collect in class AbstractMutableList<T>

Parameters:

function - a Function to use as the collect transformation function

target - the Collection to append to for all elements in this RichIterable that meet select criteria function

Returns:

target, which contains appended elements as a result of the collect transformation

See Also:

RichIterable.collect(Function)

flatCollect

public <V> FastList<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 MutableCollection<T>

Specified by:

flatCollect in interface ListIterable<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 AbstractMutableList<T>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

flatCollect

public <V,R extends Collection<V>> R flatCollect(Function<? super T,? extends Iterable<V>> function,
                                                 R target)

Description copied from interface: RichIterable

Same as flatCollect, only the results are collected into the target collection.

Specified by:

flatCollect in interface RichIterable<T>

Overrides:

flatCollect in class AbstractMutableList<T>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

target, which will contain a flattened collection of results produced by applying the given function

See Also:

RichIterable.flatCollect(Function)

collectWith

public <P,V> FastList<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 MutableCollection<T>

Specified by:

collectWith in interface ListIterable<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 AbstractMutableList<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)

collectWith

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

Description copied from interface: RichIterable

Same as collectWith but with a targetCollection parameter to gather the results.

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

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

Specified by:

collectWith in interface RichIterable<T>

Overrides:

collectWith in class AbstractMutableList<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

target - the Collection to append to for all elements in this RichIterable that meet select criteria function

Returns:

targetCollection, which contains appended elements as a result of the collect transformation

collectIf

public <V> FastList<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 MutableCollection<T>

Specified by:

collectIf in interface ListIterable<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 AbstractMutableList<T>

collectIf

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

Description copied from interface: RichIterable

Same as the collectIf method with two parameters but uses the specified target collection for the results.

Specified by:

collectIf in interface RichIterable<T>

Overrides:

collectIf in class AbstractMutableList<T>

Parameters:

predicate - a Predicate to use as the select criteria

function - a Function to use as the collect transformation function

target - the Collection to append to for all elements in this RichIterable that meet the collect criteria predicate

Returns:

targetCollection, which contains appended elements as a result of the collect criteria and transformation

See Also:

RichIterable.collectIf(Predicate, Function)

detect

public T detect(Predicate<? super T> predicate)

Description copied from interface: RichIterable

Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true. This method is commonly called find.

Example using a Java 8 lambda expression:

 Person person =
     people.detect(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));
 

Example using an anonymous inner class:

 Person person =
     people.detect(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getFirstName().equals("John") && person.getLastName().equals("Smith");
         }
     });
 

Specified by:

detect in interface RichIterable<T>

Overrides:

detect in class AbstractMutableList<T>

detectWith

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

Description copied from interface: RichIterable

Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true.

Example using a Java 8 lambda expression:

 Person person =
     people.detectWith((person, fullName) -> person.getFullName().equals(fullName), "John Smith");
 

Example using an anonymous inner class:

 Person person =
     people.detectWith(new Predicate2<Person, String>()
     {
         public boolean accept(Person person, String fullName)
         {
             return person.getFullName().equals(fullName);
         }
     }, "John Smith");
 

Specified by:

detectWith in interface RichIterable<T>

Overrides:

detectWith in class AbstractMutableList<T>

detectOptional

public Optional<T> detectOptional(Predicate<? super T> predicate)

Description copied from interface: RichIterable

Returns the first element of the iterable for which the predicate evaluates to true as an Optional. This method is commonly called find.

Example using a Java 8 lambda expression:

 Person person =
     people.detectOptional(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));
 

Specified by:

detectOptional in interface RichIterable<T>

Overrides:

detectOptional in class AbstractMutableList<T>

detectWithOptional

public <P> Optional<T> detectWithOptional(Predicate2<? super T,? super P> predicate,
                                          P parameter)

Description copied from interface: RichIterable

Returns the first element that evaluates to true for the specified predicate2 and parameter as an Optional.

Example using a Java 8 lambda expression:

 Optional<Person> person =
     people.detectWithOptional((person, fullName) -> person.getFullName().equals(fullName), "John Smith");
 

Specified by:

detectWithOptional in interface RichIterable<T>

Overrides:

detectWithOptional in class AbstractMutableList<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>

Overrides:

detectIndex in class AbstractMutableList<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>

Overrides:

detectLastIndex in class AbstractMutableList<T>

min

public T min(Comparator<? super T> comparator)

Description copied from interface: RichIterable

Returns the minimum element out of this container based on the comparator.

Specified by:

min in interface RichIterable<T>

Overrides:

min in class AbstractMutableList<T>

max

public T max(Comparator<? super T> comparator)

Description copied from interface: RichIterable

Returns the maximum element out of this container based on the comparator.

Specified by:

max in interface RichIterable<T>

Overrides:

max in class AbstractMutableList<T>

min

public T min()

Description copied from interface: RichIterable

Returns the minimum element out of this container based on the natural order.

Specified by:

min in interface OrderedIterable<T>

Specified by:

min in interface RichIterable<T>

Overrides:

min in class AbstractMutableList<T>

max

public T max()

Description copied from interface: RichIterable

Returns the maximum element out of this container based on the natural order.

Specified by:

max in interface OrderedIterable<T>

Specified by:

max in interface RichIterable<T>

Overrides:

max in class AbstractMutableList<T>

minBy

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

Description copied from interface: RichIterable

Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.

Specified by:

minBy in interface RichIterable<T>

Overrides:

minBy in class AbstractMutableList<T>

maxBy

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

Description copied from interface: RichIterable

Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.

Specified by:

maxBy in interface RichIterable<T>

Overrides:

maxBy in class AbstractMutableList<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>

add

public boolean add(T newItem)

Specified by:

add in interface Collection<T>

Specified by:

add in interface List<T>

Overrides:

add in class AbstractMutableCollection<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>

remove

public boolean remove(Object object)

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface List<T>

Overrides:

remove in class AbstractMutableCollection<T>

addAll

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

Specified by:

addAll in interface List<T>

size

public int size()

Description copied from interface: RichIterable

Returns the number of items in this iterable.

Specified by:

size in interface Collection<T>

Specified by:

size in interface List<T>

Specified by:

size in interface RichIterable<T>

Specified by:

size in interface BatchIterable<T>

count

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

Description copied from interface: RichIterable

Return the total number of elements that answer true to the specified predicate.

Example using a Java 8 lambda expression:

 int count =
     people.count(person -> person.getAddress().getState().getName().equals("New York"));
 

Example using an anonymous inner class:

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

Specified by:

count in interface RichIterable<T>

Overrides:

count in class AbstractMutableList<T>

countWith

public <P> int countWith(Predicate2<? super T,? super P> predicate,
                         P parameter)

Description copied from interface: RichIterable

Returns the total number of elements that evaluate to true for the specified predicate.

e.g.
 return lastNames.countWith(Predicates2.equal(), "Smith");
 

Specified by:

countWith in interface RichIterable<T>

Overrides:

countWith in class AbstractMutableList<T>

corresponds

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

Description copied from interface: OrderedIterable

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

Specified by:

corresponds in interface OrderedIterable<T>

Overrides:

corresponds in class AbstractMutableList<T>

anySatisfy

public boolean anySatisfy(Predicate<? super T> predicate)

Description copied from interface: RichIterable

Returns true if the predicate evaluates to true for any element of the iterable. Returns false if the iterable is empty, or if no element returned true when evaluating the predicate.

Specified by:

anySatisfy in interface RichIterable<T>

Overrides:

anySatisfy in class AbstractMutableList<T>

anySatisfyWith

public <P> boolean anySatisfyWith(Predicate2<? super T,? super P> predicate,
                                  P parameter)

Description copied from interface: RichIterable

Returns true if the predicate evaluates to true for any element of the collection, or return false. Returns false if the collection is empty.

Specified by:

anySatisfyWith in interface RichIterable<T>

Overrides:

anySatisfyWith in class AbstractMutableList<T>

allSatisfy

public boolean allSatisfy(Predicate<? super T> predicate)

Description copied from interface: RichIterable

Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty. Otherwise, returns false.

Specified by:

allSatisfy in interface RichIterable<T>

Overrides:

allSatisfy in class AbstractMutableList<T>

allSatisfyWith

public <P> boolean allSatisfyWith(Predicate2<? super T,? super P> predicate,
                                  P parameter)

Description copied from interface: RichIterable

Returns true if the predicate evaluates to true for every element of the collection, or returns false.

Specified by:

allSatisfyWith in interface RichIterable<T>

Overrides:

allSatisfyWith in class AbstractMutableList<T>

noneSatisfy

public boolean noneSatisfy(Predicate<? super T> predicate)

Description copied from interface: RichIterable

Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty. Otherwise, returns false.

Specified by:

noneSatisfy in interface RichIterable<T>

Overrides:

noneSatisfy in class AbstractMutableList<T>

noneSatisfyWith

public <P> boolean noneSatisfyWith(Predicate2<? super T,? super P> predicate,
                                   P parameter)

Description copied from interface: RichIterable

Returns true if the predicate evaluates to false for every element of the collection, or return false. Returns true if the collection is empty.

Specified by:

noneSatisfyWith in interface RichIterable<T>

Overrides:

noneSatisfyWith in class AbstractMutableList<T>

injectInto

public <IV> IV injectInto(IV injectedValue,
                          Function2<? super IV,? super T,? extends IV> function)

Description copied from interface: RichIterable

Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. This method is commonly called fold or sometimes reduce.

Specified by:

injectInto in interface RichIterable<T>

Overrides:

injectInto in class AbstractMutableList<T>

injectInto

public int injectInto(int injectedValue,
                      IntObjectToIntFunction<? super T> function)

Description copied from interface: RichIterable

Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Specified by:

injectInto in interface RichIterable<T>

Overrides:

injectInto in class AbstractMutableList<T>

injectInto

public long injectInto(long injectedValue,
                       LongObjectToLongFunction<? super T> function)

Description copied from interface: RichIterable

Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Specified by:

injectInto in interface RichIterable<T>

Overrides:

injectInto in class AbstractMutableList<T>

injectInto

public double injectInto(double injectedValue,
                         DoubleObjectToDoubleFunction<? super T> function)

Description copied from interface: RichIterable

Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Specified by:

injectInto in interface RichIterable<T>

Overrides:

injectInto in class AbstractRichIterable<T>

injectInto

public float injectInto(float injectedValue,
                        FloatObjectToFloatFunction<? super T> function)

Description copied from interface: RichIterable

Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Specified by:

injectInto in interface RichIterable<T>

Overrides:

injectInto in class AbstractMutableList<T>

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>

Overrides:

distinct in class AbstractMutableList<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>

Overrides:

distinct in class AbstractMutableList<T>

Returns:

ListIterable of distinct elements

summarizeInt

public IntSummaryStatistics summarizeInt(IntFunction<? super T> function)

Description copied from interface: RichIterable

Returns the result of summarizing the value returned from applying the IntFunction to each element of the iterable.

 IntSummaryStatistics stats =
     Lists.mutable.with(1, 2, 3).summarizeInt(Integer::intValue);
 

Specified by:

summarizeInt in interface RichIterable<T>

Since:

8.0

summarizeFloat

public DoubleSummaryStatistics summarizeFloat(FloatFunction<? super T> function)

Description copied from interface: RichIterable

Returns the result of summarizing the value returned from applying the FloatFunction to each element of the iterable.

 DoubleSummaryStatistics stats =
     Lists.mutable.with(1, 2, 3).summarizeFloat(Integer::floatValue);
 

Specified by:

summarizeFloat in interface RichIterable<T>

Since:

8.0

summarizeLong

public LongSummaryStatistics summarizeLong(LongFunction<? super T> function)

Description copied from interface: RichIterable

Returns the result of summarizing the value returned from applying the LongFunction to each element of the iterable.

 LongSummaryStatistics stats =
     Lists.mutable.with(1, 2, 3).summarizeLong(Integer::longValue);
 

Specified by:

summarizeLong in interface RichIterable<T>

Since:

8.0

summarizeDouble

public DoubleSummaryStatistics summarizeDouble(DoubleFunction<? super T> function)

Description copied from interface: RichIterable

Returns the result of summarizing the value returned from applying the DoubleFunction to each element of the iterable.

 DoubleSummaryStatistics stats =
     Lists.mutable.with(1, 2, 3).summarizeDouble(Integer::doubleValue);
 

Specified by:

summarizeDouble in interface RichIterable<T>

Since:

8.0

reduce

public Optional<T> reduce(BinaryOperator<T> accumulator)

Description copied from interface: RichIterable

This method produces the equivalent result as Stream.reduce(BinaryOperator).

Specified by:

reduce in interface RichIterable<T>

Overrides:

reduce in class AbstractMutableCollection<T>

Since:

8.0

reduceInPlace

public <R,A> R reduceInPlace(Collector<? super T,A,R> collector)

Description copied from interface: RichIterable

This method produces the equivalent result as Stream.collect(Collector).

 MutableObjectLongMap map2 =
     Lists.mutable.with(1, 2, 3, 4, 5).reduceInPlace(Collectors2.sumByInt(i -> Integer.valueOf(i % 2), Integer::intValue));
 

Specified by:

reduceInPlace in interface RichIterable<T>

Since:

8.0

reduceInPlace

public <R> R reduceInPlace(Supplier<R> supplier,
                           BiConsumer<R,? super T> accumulator)

Description copied from interface: RichIterable

This method produces the equivalent result as Stream.collect(Supplier, BiConsumer, BiConsumer). The combiner used in collect is unnecessary in the serial case, so is not included in the API.

Specified by:

reduceInPlace in interface RichIterable<T>

Since:

8.0

sumOfInt

public long sumOfInt(IntFunction<? super T> function)

Description copied from interface: RichIterable

Returns the final long result of evaluating function for each element of the iterable and adding the results together.

Specified by:

sumOfInt in interface RichIterable<T>

Overrides:

sumOfInt in class AbstractMutableList<T>

sumOfLong

public long sumOfLong(LongFunction<? super T> function)

Description copied from interface: RichIterable

Returns the final long result of evaluating function for each element of the iterable and adding the results together.

Specified by:

sumOfLong in interface RichIterable<T>

Overrides:

sumOfLong in class AbstractMutableList<T>

sumOfFloat

public double sumOfFloat(FloatFunction<? super T> function)

Description copied from interface: RichIterable

Returns the final double result of evaluating function for each element of the iterable and adding the results together. It uses Kahan summation algorithm to reduce numerical error.

Specified by:

sumOfFloat in interface RichIterable<T>

Overrides:

sumOfFloat in class AbstractMutableList<T>

sumOfDouble

public double sumOfDouble(DoubleFunction<? super T> function)

Description copied from interface: RichIterable

Returns the final double result of evaluating function for each element of the iterable and adding the results together. It uses Kahan summation algorithm to reduce numerical error.

Specified by:

sumOfDouble in interface RichIterable<T>

Overrides:

sumOfDouble in class AbstractMutableList<T>

sumByInt

public <V> MutableObjectLongMap<V> sumByInt(Function<? super T,? extends V> groupBy,
                                            IntFunction<? super T> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByInt in interface MutableCollection<T>

Specified by:

sumByInt in interface RichIterable<T>

Overrides:

sumByInt in class AbstractMutableCollection<T>

sumByLong

public <V> MutableObjectLongMap<V> sumByLong(Function<? super T,? extends V> groupBy,
                                             LongFunction<? super T> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByLong in interface MutableCollection<T>

Specified by:

sumByLong in interface RichIterable<T>

Overrides:

sumByLong in class AbstractMutableCollection<T>

sumByFloat

public <V> MutableObjectDoubleMap<V> sumByFloat(Function<? super T,? extends V> groupBy,
                                                FloatFunction<? super T> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByFloat in interface MutableCollection<T>

Specified by:

sumByFloat in interface RichIterable<T>

Overrides:

sumByFloat in class AbstractMutableCollection<T>

sumByDouble

public <V> MutableObjectDoubleMap<V> sumByDouble(Function<? super T,? extends V> groupBy,
                                                 DoubleFunction<? super T> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByDouble in interface MutableCollection<T>

Specified by:

sumByDouble in interface RichIterable<T>

Overrides:

sumByDouble in class AbstractMutableCollection<T>

injectIntoWith

public <IV,P> IV injectIntoWith(IV injectValue,
                                Function3<? super IV,? super T,? super P,? extends IV> function,
                                P parameter)

Specified by:

injectIntoWith in interface MutableCollection<T>

Overrides:

injectIntoWith in class AbstractMutableList<T>

toList

public FastList<T> toList()

Description copied from interface: RichIterable

Converts the collection to a MutableList implementation.

Specified by:

toList in interface RichIterable<T>

Overrides:

toList in class AbstractMutableList<T>

toSortedList

public FastList<T> toSortedList()

Description copied from interface: RichIterable

Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.

Specified by:

toSortedList in interface RichIterable<T>

Overrides:

toSortedList in class AbstractMutableList<T>

toSortedList

public FastList<T> toSortedList(Comparator<? super T> comparator)

Description copied from interface: RichIterable

Converts the collection to a MutableList implementation and sorts it using the specified comparator.

Specified by:

toSortedList in interface RichIterable<T>

Overrides:

toSortedList in class AbstractMutableList<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>

Overrides:

takeWhile in class AbstractMutableList<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>

Overrides:

dropWhile in class AbstractMutableList<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>

Overrides:

partitionWhile in class AbstractMutableList<T>

equals

public boolean equals(Object that)

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

fastListEquals

public boolean fastListEquals(FastList<?> that)

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

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException