UnmodifiableStack (Goldman Sachs Collections

java.lang.Object
- com.gs.collections.impl.stack.mutable.UnmodifiableStack<T>

All Implemented Interfaces:

com.gs.collections.api.InternalIterable<T>, com.gs.collections.api.RichIterable<T>, com.gs.collections.api.stack.MutableStack<T>, com.gs.collections.api.stack.StackIterable<T>, java.io.Serializable, java.lang.Iterable<T>
```
public final class UnmodifiableStack<T>
extends java.lang.Object
implements com.gs.collections.api.stack.MutableStack<T>, java.io.Serializable
```
See Also:
Serialized Form

Method Summary

Methods
Modifier and Type	Method and Description
`<K,V> com.gs.collections.api.map.MutableMap<K,V>`	`aggregateBy(com.gs.collections.api.block.function.Function<? super T,? extends K> groupBy, com.gs.collections.api.block.function.Function0<? extends V> zeroValueFactory, com.gs.collections.api.block.function.Function2<? super V,? super T,? extends V> nonMutatingAggregator)` Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function.
`<K,V> com.gs.collections.api.map.MutableMap<K,V>`	`aggregateInPlaceBy(com.gs.collections.api.block.function.Function<? super T,? extends K> groupBy, com.gs.collections.api.block.function.Function0<? extends V> zeroValueFactory, com.gs.collections.api.block.procedure.Procedure2<? super V,? super T> mutatingAggregator)` Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function.
`boolean`	`allSatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty.
`<P> boolean`	`allSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)` Returns true if the predicate evaluates to true for every element of the collection, or returns false.
`boolean`	`anySatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Returns true if the predicate evaluates to true for any element of the iterable.
`<P> boolean`	`anySatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)` Returns true if the predicate evaluates to true for any element of the collection, or return false.
`void`	`appendString(java.lang.Appendable appendable)` Prints a string representation of this collection onto the given `Appendable`.
`void`	`appendString(java.lang.Appendable appendable, java.lang.String separator)` Prints a string representation of this collection onto the given `Appendable`.
`void`	`appendString(java.lang.Appendable appendable, java.lang.String start, java.lang.String separator, java.lang.String end)` Prints a string representation of this collection onto the given `Appendable`.
`com.gs.collections.api.LazyIterable<T>`	`asLazy()` Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).
`com.gs.collections.api.stack.MutableStack<T>`	`asSynchronized()`
`com.gs.collections.api.stack.MutableStack<T>`	`asUnmodifiable()`
`com.gs.collections.api.RichIterable<com.gs.collections.api.RichIterable<T>>`	`chunk(int size)` Partitions elements in fixed size chunks.
`void`	`clear()`
`<V> com.gs.collections.api.stack.MutableStack<V>`	`collect(com.gs.collections.api.block.function.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.
`<V,R extends java.util.Collection<V>> R`	`collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function, R target)` Same as `RichIterable.collect(Function)`, except that the results are gathered into the specified `target` collection.
`com.gs.collections.api.stack.primitive.MutableBooleanStack`	`collectBoolean(com.gs.collections.api.block.function.primitive.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.
`<R extends com.gs.collections.api.collection.primitive.MutableBooleanCollection> R`	`collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super T> booleanFunction, R target)` Same as `RichIterable.collectBoolean(BooleanFunction)`, except that the results are gathered into the specified `target` collection.
`com.gs.collections.api.stack.primitive.MutableByteStack`	`collectByte(com.gs.collections.api.block.function.primitive.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.
`<R extends com.gs.collections.api.collection.primitive.MutableByteCollection> R`	`collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super T> byteFunction, R target)` Same as `RichIterable.collectByte(ByteFunction)`, except that the results are gathered into the specified `target` collection.
`com.gs.collections.api.stack.primitive.MutableCharStack`	`collectChar(com.gs.collections.api.block.function.primitive.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.
`<R extends com.gs.collections.api.collection.primitive.MutableCharCollection> R`	`collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super T> charFunction, R target)` Same as `RichIterable.collectChar(CharFunction)`, except that the results are gathered into the specified `target` collection.
`com.gs.collections.api.stack.primitive.MutableDoubleStack`	`collectDouble(com.gs.collections.api.block.function.primitive.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.
`<R extends com.gs.collections.api.collection.primitive.MutableDoubleCollection> R`	`collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction, R target)` Same as `RichIterable.collectDouble(DoubleFunction)`, except that the results are gathered into the specified `target` collection.
`com.gs.collections.api.stack.primitive.MutableFloatStack`	`collectFloat(com.gs.collections.api.block.function.primitive.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.
`<R extends com.gs.collections.api.collection.primitive.MutableFloatCollection> R`	`collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction, R target)` Same as `RichIterable.collectFloat(FloatFunction)`, except that the results are gathered into the specified `target` collection.
`<V> com.gs.collections.api.stack.MutableStack<V>`	`collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.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.
`<V,R extends java.util.Collection<V>> R`	`collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function<? super T,? extends V> function, R target)` Same as the collectIf method with two parameters but uses the specified target collection for the results.
`com.gs.collections.api.stack.primitive.MutableIntStack`	`collectInt(com.gs.collections.api.block.function.primitive.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.
`<R extends com.gs.collections.api.collection.primitive.MutableIntCollection> R`	`collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction, R target)` Same as `RichIterable.collectInt(IntFunction)`, except that the results are gathered into the specified `target` collection.
`com.gs.collections.api.stack.primitive.MutableLongStack`	`collectLong(com.gs.collections.api.block.function.primitive.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.
`<R extends com.gs.collections.api.collection.primitive.MutableLongCollection> R`	`collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction, R target)` Same as `RichIterable.collectLong(LongFunction)`, except that the results are gathered into the specified `target` collection.
`com.gs.collections.api.stack.primitive.MutableShortStack`	`collectShort(com.gs.collections.api.block.function.primitive.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.
`<R extends com.gs.collections.api.collection.primitive.MutableShortCollection> R`	`collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super T> shortFunction, R target)` Same as `RichIterable.collectShort(ShortFunction)`, except that the results are gathered into the specified `target` collection.
`<P,V> com.gs.collections.api.stack.MutableStack<V>`	`collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function, P parameter)` Same as collect with a `Function2` and specified parameter which is passed to the block
`<P,V,R extends java.util.Collection<V>> R`	`collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function, P parameter, R targetCollection)` Same as collectWith but with a targetCollection parameter to gather the results.
`boolean`	`contains(java.lang.Object object)` Returns true if the iterable has an element which responds true to element.equals(object).
`boolean`	`containsAll(java.util.Collection<?> source)` Returns true if all elements in source are contained in this collection.
`boolean`	`containsAllArguments(java.lang.Object... elements)` Returns true if all elements in the specified var arg array are contained in this collection.
`boolean`	`containsAllIterable(java.lang.Iterable<?> source)` Returns true if all elements in source are contained in this collection.
`int`	`count(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Return the total number of elements that answer true to the specified predicate.
`<P> int`	`countWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)` Returns the total number of elements that evaluate to true for the specified predicate.
`T`	`detect(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true.
`T`	`detectIfNone(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function0<? extends T> function)` Returns the first element of the iterable for which the predicate evaluates to true.
`<P> T`	`detectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)` Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true.
`<P> T`	`detectWithIfNone(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter, com.gs.collections.api.block.function.Function0<? extends T> function)` Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or returns the value of evaluating the specified function.
`boolean`	`equals(java.lang.Object obj)` Follows the same general contract as `List.equals(Object)`, but for Stacks.
`<V> com.gs.collections.api.stack.MutableStack<V>`	`flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)` `flatCollect` is a special case of `RichIterable.collect(Function)`.
`<V,R extends java.util.Collection<V>> R`	`flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function, R target)` Same as flatCollect, only the results are collected into the target collection.
`void`	`forEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)` The procedure is executed for each element in the iterable.
`<P> void`	`forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super T,? super P> procedure, P parameter)` The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.
`void`	`forEachWithIndex(com.gs.collections.api.block.procedure.primitive.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()` Should return the same value as peek().
`T`	`getLast()` Should not work as it violates the contract of a Stack.
`<V> com.gs.collections.api.multimap.list.MutableListMultimap<V,T>`	`groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)` For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
`<V,R extends com.gs.collections.api.multimap.MutableMultimap<V,T>> R`	`groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function, R target)` Same as `RichIterable.groupBy(Function)`, except that the results are gathered into the specified `target` multimap.
`<V> com.gs.collections.api.multimap.list.MutableListMultimap<V,T>`	`groupByEach(com.gs.collections.api.block.function.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.
`<V,R extends com.gs.collections.api.multimap.MutableMultimap<V,T>> R`	`groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function, R target)` Same as `RichIterable.groupByEach(Function)`, except that the results are gathered into the specified `target` multimap.
`<V> com.gs.collections.api.map.MutableMap<V,T>`	`groupByUniqueKey(com.gs.collections.api.block.function.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.
`int`	`hashCode()` Follows the same general contract as `List.hashCode()`, but for Stacks.
`double`	`injectInto(double injectedValue, com.gs.collections.api.block.function.primitive.DoubleObjectToDoubleFunction<? super T> doubleObjectToDoubleFunction)` Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
`float`	`injectInto(float injectedValue, com.gs.collections.api.block.function.primitive.FloatObjectToFloatFunction<? super T> floatObjectToFloatFunction)` Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
`int`	`injectInto(int injectedValue, com.gs.collections.api.block.function.primitive.IntObjectToIntFunction<? super T> intObjectToIntFunction)` Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
`<IV> IV`	`injectInto(IV injectedValue, com.gs.collections.api.block.function.Function2<? super IV,? super T,? extends IV> function)` Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
`long`	`injectInto(long injectedValue, com.gs.collections.api.block.function.primitive.LongObjectToLongFunction<? super T> longObjectToLongFunction)` Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
`boolean`	`isEmpty()` Returns true if this iterable has zero items.
`java.util.Iterator<T>`	`iterator()`
`java.lang.String`	`makeString()` Returns a string representation of this collection by delegating to `RichIterable.makeString(String)` and defaulting the separator parameter to the characters `", "` (comma and space).
`java.lang.String`	`makeString(java.lang.String separator)` Returns a string representation of this collection by delegating to `RichIterable.makeString(String, String, String)` and defaulting the start and end parameters to `""` (the empty String).
`java.lang.String`	`makeString(java.lang.String start, java.lang.String separator, java.lang.String end)` Returns a string representation of this collection.
`T`	`max()` Returns the maximum element out of this container based on the natural order.
`T`	`max(java.util.Comparator<? super T> comparator)` Returns the maximum element out of this container based on the comparator.
`<V extends java.lang.Comparable<? super V>> T`	`maxBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)` Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.
`T`	`min()` Returns the minimum element out of this container based on the natural order.
`T`	`min(java.util.Comparator<? super T> comparator)` Returns the minimum element out of this container based on the comparator.
`<V extends java.lang.Comparable<? super V>> T`	`minBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)` Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.
`boolean`	`noneSatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty.
`<P> boolean`	`noneSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)` Returns true if the predicate evaluates to false for every element of the collection, or return false.
`boolean`	`notEmpty()` The English equivalent of !this.isEmpty()
`static <T,S extends com.gs.collections.api.stack.MutableStack<T>> UnmodifiableStack<T>`	`of(S stack)`
`com.gs.collections.api.partition.stack.PartitionMutableStack<T>`	`partition(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
`<P> com.gs.collections.api.partition.stack.PartitionMutableStack<T>`	`partitionWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)` Filters a collection into a PartitionIterable based on the evaluation of the predicate.
`T`	`peek()`
`com.gs.collections.api.list.ListIterable<T>`	`peek(int count)`
`T`	`peekAt(int index)`
`T`	`pop()` Removes and returns the top element of the stack.
`com.gs.collections.api.list.ListIterable<T>`	`pop(int count)` Removes and returns a ListIterable of the number of elements specified by the count, beginning with the top of the stack.
`<R extends com.gs.collections.api.stack.MutableStack<T>> R`	`pop(int count, R targetStack)` Removes and returns a ListIterable of the number of elements specified by the count, beginning with the top of the stack and puts them into a new stack.
`<R extends java.util.Collection<T>> R`	`pop(int count, R targetCollection)` Removes and returns a ListIterable of the number of elements specified by the count, beginning with the top of the stack and puts them into the targeted collection type.
`void`	`push(T item)` Adds an item to the top of the stack.
`com.gs.collections.api.stack.MutableStack<T>`	`reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Returns all elements of the source collection that return false when evaluating of the predicate.
`<R extends java.util.Collection<T>> R`	`reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, R target)` Same as the reject method with one parameter but uses the specified target collection for the results.
`<P> com.gs.collections.api.stack.MutableStack<T>`	`rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)` Similar to `RichIterable.reject(Predicate)`, except with an evaluation parameter for the second generic argument in `Predicate2`.
`<P,R extends java.util.Collection<T>> R`	`rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter, R targetCollection)` Similar to `RichIterable.reject(Predicate, Collection)`, except with an evaluation parameter for the second generic argument in `Predicate2`.
`com.gs.collections.api.stack.MutableStack<T>`	`select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)` Returns all elements of the source collection that return true when evaluating the predicate.
`<R extends java.util.Collection<T>> R`	`select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, R target)` Same as the select method with one parameter but uses the specified target collection for the results.
`<S> com.gs.collections.api.RichIterable<S>`	`selectInstancesOf(java.lang.Class<S> clazz)` Returns all elements of the source collection that are instances of the Class `clazz`.
`<P> com.gs.collections.api.stack.MutableStack<T>`	`selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter)` Similar to `RichIterable.select(Predicate)`, except with an evaluation parameter for the second generic argument in `Predicate2`.
`<P,R extends java.util.Collection<T>> R`	`selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate, P parameter, R targetCollection)` Similar to `RichIterable.select(Predicate, Collection)`, except with an evaluation parameter for the second generic argument in `Predicate2`.
`int`	`size()` Returns the number of items in this iterable.
`double`	`sumOfDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction)` Returns the final double result of evaluating function for each element of the iterable and adding the results together.
`double`	`sumOfFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction)` Returns the final double result of evaluating function for each element of the iterable and adding the results together.
`long`	`sumOfInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction)` Returns the final long result of evaluating function for each element of the iterable and adding the results together.
`long`	`sumOfLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction)` Returns the final long result of evaluating function for each element of the iterable and adding the results together.
`java.lang.Object[]`	`toArray()` Converts this iterable to an array.
`<T> T[]`	`toArray(T[] a)` Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.
`com.gs.collections.api.bag.MutableBag<T>`	`toBag()` Converts the collection to the default MutableBag implementation.
`com.gs.collections.api.stack.ImmutableStack<T>`	`toImmutable()` Converts the StackIterable to an immutable implementation.
`com.gs.collections.api.list.MutableList<T>`	`toList()` Converts the collection to a MutableList implementation.
`<NK,NV> com.gs.collections.api.map.MutableMap<NK,NV>`	`toMap(com.gs.collections.api.block.function.Function<? super T,? extends NK> keyFunction, com.gs.collections.api.block.function.Function<? super T,? extends NV> valueFunction)` Converts the collection to a MutableMap implementation using the specified key and value functions.
`com.gs.collections.api.set.MutableSet<T>`	`toSet()` Converts the collection to a MutableSet implementation.
`com.gs.collections.api.list.MutableList<T>`	`toSortedList()` Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.
`com.gs.collections.api.list.MutableList<T>`	`toSortedList(java.util.Comparator<? super T> comparator)` Converts the collection to a MutableList implementation and sorts it using the specified comparator.
`<V extends java.lang.Comparable<? super V>> com.gs.collections.api.list.MutableList<T>`	`toSortedListBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)` Converts the collection to a MutableList implementation and sorts it based on the natural order of the attribute returned by `function`.
`<NK,NV> com.gs.collections.api.map.sorted.MutableSortedMap<NK,NV>`	`toSortedMap(java.util.Comparator<? super NK> comparator, com.gs.collections.api.block.function.Function<? super T,? extends NK> keyFunction, com.gs.collections.api.block.function.Function<? super T,? extends NV> valueFunction)` Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the given comparator.
`<NK,NV> com.gs.collections.api.map.sorted.MutableSortedMap<NK,NV>`	`toSortedMap(com.gs.collections.api.block.function.Function<? super T,? extends NK> keyFunction, com.gs.collections.api.block.function.Function<? super T,? extends NV> valueFunction)` Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the key elements' natural ordering.
`com.gs.collections.api.set.sorted.MutableSortedSet<T>`	`toSortedSet()` Converts the collection to a MutableSortedSet implementation and sorts it using the natural order of the elements.
`com.gs.collections.api.set.sorted.MutableSortedSet<T>`	`toSortedSet(java.util.Comparator<? super T> comparator)` Converts the collection to a MutableSortedSet implementation and sorts it using the specified comparator.
`<V extends java.lang.Comparable<? super V>> com.gs.collections.api.set.sorted.MutableSortedSet<T>`	`toSortedSetBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)` Converts the collection to a MutableSortedSet implementation and sorts it based on the natural order of the attribute returned by `function`.
`com.gs.collections.api.stack.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> com.gs.collections.api.stack.MutableStack<com.gs.collections.api.tuple.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.
`<S,R extends java.util.Collection<com.gs.collections.api.tuple.Pair<T,S>>> R`	`zip(java.lang.Iterable<S> that, R target)` Same as `RichIterable.zip(Iterable)` but uses `target` for output.
`com.gs.collections.api.stack.MutableStack<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>>`	`zipWithIndex()` Zips this `RichIterable` with its indices.
`<R extends java.util.Collection<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>>> R`	`zipWithIndex(R target)` Same as `RichIterable.zipWithIndex()` but uses `target` for output.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
 - of
