Package org.eclipse.collections.api.ordered

Interface OrderedIterable<T>

All Superinterfaces:

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

All Known Subinterfaces:

FixedSizeList<T>, ImmutableList<T>, ImmutableOrderedMap<K,V>, ImmutableSortedBag<T>, ImmutableSortedMap<K,V>, ImmutableSortedSet<T>, ImmutableStack<T>, ListIterable<T>, MultiReaderList<T>, MutableList<T>, MutableOrderedMap<K,V>, MutableSortedBag<T>, MutableSortedMap<K,V>, MutableSortedSet<T>, MutableStack<T>, OrderedMap<K,V>, ReversibleIterable<T>, SortedBag<T>, SortedIterable<T>, SortedMapIterable<K,V>, SortedSetIterable<T>, StackIterable<T>

public interface OrderedIterable<T>
extends RichIterable<T>

An OrderedIterable is a RichIterable with some meaningful order, such as insertion order, access order, or sorted order.

Since:

6.0

Method Summary

Modifier and Type	Method	Description
<V> OrderedIterable<V>	collect(Function<? super T,? extends V> function)	Returns a new collection with the results of applying the specified function on each element of the source collection.
OrderedBooleanIterable	collectBoolean(BooleanFunction<? super T> booleanFunction)	Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection.
OrderedByteIterable	collectByte(ByteFunction<? super T> byteFunction)	Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection.
OrderedCharIterable	collectChar(CharFunction<? super T> charFunction)	Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection.
OrderedDoubleIterable	collectDouble(DoubleFunction<? super T> doubleFunction)	Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection.
OrderedFloatIterable	collectFloat(FloatFunction<? super T> floatFunction)	Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection.
<V> OrderedIterable<V>	collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function)	Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate.
OrderedIntIterable	collectInt(IntFunction<? super T> intFunction)	Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection.
OrderedLongIterable	collectLong(LongFunction<? super T> longFunction)	Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection.
OrderedShortIterable	collectShort(ShortFunction<? super T> shortFunction)	Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection.
<P, V> OrderedIterable<V>	collectWith(Function2<? super T,? super P,? extends V> function, P parameter)	Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.
default <V> OrderedIterable<V>	collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function)	Returns a new OrderedIterable using results obtained by applying the specified function to each element and its corresponding index.
default <V, R extends Collection<V>> R	collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function, R target)	Adds elements to the target Collection using results obtained by applying the specified function to each element and its corresponding index.
<S> boolean	corresponds(OrderedIterable<S> other, Predicate2<? super T,? super S> predicate)	Returns true if both OrderedIterables have the same length and predicate returns true for all corresponding elements e1 of this OrderedIterable and e2 of other.
int	detectIndex(Predicate<? super T> predicate)	Returns the index of the first element of the OrderedIterable for which the predicate evaluates to true.
OrderedIterable<T>	distinct()	Returns a new OrderedIterable containing the distinct elements in this iterable.
OrderedIterable<T>	dropWhile(Predicate<? super T> predicate)	Returns the final elements that do not satisfy the Predicate.
<V> OrderedIterable<V>	flatCollect(Function<? super T,? extends Iterable<V>> function)	flatCollect is a special case of RichIterable.collect(Function).
default <P, V> OrderedIterable<V>	flatCollectWith(Function2<? super T,? super P,? extends Iterable<V>> function, P parameter)	Same as flatCollect, only with a Function2 that is passed an extra parameter.
void	forEach(int startIndex, int endIndex, Procedure<? super T> procedure)	Iterates over the section of the iterable covered by the specified inclusive indexes.
void	forEachWithIndex(int fromIndex, int toIndex, ObjectIntProcedure<? super T> objectIntProcedure)	Iterates over the section of the iterable covered by the specified inclusive indexes.
void	forEachWithIndex(ObjectIntProcedure<? super T> objectIntProcedure)	Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure
T	getFirst()	Returns the first element of an iterable.
default Optional<T>	getFirstOptional()	Returns the first element of an iterable as an Optional.
T	getLast()	Returns the last element of an iterable.
default Optional<T>	getLastOptional()	Returns the last element of an iterable as an Optional.
<V> OrderedIterableMultimap<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> OrderedIterableMultimap<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.
default int	indexOf(Object object)	Returns the index of the first occurrence of the specified item in this iterable, or -1 if this iterable does not contain the item.
T	max()	Returns the maximum element out of this container based on the natural order, not the order of this container.
T	min()	Returns the minimum element out of this container based on the natural order, not the order of this container.
PartitionOrderedIterable<T>	partition(Predicate<? super T> predicate)	Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
PartitionOrderedIterable<T>	partitionWhile(Predicate<? super T> predicate)	Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
<P> PartitionOrderedIterable<T>	partitionWith(Predicate2<? super T,? super P> predicate, P parameter)	Filters a collection into a PartitionIterable based on the evaluation of the predicate.
OrderedIterable<T>	reject(Predicate<? super T> predicate)	Returns all elements of the source collection that return false when evaluating of the predicate.
<P> OrderedIterable<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.
default <R extends Collection<T>> R	rejectWithIndex(ObjectIntPredicate<? super T> predicate, R target)	Adds all elements to the target Collection that return false when evaluating the specified predicate which is supplied each element and its relative index.
OrderedIterable<T>	select(Predicate<? super T> predicate)	Returns all elements of the source collection that return true when evaluating the predicate.
<S> OrderedIterable<S>	selectInstancesOf(Class<S> clazz)	Returns all elements of the source collection that are instances of the Class clazz.
<P> OrderedIterable<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.
default <R extends Collection<T>> R	selectWithIndex(ObjectIntPredicate<? super T> predicate, R target)	Adds all elements to the target Collection that return true when evaluating the specified predicate which is supplied each element and its relative index.
OrderedIterable<T>	takeWhile(Predicate<? super T> predicate)	Returns the initial elements that satisfy the Predicate.
OrderedIterable<T>	tap(Procedure<? super T> procedure)	Executes the Procedure for each element in the iterable and returns this.
default MutableStack<T>	toStack()	Converts the OrderedIterable to a mutable MutableStack implementation.
<S> OrderedIterable<Pair<T,S>>	zip(Iterable<S> that)	Returns a OrderedIterable formed from this OrderedIterable and another Iterable by combining corresponding elements in pairs.
<S, R extends Collection<Pair<T, S>>> R	zip(Iterable<S> that, R target)	Same as zip(Iterable) but uses target for output.
OrderedIterable<Pair<T,Integer>>	zipWithIndex()	Zips this RichIterable with its indices.
<R extends Collection<Pair<T, Integer>>> R	zipWithIndex(R target)	Same as zipWithIndex() but uses target for output.

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

