Class AbstractMultiReaderMutableCollection.UntouchableMutableCollection<T>

java.lang.Object

org.eclipse.collections.impl.collection.mutable.AbstractMultiReaderMutableCollection.UntouchableMutableCollection<T>

All Implemented Interfaces:

Iterable<T>, Collection<T>, MutableCollection<T>, InternalIterable<T>, RichIterable<T>

Direct Known Subclasses:

MultiReaderFastList.UntouchableMutableList, MultiReaderHashBag.UntouchableMutableBag, MultiReaderUnifiedSet.UntouchableMutableSet

Enclosing class:

AbstractMultiReaderMutableCollection<T>

protected abstract static class AbstractMultiReaderMutableCollection.UntouchableMutableCollection<T>
extends Object
implements MutableCollection<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected MutableCollection<T>	delegate

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UntouchableMutableCollection(MutableCollection<T> delegate)

Method Summary

Modifier and Type	Method	Description
boolean	add(T o)
boolean	addAll(Collection<? extends T> collection)
boolean	addAllIterable(Iterable<? extends T> iterable)
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)	Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String separator)	Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String start, String separator, String end)	Prints a string representation of this collection onto the given Appendable.
LazyIterable<T>	asLazy()	Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).
RichIterable<RichIterable<T>>	chunk(int size)	Partitions elements in fixed size chunks.
void	clear()
<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.
final <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.
final <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.
final <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.
final <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.
final <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, 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.
final <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.
final <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.
final <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, R extends Collection<V>> R	collectWith(Function2<? super T, ? super P, ? extends V> function, P parameter, R targetCollection)	Same as collectWith but with a targetCollection parameter to gather the results.
boolean	contains(Object o)	Returns true if the iterable has an element which responds true to element.equals(object).
boolean	containsAll(Collection<?> collection)	Returns true if all elements in source are contained in this collection.
boolean	containsAllArguments(Object... elements)	Returns true if all elements in the specified var arg array are contained in this collection.
boolean	containsAllIterable(Iterable<?> source)	Returns true if all elements in source are contained in this collection.
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.
T	detectIfNone(Predicate<? super T> predicate, Function0<? extends T> function)	Returns the first element of the iterable 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> T	detectWithIfNone(Predicate2<? super T, ? super P> predicate, P parameter, Function0<? extends T> function)	Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or returns the value of evaluating the specified function.
<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.
void	each(Procedure<? super T> procedure)	The procedure is executed for each element in the iterable.
boolean	equals(Object o)
<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.
final <R extends MutableBooleanCollection> R	flatCollectBoolean(Function<? super T, ? extends BooleanIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
final <R extends MutableByteCollection> R	flatCollectByte(Function<? super T, ? extends ByteIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
final <R extends MutableCharCollection> R	flatCollectChar(Function<? super T, ? extends CharIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
final <R extends MutableDoubleCollection> R	flatCollectDouble(Function<? super T, ? extends DoubleIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
final <R extends MutableFloatCollection> R	flatCollectFloat(Function<? super T, ? extends FloatIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
final <R extends MutableIntCollection> R	flatCollectInt(Function<? super T, ? extends IntIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
final <R extends MutableLongCollection> R	flatCollectLong(Function<? super T, ? extends LongIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
final <R extends MutableShortCollection> R	flatCollectShort(Function<? super T, ? extends ShortIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<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(ObjectIntProcedure<? super T> objectIntProcedure)	Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure.
protected abstract MutableCollection<T>	getDelegate()
T	getFirst()	Returns the first element of an iterable.
T	getLast()	Returns the last element of an iterable.
T	getOnly()	Returns the element if the iterable has exactly one element.
<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, 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.
<V> MutableMap<V,T>	groupByUniqueKey(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 map, where the transformed value is the key.
<V, R extends MutableMapIterable<V,T>> R	groupByUniqueKey(Function<? super T, ? extends V> function, R target)	Same as RichIterable.groupByUniqueKey(Function), except that the results are gathered into the specified target map.
int	hashCode()
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.
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> 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.
<IV,P> IV	injectIntoWith(IV injectValue, Function3<? super IV, ? super T, ? super P, ? extends IV> function, P parameter)	Returns the final result of evaluating function using each element of the iterable, the previous evaluation result and the parameters.
<R extends Collection<T>> R	into(R target)	Adds all the elements in this iterable to the specific target Collection.
boolean	isEmpty()	Returns true if this iterable has zero items.
String	makeString()	Returns a string representation of this collection by delegating to RichIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
String	makeString(String separator)	Returns a string representation of this collection by delegating to RichIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).
String	makeString(String start, String separator, String end)	Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.
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.
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.
boolean	notEmpty()	The English equivalent of !this.isEmpty()
<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, R extends Collection<T>> R	rejectWith(Predicate2<? super T, ? super P> predicate, P parameter, R targetCollection)	Similar to RichIterable.reject(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
boolean	remove(Object o)
boolean	removeAll(Collection<?> collection)
boolean	removeAllIterable(Iterable<?> iterable)
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.
boolean	retainAll(Collection<?> collection)
boolean	retainAllIterable(Iterable<?> iterable)
<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.
<P, R extends Collection<T>> R	selectWith(Predicate2<? super T, ? super P> predicate, P parameter, R targetCollection)	Similar to RichIterable.select(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
int	size()	Returns the number of items in this iterable.
<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.
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.
Object[]	toArray()	Converts this iterable to an array.
<E> E[]	toArray(E[] a)	Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.
MutableBag<T>	toBag()	Converts the collection to the default MutableBag implementation.
<NK,NV> MutableBiMap<NK,NV>	toBiMap(Function<? super T, ? extends NK> keyFunction, Function<? super T, ? extends NV> valueFunction)	Converts the collection to a BiMap implementation using the specified key and value functions.
MutableList<T>	toList()	Converts the collection to a MutableList implementation.
<NK,NV> MutableMap<NK,NV>	toMap(Function<? super T, ? extends NK> keyFunction, Function<? super T, ? extends NV> valueFunction)	Converts the collection to a MutableMap implementation using the specified key and value functions.
<NK, NV, R extends Map<NK,NV>> R	toMap(Function<? super T, ? extends NK> keyFunction, Function<? super T, ? extends NV> valueFunction, R target)	Same as RichIterable.toMap(Function, Function), except that the results are gathered into the specified target map.
MutableSet<T>	toSet()	Converts the collection to a MutableSet implementation.
MutableSortedBag<T>	toSortedBag()	Converts the collection to a MutableSortedBag implementation and sorts it using the natural order of the elements.
MutableSortedBag<T>	toSortedBag(Comparator<? super T> comparator)	Converts the collection to the MutableSortedBag implementation and sorts it using the specified comparator.
<V extends Comparable<? super V>> MutableSortedBag<T>	toSortedBagBy(Function<? super T, ? extends V> function)	Converts the collection to a MutableSortedBag implementation and sorts it based on the natural order of the attribute returned by function.
MutableList<T>	toSortedList()	Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.
MutableList<T>	toSortedList(Comparator<? super T> comparator)	Converts the collection to a MutableList implementation and sorts it using the specified comparator.
<V extends Comparable<? super V>> MutableList<T>	toSortedListBy(Function<? super T, ? extends V> function)	Converts the collection to a MutableList implementation and sorts it based on the natural order of the attribute returned by function.
<NK,NV> MutableSortedMap<NK,NV>	toSortedMap(Comparator<? super NK> comparator, Function<? super T, ? extends NK> keyFunction, Function<? super T, ? extends NV> valueFunction)	Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the given comparator.
<NK,NV> MutableSortedMap<NK,NV>	toSortedMap(Function<? super T, ? extends NK> keyFunction, Function<? super T, ? extends NV> valueFunction)	Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the key elements' natural ordering.
<KK extends Comparable<? super KK>, NK, NV> MutableSortedMap<NK,NV>	toSortedMapBy(Function<? super NK, KK> sortBy, Function<? super T, ? extends NK> keyFunction, Function<? super T, ? extends NV> valueFunction)	Converts the collection to a MutableSortedMap implementation using the specified key and value functions and sorts it based on the natural order of the attribute returned by sortBy function.
MutableSortedSet<T>	toSortedSet()	Converts the collection to a MutableSortedSet implementation and sorts it using the natural order of the elements.
MutableSortedSet<T>	toSortedSet(Comparator<? super T> comparator)	Converts the collection to a MutableSortedSet implementation and sorts it using the specified comparator.
<V extends Comparable<? super V>> MutableSortedSet<T>	toSortedSetBy(Function<? super T, ? extends V> function)	Converts the collection to a MutableSortedSet implementation and sorts it based on the natural order of the attribute returned by function.
String	toString()	Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.
<S, R extends Collection<Pair<T,S>>> R	zip(Iterable<S> that, R target)	Same as RichIterable.zip(Iterable) but uses target for output.
<R extends Collection<Pair<T,Integer>>> R	zipWithIndex(R target)	Same as RichIterable.zipWithIndex() but uses target for output.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Collection

iterator, parallelStream, removeIf, spliterator, stream, toArray

Methods inherited from interface InternalIterable

forEach

Methods inherited from interface MutableCollection

aggregateBy, aggregateInPlaceBy, asSynchronized, asUnmodifiable, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, countBy, countByEach, countByWith, flatCollect, flatCollectWith, groupBy, groupByEach, newEmpty, partition, partitionWith, reject, rejectWith, select, selectInstancesOf, selectWith, tap, toImmutable, with, withAll, without, withoutAll, zip, zipWithIndex

Methods inherited from interface RichIterable

aggregateBy, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, countBy, countByEach, countByWith, flatCollectWith, forEach, getAny, groupByAndCollect, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, makeString, maxByOptional, maxOptional, maxOptional, minByOptional, minOptional, minOptional, reduce, reduceBy, reduceBy, reduceInPlace, reduceInPlace, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy

Field Details

delegate

protected MutableCollection<T> delegate

Constructor Details

UntouchableMutableCollection

protected UntouchableMutableCollection(MutableCollection<T> delegate)

Method Details

getDelegate

protected abstract MutableCollection<T> getDelegate()

asLazy

public LazyIterable<T> asLazy()

Description copied from interface: RichIterable

Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).

Specified by:

asLazy in interface RichIterable<T>

collectBoolean

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

Specified by:

collectBoolean in interface RichIterable<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 final <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());

Specified by:

collectByte in interface RichIterable<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 final <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());

Specified by:

collectChar in interface RichIterable<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 final <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());

Specified by:

collectDouble in interface RichIterable<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 final <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());

Specified by:

collectFloat in interface RichIterable<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 final <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());

Specified by:

collectInt in interface RichIterable<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 final <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());

Specified by:

collectLong in interface RichIterable<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 final <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());

Specified by:

collectShort in interface RichIterable<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

flatCollectBoolean

public final <R extends MutableBooleanCollection> R flatCollectBoolean(Function<? super T, ? extends BooleanIterable> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

flatCollectBoolean in interface RichIterable<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)

flatCollectByte

public final <R extends MutableByteCollection> R flatCollectByte(Function<? super T, ? extends ByteIterable> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

flatCollectByte in interface RichIterable<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)

flatCollectChar

public final <R extends MutableCharCollection> R flatCollectChar(Function<? super T, ? extends CharIterable> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

flatCollectChar in interface RichIterable<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)

flatCollectDouble

public final <R extends MutableDoubleCollection> R flatCollectDouble(Function<? super T, ? extends DoubleIterable> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

flatCollectDouble in interface RichIterable<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)

flatCollectFloat

public final <R extends MutableFloatCollection> R flatCollectFloat(Function<? super T, ? extends FloatIterable> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

flatCollectFloat in interface RichIterable<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)

flatCollectInt

public final <R extends MutableIntCollection> R flatCollectInt(Function<? super T, ? extends IntIterable> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

flatCollectInt in interface RichIterable<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)

flatCollectLong

public final <R extends MutableLongCollection> R flatCollectLong(Function<? super T, ? extends LongIterable> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

flatCollectLong in interface RichIterable<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)

flatCollectShort

public final <R extends MutableShortCollection> R flatCollectShort(Function<? super T, ? extends ShortIterable> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

flatCollectShort in interface RichIterable<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)

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>

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>

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>

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>

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>

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>

into

public <R extends Collection<T>> R into(R target)

Description copied from interface: RichIterable

Adds all the elements in this iterable to the specific target Collection.

Specified by:

into in interface RichIterable<T>

toList

public MutableList<T> toList()

Description copied from interface: RichIterable

Converts the collection to a MutableList implementation.

Specified by:

toList in interface RichIterable<T>

toMap

public <NK,NV> MutableMap<NK,NV> toMap(Function<? super T, ? extends NK> keyFunction,
 Function<? super T, ? extends NV> valueFunction)

Description copied from interface: RichIterable

Converts the collection to a MutableMap implementation using the specified key and value functions.

Specified by:

toMap in interface RichIterable<T>

toMap

public <NK, NV, R extends Map<NK,NV>> R toMap(Function<? super T, ? extends NK> keyFunction,
 Function<? super T, ? extends NV> valueFunction,
 R target)

Description copied from interface: RichIterable

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

Specified by:

toMap in interface RichIterable<T>

toSortedMap

public <NK,NV> MutableSortedMap<NK,NV> toSortedMap(Function<? super T, ? extends NK> keyFunction,
 Function<? super T, ? extends NV> valueFunction)

Description copied from interface: RichIterable

Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the key elements' natural ordering.

Specified by:

toSortedMap in interface RichIterable<T>

toSortedMap

public <NK,NV> MutableSortedMap<NK,NV> toSortedMap(Comparator<? super NK> comparator,
 Function<? super T, ? extends NK> keyFunction,
 Function<? super T, ? extends NV> valueFunction)

Description copied from interface: RichIterable

Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the given comparator.

Specified by:

toSortedMap in interface RichIterable<T>

toSortedMapBy

public <KK extends Comparable<? super KK>, NK, NV>
MutableSortedMap<NK,NV> toSortedMapBy(Function<? super NK, KK> sortBy,
 Function<? super T, ? extends NK> keyFunction,
 Function<? super T, ? extends NV> valueFunction)

Description copied from interface: RichIterable

Converts the collection to a MutableSortedMap implementation using the specified key and value functions and sorts it based on the natural order of the attribute returned by sortBy function.

Specified by:

toSortedMapBy in interface RichIterable<T>

toBiMap

public <NK,NV> MutableBiMap<NK,NV> toBiMap(Function<? super T, ? extends NK> keyFunction,
 Function<? super T, ? extends NV> valueFunction)

Description copied from interface: RichIterable

Converts the collection to a BiMap implementation using the specified key and value functions.

Specified by:

toBiMap in interface RichIterable<T>

toSet

public MutableSet<T> toSet()

Description copied from interface: RichIterable

Converts the collection to a MutableSet implementation.

Specified by:

toSet in interface RichIterable<T>

toBag

public MutableBag<T> toBag()

Description copied from interface: RichIterable

Converts the collection to the default MutableBag implementation.

Specified by:

toBag in interface RichIterable<T>

toSortedBag

public MutableSortedBag<T> toSortedBag()

Description copied from interface: RichIterable

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

Specified by:

toSortedBag in interface RichIterable<T>

toSortedBag

public MutableSortedBag<T> toSortedBag(Comparator<? super T> comparator)

Description copied from interface: RichIterable

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

Specified by:

toSortedBag in interface RichIterable<T>

toSortedBagBy

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

Description copied from interface: RichIterable

Converts the collection to a MutableSortedBag implementation and sorts it based on the natural order of the attribute returned by function.

Specified by:

toSortedBagBy in interface RichIterable<T>

toSortedList

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

toSortedList

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

toSortedListBy

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

Description copied from interface: RichIterable

Converts the collection to a MutableList implementation and sorts it based on the natural order of the attribute returned by function.

Specified by:

toSortedListBy in interface RichIterable<T>

toSortedSet

public MutableSortedSet<T> toSortedSet()

Description copied from interface: RichIterable

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

Specified by:

toSortedSet in interface RichIterable<T>

toSortedSet

public MutableSortedSet<T> toSortedSet(Comparator<? super T> comparator)

Description copied from interface: RichIterable

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

Specified by:

toSortedSet in interface RichIterable<T>

toSortedSetBy

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

Description copied from interface: RichIterable

Converts the collection to a MutableSortedSet implementation and sorts it based on the natural order of the attribute returned by function.

Specified by:

toSortedSetBy in interface RichIterable<T>

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

Specified by:

collect in interface RichIterable<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, 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>

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)

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>

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)