```
public static <T,S extends com.gs.collections.api.stack.MutableStack<T>> UnmodifiableStack<T> of(S stack)
```
 - pop
```
public T pop()
```
 Description copied from interface: com.gs.collections.api.stack.MutableStack
 
 Removes and returns the top element of the stack.
 
 Specified by:
 
 pop in interface com.gs.collections.api.stack.MutableStack<T>
 - pop
```
public com.gs.collections.api.list.ListIterable<T> pop(int count)
```
 Description copied from interface: com.gs.collections.api.stack.MutableStack
 
 Removes and returns a ListIterable of the number of elements specified by the count, beginning with the top of the stack.
 
 Specified by:
 
 pop in interface com.gs.collections.api.stack.MutableStack<T>
 - pop
```
public <R extends java.util.Collection<T>> R pop(int count,
 R targetCollection)
```
 Description copied from interface: com.gs.collections.api.stack.MutableStack
 
 Removes and returns a ListIterable of the number of elements specified by the count, beginning with the top of the stack and puts them into the targeted collection type.
 
 Specified by:
 
 pop in interface com.gs.collections.api.stack.MutableStack<T>
 - pop
```
public <R extends com.gs.collections.api.stack.MutableStack<T>> R pop(int count,
 R targetStack)
```
 Description copied from interface: com.gs.collections.api.stack.MutableStack
 
 Removes and returns a ListIterable of the number of elements specified by the count, beginning with the top of the stack and puts them into a new stack.
 
 Specified by:
 
 pop in interface com.gs.collections.api.stack.MutableStack<T>
 - clear
