com.gs.collections.impl.lazy

Class AbstractLazyIterable<T>

java.lang.Object

com.gs.collections.impl.lazy.AbstractLazyIterable<T>

All Implemented Interfaces:

InternalIterable<T>, LazyIterable<T>, RichIterable<T>, Iterable<T>

Direct Known Subclasses:

ChunkIterable, CollectBooleanToObjectIterable, CollectByteToObjectIterable, CollectCharToObjectIterable, CollectDoubleToObjectIterable, CollectFloatToObjectIterable, CollectIntToObjectIterable, CollectIterable, CollectLongToObjectIterable, CollectShortToObjectIterable, CompositeIterable, DistinctIterable, DropIterable, FlatCollectIterable, Interval, LazyIterableAdapter, RejectIterable, ReverseIterable, SelectInstancesOfIterable, SelectIterable, TakeIterable, ZipIterable, ZipWithIndexIterable

@Immutable
public abstract class AbstractLazyIterable<T>
extends Object
implements LazyIterable<T>

AbstractLazyIterable provides a base from which deferred iterables such as SelectIterable, RejectIterable and CollectIterable can be derived.

Constructor Summary

Constructors

Constructor and Description
AbstractLazyIterable()

Method Summary

Modifier and Type	Method and Description
<K,V> MapIterable<K,V>	aggregateBy(Function<? super T,? extends K> groupBy, Function0<? extends V> zeroValueFactory, Function2<? super V,? super T,? extends V> nonMutatingAggregator) Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function.
<K,V> MapIterable<K,V>	aggregateInPlaceBy(Function<? super T,? extends K> groupBy, Function0<? extends V> zeroValueFactory, Procedure2<? super V,? super T> mutatingAggregator) Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function.
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).
LazyIterable<RichIterable<T>>	chunk(int size) Creates a deferred chunking iterable.
<V> LazyIterable<V>	collect(Function<? super T,? extends V> function) Creates a deferred iterable for collecting elements from the current iterable.
<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.
LazyBooleanIterable	collectBoolean(BooleanFunction<? super T> booleanFunction) Returns a lazy BooleanIterable which will transform the underlying iterable data to boolean values based on the booleanFunction.
<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.
LazyByteIterable	collectByte(ByteFunction<? super T> byteFunction) Returns a lazy ByteIterable which will transform the underlying iterable data to byte values based on the byteFunction.
<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.
LazyCharIterable	collectChar(CharFunction<? super T> charFunction) Returns a lazy CharIterable which will transform the underlying iterable data to char values based on the charFunction.
<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.
LazyDoubleIterable	collectDouble(DoubleFunction<? super T> doubleFunction) Returns a lazy DoubleIterable which will transform the underlying iterable data to double values based on the doubleFunction.
<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.
LazyFloatIterable	collectFloat(FloatFunction<? super T> floatFunction) Returns a lazy FloatIterable which will transform the underlying iterable data to float values based on the floatFunction.
<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> LazyIterable<V>	collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function) Creates a deferred iterable for selecting and collecting elements from the current iterable.
<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.
LazyIntIterable	collectInt(IntFunction<? super T> intFunction) Returns a lazy IntIterable which will transform the underlying iterable data to int values based on the intFunction.
<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.
LazyLongIterable	collectLong(LongFunction<? super T> longFunction) Returns a lazy LongIterable which will transform the underlying iterable data to long values based on the longFunction.
<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.
LazyShortIterable	collectShort(ShortFunction<? super T> shortFunction) Returns a lazy ShortIterable which will transform the underlying iterable data to short values based on the shortFunction.
<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> LazyIterable<V>	collectWith(Function2<? super T,? super P,? extends V> function, P parameter) Same as collect 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 targetCollection) Same as collectWith but with a targetCollection parameter to gather the results.
LazyIterable<T>	concatenate(Iterable<T> iterable) Creates a deferred iterable that will join this iterable with the specified iterable.
boolean	contains(Object object) Returns true if the iterable has an element which responds true to element.equals(object).
boolean	containsAll(Collection<?> source) 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.
<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.
LazyIterable<T>	distinct() Creates a deferred distinct iterable to get distinct elements from the current iterable.
LazyIterable<T>	drop(int count) Creates a deferred drop iterable for the current iterable using the specified count as the limit.
<V> LazyIterable<V>	flatCollect(Function<? super T,? extends Iterable<V>> function) Creates a deferred flattening iterable for the current iterable.
<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.
T	getFirst() Returns the first element of an iterable.
T	getLast() Returns the last element of an iterable.
<V> ImmutableMultimap<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> ImmutableMultimap<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.
<V> MapIterable<V,T>	groupByUniqueKey(Function<? super T,? extends V> 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.
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.
<R extends Collection<T>> R	into(R target) Iterates over this iterable adding all elements into the 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.
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()
PartitionMutableList<T>	partition(Predicate<? super T> predicate) Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
<P> PartitionMutableList<T>	partitionWith(Predicate2<? super T,? super P> predicate, P parameter) Filters a collection into a PartitionIterable based on the evaluation of the predicate.
LazyIterable<T>	reject(Predicate<? super T> predicate) Creates a deferred iterable for rejecting elements from the current iterable.
<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> LazyIterable<T>	rejectWith(Predicate2<? super T,? super P> predicate, P parameter) Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
<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.
LazyIterable<T>	select(Predicate<? super T> predicate) Creates a deferred iterable for selecting elements from the current 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.
<S> LazyIterable<S>	selectInstancesOf(Class<S> clazz) Returns all elements of the source collection that are instances of the Class clazz.
<P> LazyIterable<T>	selectWith(Predicate2<? super T,? super P> predicate, P parameter) Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
<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.
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.
LazyIterable<T>	take(int count) Creates a deferred take iterable for the current iterable using the specified count as the limit.
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.
MutableBag<T>	toBag() Converts the collection to the default MutableBag implementation.
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.
MutableSet<T>	toSet() Converts the collection to a MutableSet implementation.
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.
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.
MutableStack<T>	toStack()
String	toString() Returns a string representation of this RichIterable.
<S> LazyIterable<Pair<T,S>>	zip(Iterable<S> that) Creates a deferred zip iterable.
<S,R extends Collection<Pair<T,S>>> R	zip(Iterable<S> that, R target) Same as RichIterable.zip(Iterable) but uses target for output.
LazyIterable<Pair<T,Integer>>	zipWithIndex() Creates a deferred zipWithIndex iterable.
<R extends Collection<Pair<T,Integer>>> R	zipWithIndex(R target) Same as RichIterable.zipWithIndex() but uses target for output.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.gs.collections.api.InternalIterable

forEach, forEachWith, forEachWithIndex

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Constructor Detail

AbstractLazyIterable

public AbstractLazyIterable()

Method Detail

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>

into

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

Description copied from interface: LazyIterable

Iterates over this iterable adding all elements into the target collection.

Specified by:

into in interface LazyIterable<T>

toString

public String toString()

Description copied from interface: RichIterable

Returns a string representation of this RichIterable. The string representation consists of a list of the RichIterable's elements in the order they are returned by its iterator, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space). Elements are converted to strings as by String.valueOf(Object).

Specified by:

toString in interface RichIterable<T>

Overrides:

toString in class Object

Returns:

a string representation of this RichIterable

toArray

public Object[] toArray()

Description copied from interface: RichIterable

Converts this iterable to an array.

Specified by:

toArray in interface RichIterable<T>

See Also:

Collection.toArray()

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

See Also:

Collection.toArray(Object[])

contains

public boolean contains(Object object)

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

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>

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

See Also:

Collection.containsAll(Collection)

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>

size

public int size()

Description copied from interface: RichIterable

Returns the number of items in this iterable.

Specified by:

size in interface RichIterable<T>

isEmpty

public boolean isEmpty()

Description copied from interface: RichIterable

Returns true if this iterable has zero items.

Specified by:

isEmpty in interface RichIterable<T>

notEmpty

public boolean notEmpty()

Description copied from interface: RichIterable

The English equivalent of !this.isEmpty()

Specified by:

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

select

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

Description copied from interface: LazyIterable

Creates a deferred iterable for selecting elements from the current iterable.

Specified by:

select in interface LazyIterable<T>

Specified by:

select in interface RichIterable<T>

selectWith

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

Description copied from interface: RichIterable

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

Specified by:

selectWith in interface LazyIterable<T>

Specified by:

selectWith in interface RichIterable<T>

Parameters:

predicate - a Predicate2 to use as the select criteria

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

See Also:

RichIterable.select(Predicate)

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.

e.g.
 return people.select(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.person.getLastName().equals("Smith");
     }
 }, Lists.mutable.of());
 