collectWith

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

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

Specified by:

collectWith in interface RichIterable<T>

Parameters:

function - a Function2 to use as the collect transformation function

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

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

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

Specified by:

groupBy in interface RichIterable<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>

groupByUniqueKey

public <V, R extends MutableMapIterable<V,T>> R groupByUniqueKey(Function<? super T, ? extends V> 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>

See Also:

• RichIterable.groupByUniqueKey(Function)

groupByUniqueKey

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

Description copied from interface: RichIterable

For each element of the iterable, the function is evaluated, and the results of these evaluations are collected into a new 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>

See Also:

• RichIterable.groupBy(Function)

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

Specified by:

count in interface RichIterable<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>

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

Specified by:

detect in interface RichIterable<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");

Specified by:

detectWith in interface RichIterable<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>

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>

detectIfNone

public T detectIfNone(Predicate<? super T> predicate,
 Function0<? extends T> function)

Description copied from interface: RichIterable

Returns the first element of the iterable for which the predicate evaluates to true. If no element matches the predicate, then returns the value of applying the specified function.

Specified by:

detectIfNone in interface RichIterable<T>

detectWithIfNone

public <P> T detectWithIfNone(Predicate2<? super T, ? super P> predicate,
 P parameter,
 Function0<? extends T> function)

Description copied from interface: RichIterable

Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or returns the value of evaluating the specified function.

Specified by:

detectWithIfNone in interface RichIterable<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>

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>

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

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>

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

getOnly

public T getOnly()

Description copied from interface: RichIterable

Returns the element if the iterable has exactly one element. Otherwise, throw IllegalStateException.

Specified by:

getOnly in interface RichIterable<T>

Returns:

an element of an iterable.

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

injectIntoWith

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

Description copied from interface: MutableCollection

Returns the final result of evaluating function using each element of the iterable, the previous evaluation result and 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. The parameter value is always used as the third parameter to the function call.

Specified by:

injectIntoWith in interface MutableCollection<T>

See Also:

• RichIterable.injectInto(Object, Function2)

notEmpty

public boolean notEmpty()

Description copied from interface: RichIterable

The English equivalent of !this.isEmpty()

Specified by:

notEmpty in interface RichIterable<T>

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

Specified by:

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

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

Specified by:

rejectWith in interface RichIterable<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

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

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>

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>

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

Specified by:

select in interface RichIterable<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)

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>