```
public void clear()
```
 Specified by:
 
 clear in interface com.gs.collections.api.stack.MutableStack<T>
 - push
```
public void push(T item)
```
 Description copied from interface: com.gs.collections.api.stack.MutableStack
 
 Adds an item to the top of the stack.
 
 Specified by:
 
 push in interface com.gs.collections.api.stack.MutableStack<T>
 - iterator
```
public java.util.Iterator<T> iterator()
```
 Specified by:
 
 iterator in interface java.lang.Iterable<T>
 - select
```
public com.gs.collections.api.stack.MutableStack<T> select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 select in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 select in interface com.gs.collections.api.stack.StackIterable<T>
 - selectWith
```
public  com.gs.collections.api.stack.MutableStack<T> selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
 
 Specified by:
 
 selectWith in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 selectWith in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 selectWith in interface com.gs.collections.api.stack.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
```
public com.gs.collections.api.stack.MutableStack<T> reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 reject in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 reject in interface com.gs.collections.api.stack.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
```
public  com.gs.collections.api.stack.MutableStack<T> rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
 
 Specified by:
 
 rejectWith in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 rejectWith in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 rejectWith in interface com.gs.collections.api.stack.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)
 - partition
```
public com.gs.collections.api.partition.stack.PartitionMutableStack<T> partition(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 partition in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 partition in interface com.gs.collections.api.stack.StackIterable<T>
 - partitionWith
```
public  com.gs.collections.api.partition.stack.PartitionMutableStack<T> partitionWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 partitionWith in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 partitionWith in interface com.gs.collections.api.stack.StackIterable<T>
 - selectInstancesOf
```
public <S> com.gs.collections.api.RichIterable<S> selectInstancesOf(java.lang.Class<S> clazz)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns all elements of the source collection that are instances of the Class clazz.
 
 Specified by:
 
 selectInstancesOf in interface com.gs.collections.api.RichIterable<T>
 - collect
```
public <V> com.gs.collections.api.stack.MutableStack<V> collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collect in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 collect in interface com.gs.collections.api.stack.StackIterable<T>
 - collectBoolean
```
public com.gs.collections.api.stack.primitive.MutableBooleanStack collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super T> booleanFunction)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collectBoolean in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 collectBoolean in interface com.gs.collections.api.stack.StackIterable<T>
 - collectBoolean
```
public <R extends com.gs.collections.api.collection.primitive.MutableBooleanCollection> R collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super T> booleanFunction,
 R target)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Same as RichIterable.collectBoolean(BooleanFunction), except that the results are gathered into the specified target collection.
```
e.g.
 return people.collectBoolean(new BooleanFunction<Person>()
 {
 public boolean booleanValueOf(Person person)
 {
 return person.hasDrivingLicense();
 }
 }, new BooleanArrayList());
 
```
 Specified by:
 
 collectBoolean in interface com.gs.collections.api.RichIterable<T>
 
 Parameters:
 booleanFunction - a BooleanFunction to use as the collect transformation function
 target - the MutableBooleanCollection to append to for all elements in this RichIterable
 
 Returns:
 target, which contains appended elements as a result of the collect transformation
 - collectByte
