Package org.eclipse.collections.api.stack

Interface ImmutableStack<T>

All Superinterfaces:

InternalIterable<T>, Iterable<T>, OrderedIterable<T>, RichIterable<T>, StackIterable<T>

public interface ImmutableStack<T>
extends StackIterable<T>

Method Summary

Modifier and Type	Method	Description
default <K, V> ImmutableMap<K,V>	aggregateBy(Function<? super T,? extends K> groupBy, Function0<? extends V> zeroValueFactory, Function2<? super V,? super T,? extends V> nonMutatingAggregator)	Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function.
default <K, V> ImmutableMap<K,V>	aggregateInPlaceBy(Function<? super T,? extends K> groupBy, Function0<? extends V> zeroValueFactory, Procedure2<? super V,? super T> mutatingAggregator)	Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function.
<V> ImmutableStack<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.
ImmutableBooleanStack	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.
ImmutableByteStack	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.
ImmutableCharStack	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.
ImmutableDoubleStack	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.
ImmutableFloatStack	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> ImmutableStack<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.
ImmutableIntStack	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.
ImmutableLongStack	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.
ImmutableShortStack	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> ImmutableStack<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> ImmutableStack<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> ImmutableBag<V>	countBy(Function<? super T,? extends V> function)	This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.
default <V> ImmutableBag<V>	countByEach(Function<? super T,? extends Iterable<V>> function)	This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.
default <V, P> ImmutableBag<V>	countByWith(Function2<? super T,? super P,? extends V> function, P parameter)	This method will count the number of occurrences of each value calculated by applying the function to each element of the collection with the specified parameter as the second argument.
ImmutableStack<T>	distinct()	Returns a new OrderedIterable containing the distinct elements in this iterable.
ImmutableStack<T>	dropWhile(Predicate<? super T> predicate)	Returns the final elements that do not satisfy the Predicate.
<V> ImmutableStack<V>	flatCollect(Function<? super T,? extends Iterable<V>> function)	flatCollect is a special case of RichIterable.collect(Function).
default <P, V> ImmutableStack<V>	flatCollectWith(Function2<? super T,? super P,? extends Iterable<V>> function, P parameter)
<V> ImmutableListMultimap<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> ImmutableListMultimap<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 <V> ImmutableMap<V,T>	groupByUniqueKey(Function<? super T,? extends V> function)	For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key.
PartitionImmutableStack<T>	partition(Predicate<? super T> predicate)	Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
PartitionImmutableStack<T>	partitionWhile(Predicate<? super T> predicate)	Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
<P> PartitionImmutableStack<T>	partitionWith(Predicate2<? super T,? super P> predicate, P parameter)	Filters a collection into a PartitionIterable based on the evaluation of the predicate.
ImmutableStack<T>	pop()
ImmutableStack<T>	pop(int count)
ImmutableStack<T>	push(T item)
ImmutableStack<T>	reject(Predicate<? super T> predicate)	Returns all elements of the source collection that return false when evaluating of the predicate.
<P> ImmutableStack<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.
ImmutableStack<T>	select(Predicate<? super T> predicate)	Returns all elements of the source collection that return true when evaluating the predicate.
<S> ImmutableStack<S>	selectInstancesOf(Class<S> clazz)	Returns all elements of the source collection that are instances of the Class clazz.
<P> ImmutableStack<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.
int	size()	Size takes linear time on ImmutableStacks.
<V> ImmutableObjectDoubleMap<V>	sumByDouble(Function<? super T,? extends V> groupBy, DoubleFunction<? super T> function)	Groups and sums the values using the two specified functions.
<V> ImmutableObjectDoubleMap<V>	sumByFloat(Function<? super T,? extends V> groupBy, FloatFunction<? super T> function)	Groups and sums the values using the two specified functions.
<V> ImmutableObjectLongMap<V>	sumByInt(Function<? super T,? extends V> groupBy, IntFunction<? super T> function)	Groups and sums the values using the two specified functions.
<V> ImmutableObjectLongMap<V>	sumByLong(Function<? super T,? extends V> groupBy, LongFunction<? super T> function)	Groups and sums the values using the two specified functions.
ImmutableStack<T>	takeWhile(Predicate<? super T> predicate)	Returns the initial elements that satisfy the Predicate.
ImmutableStack<T>	tap(Procedure<? super T> procedure)	Executes the Procedure for each element in the iterable and returns this.
<S> ImmutableStack<Pair<T,S>>	zip(Iterable<S> that)	Returns a OrderedIterable formed from this OrderedIterable and another Iterable by combining corresponding elements in pairs.
ImmutableStack<Pair<T,Integer>>	zipWithIndex()	Zips this RichIterable with its indices.

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.ordered.OrderedIterable