selectWith

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

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

Specified by:

selectWith in interface RichIterable<T>

Parameters:

predicate - a Predicate2 to use as the select criteria

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

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

add

public boolean add(T o)

Specified by:

add in interface Collection<T>

addAll

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

Specified by:

addAll in interface Collection<T>

addAllIterable

public boolean addAllIterable(Iterable<? extends T> iterable)

Specified by:

addAllIterable in interface MutableCollection<T>

See Also:

• Collection.addAll(Collection)

clear

public void clear()

Specified by:

clear in interface Collection<T>

contains

public boolean contains(Object o)

Description copied from interface: RichIterable

Returns true if the iterable has an element which responds true to element.equals(object).

Specified by:

contains in interface Collection<T>

Specified by:

contains in interface RichIterable<T>

containsAll

public boolean containsAll(Collection<?> collection)

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

See Also:

• Collection.containsAll(Collection)

containsAllIterable

public boolean containsAllIterable(Iterable<?> source)

Description copied from interface: RichIterable

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

Specified by:

containsAllIterable in interface RichIterable<T>

containsAllArguments

public boolean containsAllArguments(Object... elements)

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>

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<T>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<T>

Overrides:

hashCode in class Object

isEmpty

public boolean isEmpty()

Description copied from interface: RichIterable