```
public com.gs.collections.api.stack.primitive.MutableByteStack collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super T> byteFunction)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collectByte in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 collectByte in interface com.gs.collections.api.stack.StackIterable<T>
 - collectByte
```
public <R extends com.gs.collections.api.collection.primitive.MutableByteCollection> R collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super T> byteFunction,
 R target)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Same as RichIterable.collectByte(ByteFunction), except that the results are gathered into the specified target collection.
```
e.g.
 return people.collectByte(new ByteFunction<Person>()
 {
 public byte byteValueOf(Person person)
 {
 return person.getCode();
 }
 }, new ByteArrayList());
 
```
 Specified by:
 
 collectByte in interface com.gs.collections.api.RichIterable<T>
 
 Parameters:
 byteFunction - a ByteFunction to use as the collect transformation function
 target - the MutableByteCollection to append to for all elements in this RichIterable
 
 Returns:
 target, which contains appended elements as a result of the collect transformation
 - collectChar
```
public com.gs.collections.api.stack.primitive.MutableCharStack collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super T> charFunction)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collectChar in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 collectChar in interface com.gs.collections.api.stack.StackIterable<T>
 - collectChar
```
public <R extends com.gs.collections.api.collection.primitive.MutableCharCollection> R collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super T> charFunction,
 R target)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Same as RichIterable.collectChar(CharFunction), except that the results are gathered into the specified target collection.
```
e.g.
 return people.collectChar(new CharFunction<Person>()
 {
 public char charValueOf(Person person)
 {
 return person.getMiddleInitial();
 }
 }, new CharArrayList());
 
```
 Specified by:
 
 collectChar in interface com.gs.collections.api.RichIterable<T>
 
 Parameters:
 charFunction - a CharFunction to use as the collect transformation function
 target - the MutableCharCollection to append to for all elements in this RichIterable
 
 Returns:
 target, which contains appended elements as a result of the collect transformation
 - collectDouble
```
public com.gs.collections.api.stack.primitive.MutableDoubleStack collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collectDouble in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 collectDouble in interface com.gs.collections.api.stack.StackIterable<T>
 - collectDouble
```
public <R extends com.gs.collections.api.collection.primitive.MutableDoubleCollection> R collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction,
 R target)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Same as RichIterable.collectDouble(DoubleFunction), except that the results are gathered into the specified target collection.
```
e.g.
 return people.collectDouble(new DoubleFunction<Person>()
 {
 public double doubleValueOf(Person person)
 {
 return person.getMilesFromNorthPole();
 }
 }, new DoubleArrayList());
 
```
 Specified by:
 
 collectDouble in interface com.gs.collections.api.RichIterable<T>
 
 Parameters:
 doubleFunction - a DoubleFunction to use as the collect transformation function
 target - the MutableDoubleCollection to append to for all elements in this RichIterable
 
 Returns:
 target, which contains appended elements as a result of the collect transformation
 - collectFloat
```
public com.gs.collections.api.stack.primitive.MutableFloatStack collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collectFloat in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 collectFloat in interface com.gs.collections.api.stack.StackIterable<T>
 - collectFloat
```
public <R extends com.gs.collections.api.collection.primitive.MutableFloatCollection> R collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction,
 R target)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Same as RichIterable.collectFloat(FloatFunction), except that the results are gathered into the specified target collection.
```
e.g.
 return people.collectFloat(new FloatFunction<Person>()
 {
 public float floatValueOf(Person person)
 {
 return person.getHeightInInches();
 }
 }, new FloatArrayList());
 
```
 Specified by:
 
 collectFloat in interface com.gs.collections.api.RichIterable<T>
 
 Parameters:
 floatFunction - a FloatFunction to use as the collect transformation function
 target - the MutableFloatCollection to append to for all elements in this RichIterable
 
 Returns:
 target, which contains appended elements as a result of the collect transformation
 - collectInt
```
public com.gs.collections.api.stack.primitive.MutableIntStack collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collectInt in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 collectInt in interface com.gs.collections.api.stack.StackIterable<T>
 - collectInt
```
public <R extends com.gs.collections.api.collection.primitive.MutableIntCollection> R collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction,
 R target)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Same as RichIterable.collectInt(IntFunction), except that the results are gathered into the specified target collection.
```
e.g.
 return people.collectInt(new IntFunction<Person>()
 {
 public int intValueOf(Person person)
 {
 return person.getAge();
 }
 }, new IntArrayList());
 
```
 Specified by:
 
 collectInt in interface com.gs.collections.api.RichIterable<T>
 
 Parameters:
 intFunction - a IntFunction to use as the collect transformation function
 target - the MutableIntCollection to append to for all elements in this RichIterable
 
 Returns:
 target, which contains appended elements as a result of the collect transformation
 - collectLong
```
public com.gs.collections.api.stack.primitive.MutableLongStack collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collectLong in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 collectLong in interface com.gs.collections.api.stack.StackIterable<T>
 - collectLong
```
public <R extends com.gs.collections.api.collection.primitive.MutableLongCollection> R collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction,
 R target)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Same as RichIterable.collectLong(LongFunction), except that the results are gathered into the specified target collection.
```
e.g.
 return people.collectLong(new LongFunction<Person>()
 {
 public long longValueOf(Person person)
 {
 return person.getGuid();
 }
 }, new LongArrayList());
 
```
 Specified by:
 
 collectLong in interface com.gs.collections.api.RichIterable<T>
 
 Parameters:
 longFunction - a LongFunction to use as the collect transformation function
 target - the MutableLongCollection to append to for all elements in this RichIterable
 
 Returns:
 target, which contains appended elements as a result of the collect transformation
 - collectShort
```
public com.gs.collections.api.stack.primitive.MutableShortStack collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super T> shortFunction)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collectShort in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 collectShort in interface com.gs.collections.api.stack.StackIterable<T>
 - collectShort
```
public <R extends com.gs.collections.api.collection.primitive.MutableShortCollection> R collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super T> shortFunction,
 R target)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Same as RichIterable.collectShort(ShortFunction), except that the results are gathered into the specified target collection.
```
e.g.
 return people.collectShort(new ShortFunction<Person>()
 {
 public short shortValueOf(Person person)
 {
 return person.getNumberOfJunkMailItemsReceivedPerMonth;
 }
 }, new ShortArrayList());
 
```
 Specified by:
 
 collectShort in interface com.gs.collections.api.RichIterable<T>
 
 Parameters:
 shortFunction - a ShortFunction to use as the collect transformation function
 target - the MutableShortCollection to append to for all elements in this RichIterable
 
 Returns:
 target, which contains appended elements as a result of the collect transformation
 - collectWith
```
public <P,V> com.gs.collections.api.stack.MutableStack<V> collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function,
 P parameter)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collectWith in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 collectWith in interface com.gs.collections.api.stack.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
```
public <V> com.gs.collections.api.stack.MutableStack<V> collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
 com.gs.collections.api.block.function.Function<? super T,? extends V> function)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 collectIf in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 collectIf in interface com.gs.collections.api.stack.StackIterable<T>
 - flatCollect
```
public <V> com.gs.collections.api.stack.MutableStack<V> flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 flatCollect in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 flatCollect in interface com.gs.collections.api.stack.StackIterable<T>
 
 Parameters:
 function - The Function to apply
 
 Returns:
 a new flattened collection produced by applying the given function
 - zip
```
public <S> com.gs.collections.api.stack.MutableStack<com.gs.collections.api.tuple.Pair<T,S>> zip(java.lang.Iterable<S> that)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 zip in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 zip in interface com.gs.collections.api.stack.StackIterable<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
```
public com.gs.collections.api.stack.MutableStack<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>> zipWithIndex()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Zips this RichIterable with its indices.
 
 Specified by:
 
 zipWithIndex in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 zipWithIndex in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 zipWithIndex in interface com.gs.collections.api.stack.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)
 - size
```
public int size()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the number of items in this iterable.
 
 Specified by:
 
 size in interface com.gs.collections.api.RichIterable<T>
 - isEmpty