e.g.
 return collection.select(Predicates.attributeEqual("lastName", "Smith"), new ArrayList());
 

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)

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.

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)

reject

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

Description copied from interface: LazyIterable

Creates a deferred iterable for rejecting elements from the current iterable.

Specified by:

reject in interface LazyIterable<T>

Specified by:

reject in interface RichIterable<T>

Parameters:

predicate - a Predicate to use as the reject criteria

Returns:

a RichIterable that contains elements that cause Predicate.accept(Object) method to evaluate to false

rejectWith

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

Description copied from interface: RichIterable

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

Specified by:

rejectWith in interface LazyIterable<T>

Specified by:

rejectWith in interface RichIterable<T>

Parameters:

predicate - a Predicate2 to use as the select criteria

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

See Also:

RichIterable.select(Predicate)

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.

e.g.
 return people.reject(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.person.getLastName().equals("Smith");
     }
 }, Lists.mutable.of());
 

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 a height greater than 100cm

 return people.reject(new Predicate2<Person, Integer>()
 {
     public boolean accept(Person p, Integer i)
     {
         return p.getHeightInCm() < i.intValue();
     }
 }, Integer.valueOf(100), FastList.newList());
 

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)

partition

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

Description copied from interface: RichIterable

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

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

Specified by:

partition in interface RichIterable<T>