Returns true if this iterable has zero items.

Specified by:

isEmpty in interface Collection<T>

Specified by:

isEmpty in interface RichIterable<T>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<T>

removeAll

public boolean removeAll(Collection<?> collection)

Specified by:

removeAll in interface Collection<T>

removeAllIterable

public boolean removeAllIterable(Iterable<?> iterable)

Specified by:

removeAllIterable in interface MutableCollection<T>

See Also:

• Collection.removeAll(Collection)

retainAll

public boolean retainAll(Collection<?> collection)

Specified by:

retainAll in interface Collection<T>

retainAllIterable

public boolean retainAllIterable(Iterable<?> iterable)

Specified by:

retainAllIterable in interface MutableCollection<T>

See Also:

• Collection.retainAll(Collection)

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

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

Specified by:

toArray in interface RichIterable<T>

See Also:

• Collection.toArray()

toArray

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

Description copied from interface: RichIterable

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

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface MutableCollection<T>

Specified by:

toArray in interface RichIterable<T>

See Also:

• Collection.toArray(Object[])

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

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>

See Also:

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

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

Specified by:

forEachWith in interface InternalIterable<T>

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<Person>()
{
    public void value(Person person, int index)
    {
        LOGGER.info("Index: " + index + " person: " + person.getName());
    }
});