```
public boolean isEmpty()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns true if this iterable has zero items.
 
 Specified by:
 
 isEmpty in interface com.gs.collections.api.RichIterable<T>
 - notEmpty
```
public boolean notEmpty()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 The English equivalent of !this.isEmpty()
 
 Specified by:
 
 notEmpty in interface com.gs.collections.api.RichIterable<T>
 - getFirst
```
public T getFirst()
```
 Description copied from interface: com.gs.collections.api.stack.StackIterable
 
 Should return the same value as peek().
 
 Specified by:
 
 getFirst in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 getFirst in interface com.gs.collections.api.stack.StackIterable<T>
 - getLast
```
public T getLast()
```
 Description copied from interface: com.gs.collections.api.stack.StackIterable
 
 Should not work as it violates the contract of a Stack.
 
 Specified by:
 
 getLast in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 getLast in interface com.gs.collections.api.stack.StackIterable<T>
 - contains
```
public boolean contains(java.lang.Object object)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns true if the iterable has an element which responds true to element.equals(object).
 
 Specified by:
 
 contains in interface com.gs.collections.api.RichIterable<T>
 - containsAllIterable
```
public boolean containsAllIterable(java.lang.Iterable<?> source)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns true if all elements in source are contained in this collection.
 
 Specified by:
 
 containsAllIterable in interface com.gs.collections.api.RichIterable<T>
 - containsAll
```
public boolean containsAll(java.util.Collection<?> source)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns true if all elements in source are contained in this collection.
 
 Specified by:
 
 containsAll in interface com.gs.collections.api.RichIterable<T>
 
 See Also:
 Collection.containsAll(Collection)
 - containsAllArguments
```
public boolean containsAllArguments(java.lang.Object... elements)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns true if all elements in the specified var arg array are contained in this collection.
 
 Specified by:
 
 containsAllArguments in interface com.gs.collections.api.RichIterable<T>
 - select
```
public <R extends java.util.Collection<T>> R select(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
 R target)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Same as the select method with one parameter but uses the specified target collection for the results.
```
e.g.
 return people.select(new Predicate<Person>()
 {
 public boolean accept(Person person)
 {
 return person.person.getLastName().equals("Smith");
 }
 }, Lists.mutable.of());
 
```
```
e.g.
 return collection.select(Predicates.attributeEqual("lastName", "Smith"), new ArrayList());
 
