com.gs.collections.impl.utility

Class Iterate

java.lang.Object

com.gs.collections.impl.utility.Iterate

public final class Iterate
extends java.lang.Object

The Iterate utility class acts as a router to other utility classes to provide optimized iteration pattern implementations based on the type of iterable. The lowest common denominator used will normally be IterableIterate. Iterate can be used when a JDK interface is the only type available to the developer, as it can determine the best way to iterate based on instanceof checks.

Since:

1.0

Method Summary

Methods

Modifier and Type	Method and Description
static <T> boolean	addAllIterable(java.lang.Iterable<? extends T> iterable, java.util.Collection<T> targetCollection)
static <T,R extends java.util.Collection<T>> R	addAllTo(java.lang.Iterable<? extends T> iterable, R targetCollection) Add all elements from the source Iterable to the target collection, return the target collection
static <T,K,V,M extends java.util.Map<K,V>> M	addToMap(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.Function<? super T,? extends K> keyFunction, com.gs.collections.api.block.function.Function<? super T,? extends V> valueFunction, M map) Iterate over the specified collection applying the specified Functions to each element to calculate a key and value, and return the results as a Map.
static <T,K,V,M extends java.util.Map<K,V>> M	addToMap(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.Function<? super T,? extends K> keyFunction, M map) Iterate over the specified collection applying a specific Function to each element to calculate a key, and return the results as a Map.
static <T,K,V> com.gs.collections.api.map.MutableMap<K,V>	aggregateBy(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.Function<? super T,? extends K> groupBy, com.gs.collections.api.block.function.Function0<? extends V> zeroValueFactory, com.gs.collections.api.block.function.Function2<? super V,? super T,? extends V> nonMutatingAggregator)
static <T,K,V> com.gs.collections.api.map.MutableMap<K,V>	aggregateInPlaceBy(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.Function<? super T,? extends K> groupBy, com.gs.collections.api.block.function.Function0<? extends V> zeroValueFactory, com.gs.collections.api.block.procedure.Procedure2<? super V,? super T> mutatingAggregator)
static <T> boolean	allSatisfy(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns true if the predicate evaluates to true for every element of the iterable, or returns false.
static <T,P> boolean	allSatisfyWith(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Returns true if the predicate evaluates to true for every element of the iterable, or returns false.
static <T> boolean	anySatisfy(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns true if the predicate evaluates to true for any element of the iterable.
static <T,P> boolean	anySatisfyWith(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Returns true if the predicate2 and parameter evaluates to true for any element of the iterable.
static <T> void	appendString(java.lang.Iterable<T> iterable, java.lang.Appendable appendable)
static <T> void	appendString(java.lang.Iterable<T> iterable, java.lang.Appendable appendable, java.lang.String separator)
static <T> void	appendString(java.lang.Iterable<T> iterable, java.lang.Appendable appendable, java.lang.String start, java.lang.String separator, java.lang.String end)
static <T> com.gs.collections.api.RichIterable<com.gs.collections.api.RichIterable<T>>	chunk(java.lang.Iterable<T> iterable, int size)
static <T,A,R extends java.util.Collection<A>> R	collect(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.Function<? super T,? extends A> function, R targetCollection) Same as the collect method with two parameters, except that the results are gathered into the specified targetCollection
static <T,V> java.util.Collection<V>	collect(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.Function<? super T,? extends V> function) Returns a new collection with the results of applying the specified function for each element of the iterable.
static <T> com.gs.collections.api.collection.primitive.MutableBooleanCollection	collectBoolean(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.primitive.BooleanFunction<? super T> booleanFunction) Returns a new collection with the results of applying the specified booleanFunction for each element of the iterable.
static <T> com.gs.collections.api.collection.primitive.MutableByteCollection	collectByte(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.primitive.ByteFunction<? super T> byteFunction) Returns a new collection with the results of applying the specified byteFunction for each element of the iterable.
static <T> com.gs.collections.api.collection.primitive.MutableCharCollection	collectChar(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.primitive.CharFunction<? super T> charFunction) Returns a new collection with the results of applying the specified charFunction for each element of the iterable.
static <T> com.gs.collections.api.collection.primitive.MutableDoubleCollection	collectDouble(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction) Returns a new collection with the results of applying the specified doubleFunction for each element of the iterable.
static <T> com.gs.collections.api.collection.primitive.MutableFloatCollection	collectFloat(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction) Returns a new collection with the results of applying the specified floatFunction for each element of the iterable.
static <T,V> java.util.Collection<V>	collectIf(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function<? super T,? extends V> function)
static <T,V,R extends java.util.Collection<V>> R	collectIf(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function<? super T,? extends V> function, R target)
static <T> com.gs.collections.api.collection.primitive.MutableIntCollection	collectInt(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction) Returns a new collection with the results of applying the specified intFunction for each element of the iterable.
static <T> com.gs.collections.api.collection.primitive.MutableLongCollection	collectLong(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction) Returns a new collection with the results of applying the specified longFunction for each element of the iterable.
static <T> com.gs.collections.api.collection.primitive.MutableShortCollection	collectShort(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.primitive.ShortFunction<? super T> shortFunction) Returns a new collection with the results of applying the specified shortFunction for each element of the iterable.
static <T,P,A> java.util.Collection<A>	collectWith(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.Function2<? super T,? super P,? extends A> function, P parameter) Same as collect with a Function2 and specified parameter which is passed to the function.
static <T,P,A,R extends java.util.Collection<A>> R	collectWith(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.Function2<? super T,? super P,? extends A> function, P parameter, R targetCollection) Same as collectWith but with a targetCollection parameter to gather the results.
static boolean	contains(java.lang.Iterable<?> iterable, java.lang.Object value) Returns true if the iterable contains the value.
static <T> int	count(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns the total number of elements that evaluate to true for the specified predicate.
static <T,IV> int	countWith(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate2<? super T,? super IV> predicate, IV injectedValue) Returns the total number of elements that evaluate to true for the specified predicate2 and parameter.
static <T> T	detect(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns the first element of the iterable that evaluates to true for the specified predicate, or null if no element evaluates to true.
static <T> T	detectIfNone(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate<? super T> predicate, T ifNone) Returns the first element of the iterable that evaluates to true for the specified predicate, or returns the result ifNone if no element evaluates to true.
static <T> int	detectIndex(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Searches for the first occurrence where the predicate evaluates to true.
static <T,P> int	detectIndexWith(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Searches for the first occurrence where the predicate evaluates to true.
static <T,P> T	detectWith(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or null if no element evaluates to true.
static <T,P> T	detectWithIfNone(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter, T ifNone) Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or returns the result ifNone if no element evaluates to true.
static <T> java.util.Collection<T>	drop(java.lang.Iterable<T> iterable, int count) Returns a collection without the first count elements of the iterable or the iterable itself if count is non-positive.
static <T,A,R extends java.util.Collection<A>> R	flatCollect(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<A>> function, R targetCollection)
static <T,V> java.util.Collection<V>	flatCollect(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
static <T> java.util.Collection<T>	flatten(java.lang.Iterable<? extends java.lang.Iterable<T>> iterable) Flattens a collection of collections into one "flat" collection.
static <T,R extends java.util.Collection<T>> R	flatten(java.lang.Iterable<? extends java.lang.Iterable<T>> iterable, R targetCollection) Same as flatten(Iterable) except that the results are gathered into the specified targetCollection.
static <T> void	forEach(java.lang.Iterable<T> iterable, com.gs.collections.api.block.procedure.Procedure<? super T> procedure) The procedure is evaluated for each element of the iterable.
static <T,P> void	forEachWith(java.lang.Iterable<T> iterable, com.gs.collections.api.block.procedure.Procedure2<? super T,? super P> procedure, P parameter) The procedure2 is evaluated for each element of the iterable with the specified parameter passed as the second argument.
static <T> void	forEachWithIndex(java.lang.Iterable<T> iterable, com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure) Iterates over a collection passing each element and the current relative int index to the specified instance of ObjectIntProcedure.
static <T> T	getFirst(java.lang.Iterable<T> iterable) Returns the first element of a collection.
static <T> T	getLast(java.lang.Iterable<T> iterable) Returns the last element of a collection.
static <T> T	getOnly(java.lang.Iterable<T> iterable)
static <T,V> com.gs.collections.api.multimap.MutableMultimap<V,T>	groupBy(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.Function<? super T,? extends V> function)
static <T,V,R extends com.gs.collections.api.multimap.MutableMultimap<V,T>> R	groupBy(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.Function<? super T,? extends V> function, R targetMultimap)
static <T,V> com.gs.collections.api.multimap.MutableMultimap<V,T>	groupByEach(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
static <T,V,R extends com.gs.collections.api.multimap.MutableMultimap<V,T>> R	groupByEach(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function, R targetCollection)
static <T> double	injectInto(double injectValue, java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.primitive.DoubleObjectToDoubleFunction<? super T> function)
static <T> float	injectInto(float injectValue, java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.primitive.FloatObjectToFloatFunction<? super T> function)
static <T> int	injectInto(int injectValue, java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.primitive.IntObjectToIntFunction<? super T> function)
static <T,IV> IV	injectInto(IV injectValue, java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.Function2<? super IV,? super T,? extends IV> function)
static <T> long	injectInto(long injectValue, java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.primitive.LongObjectToLongFunction<? super T> function)
static <T,IV,P> IV	injectIntoWith(IV injectValue, java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.Function3<? super IV,? super T,? super P,? extends IV> function, P parameter)
static boolean	isEmpty(java.lang.Iterable<?> iterable) A null-safe check on a collection to see if it isEmpty.
static <T> java.lang.String	makeString(java.lang.Iterable<T> iterable)
static <T> java.lang.String	makeString(java.lang.Iterable<T> iterable, java.lang.String separator)
static <T> java.lang.String	makeString(java.lang.Iterable<T> iterable, java.lang.String start, java.lang.String separator, java.lang.String end)
static <T> T	max(java.lang.Iterable<T> iterable)
static <T> T	max(java.lang.Iterable<T> iterable, java.util.Comparator<? super T> comparator)
static <T,V extends java.lang.Comparable<? super V>> T	maxBy(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.Function<? super T,? extends V> function)
static <T> T	min(java.lang.Iterable<T> iterable)
static <T> T	min(java.lang.Iterable<T> iterable, java.util.Comparator<? super T> comparator)
static <T,V extends java.lang.Comparable<? super V>> T	minBy(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.Function<? super T,? extends V> function)
static <T> boolean	noneSatisfy(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns true if the predicate evaluates to false for every element of the iterable, or returns false.
static <T,P> boolean	noneSatisfyWith(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Returns true if the predicate evaluates to false for every element of the iterable, or returns false.
static boolean	notEmpty(java.lang.Iterable<?> iterable) A null-safe check on a collection to see if it is notEmpty.
static <T> com.gs.collections.api.partition.PartitionIterable<T>	partition(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Filters a collection into a PartitionIterable based on a predicate.
static <T> java.util.Collection<T>	reject(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns all elements of the iterable that evaluate to false for the specified predicate.
static <T,R extends java.util.Collection<T>> R	reject(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate<? super T> predicate, R targetCollection) Same as the reject method with two parameters but uses the specified target collection for the results.
static <T,IV> java.util.Collection<T>	rejectWith(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate2<? super T,? super IV> predicate, IV injectedValue) Returns all elements of the iterable that evaluate to false for the specified predicate2 and parameter.
static <T,P,R extends java.util.Collection<T>> R	rejectWith(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter, R targetCollection) Same as the reject method with two parameters but uses the specified target collection.
static <T> java.util.Collection<T>	removeIf(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Removes all elements from the iterable that evaluate to true for the specified predicate.
static <T,P> java.util.Collection<T>	removeIfWith(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter) Removes all elements of the iterable that evaluate to true for the specified predicate2 and parameter.
static <T> java.util.Collection<T>	select(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate<? super T> predicate) Returns a new collection with only the elements that evaluated to true for the specified predicate.
static <T,R extends java.util.Collection<T>> R	select(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate<? super T> predicate, R targetCollection) Same as the select method with two parameters but uses the specified target collection
static <T,IV> com.gs.collections.api.tuple.Twin<com.gs.collections.api.list.MutableList<T>>	selectAndRejectWith(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate2<? super T,? super IV> predicate, IV injectedValue) Filters a collection into two separate collections based on a predicate returned via a Twin.
static <T> java.util.Collection<T>	selectInstancesOf(java.lang.Iterable<?> iterable, java.lang.Class<T> clazz) Returns a new collection with only the elements that are instances of the Class clazz.
static <T,IV> java.util.Collection<T>	selectWith(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate2<? super T,? super IV> predicate, IV parameter) Returns a new collection with only elements that evaluated to true for the specified predicate and parameter.
static <T,P,R extends java.util.Collection<T>> R	selectWith(java.lang.Iterable<T> iterable, com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter, R targetCollection) Same as the selectWith method with two parameters but uses the specified target collection.
static int	sizeOf(java.lang.Iterable<?> iterable) Returns the size of an iterable.
static <T extends java.lang.Comparable<? super T>,L extends java.util.List<T>> L	sortThis(L list) SortThis is a mutating method.
static <T,L extends java.util.List<T>> L	sortThis(L list, java.util.Comparator<? super T> comparator) SortThis is a mutating method.
static <T,L extends java.util.List<T>> L	sortThis(L list, com.gs.collections.api.block.predicate.Predicate2<? super T,? super T> predicate) SortThis is a mutating method.
static <T,V extends java.lang.Comparable<V>,L extends java.util.List<T>> L	sortThisBy(L list, com.gs.collections.api.block.function.Function<? super T,? extends V> function) Sort the list by comparing an attribute defined by the function.
static <T> double	sumOfDouble(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> function)
static <T> double	sumOfFloat(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.primitive.FloatFunction<? super T> function)
static <T> long	sumOfInt(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.primitive.IntFunction<? super T> function)
static <T> long	sumOfLong(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.primitive.LongFunction<? super T> function)
static <T> java.util.Collection<T>	take(java.lang.Iterable<T> iterable, int count) Returns the first count elements of the iterable or the iterable itself if count is greater than the length of the iterable.
static <T> T[]	toArray(java.lang.Iterable<? extends T> iterable, T[] target) Copies the specified iterable into the specified array.
static <T> java.lang.Object[]	toArray(java.lang.Iterable<T> iterable) Converts the specified iterable to an array.
static <T,K> com.gs.collections.api.map.MutableMap<K,T>	toMap(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.Function<? super T,? extends K> keyFunction) Iterate over the specified collection applying the specified Function to each element to calculate a key and return the results as a Map.
static <T,K,V> com.gs.collections.api.map.MutableMap<K,V>	toMap(java.lang.Iterable<T> iterable, com.gs.collections.api.block.function.Function<? super T,? extends K> keyFunction, com.gs.collections.api.block.function.Function<? super T,? extends V> valueFunction) Iterate over the specified collection applying the specified Functions to each element to calculate a key and value, and return the results as a Map.
static <T extends java.lang.Comparable<? super T>> com.gs.collections.api.list.MutableList<T>	toSortedList(java.lang.Iterable<T> iterable) Return the specified collection as a sorted List.
static <T> com.gs.collections.api.list.MutableList<T>	toSortedList(java.lang.Iterable<T> iterable, java.util.Comparator<? super T> comparator) Return the specified collection as a sorted List using the specified Comparator.
static <X,Y> java.util.Collection<com.gs.collections.api.tuple.Pair<X,Y>>	zip(java.lang.Iterable<X> xs, java.lang.Iterable<Y> ys)
static <X,Y,R extends java.util.Collection<com.gs.collections.api.tuple.Pair<X,Y>>> R	zip(java.lang.Iterable<X> xs, java.lang.Iterable<Y> ys, R targetCollection)
static <T> java.util.Collection<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>>	zipWithIndex(java.lang.Iterable<T> iterable)
static <T,R extends java.util.Collection<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>>> R	zipWithIndex(java.lang.Iterable<T> iterable, R targetCollection)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

forEach

public static <T> void forEach(java.lang.Iterable<T> iterable,
               com.gs.collections.api.block.procedure.Procedure<? super T> procedure)

The procedure is evaluated for each element of the iterable.

e.g.
 Iterate.forEach(people, new Procedure()
 {
     public void value(Person person)
     {
         LOGGER.info(person.getName());
     }
 });
 

forEachWith

public static <T,P> void forEachWith(java.lang.Iterable<T> iterable,
                     com.gs.collections.api.block.procedure.Procedure2<? super T,? super P> procedure,
                     P parameter)

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

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

forEachWithIndex

public static <T> void forEachWithIndex(java.lang.Iterable<T> iterable,
                        com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure)

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

select

public static <T> java.util.Collection<T> select(java.lang.Iterable<T> iterable,
                                 com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Returns a new collection with only the elements that evaluated to true for the specified predicate.

e.g.
 return Iterate.select(collection, new Predicate<Person>()
 {
     public boolean value(Person person)
     {
         return person.getAddress().getCity().equals("Metuchen");
     }
 });
 

selectWith

public static <T,IV> java.util.Collection<T> selectWith(java.lang.Iterable<T> iterable,
                                        com.gs.collections.api.block.predicate.Predicate2<? super T,? super IV> predicate,
                                        IV parameter)

Returns a new collection with only elements that evaluated to true for the specified predicate and parameter.

e.g.
 return Iterate.selectWith(integers, Predicates2.equal(), new Integer(5));
 

selectAndRejectWith

public static <T,IV> com.gs.collections.api.tuple.Twin<com.gs.collections.api.list.MutableList<T>> selectAndRejectWith(java.lang.Iterable<T> iterable,
                                                                                                       com.gs.collections.api.block.predicate.Predicate2<? super T,? super IV> predicate,
                                                                                                       IV injectedValue)

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

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

partition

public static <T> com.gs.collections.api.partition.PartitionIterable<T> partition(java.lang.Iterable<T> iterable,
                                                                  com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Filters a collection into a PartitionIterable based on a predicate.

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

selectInstancesOf

public static <T> java.util.Collection<T> selectInstancesOf(java.lang.Iterable<?> iterable,
                                            java.lang.Class<T> clazz)

Returns a new collection with only the elements that are instances of the Class clazz.

count

public static <T> int count(java.lang.Iterable<T> iterable,
            com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

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

e.g.
 return Iterate.count(collection, new Predicate<Person>()
 {
     public boolean value(Person person)
     {
         return person.getAddress().getState().getName().equals("New York");
     }
 });
 

countWith

public static <T,IV> int countWith(java.lang.Iterable<T> iterable,
                   com.gs.collections.api.block.predicate.Predicate2<? super T,? super IV> predicate,
                   IV injectedValue)

Returns the total number of elements that evaluate to true for the specified predicate2 and parameter.

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

collectIf

public static <T,V> java.util.Collection<V> collectIf(java.lang.Iterable<T> iterable,
                                      com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
                                      com.gs.collections.api.block.function.Function<? super T,? extends V> function)

See Also:

RichIterable.collectIf(Predicate, Function)

collectIf

public static <T,V,R extends java.util.Collection<V>> R collectIf(java.lang.Iterable<T> iterable,
                                                  com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
                                                  com.gs.collections.api.block.function.Function<? super T,? extends V> function,
                                                  R target)

See Also:

RichIterable.collectIf(Predicate, Function, Collection)

select

public static <T,R extends java.util.Collection<T>> R select(java.lang.Iterable<T> iterable,
                                             com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
                                             R targetCollection)

Same as the select method with two parameters but uses the specified target collection

e.g.
 return Iterate.select(collection, new Predicate<Person>()
 {
     public boolean value(Person person)
     {
         return person.person.getLastName().equals("Smith");
     }
 }, FastList.newList());
 

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

selectWith

public static <T,P,R extends java.util.Collection<T>> R selectWith(java.lang.Iterable<T> iterable,
                                                   com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                                                   P parameter,
                                                   R targetCollection)

Same as the selectWith method with two parameters but uses the specified target collection.

take

public static <T> java.util.Collection<T> take(java.lang.Iterable<T> iterable,
                               int count)

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

Parameters:

iterable - the collection to take from.

count - the number of items to take.

Returns:

a new list with the items take from the given collection.

drop

public static <T> java.util.Collection<T> drop(java.lang.Iterable<T> iterable,
                               int count)

Returns a collection without the first count elements of the iterable or the iterable itself if count is non-positive.

Parameters:

iterable - the collection to drop from.

count - the number of items to drop.

Returns:

a new list with the items dropped from the given collection.

reject

public static <T> java.util.Collection<T> reject(java.lang.Iterable<T> iterable,
                                 com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Returns all elements of the iterable that evaluate to false for the specified predicate.

e.g.
 return Iterate.reject(collection, new Predicate<Person>()
 {
     public boolean value(Person person)
     {
         return person.person.getLastName().equals("Smith");
     }
 });
 

e.g.
 return Iterate.reject(collection, Predicates.attributeEqual("lastName", "Smith"));
 

sortThis

public static <T extends java.lang.Comparable<? super T>,L extends java.util.List<T>> L sortThis(L list)

SortThis is a mutating method. The List passed in is also returned.

sortThis

public static <T,L extends java.util.List<T>> L sortThis(L list,
                                         java.util.Comparator<? super T> comparator)

SortThis is a mutating method. The List passed in is also returned.

sortThis

public static <T,L extends java.util.List<T>> L sortThis(L list,
                                         com.gs.collections.api.block.predicate.Predicate2<? super T,? super T> predicate)

SortThis is a mutating method. The List passed in is also returned.

sortThisBy

public static <T,V extends java.lang.Comparable<V>,L extends java.util.List<T>> L sortThisBy(L list,
                                                                             com.gs.collections.api.block.function.Function<? super T,? extends V> function)

Sort the list by comparing an attribute defined by the function. SortThisBy is a mutating method. The List passed in is also returned.

removeIf

public static <T> java.util.Collection<T> removeIf(java.lang.Iterable<T> iterable,
                                   com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Removes all elements from the iterable that evaluate to true for the specified predicate.

removeIfWith

public static <T,P> java.util.Collection<T> removeIfWith(java.lang.Iterable<T> iterable,
                                         com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                                         P parameter)

Removes all elements of the iterable that evaluate to true for the specified predicate2 and parameter.

rejectWith

public static <T,IV> java.util.Collection<T> rejectWith(java.lang.Iterable<T> iterable,
                                        com.gs.collections.api.block.predicate.Predicate2<? super T,? super IV> predicate,
                                        IV injectedValue)

Returns all elements of the iterable that evaluate to false for the specified predicate2 and parameter.

reject

public static <T,R extends java.util.Collection<T>> R reject(java.lang.Iterable<T> iterable,
                                             com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
                                             R targetCollection)

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

e.g.
 return Iterate.reject(collection, new Predicate<Person>()
 {
     public boolean value(Person person)
     {
         return person.person.getLastName().equals("Smith");
     }
 }, FastList.newList());
 

rejectWith

public static <T,P,R extends java.util.Collection<T>> R rejectWith(java.lang.Iterable<T> iterable,
                                                   com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                                                   P parameter,
                                                   R targetCollection)

Same as the reject method with two parameters but uses the specified target collection.

addAllTo

public static <T,R extends java.util.Collection<T>> R addAllTo(java.lang.Iterable<? extends T> iterable,
                                               R targetCollection)

Add all elements from the source Iterable to the target collection, return the target collection

addAllIterable

public static <T> boolean addAllIterable(java.lang.Iterable<? extends T> iterable,
                         java.util.Collection<T> targetCollection)

collect

public static <T,V> java.util.Collection<V> collect(java.lang.Iterable<T> iterable,
                                    com.gs.collections.api.block.function.Function<? super T,? extends V> function)

Returns a new collection with the results of applying the specified function for each element of the iterable.

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

collectBoolean

public static <T> com.gs.collections.api.collection.primitive.MutableBooleanCollection collectBoolean(java.lang.Iterable<T> iterable,
                                                                                      com.gs.collections.api.block.function.primitive.BooleanFunction<? super T> booleanFunction)

Returns a new collection with the results of applying the specified booleanFunction for each element of the iterable.

e.g.
 return Iterate.collectBoolean(collection, new BooleanFunction<Person>()
 {
     public boolean booleanValueOf(Person person)
     {
         return person.canVote();
     }
 });
 

collectByte

public static <T> com.gs.collections.api.collection.primitive.MutableByteCollection collectByte(java.lang.Iterable<T> iterable,
                                                                                com.gs.collections.api.block.function.primitive.ByteFunction<? super T> byteFunction)

Returns a new collection with the results of applying the specified byteFunction for each element of the iterable.

e.g.
 return Iterate.collectByte(collection, new ByteFunction<Person>()
 {
     public byte byteValueOf(Person person)
     {
         return person.getAge();
     }
 });
 

collectChar

public static <T> com.gs.collections.api.collection.primitive.MutableCharCollection collectChar(java.lang.Iterable<T> iterable,
                                                                                com.gs.collections.api.block.function.primitive.CharFunction<? super T> charFunction)

Returns a new collection with the results of applying the specified charFunction for each element of the iterable.

e.g.
 return Iterate.collectChar(collection, new CharFunction<Person>()
 {
     public char charValueOf(Person person)
     {
         return person.getMiddleInitial();
     }
 });
 

collectDouble

public static <T> com.gs.collections.api.collection.primitive.MutableDoubleCollection collectDouble(java.lang.Iterable<T> iterable,
                                                                                    com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction)

Returns a new collection with the results of applying the specified doubleFunction for each element of the iterable.

e.g.
 return Iterate.collectDouble(collection, new DoubleFunction<Person>()
 {
     public double doubleValueOf(Person person)
     {
         return person.getAge();
     }
 });
 

collectFloat

public static <T> com.gs.collections.api.collection.primitive.MutableFloatCollection collectFloat(java.lang.Iterable<T> iterable,
                                                                                  com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction)

Returns a new collection with the results of applying the specified floatFunction for each element of the iterable.

e.g.
 return Iterate.collectFloat(collection, new FloatFunction<Person>()
 {
     public float floatValueOf(Person person)
     {
         return person.getAge();
     }
 });
 

collectInt

public static <T> com.gs.collections.api.collection.primitive.MutableIntCollection collectInt(java.lang.Iterable<T> iterable,
                                                                              com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction)

Returns a new collection with the results of applying the specified intFunction for each element of the iterable.

e.g.
 return Iterate.collectInt(collection, new IntFunction<Person>()
 {
     public int intValueOf(Person person)
     {
         return person.getAge();
     }
 });
 

collectLong

public static <T> com.gs.collections.api.collection.primitive.MutableLongCollection collectLong(java.lang.Iterable<T> iterable,
                                                                                com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction)

Returns a new collection with the results of applying the specified longFunction for each element of the iterable.

e.g.
 return Iterate.collectLong(collection, new LongFunction<Person>()
 {
     public long longValueOf(Person person)
     {
         return person.getGuid();
     }
 });
 

collectShort

public static <T> com.gs.collections.api.collection.primitive.MutableShortCollection collectShort(java.lang.Iterable<T> iterable,
                                                                                  com.gs.collections.api.block.function.primitive.ShortFunction<? super T> shortFunction)

Returns a new collection with the results of applying the specified shortFunction for each element of the iterable.

e.g.
 return Iterate.collectShort(collection, new ShortFunction<Person>()
 {
     public short shortValueOf(Person person)
     {
         return person.getAge();
     }
 });
 

flatCollect

public static <T,V> java.util.Collection<V> flatCollect(java.lang.Iterable<T> iterable,
                                        com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)

See Also:

RichIterable.flatCollect(Function)

collect

public static <T,A,R extends java.util.Collection<A>> R collect(java.lang.Iterable<T> iterable,
                                                com.gs.collections.api.block.function.Function<? super T,? extends A> function,
                                                R targetCollection)

Same as the collect method with two parameters, except that the results are gathered into the specified targetCollection

e.g.
 return Iterate.collect(collection, new Function<Person, String>()
 {
     public String value(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 }, FastList.newList());
 

flatCollect

public static <T,A,R extends java.util.Collection<A>> R flatCollect(java.lang.Iterable<T> iterable,
                                                    com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<A>> function,
                                                    R targetCollection)

See Also:

RichIterable.flatCollect(Function, Collection)

collectWith

public static <T,P,A> java.util.Collection<A> collectWith(java.lang.Iterable<T> iterable,
                                          com.gs.collections.api.block.function.Function2<? super T,? super P,? extends A> function,
                                          P parameter)

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

collectWith

public static <T,P,A,R extends java.util.Collection<A>> R collectWith(java.lang.Iterable<T> iterable,
                                                      com.gs.collections.api.block.function.Function2<? super T,? super P,? extends A> function,
                                                      P parameter,
                                                      R targetCollection)

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

flatten

public static <T> java.util.Collection<T> flatten(java.lang.Iterable<? extends java.lang.Iterable<T>> iterable)

Flattens a collection of collections into one "flat" collection.

Parameters:

iterable - A list of lists, e.g. { { 1, 2, 3 }, { 4, 5 }, { 6 } }

Returns:

A flattened list, e.g. { 1, 2, 3, 4, 5, 6 }

flatten

public static <T,R extends java.util.Collection<T>> R flatten(java.lang.Iterable<? extends java.lang.Iterable<T>> iterable,
                                              R targetCollection)

Same as flatten(Iterable) except that the results are gathered into the specified targetCollection.

getFirst

public static <T> T getFirst(java.lang.Iterable<T> iterable)

Returns the first element of a collection. 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 Collection is empty, the result is null.

WARNING!!! 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.

Throws:

java.lang.IllegalArgumentException - if the Collection is null

isEmpty

public static boolean isEmpty(java.lang.Iterable<?> iterable)

A null-safe check on a collection to see if it isEmpty. A null collection results in a true.

notEmpty

public static boolean notEmpty(java.lang.Iterable<?> iterable)

A null-safe check on a collection to see if it is notEmpty. A null collection results in a false.

getLast

public static <T> T getLast(java.lang.Iterable<T> iterable)

Returns the last element of a collection. 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 Collection is empty, the result is null.

WARNING!!! 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.

Throws:

java.lang.IllegalArgumentException - if the Collection is null

detect

public static <T> T detect(java.lang.Iterable<T> iterable,
           com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Returns the first element of the iterable that evaluates to true for the specified predicate, or null if no element evaluates to true.

e.g.
 return Iterate.detect(collection, new Predicate<Person>()
 {
     public boolean value(Person person)
     {
         return person.getFirstName().equals("John") && person.getLastName().equals("Smith");
     }
 });
 

detectWith

public static <T,P> T detectWith(java.lang.Iterable<T> iterable,
                 com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                 P parameter)

Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or null if no element evaluates to true.

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

detectIfNone

public static <T> T detectIfNone(java.lang.Iterable<T> iterable,
                 com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
                 T ifNone)

Returns the first element of the iterable that evaluates to true for the specified predicate, or returns the result ifNone if no element evaluates to true.

detectWithIfNone

public static <T,P> T detectWithIfNone(java.lang.Iterable<T> iterable,
                       com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                       P parameter,
                       T ifNone)

Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or returns the result ifNone if no element evaluates to true.

detectIndex

public static <T> int detectIndex(java.lang.Iterable<T> iterable,
                  com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Searches for the first occurrence where the predicate evaluates to true.

detectIndexWith

public static <T,P> int detectIndexWith(java.lang.Iterable<T> iterable,
                        com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                        P parameter)

Searches for the first occurrence where the predicate evaluates to true.

injectInto

public static <T,IV> IV injectInto(IV injectValue,
                   java.lang.Iterable<T> iterable,
                   com.gs.collections.api.block.function.Function2<? super IV,? super T,? extends IV> function)

See Also:

RichIterable.injectInto(Object, Function2)

injectInto

public static <T> int injectInto(int injectValue,
                 java.lang.Iterable<T> iterable,
                 com.gs.collections.api.block.function.primitive.IntObjectToIntFunction<? super T> function)

See Also:

RichIterable.injectInto(int, IntObjectToIntFunction)

injectInto

public static <T> long injectInto(long injectValue,
                  java.lang.Iterable<T> iterable,
                  com.gs.collections.api.block.function.primitive.LongObjectToLongFunction<? super T> function)

See Also:

RichIterable.injectInto(long, LongObjectToLongFunction)

injectInto

public static <T> double injectInto(double injectValue,
                    java.lang.Iterable<T> iterable,
                    com.gs.collections.api.block.function.primitive.DoubleObjectToDoubleFunction<? super T> function)

See Also:

RichIterable.injectInto(double, DoubleObjectToDoubleFunction)

injectInto

public static <T> float injectInto(float injectValue,
                   java.lang.Iterable<T> iterable,
                   com.gs.collections.api.block.function.primitive.FloatObjectToFloatFunction<? super T> function)

See Also:

RichIterable.injectInto(float, FloatObjectToFloatFunction)

sumOfInt

public static <T> long sumOfInt(java.lang.Iterable<T> iterable,
                com.gs.collections.api.block.function.primitive.IntFunction<? super T> function)

See Also:

RichIterable.sumOfInt(IntFunction)

sumOfLong

public static <T> long sumOfLong(java.lang.Iterable<T> iterable,
                 com.gs.collections.api.block.function.primitive.LongFunction<? super T> function)

See Also:

RichIterable.sumOfLong(LongFunction)

sumOfFloat

public static <T> double sumOfFloat(java.lang.Iterable<T> iterable,
                    com.gs.collections.api.block.function.primitive.FloatFunction<? super T> function)

See Also:

RichIterable.sumOfFloat(FloatFunction)

sumOfDouble

public static <T> double sumOfDouble(java.lang.Iterable<T> iterable,
                     com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> function)

See Also:

RichIterable.sumOfDouble(DoubleFunction)

injectIntoWith

public static <T,IV,P> IV injectIntoWith(IV injectValue,
                         java.lang.Iterable<T> iterable,
                         com.gs.collections.api.block.function.Function3<? super IV,? super T,? super P,? extends IV> function,
                         P parameter)

anySatisfy

public static <T> boolean anySatisfy(java.lang.Iterable<T> iterable,
                     com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

Returns true if the predicate evaluates to true for any element of the iterable. Returns false if the iterable is empty or if no elements return true for the predicate.

anySatisfyWith

public static <T,P> boolean anySatisfyWith(java.lang.Iterable<T> iterable,
                           com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                           P parameter)

Returns true if the predicate2 and parameter evaluates to true for any element of the iterable. Returns false if the iterable is empty or if no elements return true for the predicate2.

allSatisfy

public static <T> boolean allSatisfy(java.lang.Iterable<T> iterable,
                     com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

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

allSatisfyWith

public static <T,P> boolean allSatisfyWith(java.lang.Iterable<T> iterable,
                           com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                           P parameter)

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

noneSatisfy

public static <T> boolean noneSatisfy(java.lang.Iterable<T> iterable,
                      com.gs.collections.api.block.predicate.Predicate<? super T> predicate)

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

noneSatisfyWith

public static <T,P> boolean noneSatisfyWith(java.lang.Iterable<T> iterable,
                            com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
                            P parameter)

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

toMap

public static <T,K> com.gs.collections.api.map.MutableMap<K,T> toMap(java.lang.Iterable<T> iterable,
                                                     com.gs.collections.api.block.function.Function<? super T,? extends K> keyFunction)

Iterate over the specified collection applying the specified Function to each element to calculate a key and return the results as a Map.

toMap

public static <T,K,V> com.gs.collections.api.map.MutableMap<K,V> toMap(java.lang.Iterable<T> iterable,
                                                       com.gs.collections.api.block.function.Function<? super T,? extends K> keyFunction,
                                                       com.gs.collections.api.block.function.Function<? super T,? extends V> valueFunction)

Iterate over the specified collection applying the specified Functions to each element to calculate a key and value, and return the results as a Map.

addToMap

public static <T,K,V,M extends java.util.Map<K,V>> M addToMap(java.lang.Iterable<T> iterable,
                                              com.gs.collections.api.block.function.Function<? super T,? extends K> keyFunction,
                                              M map)

Iterate over the specified collection applying a specific Function to each element to calculate a key, and return the results as a Map.

addToMap

public static <T,K,V,M extends java.util.Map<K,V>> M addToMap(java.lang.Iterable<T> iterable,
                                              com.gs.collections.api.block.function.Function<? super T,? extends K> keyFunction,
                                              com.gs.collections.api.block.function.Function<? super T,? extends V> valueFunction,
                                              M map)

Iterate over the specified collection applying the specified Functions to each element to calculate a key and value, and return the results as a Map.

toSortedList

public static <T extends java.lang.Comparable<? super T>> com.gs.collections.api.list.MutableList<T> toSortedList(java.lang.Iterable<T> iterable)

Return the specified collection as a sorted List.

toSortedList

public static <T> com.gs.collections.api.list.MutableList<T> toSortedList(java.lang.Iterable<T> iterable,
                                                          java.util.Comparator<? super T> comparator)

Return the specified collection as a sorted List using the specified Comparator.

sizeOf

public static int sizeOf(java.lang.Iterable<?> iterable)

Returns the size of an iterable. In the case of Collections and RichIterables, the method size is called. All other iterables will force a complete iteration to happen, which can be unnecessarily costly.

contains

public static boolean contains(java.lang.Iterable<?> iterable,
               java.lang.Object value)

Returns true if the iterable contains the value. In the case of Collections and RichIterables, the method contains is called. All other iterables will force a complete iteration to happen, which can be unnecessarily costly.

toArray

public static <T> java.lang.Object[] toArray(java.lang.Iterable<T> iterable)

Converts the specified iterable to an array.

toArray

public static <T> T[] toArray(java.lang.Iterable<? extends T> iterable,
              T[] target)

Copies the specified iterable into the specified array.

groupBy

public static <T,V> com.gs.collections.api.multimap.MutableMultimap<V,T> groupBy(java.lang.Iterable<T> iterable,
                                                                 com.gs.collections.api.block.function.Function<? super T,? extends V> function)

See Also:

RichIterable.groupBy(Function)

groupBy

public static <T,V,R extends com.gs.collections.api.multimap.MutableMultimap<V,T>> R groupBy(java.lang.Iterable<T> iterable,
                                                                             com.gs.collections.api.block.function.Function<? super T,? extends V> function,
                                                                             R targetMultimap)

See Also:

RichIterable.groupBy(Function, MutableMultimap)

aggregateInPlaceBy

public static <T,K,V> com.gs.collections.api.map.MutableMap<K,V> aggregateInPlaceBy(java.lang.Iterable<T> iterable,
                                                                    com.gs.collections.api.block.function.Function<? super T,? extends K> groupBy,
                                                                    com.gs.collections.api.block.function.Function0<? extends V> zeroValueFactory,
                                                                    com.gs.collections.api.block.procedure.Procedure2<? super V,? super T> mutatingAggregator)

See Also:

RichIterable.aggregateInPlaceBy(Function, Function0, Procedure2)

aggregateBy

public static <T,K,V> com.gs.collections.api.map.MutableMap<K,V> aggregateBy(java.lang.Iterable<T> iterable,
                                                             com.gs.collections.api.block.function.Function<? super T,? extends K> groupBy,
                                                             com.gs.collections.api.block.function.Function0<? extends V> zeroValueFactory,
                                                             com.gs.collections.api.block.function.Function2<? super V,? super T,? extends V> nonMutatingAggregator)

See Also:

RichIterable.aggregateBy(Function, Function0, Function2)

groupByEach

public static <T,V> com.gs.collections.api.multimap.MutableMultimap<V,T> groupByEach(java.lang.Iterable<T> iterable,
                                                                     com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)

See Also:

RichIterable.groupByEach(Function)

groupByEach

public static <T,V,R extends com.gs.collections.api.multimap.MutableMultimap<V,T>> R groupByEach(java.lang.Iterable<T> iterable,
                                                                                 com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function,
                                                                                 R targetCollection)

See Also:

RichIterable.groupByEach(Function, MutableMultimap)

min

public static <T> T min(java.lang.Iterable<T> iterable,
        java.util.Comparator<? super T> comparator)

See Also:

RichIterable.min(Comparator)

max

public static <T> T max(java.lang.Iterable<T> iterable,
        java.util.Comparator<? super T> comparator)

See Also:

RichIterable.max(Comparator)

min

public static <T> T min(java.lang.Iterable<T> iterable)

See Also:

RichIterable.min()

max

public static <T> T max(java.lang.Iterable<T> iterable)

See Also:

RichIterable.max()

getOnly

public static <T> T getOnly(java.lang.Iterable<T> iterable)

zip

public static <X,Y> java.util.Collection<com.gs.collections.api.tuple.Pair<X,Y>> zip(java.lang.Iterable<X> xs,
                                                                     java.lang.Iterable<Y> ys)

See Also:

RichIterable.zip(Iterable)

zip

public static <X,Y,R extends java.util.Collection<com.gs.collections.api.tuple.Pair<X,Y>>> R zip(java.lang.Iterable<X> xs,
                                                                                 java.lang.Iterable<Y> ys,
                                                                                 R targetCollection)

See Also:

RichIterable.zip(Iterable, Collection)

zipWithIndex

public static <T> java.util.Collection<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>> zipWithIndex(java.lang.Iterable<T> iterable)

See Also:

RichIterable.zipWithIndex()

zipWithIndex

public static <T,R extends java.util.Collection<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>>> R zipWithIndex(java.lang.Iterable<T> iterable,
                                                                                                        R targetCollection)

See Also:

RichIterable.zipWithIndex(Collection)

chunk

public static <T> com.gs.collections.api.RichIterable<com.gs.collections.api.RichIterable<T>> chunk(java.lang.Iterable<T> iterable,
                                                                                    int size)

See Also:

RichIterable.chunk(int)

makeString

public static <T> java.lang.String makeString(java.lang.Iterable<T> iterable)

See Also:

RichIterable.makeString()

makeString

public static <T> java.lang.String makeString(java.lang.Iterable<T> iterable,
                              java.lang.String separator)

See Also:

RichIterable.makeString(String)

makeString

public static <T> java.lang.String makeString(java.lang.Iterable<T> iterable,
                              java.lang.String start,
                              java.lang.String separator,
                              java.lang.String end)

See Also:

RichIterable.makeString(String, String, String)

appendString

public static <T> void appendString(java.lang.Iterable<T> iterable,
                    java.lang.Appendable appendable)

See Also:

RichIterable.appendString(Appendable)

appendString

public static <T> void appendString(java.lang.Iterable<T> iterable,
                    java.lang.Appendable appendable,
                    java.lang.String separator)

See Also:

RichIterable.appendString(Appendable, String)

appendString

public static <T> void appendString(java.lang.Iterable<T> iterable,
                    java.lang.Appendable appendable,
                    java.lang.String start,
                    java.lang.String separator,
                    java.lang.String end)

See Also:

RichIterable.appendString(Appendable, String, String, String)

maxBy

public static <T,V extends java.lang.Comparable<? super V>> T maxBy(java.lang.Iterable<T> iterable,
                                                    com.gs.collections.api.block.function.Function<? super T,? extends V> function)

minBy

public static <T,V extends java.lang.Comparable<? super V>> T minBy(java.lang.Iterable<T> iterable,
                                                    com.gs.collections.api.block.function.Function<? super T,? extends V> function)