StackIterable (Goldman Sachs Collections API

All Superinterfaces:

InternalIterable<T>, java.lang.Iterable<T>, RichIterable<T>

All Known Subinterfaces:

ImmutableStack<T>, MutableStack<T>
```
public interface StackIterable<T>
extends RichIterable<T>
```
StackIterable is a last-in-first-out data structure. All iteration methods iterate from the "top" of the stack to the "bottom". In other words, it processes the most recently added elements first.
For example:
InternalIterable.forEach(Procedure) iterates over every element, starting with the most recently added
getFirst() returns the most recently added element, not the element that was added first
toString() follows the same rules as AbstractCollection.toString() except it processes the elements in the same order as forEach().

Method Summary

Methods
Modifier and Type	Method and Description
`<V> StackIterable<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.
`BooleanStack`	`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.
`ByteStack`	`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.
`CharStack`	`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.
`DoubleStack`	`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.
`FloatStack`	`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> StackIterable<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.
`IntStack`	`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.
`LongStack`	`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.
`ShortStack`	`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> StackIterable<V>`	`collectWith(Function2<? super T,? super P,? extends V> function, P parameter)` Same as collect with a `Function2` and specified parameter which is passed to the block
`boolean`	`equals(java.lang.Object o)` Follows the same general contract as `List.equals(Object)`, but for Stacks.
`<V> StackIterable<V>`	`flatCollect(Function<? super T,? extends java.lang.Iterable<V>> function)` `flatCollect` is a special case of `RichIterable.collect(Function)`.
`T`	`getFirst()` Should return the same value as peek().
`T`	`getLast()` Should not work as it violates the contract of a Stack.
`<V> ListMultimap<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> ListMultimap<V,T>`	`groupByEach(Function<? super T,? extends java.lang.Iterable<V>> function)` Similar to `RichIterable.groupBy(Function)`, except the result of evaluating function will return a collection of keys for each value.
`int`	`hashCode()` Follows the same general contract as `List.hashCode()`, but for Stacks.
`PartitionStack<T>`	`partition(Predicate<? super T> predicate)` Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
`<P> PartitionStack<T>`	`partitionWith(Predicate2<? super T,? super P> predicate, P parameter)` Filters a collection into a PartitionIterable based on the evaluation of the predicate.
`T`	`peek()`
`ListIterable<T>`	`peek(int count)`
`T`	`peekAt(int index)`
`StackIterable<T>`	`reject(Predicate<? super T> predicate)` Returns all elements of the source collection that return false when evaluating of the predicate.
`<P> StackIterable<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`.
`StackIterable<T>`	`select(Predicate<? super T> predicate)` Returns all elements of the source collection that return true when evaluating the predicate.
`<P> StackIterable<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`.
`ImmutableStack<T>`	`toImmutable()` Converts the StackIterable to an immutable implementation.
`MutableStack<T>`	`toStack()` Converts the stack to a MutableStack implementation.
`java.lang.String`	`toString()` Follows the same rules as `AbstractCollection.toString()` except it processes the elements in the same order as `forEach()`.
`<S> StackIterable<Pair<T,S>>`	`zip(java.lang.Iterable<S> that)` Returns a `RichIterable` formed from this `RichIterable` and another `RichIterable` by combining corresponding elements in pairs.
`StackIterable<Pair<T,java.lang.Integer>>`	`zipWithIndex()` Zips this `RichIterable` with its indices.

Methods inherited from interface com.gs.collections.api.RichIterable
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, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectInstancesOf, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex

Methods inherited from interface com.gs.collections.api.InternalIterable
forEach, forEachWith, forEachWithIndex

Methods inherited from interface java.lang.Iterable
iterator

- Method Detail
  - peek
```
T peek()
```
    Returns:
    the top of the stack.
  - peek
```
ListIterable<T> peek(int count)
```
    Returns:
    a ListIterable of the number of elements specified by the count, beginning with the top of the stack.
  - peekAt
```
T peekAt(int index)
```
    Parameters:
    index - the location to peek into
    
    Returns:
    the element at the specified index
  - getFirst
```
T getFirst()
```
    Should return the same value as peek().
    
    Specified by:
    
    getFirst in interface RichIterable<T>
  - getLast
```
T getLast()
```
    Should not work as it violates the contract of a Stack.
    
    Specified by:
    
    getLast in interface RichIterable<T>
    
    Throws:
    
    java.lang.UnsupportedOperationException
  - toString
```
java.lang.String toString()
```
    Follows the same rules as AbstractCollection.toString() except it processes the elements in the same order as forEach().
    
    Specified by:
    
    toString in interface RichIterable<T>
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    a string representation of this RichIterable
  - equals
```
boolean equals(java.lang.Object o)
```
    Follows the same general contract as List.equals(Object), but for Stacks.
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
int hashCode()
```
    Follows the same general contract as List.hashCode(), but for Stacks.
    
    Overrides:
    
    hashCode in class java.lang.Object
  - toStack
```
MutableStack<T> toStack()
```
    Converts the stack to a MutableStack implementation.
    
    Since:
    
    2.0
  - select
```
StackIterable<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.
```
e.g.
 return people.select(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.getAddress().getCity().equals("Metuchen");
     }
 });
 
```
    Specified by:
    
    select in interface RichIterable<T>
  - selectWith
```
<P> StackIterable<T> selectWith(Predicate2<? super T,? super P> predicate,
                              P parameter)
```
    Description copied from interface: RichIterable
    
    Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
    
    Specified by:
    
    selectWith in interface 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
```
StackIterable<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)).
```
e.g.
 return people.reject(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.person.getLastName().equals("Smith");
     }
 });
 