```
 Specified by:
 
 select in interface com.gs.collections.api.RichIterable<T>
 
 Parameters:
 predicate - a Predicate to use as the select criteria
 target - the Collection to append to for all elements in this RichIterable that meet select criteria predicate
 
 Returns:
 target, which contains appended elements as a result of the select criteria
 See Also:
 RichIterable.select(Predicate)
 - selectWith
```
public <P,R extends java.util.Collection<T>> R selectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
 P parameter,
 R targetCollection)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Similar to RichIterable.select(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
 
 Specified by:
 
 selectWith in interface com.gs.collections.api.RichIterable<T>
 
 Parameters:
 predicate - a Predicate2 to use as the select criteria
 parameter - a parameter to pass in for evaluation of the second argument P in predicate
 targetCollection - the Collection to append to for all elements in this RichIterable that meet select criteria predicate
 
 Returns:
 targetCollection, which contains appended elements as a result of the select criteria
 See Also:
 RichIterable.select(Predicate), RichIterable.select(Predicate, Collection)
 - reject
```
public <R extends java.util.Collection<T>> R reject(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
 R target)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Same as the reject method with one parameter but uses the specified target collection for the results.
```
e.g.
 return people.reject(new Predicate<Person>()
 {
 public boolean accept(Person person)
 {
 return person.person.getLastName().equals("Smith");
 }
 }, Lists.mutable.of());
 
```
 Specified by:
 
 reject in interface com.gs.collections.api.RichIterable<T>
 
 Parameters:
 predicate - a Predicate to use as the reject criteria
 target - the Collection to append to for all elements in this RichIterable that cause Predicate#accept(Object) method to evaluate to false
 
 Returns:
 target, which contains appended elements as a result of the reject criteria
 - rejectWith
```
public <P,R extends java.util.Collection<T>> R rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
 P parameter,
 R targetCollection)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Similar to RichIterable.reject(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
 E.g. return a Collection of Person elements where the person has a height greater than 100cm
```
 return people.reject(new Predicate2<Person, Integer>()
 {
 public boolean accept(Person p, Integer i)
 {
 return p.getHeightInCm() < i.intValue();
 }
 }, Integer.valueOf(100), FastList.newList());
 
```
 Specified by:
 
 rejectWith in interface com.gs.collections.api.RichIterable<T>
 
 Parameters:
 predicate - a Predicate2 to use as the reject criteria
 parameter - a parameter to pass in for evaluation of the second argument P in predicate
 targetCollection - the Collection to append to for all elements in this RichIterable that cause Predicate#accept(Object) method to evaluate to false
 
 Returns:
 targetCollection, which contains appended elements as a result of the reject criteria
 See Also:
 RichIterable.reject(Predicate), RichIterable.reject(Predicate, Collection)
 - collect
```
public <V,R extends java.util.Collection<V>> R collect(com.gs.collections.api.block.function.Function<? super T,? extends V> function,
 R target)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Same as RichIterable.collect(Function), except that the results are gathered into the specified target collection.
```
e.g.
 return people.collect(new Function<Person, String>()
 {
 public String valueOf(Person person)
 {
 return person.getFirstName() + " " + person.getLastName();
 }
 }, Lists.mutable.of());
 
```
 Specified by:
 
 collect in interface com.gs.collections.api.RichIterable<T>
 
 Parameters:
 function - a Function to use as the collect transformation function
 target - the Collection to append to for all elements in this RichIterable that meet select criteria function
 
 Returns:
 target, which contains appended elements as a result of the collect transformation
 See Also:
 RichIterable.collect(Function)
 - collectWith
```
public <P,V,R extends java.util.Collection<V>> R collectWith(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends V> function,
 P parameter,
 R targetCollection)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Same as collectWith but with a targetCollection parameter to gather the results.
```
e.g.
 Function2 addParameterFunction =
 new Function2()
 {
 public Integer value(final Integer each, final Integer parameter)
 {
 return each + parameter;
 }
 };
 FastList.newListWith(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1), UnifiedSet.newSet());
 
```
 Specified by:
 
 collectWith in interface com.gs.collections.api.RichIterable<T>
 
 Parameters:
 function - a Function2 to use as the collect transformation function
 parameter - a parameter to pass in for evaluation of the second argument P in function
 targetCollection - the Collection to append to for all elements in this RichIterable that meet select criteria function
 
 Returns:
 targetCollection, which contains appended elements as a result of the collect transformation
 - collectIf
```
public <V,R extends java.util.Collection<V>> R collectIf(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
 com.gs.collections.api.block.function.Function<? super T,? extends V> function,
 R target)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Same as the collectIf method with two parameters but uses the specified target collection for the results.
 
 Specified by:
 
 collectIf in interface com.gs.collections.api.RichIterable<T>
 
 Parameters:
 predicate - a Predicate to use as the select criteria
 function - a Function to use as the collect transformation function
 target - the Collection to append to for all elements in this RichIterable that meet the collect criteria predicate
 
 Returns:
 targetCollection, which contains appended elements as a result of the collect criteria and transformation
 See Also:
 RichIterable.collectIf(Predicate, Function)
 - flatCollect
```
public <V,R extends java.util.Collection<V>> R flatCollect(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function,
 R target)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Same as flatCollect, only the results are collected into the target collection.
 
 Specified by:
 
 flatCollect in interface com.gs.collections.api.RichIterable<T>
 
 Parameters:
 function - The Function to apply
 target - The collection into which results should be added.
 
 Returns:
 target, which will contain a flattened collection of results produced by applying the given function
 See Also:
 RichIterable.flatCollect(Function)
 - detect
```
public T detect(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true. This method is commonly called find.
```
e.g.
 return people.detect(new Predicate<Person>()
 {
 public boolean value(Person person)
 {
 return person.getFirstName().equals("John") && person.getLastName().equals("Smith");
 }
 });
 
```
 Specified by:
 
 detect in interface com.gs.collections.api.RichIterable<T>
 - detectWith
```
public  T detectWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true.
```
e.g.
 people.detectWith(new Predicate2<Person, String>()
 {
 public boolean value(Person person, String fullName)
 {
 return person.getFullName().equals(fullName);
 }
 }, "John Smith");
 
```
 Specified by:
 
 detectWith in interface com.gs.collections.api.RichIterable<T>
 - detectIfNone
```
public T detectIfNone(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
 com.gs.collections.api.block.function.Function0<? extends T> function)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the first element of the iterable for which the predicate evaluates to true. If no element matches the predicate, then returns the value of applying the specified function.
 
 Specified by:
 
 detectIfNone in interface com.gs.collections.api.RichIterable<T>
 - detectWithIfNone
```
public  T detectWithIfNone(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
 P parameter,
 com.gs.collections.api.block.function.Function0<? extends T> function)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or returns the value of evaluating the specified function.
 
 Specified by:
 
 detectWithIfNone in interface com.gs.collections.api.RichIterable<T>
 - count
```
public int count(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Return the total number of elements that answer true to the specified predicate.
```
e.g.
 return people.count(new Predicate<Person>()
 {
 public boolean value(Person person)
 {
 return person.getAddress().getState().getName().equals("New York");
 }
 });
 
```
 Specified by:
 
 count in interface com.gs.collections.api.RichIterable<T>
 - countWith
```
public  int countWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Returns the total number of elements that evaluate to true for the specified predicate.
```
e.g.
 return lastNames.countWith(PredicatesLite.equal(), "Smith");
 
```
 Specified by:
 
 countWith in interface com.gs.collections.api.RichIterable<T>
 - anySatisfy
```
public boolean anySatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns true if the predicate evaluates to true for any element of the iterable. Returns false if the iterable is empty, or if no element returned true when evaluating the predicate.
 
 Specified by:
 
 anySatisfy in interface com.gs.collections.api.RichIterable<T>
 - anySatisfyWith
```
public  boolean anySatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns true if the predicate evaluates to true for any element of the collection, or return false. Returns false if the collection is empty.
 
 Specified by:
 
 anySatisfyWith in interface com.gs.collections.api.RichIterable<T>
 - allSatisfy
```
public boolean allSatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty. Otherwise, returns false.
 
 Specified by:
 
 allSatisfy in interface com.gs.collections.api.RichIterable<T>
 - allSatisfyWith
```
public  boolean allSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns true if the predicate evaluates to true for every element of the collection, or returns false.
 
 Specified by:
 
 allSatisfyWith in interface com.gs.collections.api.RichIterable<T>
 - noneSatisfy
```
public boolean noneSatisfy(com.gs.collections.api.block.predicate.Predicate<? super T> predicate)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty. Otherwise, returns false.
 
 Specified by:
 
 noneSatisfy in interface com.gs.collections.api.RichIterable<T>
 - noneSatisfyWith
```
public  boolean noneSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns true if the predicate evaluates to false for every element of the collection, or return false. Returns true if the collection is empty.
 
 Specified by:
 
 noneSatisfyWith in interface com.gs.collections.api.RichIterable<T>
 - injectInto
```
public <IV> IV injectInto(IV injectedValue,
 com.gs.collections.api.block.function.Function2<? super IV,? super T,? extends IV> function)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. This method is commonly called fold or sometimes reduce.
 
 Specified by:
 
 injectInto in interface com.gs.collections.api.RichIterable<T>
 - injectInto
```
public int injectInto(int injectedValue,
 com.gs.collections.api.block.function.primitive.IntObjectToIntFunction<? super T> intObjectToIntFunction)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
 
 Specified by:
 
 injectInto in interface com.gs.collections.api.RichIterable<T>
 - injectInto
```
public long injectInto(long injectedValue,
 com.gs.collections.api.block.function.primitive.LongObjectToLongFunction<? super T> longObjectToLongFunction)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
 
 Specified by:
 
 injectInto in interface com.gs.collections.api.RichIterable<T>
 - injectInto
```
public float injectInto(float injectedValue,
 com.gs.collections.api.block.function.primitive.FloatObjectToFloatFunction<? super T> floatObjectToFloatFunction)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
 
 Specified by:
 
 injectInto in interface com.gs.collections.api.RichIterable<T>
 - injectInto
```
public double injectInto(double injectedValue,
 com.gs.collections.api.block.function.primitive.DoubleObjectToDoubleFunction<? super T> doubleObjectToDoubleFunction)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
 
 Specified by:
 
 injectInto in interface com.gs.collections.api.RichIterable<T>
 - toList
```
public com.gs.collections.api.list.MutableList<T> toList()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Converts the collection to a MutableList implementation.
 
 Specified by:
 
 toList in interface com.gs.collections.api.RichIterable<T>
 - toSortedList
```
public com.gs.collections.api.list.MutableList<T> toSortedList()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.
 
 Specified by:
 
 toSortedList in interface com.gs.collections.api.RichIterable<T>
 - toSortedList
```
public com.gs.collections.api.list.MutableList<T> toSortedList(java.util.Comparator<? super T> comparator)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Converts the collection to a MutableList implementation and sorts it using the specified comparator.
 
 Specified by:
 
 toSortedList in interface com.gs.collections.api.RichIterable<T>
 - toSortedListBy
```
public <V extends java.lang.Comparable<? super V>> com.gs.collections.api.list.MutableList<T> toSortedListBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Converts the collection to a MutableList implementation and sorts it based on the natural order of the attribute returned by function.
 
 Specified by:
 
 toSortedListBy in interface com.gs.collections.api.RichIterable<T>
 - toSet
```
public com.gs.collections.api.set.MutableSet<T> toSet()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Converts the collection to a MutableSet implementation.
 
 Specified by:
 
 toSet in interface com.gs.collections.api.RichIterable<T>
 - toSortedSet
```
public com.gs.collections.api.set.sorted.MutableSortedSet<T> toSortedSet()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Converts the collection to a MutableSortedSet implementation and sorts it using the natural order of the elements.
 
 Specified by:
 
 toSortedSet in interface com.gs.collections.api.RichIterable<T>
 - toSortedSet
```
public com.gs.collections.api.set.sorted.MutableSortedSet<T> toSortedSet(java.util.Comparator<? super T> comparator)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Converts the collection to a MutableSortedSet implementation and sorts it using the specified comparator.
 
 Specified by:
 
 toSortedSet in interface com.gs.collections.api.RichIterable<T>
 - toStack
```
public com.gs.collections.api.stack.MutableStack<T> toStack()
```
 Description copied from interface: com.gs.collections.api.stack.StackIterable
 
 Converts the stack to a MutableStack implementation.
 
 Specified by:
 
 toStack in interface com.gs.collections.api.stack.StackIterable<T>
 - toImmutable
```
public com.gs.collections.api.stack.ImmutableStack<T> toImmutable()
```
 Description copied from interface: com.gs.collections.api.stack.StackIterable
 
 Converts the StackIterable to an immutable implementation. Returns this for immutable stacks.
 
 Specified by:
 
 toImmutable in interface com.gs.collections.api.stack.StackIterable<T>
 - toSortedSetBy
```
public <V extends java.lang.Comparable<? super V>> com.gs.collections.api.set.sorted.MutableSortedSet<T> toSortedSetBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Converts the collection to a MutableSortedSet implementation and sorts it based on the natural order of the attribute returned by function.
 
 Specified by:
 
 toSortedSetBy in interface com.gs.collections.api.RichIterable<T>
 - toBag
```
public com.gs.collections.api.bag.MutableBag<T> toBag()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Converts the collection to the default MutableBag implementation.
 
 Specified by:
 
 toBag in interface com.gs.collections.api.RichIterable<T>
 - toMap
```
public <NK,NV> com.gs.collections.api.map.MutableMap<NK,NV> toMap(com.gs.collections.api.block.function.Function<? super T,? extends NK> keyFunction,
 com.gs.collections.api.block.function.Function<? super T,? extends NV> valueFunction)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Converts the collection to a MutableMap implementation using the specified key and value functions.
 
 Specified by:
 
 toMap in interface com.gs.collections.api.RichIterable<T>
 - toSortedMap
```
public <NK,NV> com.gs.collections.api.map.sorted.MutableSortedMap<NK,NV> toSortedMap(com.gs.collections.api.block.function.Function<? super T,? extends NK> keyFunction,
 com.gs.collections.api.block.function.Function<? super T,? extends NV> valueFunction)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the key elements' natural ordering.
 
 Specified by:
 
 toSortedMap in interface com.gs.collections.api.RichIterable<T>
 - toSortedMap
```
public <NK,NV> com.gs.collections.api.map.sorted.MutableSortedMap<NK,NV> toSortedMap(java.util.Comparator<? super NK> comparator,
 com.gs.collections.api.block.function.Function<? super T,? extends NK> keyFunction,
 com.gs.collections.api.block.function.Function<? super T,? extends NV> valueFunction)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the given comparator.
 
 Specified by:
 
 toSortedMap in interface com.gs.collections.api.RichIterable<T>
 - asLazy
```
public com.gs.collections.api.LazyIterable<T> asLazy()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).
 
 Specified by:
 
 asLazy in interface com.gs.collections.api.RichIterable<T>
 - toArray