forEach, forEachWith

Methods inherited from interface java.lang.Iterable

iterator, spliterator

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

aggregateBy, aggregateBy, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, count, countBy, countBy, countByEach, countByEach, countByWith, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, isEmpty, makeString, makeString, makeString, makeString, max, maxBy, maxByOptional, maxOptional, maxOptional, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceBy, reduceBy, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString

Method Details

indexOf

default int indexOf(Object object)

Returns the index of the first occurrence of the specified item in this iterable, or -1 if this iterable does not contain the item.

See Also:

• List.indexOf(Object)

getFirst

T getFirst()

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.

Specified by:

getFirst in interface RichIterable<T>

getFirstOptional

default Optional<T> getFirstOptional()

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

Throws:

NullPointerException - if the element is null

Since:

8.2

getLast

T getLast()

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.

Specified by:

getLast in interface RichIterable<T>

getLastOptional

default Optional<T> getLastOptional()

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

Throws:

NullPointerException - if the element is null

Since:

8.2

tap

OrderedIterable<T> tap(Procedure<? super T> procedure)

Description copied from interface: RichIterable

Executes the Procedure for each element in the iterable and returns this.

Example using a Java 8 lambda expression:

 RichIterable<Person> tapped =
     people.tap(person -> LOGGER.info(person.getName()));
 

Specified by:

tap in interface RichIterable<T>

See Also:

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

takeWhile

OrderedIterable<T> takeWhile(Predicate<? super T> predicate)

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

dropWhile

OrderedIterable<T> dropWhile(Predicate<? super T> predicate)

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

partitionWhile

PartitionOrderedIterable<T> partitionWhile(Predicate<? super T> predicate)

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

distinct

OrderedIterable<T> distinct()

Returns a new OrderedIterable containing the distinct elements in this iterable.

Conceptually similar to RichIterable.toSet().RichIterable.toList() but retains the original order. If an element appears multiple times in this iterable, the first one will be copied into the result.

Returns:

OrderedIterable of distinct elements

corresponds

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

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

Since:

6.0

forEach

void forEach(int startIndex,
 int endIndex,
 Procedure<? super T> procedure)

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

e.g.
 OrderedIterable<Person> people = FastList.newListWith(ted, mary, bob, sally)
 people.forEach(0, 1, person -> LOGGER.info(person.getName()));
 

This code would output ted and mary's names.

forEachWithIndex

void forEachWithIndex(ObjectIntProcedure<? super T> objectIntProcedure)

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

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

Specified by:

forEachWithIndex in interface InternalIterable<T>

forEachWithIndex

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

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

e.g.
 OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally)
 people.forEachWithIndex(0, 1, (person, index) -> LOGGER.info(person.getName()));
 

This code would output ted and mary's names.

toStack

default MutableStack<T> toStack()

Converts the OrderedIterable to a mutable MutableStack implementation.

min

T min()

Returns the minimum element out of this container based on the natural order, not the order of this container. If you want the minimum element based on the order of this container, use getFirst().

Specified by:

min in interface RichIterable<T>

Throws:

ClassCastException - if the elements are not Comparable

NoSuchElementException - if the OrderedIterable is empty

max

T max()