```
```
e.g.
 return people.reject(Predicates.attributeEqual("lastName", "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> StackIterable<T> rejectWith(Predicate2<? super T,? super P> predicate,
                              P parameter)
```
    Description copied from interface: RichIterable
    
    Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
    
    Specified by:
    
    rejectWith in interface 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
```
PartitionStack<T> partition(Predicate<? super T> predicate)
```
    Description copied from interface: RichIterable
    Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
```
e.g.
 return people.partition(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.getAddress().getState().getName().equals("New York");
     }
 });
 
```
    Specified by:
    
    partition in interface RichIterable<T>
  - partitionWith
```
<P> PartitionStack<T> partitionWith(Predicate2<? super T,? super P> predicate,
                                  P parameter)
```
    Description copied from interface: RichIterable
    Filters a collection into a PartitionIterable based on the evaluation of the predicate.
```
e.g.
 return people.partitionWith(new Predicate2<Person, String>()
 {
     public boolean accept(Person person, String state)
     {
         return person.getAddress().getState().getName().equals(state);
     }
 }, "New York");
 
```
    Specified by:
    
    partitionWith in interface RichIterable<T>
  - collect
```
<V> StackIterable<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.
```
e.g.
 return people.collect(new Function<Person, String>()
 {
     public String valueOf(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 });
 
```
    Specified by:
    
    collect in interface RichIterable<T>
  - collectBoolean
```
BooleanStack 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.
```
e.g.
 return people.collectBoolean(new BooleanFunction<Person>()
 {
     public boolean booleanValueOf(Person person)
     {
         return person.hasDrivingLicense();
     }
 });
 
```
    Specified by:
    
    collectBoolean in interface RichIterable<T>
  - collectByte
```
ByteStack 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.
```
e.g.
 return people.collectByte(new ByteFunction<Person>()
 {
     public byte byteValueOf(Person person)
     {
         return person.getCode();
     }
 });
 
```
    Specified by:
    
    collectByte in interface RichIterable<T>
  - collectChar
```
CharStack 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.
```
e.g.
 return people.collectChar(new CharFunction<Person>()
 {
     public char charValueOf(Person person)
     {
         return person.getMiddleInitial();
     }
 });
 
```
    Specified by:
    
    collectChar in interface RichIterable<T>
  - collectDouble
```
DoubleStack 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.
```
e.g.
 return people.collectDouble(new DoubleFunction<Person>()
 {
     public double doubleValueOf(Person person)
     {
         return person.getMilesFromNorthPole();
     }
 });
 
```
    Specified by:
    
    collectDouble in interface RichIterable<T>
  - collectFloat