```
public java.lang.Object[] toArray()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Converts this iterable to an array.
 
 Specified by:
 
 toArray in interface com.gs.collections.api.RichIterable<T>
 
 See Also:
 Collection.toArray()
 - toArray
```
public <T> T[] toArray(T[] a)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.
 
 Specified by:
 
 toArray in interface com.gs.collections.api.RichIterable<T>
 
 See Also:
 Collection.toArray(Object[])
 - min
```
public T min(java.util.Comparator<? super T> comparator)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the minimum element out of this container based on the comparator.
 
 Specified by:
 
 min in interface com.gs.collections.api.RichIterable<T>
 - max
```
public T max(java.util.Comparator<? super T> comparator)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the maximum element out of this container based on the comparator.
 
 Specified by:
 
 max in interface com.gs.collections.api.RichIterable<T>
 - min
```
public T min()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the minimum element out of this container based on the natural order.
 
 Specified by:
 
 min in interface com.gs.collections.api.RichIterable<T>
 - max
```
public T max()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the maximum element out of this container based on the natural order.
 
 Specified by:
 
 max in interface com.gs.collections.api.RichIterable<T>
 - minBy
```
public <V extends java.lang.Comparable<? super V>> T minBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.
 
 Specified by:
 
 minBy in interface com.gs.collections.api.RichIterable<T>
 - maxBy
```
public <V extends java.lang.Comparable<? super V>> T maxBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.
 
 Specified by:
 
 maxBy in interface com.gs.collections.api.RichIterable<T>
 - sumOfInt
```
public long sumOfInt(com.gs.collections.api.block.function.primitive.IntFunction<? super T> intFunction)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the final long result of evaluating function for each element of the iterable and adding the results together.
 
 Specified by:
 
 sumOfInt in interface com.gs.collections.api.RichIterable<T>
 - sumOfFloat
```
public double sumOfFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super T> floatFunction)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the final double result of evaluating function for each element of the iterable and adding the results together.
 
 Specified by:
 
 sumOfFloat in interface com.gs.collections.api.RichIterable<T>
 - sumOfLong
```
public long sumOfLong(com.gs.collections.api.block.function.primitive.LongFunction<? super T> longFunction)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the final long result of evaluating function for each element of the iterable and adding the results together.
 
 Specified by:
 
 sumOfLong in interface com.gs.collections.api.RichIterable<T>
 - sumOfDouble
```
public double sumOfDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super T> doubleFunction)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns the final double result of evaluating function for each element of the iterable and adding the results together.
 
 Specified by:
 
 sumOfDouble in interface com.gs.collections.api.RichIterable<T>
 - makeString
```
public java.lang.String makeString()
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns a string representation of this collection by delegating to RichIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
 
 Specified by:
 
 makeString in interface com.gs.collections.api.RichIterable<T>
 
 Returns:
 a string representation of this collection.
 - makeString
```
public java.lang.String makeString(java.lang.String separator)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns a string representation of this collection by delegating to RichIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).
 
 Specified by:
 
 makeString in interface com.gs.collections.api.RichIterable<T>
 
 Returns:
 a string representation of this collection.
 - makeString
```
public java.lang.String makeString(java.lang.String start,
 java.lang.String separator,
 java.lang.String end)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in the start and end strings. Adjacent elements are separated by the separator string. Elements are converted to strings as by String.valueOf(Object).
 
 Specified by:
 
 makeString in interface com.gs.collections.api.RichIterable<T>
 
 Returns:
 a string representation of this collection.
 - appendString
```
public void appendString(java.lang.Appendable appendable)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString().
 
 Specified by:
 
 appendString in interface com.gs.collections.api.RichIterable<T>
 - appendString
```
public void appendString(java.lang.Appendable appendable,
 java.lang.String separator)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString(String).
 
 Specified by:
 
 appendString in interface com.gs.collections.api.RichIterable<T>
 - appendString
```
public void appendString(java.lang.Appendable appendable,
 java.lang.String start,
 java.lang.String separator,
 java.lang.String end)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString(String, String, String).
 
 Specified by:
 
 appendString in interface com.gs.collections.api.RichIterable<T>
 - groupBy
```
public <V> com.gs.collections.api.multimap.list.MutableListMultimap<V,T> groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 groupBy in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 groupBy in interface com.gs.collections.api.stack.StackIterable<T>
 - groupBy
```
public <V,R extends com.gs.collections.api.multimap.MutableMultimap<V,T>> R groupBy(com.gs.collections.api.block.function.Function<? super T,? extends V> function,
 R target)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 Same as RichIterable.groupBy(Function), except that the results are gathered into the specified target multimap.
```
e.g.
 return people.groupBy(new Function<Person, String>()
 {
 public String value(Person person)
 {
 return person.getFirstName() + " " + person.getLastName();
 }
 }, new FastListMultimap<String, Person>());
 
```
 Specified by:
 
 groupBy in interface com.gs.collections.api.RichIterable<T>
 - groupByEach