Specified by:

forEachWithIndex in interface InternalIterable<T>

toString

public String toString()

Description copied from interface: RichIterable

Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.

Assert.assertEquals("[]", Lists.mutable.empty().toString());
Assert.assertEquals("[1]", Lists.mutable.with(1).toString());
Assert.assertEquals("[1, 2, 3]", Lists.mutable.with(1, 2, 3).toString());

Specified by:

toString in interface RichIterable<T>

Overrides:

toString in class Object

Returns:

a string representation of this RichIterable

See Also:

• AbstractCollection.toString()

makeString

public String makeString()

Description copied from interface: RichIterable

Returns a string representation of this collection by delegating to RichIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).

Specified by:

makeString in interface RichIterable<T>

Returns:

a string representation of this collection.

makeString

public String makeString(String separator)

Description copied from interface: RichIterable

Returns a string representation of this collection by delegating to RichIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).

Specified by:

makeString in interface RichIterable<T>

Returns:

a string representation of this collection.

makeString

public String makeString(String start,
 String separator,
 String end)

Description copied from interface: RichIterable

Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.

Specified by:

makeString in interface RichIterable<T>

Returns:

a string representation of this collection.

appendString

public void appendString(Appendable appendable)

Description copied from interface: RichIterable

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

Specified by:

appendString in interface RichIterable<T>

appendString

public void appendString(Appendable appendable,
 String separator)

Description copied from interface: RichIterable

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

Specified by:

appendString in interface RichIterable<T>

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>

zip

public <S, R extends Collection<Pair<T,S>>> R zip(Iterable<S> that,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.zip(Iterable) but uses target for output.

Specified by:

zip in interface RichIterable<T>

zipWithIndex

public <R extends Collection<Pair<T,Integer>>> R zipWithIndex(R target)

Description copied from interface: RichIterable

Same as RichIterable.zipWithIndex() but uses target for output.

Specified by:

zipWithIndex in interface RichIterable<T>

chunk

public RichIterable<RichIterable<T>> chunk(int size)

Description copied from interface: RichIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface RichIterable<T>

Parameters:

size - the number of elements per chunk

Returns:

A RichIterable containing RichIterables of size size, except the last will be truncated if the elements don't divide evenly.