```
FloatStack 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.
```
e.g.
 return people.collectFloat(new FloatFunction<Person>()
 {
     public float floatValueOf(Person person)
     {
         return person.getHeightInInches();
     }
 });
 
```
    Specified by:
    
    collectFloat in interface RichIterable<T>
  - collectInt
```
IntStack 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.
```
e.g.
 return people.collectInt(new IntFunction<Person>()
 {
     public int intValueOf(Person person)
     {
         return person.getAge();
     }
 });
 
```
    Specified by:
    
    collectInt in interface RichIterable<T>
  - collectLong
```
LongStack 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.
```
e.g.
 return people.collectLong(new LongFunction<Person>()
 {
     public long longValueOf(Person person)
     {
         return person.getGuid();
     }
 });
 
```
    Specified by:
    
    collectLong in interface RichIterable<T>
  - collectShort
```
ShortStack 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.
```
e.g.
 return people.collectShort(new ShortFunction<Person>()
 {
     public short shortValueOf(Person person)
     {
         return person.getNumberOfJunkMailItemsReceivedPerMonth();
     }
 });
 
```
    Specified by:
    
    collectShort in interface RichIterable<T>
  - collectWith
```
<P,V> StackIterable<V> collectWith(Function2<? super T,? super P,? extends V> function,
                                 P parameter)
```
    Description copied from interface: RichIterable
    Same as collect with a Function2 and specified parameter which is passed to the block
```
e.g.
 Function2 addParameterFunction =
 new Function2()
 {
      public Integer value(final Integer each, final Integer parameter)
      {
          return each + parameter;
      }
 };
 FastList.newListWith(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
 
```
    Specified by:
    
    collectWith in interface 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> StackIterable<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).
```
e.g.
 Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
 
```
    Specified by:
    
    collectIf in interface RichIterable<T>
  - flatCollect
```
<V> StackIterable<V> flatCollect(Function<? super T,? extends java.lang.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 = new Function<Person, List<Address>>() {
     public List<Address> valueOf(Person person) {
         return person.getAddresses();
     }
 };
 MutableList<Person> people = ...;
 
```
    Using collect returns a collection of collections of addresses.
```
 MutableList<List<Address>> addresses = people.collect(addressFunction);
 
```
    Using flatCollect returns a single flattened list of addresses.
```
 MutableList<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
  - groupBy
```
<V> ListMultimap<V,T> groupBy(Function<? super T,? extends V> function)
```
    Description copied from interface: RichIterable
    For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
```
e.g.
 return people.groupBy(new Function<Person, String>()
 {
     public String value(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 });
 
```
    Specified by:
    
    groupBy in interface RichIterable<T>
  - groupByEach
```
<V> ListMultimap<V,T> groupByEach(Function<? super T,? extends java.lang.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> StackIterable<Pair<T,S>> zip(java.lang.Iterable<S> that)
```
    Description copied from interface: RichIterable
    
    Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs. If one of the two RichIterables 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 RichIterable providing the second half of each result pair
    
    Returns:
    A new RichIterable containing pairs consisting of corresponding elements of this RichIterable and that. The length of the returned RichIterable is the minimum of the lengths of this RichIterable and that.
  - zipWithIndex
```
StackIterable<Pair<T,java.lang.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)
  - toImmutable
```
ImmutableStack<T> toImmutable()
```
    Converts the StackIterable to an immutable implementation. Returns this for immutable stacks.
    
    Since:
    
    5.0

Interface StackIterable<T>

Method Summary

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

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

Methods inherited from interface java.lang.Iterable

Method Detail

peek

peek

peekAt

getFirst

getLast

toString

equals

hashCode

toStack

select

selectWith

reject

rejectWith

partition

partitionWith

collect

collectBoolean

collectByte

collectChar

collectDouble

collectFloat

collectInt

collectLong

collectShort

collectWith

collectIf

flatCollect

groupBy

groupByEach

zip

zipWithIndex

toImmutable