```
public <V> com.gs.collections.api.multimap.list.MutableListMultimap<V,T> groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 groupByEach in interface com.gs.collections.api.stack.MutableStack<T>
 
 Specified by:
 
 groupByEach in interface com.gs.collections.api.stack.StackIterable<T>
 - groupByEach
```
public <V,R extends com.gs.collections.api.multimap.MutableMultimap<V,T>> R groupByEach(com.gs.collections.api.block.function.Function<? super T,? extends java.lang.Iterable<V>> function,
 R target)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Same as RichIterable.groupByEach(Function), except that the results are gathered into the specified target multimap.
 
 Specified by:
 
 groupByEach in interface com.gs.collections.api.RichIterable<T>
 - groupByUniqueKey
```
public <V> com.gs.collections.api.map.MutableMap<V,T> groupByUniqueKey(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 groupByUniqueKey in interface com.gs.collections.api.stack.MutableStack<T>
 
 See Also:
 RichIterable.groupBy(Function)
 - zip
```
public <S,R extends java.util.Collection<com.gs.collections.api.tuple.Pair<T,S>>> R zip(java.lang.Iterable<S> that,
 R target)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Same as RichIterable.zip(Iterable) but uses target for output.
 
 Specified by:
 
 zip in interface com.gs.collections.api.RichIterable<T>
 - zipWithIndex
```
public <R extends java.util.Collection<com.gs.collections.api.tuple.Pair<T,java.lang.Integer>>> R zipWithIndex(R target)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Same as RichIterable.zipWithIndex() but uses target for output.
 
 Specified by:
 
 zipWithIndex in interface com.gs.collections.api.RichIterable<T>
 - chunk
```
public com.gs.collections.api.RichIterable<com.gs.collections.api.RichIterable<T>> chunk(int size)
```
 Description copied from interface: com.gs.collections.api.RichIterable
 
 Partitions elements in fixed size chunks.
 
 Specified by:
 
 chunk in interface com.gs.collections.api.RichIterable<T>
 
 Parameters:
 size - the number of elements per chunk
 
 Returns:
 A RichIterable containing RichIterables of size size, except the last will be truncated if the elements don't divide evenly.
 - forEach
```
public void forEach(com.gs.collections.api.block.procedure.Procedure<? super T> procedure)
```
 Description copied from interface: com.gs.collections.api.InternalIterable
 The procedure is executed for each element in the iterable.
```
e.g.
 people.forEach(new Procedure()
 {
 public void value(Person person)
 {
 LOGGER.info(person.getName());
 }
 });
 
```
 Specified by:
 
 forEach in interface com.gs.collections.api.InternalIterable<T>
 - peek
```
public T peek()
```
 Specified by:
 
 peek in interface com.gs.collections.api.stack.StackIterable<T>
 
 Returns:
 the top of the stack.
 - peek
```
public com.gs.collections.api.list.ListIterable<T> peek(int count)
```
 Specified by:
 
 peek in interface com.gs.collections.api.stack.StackIterable<T>
 
 Returns:
 a ListIterable of the number of elements specified by the count, beginning with the top of the stack.
 - peekAt
```
public T peekAt(int index)
```
 Specified by:
 
 peekAt in interface com.gs.collections.api.stack.StackIterable<T>
 
 Parameters:
 index - the location to peek into
 
 Returns:
 the element at the specified index
 - toString
```
public java.lang.String toString()
```
 Description copied from interface: com.gs.collections.api.stack.StackIterable
 
 Follows the same rules as AbstractCollection.toString() except it processes the elements in the same order as forEach().
 
 Specified by:
 
 toString in interface com.gs.collections.api.RichIterable<T>
 
 Specified by:
 
 toString in interface com.gs.collections.api.stack.StackIterable<T>
 
 Overrides:
 
 toString in class java.lang.Object
 
 Returns:
 a string representation of this RichIterable
 - forEachWithIndex
```
public void forEachWithIndex(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T> objectIntProcedure)
```
 Description copied from interface: com.gs.collections.api.InternalIterable
 Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure
```
e.g.
 people.forEachWithIndex(new ObjectIntProcedure()
 {
 public void value(Person person, int index)
 {
 LOGGER.info("Index: " + index + " person: " + person.getName());
 }
 });
 
```
 Specified by:
 
 forEachWithIndex in interface com.gs.collections.api.InternalIterable<T>
 - forEachWith
```
public  void forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super T,? super P> procedure,
 P parameter)
```
 Description copied from interface: com.gs.collections.api.InternalIterable
 The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.
```
e.g.
 people.forEachWith(new Procedure2()
 {
 public void value(Person person, Person other)
 {
 if (person.isRelatedTo(other))
 {
 LOGGER.info(person.getName());
 }
 }
 }, fred);
 
```
 Specified by:
 
 forEachWith in interface com.gs.collections.api.InternalIterable<T>
 - asUnmodifiable
```
public com.gs.collections.api.stack.MutableStack<T> asUnmodifiable()
```
 Specified by:
 
 asUnmodifiable in interface com.gs.collections.api.stack.MutableStack<T>
 - asSynchronized
```
public com.gs.collections.api.stack.MutableStack<T> asSynchronized()
```
 Specified by:
 
 asSynchronized in interface com.gs.collections.api.stack.MutableStack<T>
 - equals
```
public boolean equals(java.lang.Object obj)
```
 Description copied from interface: com.gs.collections.api.stack.StackIterable
 
 Follows the same general contract as List.equals(Object), but for Stacks.
 
 Specified by:
 
 equals in interface com.gs.collections.api.stack.StackIterable<T>
 
 Overrides:
 
 equals in class java.lang.Object
 - hashCode
```
public int hashCode()
```
 Description copied from interface: com.gs.collections.api.stack.StackIterable
 
 Follows the same general contract as List.hashCode(), but for Stacks.
 
 Specified by:
 
 hashCode in interface com.gs.collections.api.stack.StackIterable<T>
 
 Overrides:
 
 hashCode in class java.lang.Object
 - aggregateInPlaceBy
```
public <K,V> com.gs.collections.api.map.MutableMap<K,V> aggregateInPlaceBy(com.gs.collections.api.block.function.Function<? super T,? extends K> groupBy,
 com.gs.collections.api.block.function.Function0<? extends V> zeroValueFactory,
 com.gs.collections.api.block.procedure.Procedure2<? super V,? super T> mutatingAggregator)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>
 - aggregateBy
```
public <K,V> com.gs.collections.api.map.MutableMap<K,V> aggregateBy(com.gs.collections.api.block.function.Function<? super T,? extends K> groupBy,
 com.gs.collections.api.block.function.Function0<? extends V> zeroValueFactory,
 com.gs.collections.api.block.function.Function2<? super V,? super T,? extends V> nonMutatingAggregator)
```
 Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<T>

Class UnmodifiableStack<T>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

of

pop

pop

pop

pop

clear

push

iterator

select

selectWith

reject

rejectWith

partition

partitionWith

selectInstancesOf

collect

collectBoolean

collectBoolean

collectByte

collectByte

collectChar

collectChar

collectDouble

collectDouble

collectFloat

collectFloat

collectInt

collectInt

collectLong

collectLong

collectShort

collectShort

collectWith

collectIf

flatCollect

zip

zipWithIndex

size

isEmpty

notEmpty

getFirst

getLast

contains

containsAllIterable

containsAll

containsAllArguments

select

selectWith

reject

rejectWith

collect

collectWith

collectIf

flatCollect

detect

detectWith

detectIfNone

detectWithIfNone

count

countWith

anySatisfy

anySatisfyWith

allSatisfy

allSatisfyWith

noneSatisfy

noneSatisfyWith

injectInto

injectInto

injectInto

injectInto

injectInto

toList

toSortedList

toSortedList

toSortedListBy

toSet