partitionWith

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

Description copied from interface: RichIterable

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

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

Specified by:

partitionWith in interface RichIterable<T>

selectInstancesOf

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

Description copied from interface: RichIterable

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

Specified by:

selectInstancesOf in interface LazyIterable<T>

Specified by:

selectInstancesOf in interface RichIterable<T>

collect

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

Description copied from interface: LazyIterable

Creates a deferred iterable for collecting elements from the current iterable.

Specified by:

collect in interface LazyIterable<T>

Specified by:

collect in interface RichIterable<T>

collectBoolean

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

Description copied from interface: LazyIterable

Returns a lazy BooleanIterable which will transform the underlying iterable data to boolean values based on the booleanFunction.

Specified by:

collectBoolean in interface LazyIterable<T>

Specified by:

collectBoolean in interface RichIterable<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.

e.g.
 return people.collectBoolean(new BooleanFunction<Person>()
 {
     public boolean booleanValueOf(Person person)
     {
         return 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 LazyByteIterable collectByte(ByteFunction<? super T> byteFunction)

Description copied from interface: LazyIterable

Returns a lazy ByteIterable which will transform the underlying iterable data to byte values based on the byteFunction.

Specified by:

collectByte in interface LazyIterable<T>

Specified by:

collectByte in interface RichIterable<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.

e.g.
 return people.collectByte(new ByteFunction<Person>()
 {
     public byte byteValueOf(Person person)
     {
         return 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 LazyCharIterable collectChar(CharFunction<? super T> charFunction)

Description copied from interface: LazyIterable

Returns a lazy CharIterable which will transform the underlying iterable data to char values based on the charFunction.

Specified by:

collectChar in interface LazyIterable<T>

Specified by:

collectChar in interface RichIterable<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.

e.g.
 return people.collectChar(new CharFunction<Person>()
 {
     public char charValueOf(Person person)
     {
         return 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 LazyDoubleIterable collectDouble(DoubleFunction<? super T> doubleFunction)

Description copied from interface: LazyIterable

Returns a lazy DoubleIterable which will transform the underlying iterable data to double values based on the doubleFunction.

Specified by:

collectDouble in interface LazyIterable<T>

Specified by:

collectDouble in interface RichIterable<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.

e.g.
 return people.collectDouble(new DoubleFunction<Person>()
 {
     public double doubleValueOf(Person person)
     {
         return 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 LazyFloatIterable collectFloat(FloatFunction<? super T> floatFunction)

Description copied from interface: LazyIterable

Returns a lazy FloatIterable which will transform the underlying iterable data to float values based on the floatFunction.

Specified by:

collectFloat in interface LazyIterable<T>

Specified by:

collectFloat in interface RichIterable<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.

e.g.
 return people.collectFloat(new FloatFunction<Person>()
 {
     public float floatValueOf(Person person)
     {
         return 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 LazyIntIterable collectInt(IntFunction<? super T> intFunction)

Description copied from interface: LazyIterable

Returns a lazy IntIterable which will transform the underlying iterable data to int values based on the intFunction.

Specified by:

collectInt in interface LazyIterable<T>

Specified by:

collectInt in interface RichIterable<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.

e.g.
 return people.collectInt(new IntFunction<Person>()
 {
     public int intValueOf(Person person)
     {
         return 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 LazyLongIterable collectLong(LongFunction<? super T> longFunction)

Description copied from interface: LazyIterable

Returns a lazy LongIterable which will transform the underlying iterable data to long values based on the longFunction.

Specified by:

collectLong in interface LazyIterable<T>

Specified by:

collectLong in interface RichIterable<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.

e.g.
 return people.collectLong(new LongFunction<Person>()
 {
     public long longValueOf(Person person)
     {
         return 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 LazyShortIterable collectShort(ShortFunction<? super T> shortFunction)

Description copied from interface: LazyIterable

Returns a lazy ShortIterable which will transform the underlying iterable data to short values based on the shortFunction.

Specified by:

collectShort in interface LazyIterable<T>

Specified by:

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

e.g.
 return people.collectShort(new ShortFunction<Person>()
 {
     public short shortValueOf(Person person)
     {
         return 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

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.

e.g.
 return people.collect(new Function<Person, String>()
 {
     public String valueOf(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 }, Lists.mutable.of());
 

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)

collectWith

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

Description copied from interface: RichIterable

Same as collect with a Function2 and specified parameter which is passed to the block

e.g.
 Function2 addParameterFunction =
 new Function2()
 {
      public Integer value(final Integer each, final Integer parameter)
      {
          return each + parameter;
      }
 };
 FastList.newListWith(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
 

Specified by:

collectWith in interface LazyIterable<T>

Specified by:

collectWith in interface RichIterable<T>

Parameters:

function - A Function2 to use as the collect transformation function

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

Returns:

A new RichIterable that contains the transformed elements returned by Function2.value(Object, Object)

See Also:

RichIterable.collect(Function)

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.

e.g.
 Function2 addParameterFunction =
 new Function2()
 {
      public Integer value(final Integer each, final Integer parameter)
      {
          return each + parameter;
      }
 };
 FastList.newListWith(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1), UnifiedSet.newSet());
 

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

flatCollect

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

Description copied from interface: LazyIterable

Creates a deferred flattening iterable for the current iterable.

Specified by:

flatCollect in interface LazyIterable<T>

Specified by:

flatCollect in interface RichIterable<T>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

concatenate

public LazyIterable<T> concatenate(Iterable<T> iterable)

Description copied from interface: LazyIterable

Creates a deferred iterable that will join this iterable with the specified iterable.

Specified by:

concatenate in interface LazyIterable<T>

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> LazyIterable<V> collectIf(Predicate<? super T> predicate,
                                     Function<? super T,? extends V> function)

Description copied from interface: LazyIterable

Creates a deferred iterable for selecting and collecting elements from the current iterable.

Specified by:

collectIf in interface LazyIterable<T>

Specified by:

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

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)

take

public LazyIterable<T> take(int count)

Description copied from interface: LazyIterable

Creates a deferred take iterable for the current iterable using the specified count as the limit.

Specified by:

take in interface LazyIterable<T>

drop

public LazyIterable<T> drop(int count)

Description copied from interface: LazyIterable

Creates a deferred drop iterable for the current iterable using the specified count as the limit.

Specified by:

drop in interface LazyIterable<T>

distinct

public LazyIterable<T> distinct()

Description copied from interface: LazyIterable

Creates a deferred distinct iterable to get distinct elements from the current iterable.

Specified by:

distinct in interface LazyIterable<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.

e.g.
 return people.detect(new Predicate<Person>()
 {
     public boolean value(Person person)
     {
         return 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.

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

Specified by:

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

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>

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.

e.g.
 return people.count(new Predicate<Person>()
 {
     public boolean value(Person person)
     {
         return 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(PredicatesLite.equal(), "Smith");
 

Specified by:

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

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>

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>

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>

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>

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>

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.

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.

Specified by:

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

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>

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>

toStack

public MutableStack<T> toStack()

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>

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>

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. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in the start and end strings. Adjacent elements are separated by the separator string. Elements are converted to strings as by String.valueOf(Object).

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>

groupBy

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

Description copied from interface: RichIterable

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

e.g.
 return people.groupBy(new Function<Person, String>()
 {
     public String value(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 });
 

Specified by:

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

e.g.
 return people.groupBy(new Function<Person, String>()
 {
     public String value(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 }, new FastListMultimap<String, Person>());
 

Specified by:

groupBy in interface RichIterable<T>

groupByEach

public <V> ImmutableMultimap<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 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> MapIterable<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 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 RichIterable<T>

See Also:

RichIterable.groupBy(Function)

zip

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

Description copied from interface: LazyIterable

Creates a deferred zip iterable.

Specified by:

zip in interface LazyIterable<T>

Specified by:

zip in interface RichIterable<T>

Type Parameters:

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

Parameters:

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

Returns:

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

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 LazyIterable<Pair<T,Integer>> zipWithIndex()

Description copied from interface: LazyIterable

Creates a deferred zipWithIndex iterable.

Specified by:

zipWithIndex in interface LazyIterable<T>

Specified by:

zipWithIndex in interface RichIterable<T>

Returns:

A new RichIterable containing pairs consisting of all elements of this RichIterable paired with their index. Indices start at 0.

See Also:

RichIterable.zip(Iterable)

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 LazyIterable<RichIterable<T>> chunk(int size)

Description copied from interface: LazyIterable

Creates a deferred chunking iterable.

Specified by:

chunk in interface LazyIterable<T>

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.

aggregateInPlaceBy

public <K,V> MapIterable<K,V> aggregateInPlaceBy(Function<? super T,? extends K> groupBy,
                                                 Function0<? extends V> zeroValueFactory,
                                                 Procedure2<? super V,? super T> mutatingAggregator)

Description copied from interface: RichIterable

Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function. Aggregate results are required to be mutable as they will be changed in place by the procedure. A second function specifies the initial "zero" aggregate value to work with (i.e. new AtomicInteger(0)).

Specified by:

aggregateInPlaceBy in interface RichIterable<T>

aggregateBy

public <K,V> MapIterable<K,V> aggregateBy(Function<? super T,? extends K> groupBy,
                                          Function0<? extends V> zeroValueFactory,
                                          Function2<? super V,? super T,? extends V> nonMutatingAggregator)

Description copied from interface: RichIterable

Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function. Aggregate results are allowed to be immutable as they will be replaced in place in the map. A second function specifies the initial "zero" aggregate value to work with (i.e. Integer.valueOf(0)).

Specified by:

aggregateBy in interface RichIterable<T>