Returns the maximum element out of this container based on the natural order, not the order of this container. If you want the maximum element based on the order of this container, use getLast().

Specified by:

max in interface RichIterable<T>

Throws:

ClassCastException - if the elements are not Comparable

NoSuchElementException - if the OrderedIterable is empty

select

OrderedIterable<T> select(Predicate<? super T> predicate)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

select in interface RichIterable<T>

selectWith

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

Description copied from interface: RichIterable

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

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

Example using a Java 8 lambda expression:

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

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)

reject

OrderedIterable<T> reject(Predicate<? super T> predicate)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

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

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

Description copied from interface: RichIterable

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

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

Example using a Java 8 lambda expression:

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

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)

partition

PartitionOrderedIterable<T> partition(Predicate<? super T> predicate)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partition(person -> person.getAddress().getState().getName().equals("New York"));
 

Specified by:

partition in interface RichIterable<T>

partitionWith

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
 

Specified by:

partitionWith in interface RichIterable<T>

selectInstancesOf

<S> OrderedIterable<S> selectInstancesOf(Class<S> clazz)

Description copied from interface: RichIterable

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

 RichIterable<Integer> integers =
     List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
 

Specified by:

selectInstancesOf in interface RichIterable<T>

collect

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collect in interface RichIterable<T>

collectWithIndex

default <V> OrderedIterable<V> collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function)

Returns a new OrderedIterable using results obtained by applying the specified function to each element and its corresponding index.

Since:

9.1.

collectWithIndex

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

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

Since:

9.1.

selectWithIndex

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

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

Since:

11.0

rejectWithIndex

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

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

Since:

11.0

collectWith

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

Description copied from interface: RichIterable

Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.

Example using a Java 8 lambda expression:

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

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)

collectIf

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda and method reference:

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

Example using Predicates factory:

 RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString());
 

Specified by:

collectIf in interface RichIterable<T>

flatCollect

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

Description copied from interface: RichIterable

flatCollect is a special case of RichIterable.collect(Function). With collect, when the Function returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.

Consider the following example where we have a Person class, and each Person has a list of Address objects. Take the following Function:

 Function<Person, List<Address>> addressFunction = Person::getAddresses;
 RichIterable<Person> people = ...;
 

Using collect returns a collection of collections of addresses.

 RichIterable<List<Address>> addresses = people.collect(addressFunction);
 

Using flatCollect returns a single flattened list of addresses.

 RichIterable<Address> addresses = people.flatCollect(addressFunction);
 

Specified by:

flatCollect in interface RichIterable<T>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

flatCollectWith

default <P,
V> OrderedIterable<V> flatCollectWith(Function2<? super T,? super P,? extends Iterable<V>> function,
 P parameter)

Description copied from interface: RichIterable

Same as flatCollect, only with a Function2 that is passed an extra parameter.

Specified by:

flatCollectWith in interface RichIterable<T>

Since:

9.2

collectBoolean

OrderedBooleanIterable collectBoolean(BooleanFunction<? super T> booleanFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectBoolean in interface RichIterable<T>

collectByte

OrderedByteIterable collectByte(ByteFunction<? super T> byteFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectByte in interface RichIterable<T>

collectChar

OrderedCharIterable collectChar(CharFunction<? super T> charFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectChar in interface RichIterable<T>

collectDouble

OrderedDoubleIterable collectDouble(DoubleFunction<? super T> doubleFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectDouble in interface RichIterable<T>

collectFloat

OrderedFloatIterable collectFloat(FloatFunction<? super T> floatFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectFloat in interface RichIterable<T>

collectInt

OrderedIntIterable collectInt(IntFunction<? super T> intFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectInt in interface RichIterable<T>

collectLong

OrderedLongIterable collectLong(LongFunction<? super T> longFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectLong in interface RichIterable<T>

collectShort

OrderedShortIterable collectShort(ShortFunction<? super T> shortFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectShort in interface RichIterable<T>

detectIndex

int detectIndex(Predicate<? super T> predicate)

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

Since:

6.0

groupBy

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

Description copied from interface: RichIterable

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

Example using a Java 8 method reference:

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

Specified by:

groupBy in interface RichIterable<T>

groupByEach

<V> OrderedIterableMultimap<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>

zip

<S> OrderedIterable<Pair<T,S>> zip(Iterable<S> that)

Returns a OrderedIterable formed from this OrderedIterable and another Iterable by combining corresponding elements in pairs. The second Iterable should also be ordered. If one of the two Iterables is longer than the other, its remaining elements are ignored.

Specified by:

zip in interface RichIterable<T>

Type Parameters:

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

Parameters:

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

Returns:

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

zip

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

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

Specified by:

zip in interface RichIterable<T>

zipWithIndex

OrderedIterable<Pair<T,Integer>> zipWithIndex()

Description copied from interface: RichIterable

Zips this RichIterable with its indices.

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

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

Same as zipWithIndex() but uses target for output.

Specified by:

zipWithIndex in interface RichIterable<T>