collectWithIndex, corresponds, detectIndex, forEach, forEachWithIndex, forEachWithIndex, getFirstOptional, getLastOptional, indexOf, max, min, rejectWithIndex, selectWithIndex, zip, zipWithIndex

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

aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsBy, count, countBy, countByEach, 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, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, makeString, makeString, makeString, max, maxBy, maxByOptional, maxOptional, maxOptional, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, 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

Methods inherited from interface org.eclipse.collections.api.stack.StackIterable

equals, getFirst, getLast, hashCode, peek, peek, peekAt, toImmutable, toStack, toString

Method Details

push

ImmutableStack<T> push(T item)

pop

ImmutableStack<T> pop()

pop

ImmutableStack<T> pop(int count)

takeWhile

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

Description copied from interface: OrderedIterable

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

Specified by:

takeWhile in interface OrderedIterable<T>

Specified by:

takeWhile in interface StackIterable<T>

dropWhile

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

Description copied from interface: OrderedIterable

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

Specified by:

dropWhile in interface OrderedIterable<T>

Specified by:

dropWhile in interface StackIterable<T>

partitionWhile

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

Description copied from interface: OrderedIterable

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

Specified by:

partitionWhile in interface OrderedIterable<T>

Specified by:

partitionWhile in interface StackIterable<T>

distinct

ImmutableStack<T> distinct()

Description copied from interface: OrderedIterable

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.

Specified by:

distinct in interface OrderedIterable<T>

Specified by:

distinct in interface StackIterable<T>

Returns:

OrderedIterable of distinct elements

tap

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

Example using an anonymous inner class:

 RichIterable<Person> tapped =
     people.tap(new Procedure<Person>()
     {
         public void value(Person person)
         {
             LOGGER.info(person.getName());
         }
     });
 

Specified by:

tap in interface OrderedIterable<T>

Specified by:

tap in interface RichIterable<T>

Specified by:

tap in interface StackIterable<T>

See Also:

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

select

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

Example using an anonymous inner class:

 RichIterable<Person> selected =
     people.select(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getAddress().getCity().equals("London");
         }
     });
 

Specified by:

select in interface OrderedIterable<T>

Specified by:

select in interface RichIterable<T>

Specified by:

select in interface StackIterable<T>

selectWith

<P> ImmutableStack<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));
 

Example using an anonymous inner class:

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

Specified by:

selectWith in interface OrderedIterable<T>

Specified by:

selectWith in interface RichIterable<T>

Specified by:

selectWith in interface StackIterable<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

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

Example using an anonymous inner class:

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

Specified by:

reject in interface OrderedIterable<T>

Specified by:

reject in interface RichIterable<T>

Specified by:

reject in interface StackIterable<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> ImmutableStack<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));
 

Example using an anonymous inner class:

 MutableList<Person> rejected =
     people.rejectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge() < age;
         }
     }, Integer.valueOf(18));
 

Specified by:

rejectWith in interface OrderedIterable<T>

Specified by:

rejectWith in interface RichIterable<T>

Specified by:

rejectWith in interface StackIterable<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)

selectInstancesOf

<S> ImmutableStack<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 OrderedIterable<T>

Specified by:

selectInstancesOf in interface RichIterable<T>

Specified by:

selectInstancesOf in interface StackIterable<T>

partition

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

Example using an anonymous inner class:

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

Specified by:

partition in interface OrderedIterable<T>

Specified by:

partition in interface RichIterable<T>

Specified by:

partition in interface StackIterable<T>

partitionWith

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

Example using an anonymous inner class:

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

Specified by:

partitionWith in interface OrderedIterable<T>

Specified by:

partitionWith in interface RichIterable<T>

Specified by:

partitionWith in interface StackIterable<T>

collect

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

Example using an anonymous inner class:

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

Specified by:

collect in interface OrderedIterable<T>

Specified by:

collect in interface RichIterable<T>

Specified by:

collect in interface StackIterable<T>

collectBoolean

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

Example using an anonymous inner class:

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

Specified by:

collectBoolean in interface OrderedIterable<T>

Specified by:

collectBoolean in interface RichIterable<T>

Specified by:

collectBoolean in interface StackIterable<T>

collectByte

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

Example using an anonymous inner class:

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

Specified by:

collectByte in interface OrderedIterable<T>

Specified by:

collectByte in interface RichIterable<T>

Specified by:

collectByte in interface StackIterable<T>

collectChar

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

Example using an anonymous inner class:

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

Specified by:

collectChar in interface OrderedIterable<T>

Specified by:

collectChar in interface RichIterable<T>

Specified by:

collectChar in interface StackIterable<T>

collectDouble

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

Example using an anonymous inner class:

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

Specified by:

collectDouble in interface OrderedIterable<T>

Specified by:

collectDouble in interface RichIterable<T>

Specified by:

collectDouble in interface StackIterable<T>

collectFloat

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

Example using an anonymous inner class:

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

Specified by:

collectFloat in interface OrderedIterable<T>

Specified by:

collectFloat in interface RichIterable<T>

Specified by:

collectFloat in interface StackIterable<T>

collectInt

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

Example using an anonymous inner class:

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

Specified by:

collectInt in interface OrderedIterable<T>

Specified by:

collectInt in interface RichIterable<T>

Specified by:

collectInt in interface StackIterable<T>

collectLong

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

Example using an anonymous inner class:

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

Specified by:

collectLong in interface OrderedIterable<T>

Specified by:

collectLong in interface RichIterable<T>

Specified by:

collectLong in interface StackIterable<T>

collectShort

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

Example using an anonymous inner class:

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

Specified by:

collectShort in interface OrderedIterable<T>

Specified by:

collectShort in interface RichIterable<T>

Specified by:

collectShort in interface StackIterable<T>

collectWith

<P,
V> ImmutableStack<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));
 

Example using an anonymous inner class:

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

Specified by:

collectWith in interface OrderedIterable<T>

Specified by:

collectWith in interface RichIterable<T>

Specified by:

collectWith in interface StackIterable<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> ImmutableStack<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 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 OrderedIterable<T>

Specified by:

collectIf in interface RichIterable<T>

Specified by:

collectIf in interface StackIterable<T>

collectWithIndex

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

Description copied from interface: OrderedIterable

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

Specified by:

collectWithIndex in interface OrderedIterable<T>

Specified by:

collectWithIndex in interface StackIterable<T>

Since:

9.1.

flatCollect

<V> ImmutableStack<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 OrderedIterable<T>

Specified by:

flatCollect in interface RichIterable<T>

Specified by:

flatCollect in interface StackIterable<T>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

flatCollectWith

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

Specified by:

flatCollectWith in interface OrderedIterable<T>

Specified by:

flatCollectWith in interface RichIterable<T>

Specified by:

flatCollectWith in interface StackIterable<T>

Since:

9.2

groupBy

<V> ImmutableListMultimap<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);
 

Example using an anonymous inner class:

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

Specified by:

groupBy in interface OrderedIterable<T>

Specified by:

groupBy in interface RichIterable<T>

Specified by:

groupBy in interface StackIterable<T>

countBy

default <V> ImmutableBag<V> countBy(Function<? super T,? extends V> function)

Description copied from interface: RichIterable

This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.

Specified by:

countBy in interface RichIterable<T>

Since:

9.0

countByWith

default <V,
P> ImmutableBag<V> countByWith(Function2<? super T,? super P,? extends V> function,
 P parameter)

Description copied from interface: RichIterable

This method will count the number of occurrences of each value calculated by applying the function to each element of the collection with the specified parameter as the second argument.

Specified by:

countByWith in interface RichIterable<T>

Since:

9.0

countByEach

default <V> ImmutableBag<V> countByEach(Function<? super T,? extends Iterable<V>> function)

Description copied from interface: RichIterable

This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.

Specified by:

countByEach in interface RichIterable<T>

Since:

10.0.0

groupByEach

<V> ImmutableListMultimap<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 OrderedIterable<T>

Specified by:

groupByEach in interface RichIterable<T>

Specified by:

groupByEach in interface StackIterable<T>

groupByUniqueKey

default <V> ImmutableMap<V,T> groupByUniqueKey(Function<? super T,? extends V> function)

Description copied from interface: RichIterable

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

Specified by:

groupByUniqueKey in interface RichIterable<T>

See Also:

• RichIterable.groupBy(Function)

zip

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

Description copied from interface: OrderedIterable

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

Specified by:

zip in interface RichIterable<T>

Specified by:

zip in interface StackIterable<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.

zipWithIndex

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

Description copied from interface: RichIterable

Zips this RichIterable with its indices.

Specified by:

zipWithIndex in interface OrderedIterable<T>

Specified by:

zipWithIndex in interface RichIterable<T>

Specified by:

zipWithIndex in interface StackIterable<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)

aggregateInPlaceBy

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

Description copied from interface: RichIterable

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

Specified by:

aggregateInPlaceBy in interface RichIterable<T>

aggregateBy

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

Description copied from interface: RichIterable

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

Specified by:

aggregateBy in interface RichIterable<T>

sumByInt

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

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByInt in interface RichIterable<T>

sumByFloat

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

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByFloat in interface RichIterable<T>

sumByLong

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

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByLong in interface RichIterable<T>

sumByDouble

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

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByDouble in interface RichIterable<T>

size

int size()

Size takes linear time on ImmutableStacks.

Specified by:

size in interface RichIterable<T>