Package org.eclipse.collections.impl.stack.mutable

Class UnmodifiableStack<T>

java.lang.Object

org.eclipse.collections.impl.stack.mutable.UnmodifiableStack<T>

All Implemented Interfaces:

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

public final class UnmodifiableStack<T>
extends Object
implements MutableStack<T>, Serializable

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
boolean	allSatisfy(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(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(Predicate<? super T> predicate)	Returns true if the predicate evaluates to true for any element of the iterable.
<P> boolean	anySatisfyWith(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(Appendable appendable)	Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String separator)	Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String start, String separator, String end)	Prints a string representation of this collection onto the given Appendable.
LazyIterable<T>	asLazy()	Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).
MutableStack<T>	asSynchronized()
MutableStack<T>	asUnmodifiable()
RichIterable<RichIterable<T>>	chunk(int size)	Partitions elements in fixed size chunks.
void	clear()
<V> MutableStack<V>	collect(Function<? super T,? extends V> function)	Returns a new collection with the results of applying the specified function on each element of the source collection.
<V, R extends Collection<V>> R	collect(Function<? super T,? extends V> function, R target)	Same as RichIterable.collect(Function), except that the results are gathered into the specified target collection.
MutableBooleanStack	collectBoolean(BooleanFunction<? super T> booleanFunction)	Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection.
<R extends MutableBooleanCollection> R	collectBoolean(BooleanFunction<? super T> booleanFunction, R target)	Same as RichIterable.collectBoolean(BooleanFunction), except that the results are gathered into the specified target collection.
MutableByteStack	collectByte(ByteFunction<? super T> byteFunction)	Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection.
<R extends MutableByteCollection> R	collectByte(ByteFunction<? super T> byteFunction, R target)	Same as RichIterable.collectByte(ByteFunction), except that the results are gathered into the specified target collection.
MutableCharStack	collectChar(CharFunction<? super T> charFunction)	Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection.
<R extends MutableCharCollection> R	collectChar(CharFunction<? super T> charFunction, R target)	Same as RichIterable.collectChar(CharFunction), except that the results are gathered into the specified target collection.
MutableDoubleStack	collectDouble(DoubleFunction<? super T> doubleFunction)	Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection.
<R extends MutableDoubleCollection> R	collectDouble(DoubleFunction<? super T> doubleFunction, R target)	Same as RichIterable.collectDouble(DoubleFunction), except that the results are gathered into the specified target collection.
MutableFloatStack	collectFloat(FloatFunction<? super T> floatFunction)	Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection.
<R extends MutableFloatCollection> R	collectFloat(FloatFunction<? super T> floatFunction, R target)	Same as RichIterable.collectFloat(FloatFunction), except that the results are gathered into the specified target collection.
<V> MutableStack<V>	collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function)	Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate.
<V, R extends Collection<V>> R	collectIf(Predicate<? super T> predicate, 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.
MutableIntStack	collectInt(IntFunction<? super T> intFunction)	Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection.
<R extends MutableIntCollection> R	collectInt(IntFunction<? super T> intFunction, R target)	Same as RichIterable.collectInt(IntFunction), except that the results are gathered into the specified target collection.
MutableLongStack	collectLong(LongFunction<? super T> longFunction)	Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection.
<R extends MutableLongCollection> R	collectLong(LongFunction<? super T> longFunction, R target)	Same as RichIterable.collectLong(LongFunction), except that the results are gathered into the specified target collection.
MutableShortStack	collectShort(ShortFunction<? super T> shortFunction)	Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection.
<R extends MutableShortCollection> R	collectShort(ShortFunction<? super T> shortFunction, R target)	Same as RichIterable.collectShort(ShortFunction), except that the results are gathered into the specified target collection.
<P, V> MutableStack<V>	collectWith(Function2<? super T,? super P,? extends V> function, P parameter)	Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.
<P, V, R extends Collection<V>> R	collectWith(Function2<? super T,? super P,? extends V> function, P parameter, R targetCollection)	Same as collectWith but with a targetCollection parameter to gather the results.
<V> MutableStack<V>	collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function)	Returns a new OrderedIterable using results obtained by applying the specified function to each element and its corresponding index.
boolean	contains(Object object)	Returns true if the iterable has an element which responds true to element.equals(object).
boolean	containsAll(Collection<?> source)	Returns true if all elements in source are contained in this collection.
boolean	containsAllArguments(Object... elements)	Returns true if all elements in the specified var arg array are contained in this collection.
boolean	containsAllIterable(Iterable<?> source)	Returns true if all elements in source are contained in this collection.
<S> boolean	corresponds(OrderedIterable<S> other, Predicate2<? super T,? super S> predicate)	Returns true if both OrderedIterables have the same length and predicate returns true for all corresponding elements e1 of this OrderedIterable and e2 of other.
int	count(Predicate<? super T> predicate)	Return the total number of elements that answer true to the specified predicate.
<P> int	countWith(Predicate2<? super T,? super P> predicate, P parameter)	Returns the total number of elements that evaluate to true for the specified predicate.
T	detect(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(Predicate<? super T> predicate, Function0<? extends T> function)	Returns the first element of the iterable for which the predicate evaluates to true.
int	detectIndex(Predicate<? super T> predicate)	Returns the index of the first element of the OrderedIterable for which the predicate evaluates to true.
Optional<T>	detectOptional(Predicate<? super T> predicate)	Returns the first element of the iterable for which the predicate evaluates to true as an Optional.
<P> T	detectWith(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(Predicate2<? super T,? super P> predicate, P parameter, 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.
<P> Optional<T>	detectWithOptional(Predicate2<? super T,? super P> predicate, P parameter)	Returns the first element that evaluates to true for the specified predicate2 and parameter as an Optional.
MutableStack<T>	distinct()	Returns a new OrderedIterable containing the distinct elements in this iterable.
MutableStack<T>	dropWhile(Predicate<? super T> predicate)	Returns the final elements that do not satisfy the Predicate.
void	each(Procedure<? super T> procedure)	The procedure is executed for each element in the iterable.
boolean	equals(Object obj)	Follows the same general contract as List.equals(Object), but for Stacks.
<V> MutableStack<V>	flatCollect(Function<? super T,? extends Iterable<V>> function)	flatCollect is a special case of RichIterable.collect(Function).
<V, R extends Collection<V>> R	flatCollect(Function<? super T,? extends Iterable<V>> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableBooleanCollection> R	flatCollectBoolean(Function<? super T,? extends BooleanIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableByteCollection> R	flatCollectByte(Function<? super T,? extends ByteIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableCharCollection> R	flatCollectChar(Function<? super T,? extends CharIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableDoubleCollection> R	flatCollectDouble(Function<? super T,? extends DoubleIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableFloatCollection> R	flatCollectFloat(Function<? super T,? extends FloatIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableIntCollection> R	flatCollectInt(Function<? super T,? extends IntIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableLongCollection> R	flatCollectLong(Function<? super T,? extends LongIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableShortCollection> R	flatCollectShort(Function<? super T,? extends ShortIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
void	forEach(int startIndex, int endIndex, Procedure<? super T> procedure)	Iterates over the section of the iterable covered by the specified inclusive indexes.
<P> void	forEachWith(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(int fromIndex, int toIndex, ObjectIntProcedure<? super T> objectIntProcedure)	Iterates over the section of the iterable covered by the specified inclusive indexes.
void	forEachWithIndex(ObjectIntProcedure<? super T> objectIntProcedure)	Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure
T	getFirst()	Should return the same value as peek().
T	getLast()	Should not work as it violates the contract of a Stack.
T	getOnly()	Returns the element if the iterable has exactly one element.
<V> MutableListMultimap<V,T>	groupBy(Function<? super T,? extends V> function)	For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
<V, R extends MutableMultimap<V, T>> R	groupBy(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> MutableListMultimap<V,T>	groupByEach(Function<? super T,? extends Iterable<V>> function)	Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
<V, R extends MutableMultimap<V, T>> R	groupByEach(Function<? super T,? extends Iterable<V>> function, R target)	Same as RichIterable.groupByEach(Function), except that the results are gathered into the specified target multimap.
<V> MutableMap<V,T>	groupByUniqueKey(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 map, where the transformed value is the key.
<V, R extends MutableMapIterable<V, T>> R	groupByUniqueKey(Function<? super T,? extends V> function, R target)	Same as RichIterable.groupByUniqueKey(Function), except that the results are gathered into the specified target map.
int	hashCode()	Follows the same general contract as List.hashCode(), but for Stacks.
int	indexOf(Object object)	Returns the index of the first occurrence of the specified item in this iterable, or -1 if this iterable does not contain the item.
double	injectInto(double injectedValue, 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, 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, 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.
long	injectInto(long injectedValue, 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.
<IV> IV	injectInto(IV injectedValue, 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.
<R extends Collection<T>> R	into(R target)	Adds all the elements in this iterable to the specific target Collection.
boolean	isEmpty()	Returns true if this iterable has zero items.
Iterator<T>	iterator()
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).
String	makeString(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).
String	makeString(String start, String separator, String end)	Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.
T	max()	Returns the maximum element out of this container based on the natural order, not the order of this container.
T	max(Comparator<? super T> comparator)	Returns the maximum element out of this container based on the comparator.
<V extends Comparable<? super V>> T	maxBy(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, not the order of this container.
T	min(Comparator<? super T> comparator)	Returns the minimum element out of this container based on the comparator.
<V extends Comparable<? super V>> T	minBy(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(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(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 MutableStack<T>> UnmodifiableStack<T>	of(S stack)
PartitionMutableStack<T>	partition(Predicate<? super T> predicate)	Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
PartitionMutableStack<T>	partitionWhile(Predicate<? super T> predicate)	Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
<P> PartitionMutableStack<T>	partitionWith(Predicate2<? super T,? super P> predicate, P parameter)	Filters a collection into a PartitionIterable based on the evaluation of the predicate.
T	peek()	Returns the element at the top of the stack, without removing it from the stack.
ListIterable<T>	peek(int count)
T	peekAt(int index)	Returns the element at a specific index, without removing it from the stack.
T	pop()	Removes and returns the top element of the stack.
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 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.
MutableStack<T>	reject(Predicate<? super T> predicate)	Returns all elements of the source collection that return false when evaluating of the predicate.
<R extends Collection<T>> R	reject(Predicate<? super T> predicate, R target)	Same as the reject method with one parameter but uses the specified target collection for the results.
<P> MutableStack<T>	rejectWith(Predicate2<? super T,? super P> predicate, P parameter)	Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
<P, R extends Collection<T>> R	rejectWith(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.
MutableStack<T>	select(Predicate<? super T> predicate)	Returns all elements of the source collection that return true when evaluating the predicate.
<R extends Collection<T>> R	select(Predicate<? super T> predicate, R target)	Same as the select method with one parameter but uses the specified target collection for the results.
<S> MutableStack<S>	selectInstancesOf(Class<S> clazz)	Returns all elements of the source collection that are instances of the Class clazz.
<P> MutableStack<T>	selectWith(Predicate2<? super T,? super P> predicate, P parameter)	Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
<P, R extends Collection<T>> R	selectWith(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.
<V> MutableObjectDoubleMap<V>	sumByDouble(Function<? super T,? extends V> groupBy, DoubleFunction<? super T> function)	Groups and sums the values using the two specified functions.
<V> MutableObjectDoubleMap<V>	sumByFloat(Function<? super T,? extends V> groupBy, FloatFunction<? super T> function)	Groups and sums the values using the two specified functions.
<V> MutableObjectLongMap<V>	sumByInt(Function<? super T,? extends V> groupBy, IntFunction<? super T> function)	Groups and sums the values using the two specified functions.
<V> MutableObjectLongMap<V>	sumByLong(Function<? super T,? extends V> groupBy, LongFunction<? super T> function)	Groups and sums the values using the two specified functions.
double	sumOfDouble(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(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(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(LongFunction<? super T> longFunction)	Returns the final long result of evaluating function for each element of the iterable and adding the results together.
MutableStack<T>	takeWhile(Predicate<? super T> predicate)	Returns the initial elements that satisfy the Predicate.
MutableStack<T>	tap(Procedure<? super T> procedure)	Executes the Procedure for each element in the iterable and returns this.
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.
MutableBag<T>	toBag()	Converts the collection to the default MutableBag implementation.
<NK, NV> MutableBiMap<NK,NV>	toBiMap(Function<? super T,? extends NK> keyFunction, Function<? super T,? extends NV> valueFunction)	Converts the collection to a BiMap implementation using the specified key and value functions.
ImmutableStack<T>	toImmutable()	Converts the StackIterable to an immutable implementation.
MutableList<T>	toList()	Converts the collection to a MutableList implementation.
<NK, NV> MutableMap<NK,NV>	toMap(Function<? super T,? extends NK> keyFunction, Function<? super T,? extends NV> valueFunction)	Converts the collection to a MutableMap implementation using the specified key and value functions.
<NK, NV, R extends Map<NK, NV>> R	toMap(Function<? super T,? extends NK> keyFunction, Function<? super T,? extends NV> valueFunction, R target)	Same as RichIterable.toMap(Function, Function), except that the results are gathered into the specified target map.
MutableSet<T>	toSet()	Converts the collection to a MutableSet implementation.
MutableSortedBag<T>	toSortedBag()	Converts the collection to a MutableSortedBag implementation and sorts it using the natural order of the elements.
MutableSortedBag<T>	toSortedBag(Comparator<? super T> comparator)	Converts the collection to the MutableSortedBag implementation and sorts it using the specified comparator.
MutableList<T>	toSortedList()	Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.
MutableList<T>	toSortedList(Comparator<? super T> comparator)	Converts the collection to a MutableList implementation and sorts it using the specified comparator.
<NK, NV> MutableSortedMap<NK,NV>	toSortedMap(Comparator<? super NK> comparator, Function<? super T,? extends NK> keyFunction, 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> MutableSortedMap<NK,NV>	toSortedMap(Function<? super T,? extends NK> keyFunction, 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.
MutableSortedSet<T>	toSortedSet()	Converts the collection to a MutableSortedSet implementation and sorts it using the natural order of the elements.
MutableSortedSet<T>	toSortedSet(Comparator<? super T> comparator)	Converts the collection to a MutableSortedSet implementation and sorts it using the specified comparator.
String	toString()	Follows the same rules as AbstractCollection.toString() except it processes the elements in the same order as forEach().
<S> MutableStack<Pair<T,S>>	zip(Iterable<S> that)	Returns a OrderedIterable formed from this OrderedIterable and another Iterable by combining corresponding elements in pairs.
<S, R extends Collection<Pair<T, S>>> R	zip(Iterable<S> that, R target)	Same as OrderedIterable.zip(Iterable) but uses target for output.
MutableStack<Pair<T,Integer>>	zipWithIndex()	Zips this RichIterable with its indices.
<R extends Collection<Pair<T, Integer>>> R	zipWithIndex(R target)	Same as OrderedIterable.zipWithIndex() but uses target for output.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

forEach

Methods inherited from interface java.lang.Iterable

spliterator

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

aggregateBy, aggregateInPlaceBy, countBy, countByEach, countByWith, flatCollectWith

Methods inherited from interface org.eclipse.collections.api.ordered.OrderedIterable

collectWithIndex, getFirstOptional, getLastOptional, rejectWithIndex, selectWithIndex

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

aggregateBy, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, countBy, countByEach, countByWith, flatCollectWith, forEach, getAny, groupByAndCollect, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, makeString, maxByOptional, maxOptional, maxOptional, minByOptional, minOptional, minOptional, reduce, reduceInPlace, reduceInPlace, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toSortedBagBy, toSortedListBy, toSortedMapBy, toSortedSetBy

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

toStack

Method Details

of

public static <T,
S extends MutableStack<T>>
UnmodifiableStack<T> of(S stack)

pop

public T pop()

Description copied from interface: MutableStack

Removes and returns the top element of the stack.

Specified by:

pop in interface MutableStack<T>

pop

public ListIterable<T> pop(int count)

Description copied from interface: 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 MutableStack<T>

pop

public <R extends Collection<T>> R pop(int count,
 R targetCollection)

Description copied from interface: 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 MutableStack<T>

pop

public <R extends MutableStack<T>> R pop(int count,
 R targetStack)

Description copied from interface: 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 MutableStack<T>

clear

public void clear()

Specified by:

clear in interface MutableStack<T>

push

public void push(T item)

Description copied from interface: MutableStack

Adds an item to the top of the stack.

Specified by:

push in interface MutableStack<T>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

select

public MutableStack<T> select(Predicate<? super T> predicate)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

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

Specified by:

select in interface MutableStack<T>

Specified by:

select in interface OrderedIterable<T>

Specified by:

select in interface RichIterable<T>

Specified by:

select in interface StackIterable<T>

selectWith

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

Description copied from interface: RichIterable

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

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

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

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

Specified by:

selectWith in interface MutableStack<T>

Specified by:

selectWith in interface OrderedIterable<T>

Specified by:

selectWith in interface RichIterable<T>

Specified by:

selectWith in interface StackIterable<T>

Parameters:

predicate - a Predicate2 to use as the select criteria

parameter - a parameter to pass in for evaluation of the second argument P in predicate

See Also:

• RichIterable.select(Predicate)

reject

public MutableStack<T> reject(Predicate<? super T> predicate)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

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

Specified by:

reject in interface MutableStack<T>

Specified by:

reject in interface OrderedIterable<T>

Specified by:

reject in interface RichIterable<T>

Specified by:

reject in interface StackIterable<T>

Parameters:

predicate - a Predicate to use as the reject criteria

Returns:

a RichIterable that contains elements that cause Predicate.accept(Object) method to evaluate to false

rejectWith

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

Description copied from interface: RichIterable

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

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

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

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

Specified by:

rejectWith in interface MutableStack<T>

Specified by:

rejectWith in interface OrderedIterable<T>

Specified by:

rejectWith in interface RichIterable<T>

Specified by:

rejectWith in interface StackIterable<T>

Parameters:

predicate - a Predicate2 to use as the select criteria

parameter - a parameter to pass in for evaluation of the second argument P in predicate

See Also:

• RichIterable.select(Predicate)

partition

public PartitionMutableStack<T> partition(Predicate<? super T> predicate)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

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

Specified by:

partition in interface MutableStack<T>

Specified by:

partition in interface OrderedIterable<T>

Specified by:

partition in interface RichIterable<T>

Specified by:

partition in interface StackIterable<T>

partitionWith

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

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

Specified by:

partitionWith in interface MutableStack<T>

Specified by:

partitionWith in interface OrderedIterable<T>

Specified by:

partitionWith in interface RichIterable<T>

Specified by:

partitionWith in interface StackIterable<T>

selectInstancesOf

public <S> MutableStack<S> selectInstancesOf(Class<S> clazz)

Description copied from interface: RichIterable

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

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

Specified by:

selectInstancesOf in interface MutableStack<T>

Specified by:

selectInstancesOf in interface OrderedIterable<T>

Specified by:

selectInstancesOf in interface RichIterable<T>

Specified by:

selectInstancesOf in interface StackIterable<T>

collect

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

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

Specified by:

collect in interface MutableStack<T>

Specified by:

collect in interface OrderedIterable<T>

Specified by:

collect in interface RichIterable<T>

Specified by:

collect in interface StackIterable<T>

collectBoolean

public MutableBooleanStack collectBoolean(BooleanFunction<? super T> booleanFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

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

Specified by:

collectBoolean in interface MutableStack<T>

Specified by:

collectBoolean in interface OrderedIterable<T>

Specified by:

collectBoolean in interface RichIterable<T>

Specified by:

collectBoolean in interface StackIterable<T>

collectBoolean

public <R extends MutableBooleanCollection> R collectBoolean(BooleanFunction<? super T> booleanFunction,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.collectBoolean(BooleanFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 BooleanArrayList licenses =
     people.collectBoolean(person -> person.hasDrivingLicense(), new BooleanArrayList());
 

Example using an anonymous inner class:

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

Specified by:

collectBoolean in interface 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

flatCollectBoolean

public <R extends MutableBooleanCollection> R flatCollectBoolean(Function<? super T,? extends BooleanIterable> function,
 R target)

Description copied from interface: RichIterable

Same as flatCollect, only the results are collected into the target collection.

Specified by:

flatCollectBoolean in interface 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)

collectByte

public MutableByteStack collectByte(ByteFunction<? super T> byteFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

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

Specified by:

collectByte in interface MutableStack<T>

Specified by:

collectByte in interface OrderedIterable<T>

Specified by:

collectByte in interface RichIterable<T>

Specified by:

collectByte in interface StackIterable<T>

collectByte

public <R extends MutableByteCollection> R collectByte(ByteFunction<? super T> byteFunction,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.collectByte(ByteFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 ByteArrayList bytes =
     people.collectByte(person -> person.getCode(), new ByteArrayList());
 

Example using an anonymous inner class:

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

Specified by:

collectByte in interface 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

flatCollectByte

public <R extends MutableByteCollection> R flatCollectByte(Function<? super T,? extends ByteIterable> function,
 R target)

Description copied from interface: RichIterable

Same as flatCollect, only the results are collected into the target collection.

Specified by:

flatCollectByte in interface 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)

collectChar

public MutableCharStack collectChar(CharFunction<? super T> charFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

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

Specified by:

collectChar in interface MutableStack<T>

Specified by:

collectChar in interface OrderedIterable<T>

Specified by:

collectChar in interface RichIterable<T>

Specified by:

collectChar in interface StackIterable<T>

collectChar

public <R extends MutableCharCollection> R collectChar(CharFunction<? super T> charFunction,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.collectChar(CharFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 CharArrayList chars =
     people.collectChar(person -> person.getMiddleInitial(), new CharArrayList());
 

Example using an anonymous inner class:

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

Specified by:

collectChar in interface 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

flatCollectChar

public <R extends MutableCharCollection> R flatCollectChar(Function<? super T,? extends CharIterable> function,
 R target)

Description copied from interface: RichIterable

Same as flatCollect, only the results are collected into the target collection.

Specified by:

flatCollectChar in interface 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)

collectDouble

public MutableDoubleStack collectDouble(DoubleFunction<? super T> doubleFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

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

Specified by:

collectDouble in interface MutableStack<T>

Specified by:

collectDouble in interface OrderedIterable<T>

Specified by:

collectDouble in interface RichIterable<T>

Specified by:

collectDouble in interface StackIterable<T>

collectDouble

public <R extends MutableDoubleCollection> R collectDouble(DoubleFunction<? super T> doubleFunction,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.collectDouble(DoubleFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 DoubleArrayList doubles =
     people.collectDouble(person -> person.getMilesFromNorthPole(), new DoubleArrayList());
 

Example using an anonymous inner class:

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

Specified by:

collectDouble in interface 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

flatCollectDouble

public <R extends MutableDoubleCollection> R flatCollectDouble(Function<? super T,? extends DoubleIterable> function,
 R target)

Description copied from interface: RichIterable

Same as flatCollect, only the results are collected into the target collection.

Specified by:

flatCollectDouble in interface 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)

collectFloat

public MutableFloatStack collectFloat(FloatFunction<? super T> floatFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

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

Specified by:

collectFloat in interface MutableStack<T>

Specified by:

collectFloat in interface OrderedIterable<T>

Specified by:

collectFloat in interface RichIterable<T>

Specified by:

collectFloat in interface StackIterable<T>

collectFloat

public <R extends MutableFloatCollection> R collectFloat(FloatFunction<? super T> floatFunction,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.collectFloat(FloatFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 FloatArrayList floats =
     people.collectFloat(person -> person.getHeightInInches(), new FloatArrayList());
 

Example using an anonymous inner class:

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

Specified by:

collectFloat in interface 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

flatCollectFloat

public <R extends MutableFloatCollection> R flatCollectFloat(Function<? super T,? extends FloatIterable> function,
 R target)

Description copied from interface: RichIterable

Same as flatCollect, only the results are collected into the target collection.

Specified by:

flatCollectFloat in interface 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)

collectInt

public MutableIntStack collectInt(IntFunction<? super T> intFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

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

Specified by:

collectInt in interface MutableStack<T>

Specified by:

collectInt in interface OrderedIterable<T>

Specified by:

collectInt in interface RichIterable<T>

Specified by:

collectInt in interface StackIterable<T>

collectInt

public <R extends MutableIntCollection> R collectInt(IntFunction<? super T> intFunction,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.collectInt(IntFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 IntArrayList ints =
     people.collectInt(person -> person.getAge(), new IntArrayList());
 

Example using an anonymous inner class:

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

Specified by:

collectInt in interface 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

flatCollectInt

public <R extends MutableIntCollection> R flatCollectInt(Function<? super T,? extends IntIterable> function,
 R target)

Description copied from interface: RichIterable

Same as flatCollect, only the results are collected into the target collection.

Specified by:

flatCollectInt in interface 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)

collectLong

public MutableLongStack collectLong(LongFunction<? super T> longFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

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

Specified by:

collectLong in interface MutableStack<T>

Specified by:

collectLong in interface OrderedIterable<T>

Specified by:

collectLong in interface RichIterable<T>

Specified by:

collectLong in interface StackIterable<T>

collectLong

public <R extends MutableLongCollection> R collectLong(LongFunction<? super T> longFunction,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.collectLong(LongFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 LongArrayList longs =
     people.collectLong(person -> person.getGuid(), new LongArrayList());
 

Example using an anonymous inner class:

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

Specified by:

collectLong in interface 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

flatCollectLong

public <R extends MutableLongCollection> R flatCollectLong(Function<? super T,? extends LongIterable> function,
 R target)

Description copied from interface: RichIterable

Same as flatCollect, only the results are collected into the target collection.

Specified by:

flatCollectLong in interface 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)

collectShort

public MutableShortStack collectShort(ShortFunction<? super T> shortFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

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

Specified by:

collectShort in interface MutableStack<T>

Specified by:

collectShort in interface OrderedIterable<T>

Specified by:

collectShort in interface RichIterable<T>

Specified by:

collectShort in interface StackIterable<T>

collectShort

public <R extends MutableShortCollection> R collectShort(ShortFunction<? super T> shortFunction,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.collectShort(ShortFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 ShortArrayList shorts =
     people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth, new ShortArrayList());
 

Example using an anonymous inner class:

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

Specified by:

collectShort in interface 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

flatCollectShort

public <R extends MutableShortCollection> R flatCollectShort(Function<? super T,? extends ShortIterable> function,
 R target)

Description copied from interface: RichIterable

Same as flatCollect, only the results are collected into the target collection.

Specified by:

flatCollectShort in interface 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)

collectWith

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

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

Specified by:

collectWith in interface MutableStack<T>

Specified by:

collectWith in interface OrderedIterable<T>

Specified by:

collectWith in interface RichIterable<T>

Specified by:

collectWith in interface StackIterable<T>

Parameters:

function - A Function2 to use as the collect transformation function

parameter - A parameter to pass in for evaluation of the second argument P in function

Returns:

A new RichIterable that contains the transformed elements returned by Function2.value(Object, Object)

See Also:

• RichIterable.collect(Function)

collectIf

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda and method reference:

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

Example using Predicates factory:

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

Specified by:

collectIf in interface MutableStack<T>

Specified by:

collectIf in interface OrderedIterable<T>

Specified by:

collectIf in interface RichIterable<T>

Specified by:

collectIf in interface StackIterable<T>

flatCollect

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

Description copied from interface: RichIterable

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

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

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

Using collect returns a collection of collections of addresses.

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

Using flatCollect returns a single flattened list of addresses.

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

Specified by:

flatCollect in interface MutableStack<T>

Specified by:

flatCollect in interface OrderedIterable<T>

Specified by:

flatCollect in interface RichIterable<T>

Specified by:

flatCollect in interface StackIterable<T>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

zip

public <S> MutableStack<Pair<T,S>> zip(Iterable<S> that)

Description copied from interface: OrderedIterable

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

Specified by:

zip in interface MutableStack<T>

Specified by:

zip in interface OrderedIterable<T>

Specified by:

zip in interface RichIterable<T>

Specified by:

zip in interface StackIterable<T>

Type Parameters:

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

Parameters:

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

Returns:

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

zipWithIndex

public MutableStack<Pair<T,Integer>> zipWithIndex()

Description copied from interface: RichIterable

Zips this RichIterable with its indices.

Specified by:

zipWithIndex in interface MutableStack<T>

Specified by:

zipWithIndex in interface OrderedIterable<T>

Specified by:

zipWithIndex in interface RichIterable<T>

Specified by:

zipWithIndex in interface StackIterable<T>

Returns:

A new RichIterable containing pairs consisting of all elements of this RichIterable paired with their index. Indices start at 0.

See Also:

• RichIterable.zip(Iterable)

size

public int size()

Description copied from interface: RichIterable

Returns the number of items in this iterable.

Specified by:

size in interface RichIterable<T>

isEmpty

public boolean isEmpty()

Description copied from interface: RichIterable

Returns true if this iterable has zero items.

Specified by:

isEmpty in interface RichIterable<T>

notEmpty

public boolean notEmpty()

Description copied from interface: RichIterable

The English equivalent of !this.isEmpty()

Specified by:

notEmpty in interface RichIterable<T>

getFirst

public T getFirst()

Description copied from interface: StackIterable

Should return the same value as peek().

Specified by:

getFirst in interface OrderedIterable<T>

Specified by:

getFirst in interface RichIterable<T>

Specified by:

getFirst in interface StackIterable<T>

getLast

public T getLast()

Description copied from interface: StackIterable

Should not work as it violates the contract of a Stack.

Specified by:

getLast in interface OrderedIterable<T>

Specified by:

getLast in interface RichIterable<T>

Specified by:

getLast in interface StackIterable<T>

getOnly

public T getOnly()

Description copied from interface: RichIterable

Returns the element if the iterable has exactly one element. Otherwise, throw IllegalStateException.

Specified by:

getOnly in interface RichIterable<T>

Returns:

an element of an iterable.

contains

public boolean contains(Object object)

Description copied from interface: RichIterable

Returns true if the iterable has an element which responds true to element.equals(object).

Specified by:

contains in interface RichIterable<T>

containsAllIterable

public boolean containsAllIterable(Iterable<?> source)

Description copied from interface: RichIterable

Returns true if all elements in source are contained in this collection.

Specified by:

containsAllIterable in interface RichIterable<T>

containsAll

public boolean containsAll(Collection<?> source)

Description copied from interface: RichIterable

Returns true if all elements in source are contained in this collection.

Specified by:

containsAll in interface RichIterable<T>

See Also:

• Collection.containsAll(Collection)

containsAllArguments

public boolean containsAllArguments(Object... elements)

Description copied from interface: RichIterable

Returns true if all elements in the specified var arg array are contained in this collection.

Specified by:

containsAllArguments in interface RichIterable<T>

select

public <R extends Collection<T>> R select(Predicate<? super T> predicate,
 R target)

Description copied from interface: RichIterable

Same as the select method with one parameter but uses the specified target collection for the results.

Example using a Java 8 lambda expression:

 MutableList<Person> selected =
     people.select(person -> person.person.getLastName().equals("Smith"), Lists.mutable.empty());
 

Example using an anonymous inner class:

 MutableList<Person> selected =
     people.select(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.person.getLastName().equals("Smith");
         }
     }, Lists.mutable.empty());
 

Specified by:

select in interface 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 Collection<T>> R selectWith(Predicate2<? super T,? super P> predicate,
 P parameter,
 R targetCollection)

Description copied from interface: RichIterable

Similar to RichIterable.select(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 an age greater than or equal to 18 years

Example using a Java 8 lambda expression:

 MutableList<Person> selected =
     people.selectWith((Person person, Integer age) -> person.getAge()>= age, Integer.valueOf(18), Lists.mutable.empty());
 

Example using an anonymous inner class:

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

Specified by:

selectWith in interface RichIterable<T>

Parameters:

predicate - a Predicate2 to use as the select criteria

parameter - a parameter to pass in for evaluation of the second argument P in predicate

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 Collection<T>> R reject(Predicate<? super T> predicate,
 R target)

Description copied from interface: RichIterable

Same as the reject method with one parameter but uses the specified target collection for the results.

Example using a Java 8 lambda expression:

 MutableList<Person> rejected =
     people.reject(person -> person.person.getLastName().equals("Smith"), Lists.mutable.empty());
 

Example using an anonymous inner class:

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

Specified by:

reject in interface 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 Collection<T>> R rejectWith(Predicate2<? super T,? super P> predicate,
 P parameter,
 R targetCollection)

Description copied from interface: 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 an age greater than or equal to 18 years

Example using a Java 8 lambda expression:

 MutableList<Person> rejected =
     people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18), Lists.mutable.empty());
 

Example using an anonymous inner class:

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

Specified by:

rejectWith in interface 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 Collection<V>> R collect(Function<? super T,? extends V> function,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.collect(Function), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 MutableList<String> names =
     people.collect(person -> person.getFirstName() + " " + person.getLastName(), Lists.mutable.empty());
 

Example using an anonymous inner class:

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

Specified by:

collect in interface 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 Collection<V>> R collectWith(Function2<? super T,? super P,? extends V> function,
 P parameter,
 R targetCollection)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

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

Specified by:

collectWith in interface RichIterable<T>

Parameters:

function - a Function2 to use as the collect transformation function

parameter - a parameter to pass in for evaluation of the second argument P in function

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 Collection<V>> R collectIf(Predicate<? super T> predicate,
 Function<? super T,? extends V> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

collectIf in interface 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 Collection<V>> R flatCollect(Function<? super T,? extends Iterable<V>> function,
 R target)

Description copied from interface: RichIterable

Same as flatCollect, only the results are collected into the target collection.

Specified by:

flatCollect in interface 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(Predicate<? super T> predicate)

Description copied from interface: 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.

Example using a Java 8 lambda expression:

 Person person =
     people.detect(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));
 

Example using an anonymous inner class:

 Person person =
     people.detect(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getFirstName().equals("John") && person.getLastName().equals("Smith");
         }
     });
 

Specified by:

detect in interface RichIterable<T>

detectWith

public <P> T detectWith(Predicate2<? super T,? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true.

Example using a Java 8 lambda expression:

 Person person =
     people.detectWith((person, fullName) -> person.getFullName().equals(fullName), "John Smith");
 

Example using an anonymous inner class:

 Person person =
     people.detectWith(new Predicate2<Person, String>()
     {
         public boolean accept(Person person, String fullName)
         {
             return person.getFullName().equals(fullName);
         }
     }, "John Smith");
 

Specified by:

detectWith in interface RichIterable<T>

detectOptional

public Optional<T> detectOptional(Predicate<? super T> predicate)

Description copied from interface: RichIterable

Returns the first element of the iterable for which the predicate evaluates to true as an Optional. This method is commonly called find.

Example using a Java 8 lambda expression:

 Person person =
     people.detectOptional(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));
 

Specified by:

detectOptional in interface RichIterable<T>

detectWithOptional

public <P> Optional<T> detectWithOptional(Predicate2<? super T,? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

Returns the first element that evaluates to true for the specified predicate2 and parameter as an Optional.

Example using a Java 8 lambda expression:

 Optional<Person> person =
     people.detectWithOptional((person, fullName) -> person.getFullName().equals(fullName), "John Smith");
 

Specified by:

detectWithOptional in interface RichIterable<T>

detectIfNone

public T detectIfNone(Predicate<? super T> predicate,
 Function0<? extends T> function)

Description copied from interface: 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 RichIterable<T>

detectWithIfNone

public <P> T detectWithIfNone(Predicate2<? super T,? super P> predicate,
 P parameter,
 Function0<? extends T> function)

Description copied from interface: 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 RichIterable<T>

count

public int count(Predicate<? super T> predicate)

Description copied from interface: RichIterable

Return the total number of elements that answer true to the specified predicate.

Example using a Java 8 lambda expression:

 int count =
     people.count(person -> person.getAddress().getState().getName().equals("New York"));
 

Example using an anonymous inner class:

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

Specified by:

count in interface RichIterable<T>

countWith

public <P> int countWith(Predicate2<? super T,? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

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

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

Specified by:

countWith in interface RichIterable<T>

anySatisfy

public boolean anySatisfy(Predicate<? super T> predicate)

Description copied from interface: 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 RichIterable<T>

anySatisfyWith

public <P> boolean anySatisfyWith(Predicate2<? super T,? super P> predicate,
 P parameter)

Description copied from interface: 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 RichIterable<T>

allSatisfy

public boolean allSatisfy(Predicate<? super T> predicate)

Description copied from interface: 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 RichIterable<T>

allSatisfyWith

public <P> boolean allSatisfyWith(Predicate2<? super T,? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

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

Specified by:

allSatisfyWith in interface RichIterable<T>

noneSatisfy

public boolean noneSatisfy(Predicate<? super T> predicate)

Description copied from interface: 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 RichIterable<T>

noneSatisfyWith

public <P> boolean noneSatisfyWith(Predicate2<? super T,? super P> predicate,
 P parameter)

Description copied from interface: 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 RichIterable<T>

injectInto

public <IV> IV injectInto(IV injectedValue,
 Function2<? super IV,? super T,? extends IV> function)

Description copied from interface: 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 RichIterable<T>

injectInto

public int injectInto(int injectedValue,
 IntObjectToIntFunction<? super T> intObjectToIntFunction)

Description copied from interface: 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 RichIterable<T>

injectInto

public long injectInto(long injectedValue,
 LongObjectToLongFunction<? super T> longObjectToLongFunction)

Description copied from interface: 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 RichIterable<T>

injectInto

public float injectInto(float injectedValue,
 FloatObjectToFloatFunction<? super T> floatObjectToFloatFunction)

Description copied from interface: 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 RichIterable<T>

injectInto

public double injectInto(double injectedValue,
 DoubleObjectToDoubleFunction<? super T> doubleObjectToDoubleFunction)

Description copied from interface: 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 RichIterable<T>

into

public <R extends Collection<T>> R into(R target)

Description copied from interface: RichIterable

Adds all the elements in this iterable to the specific target Collection.

Specified by:

into in interface RichIterable<T>

toList

public MutableList<T> toList()

Description copied from interface: RichIterable

Converts the collection to a MutableList implementation.

Specified by:

toList in interface RichIterable<T>

toSortedList

public MutableList<T> toSortedList()

Description copied from interface: RichIterable

Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.

Specified by:

toSortedList in interface RichIterable<T>

toSortedList

public MutableList<T> toSortedList(Comparator<? super T> comparator)

Description copied from interface: RichIterable

Converts the collection to a MutableList implementation and sorts it using the specified comparator.

Specified by:

toSortedList in interface RichIterable<T>

toSet

public MutableSet<T> toSet()

Description copied from interface: RichIterable

Converts the collection to a MutableSet implementation.

Specified by:

toSet in interface RichIterable<T>

toSortedSet

public MutableSortedSet<T> toSortedSet()

Description copied from interface: RichIterable

Converts the collection to a MutableSortedSet implementation and sorts it using the natural order of the elements.

Specified by:

toSortedSet in interface RichIterable<T>

toSortedSet

public MutableSortedSet<T> toSortedSet(Comparator<? super T> comparator)

Description copied from interface: RichIterable

Converts the collection to a MutableSortedSet implementation and sorts it using the specified comparator.

Specified by:

toSortedSet in interface RichIterable<T>

toImmutable

public ImmutableStack<T> toImmutable()

Description copied from interface: StackIterable

Converts the StackIterable to an immutable implementation. Returns this for immutable stacks.

Specified by:

toImmutable in interface StackIterable<T>

toBag

public MutableBag<T> toBag()

Description copied from interface: RichIterable

Converts the collection to the default MutableBag implementation.

Specified by:

toBag in interface RichIterable<T>

toSortedBag

public MutableSortedBag<T> toSortedBag()

Description copied from interface: RichIterable

Converts the collection to a MutableSortedBag implementation and sorts it using the natural order of the elements.

Specified by:

toSortedBag in interface RichIterable<T>

toSortedBag

public MutableSortedBag<T> toSortedBag(Comparator<? super T> comparator)

Description copied from interface: RichIterable

Converts the collection to the MutableSortedBag implementation and sorts it using the specified comparator.

Specified by:

toSortedBag in interface RichIterable<T>

toMap

public <NK,
NV> MutableMap<NK,NV> toMap(Function<? super T,? extends NK> keyFunction,
 Function<? super T,? extends NV> valueFunction)

Description copied from interface: RichIterable

Converts the collection to a MutableMap implementation using the specified key and value functions.

Specified by:

toMap in interface RichIterable<T>

toMap

public <NK,
NV,
R extends Map<NK,
NV>> R toMap(Function<? super T,? extends NK> keyFunction,
 Function<? super T,? extends NV> valueFunction,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.toMap(Function, Function), except that the results are gathered into the specified target map.

Specified by:

toMap in interface RichIterable<T>

toSortedMap

public <NK,
NV> MutableSortedMap<NK,NV> toSortedMap(Function<? super T,? extends NK> keyFunction,
 Function<? super T,? extends NV> valueFunction)

Description copied from interface: 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 RichIterable<T>

toSortedMap

public <NK,
NV> MutableSortedMap<NK,NV> toSortedMap(Comparator<? super NK> comparator,
 Function<? super T,? extends NK> keyFunction,
 Function<? super T,? extends NV> valueFunction)

Description copied from interface: 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 RichIterable<T>

toBiMap

public <NK,
NV> MutableBiMap<NK,NV> toBiMap(Function<? super T,? extends NK> keyFunction,
 Function<? super T,? extends NV> valueFunction)

Description copied from interface: RichIterable

Converts the collection to a BiMap implementation using the specified key and value functions.

Specified by:

toBiMap in interface RichIterable<T>

asLazy

public LazyIterable<T> asLazy()

Description copied from interface: RichIterable

Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).

Specified by:

asLazy in interface RichIterable<T>

toArray

public Object[] toArray()

Description copied from interface: RichIterable

Converts this iterable to an array.

Specified by:

toArray in interface RichIterable<T>

See Also:

• Collection.toArray()

toArray

public <T> T[] toArray(T[] a)

Description copied from interface: 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 RichIterable<T>

See Also:

• Collection.toArray(Object[])

min

public T min(Comparator<? super T> comparator)

Description copied from interface: RichIterable

Returns the minimum element out of this container based on the comparator.

Specified by:

min in interface RichIterable<T>

max

public T max(Comparator<? super T> comparator)

Description copied from interface: RichIterable

Returns the maximum element out of this container based on the comparator.

Specified by:

max in interface RichIterable<T>

min

public T min()

Description copied from interface: OrderedIterable

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

Specified by:

min in interface OrderedIterable<T>

Specified by:

min in interface RichIterable<T>

max

public T max()

Description copied from interface: OrderedIterable

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

Specified by:

max in interface OrderedIterable<T>

Specified by:

max in interface RichIterable<T>

detectIndex

public int detectIndex(Predicate<? super T> predicate)

Description copied from interface: OrderedIterable

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

Specified by:

detectIndex in interface OrderedIterable<T>

minBy

public <V extends Comparable<? super V>> T minBy(Function<? super T,? extends V> function)

Description copied from interface: 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 RichIterable<T>

maxBy

public <V extends Comparable<? super V>> T maxBy(Function<? super T,? extends V> function)

Description copied from interface: 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 RichIterable<T>

sumOfInt

public long sumOfInt(IntFunction<? super T> intFunction)

Description copied from interface: 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 RichIterable<T>

sumOfFloat

public double sumOfFloat(FloatFunction<? super T> floatFunction)

Description copied from interface: RichIterable

Returns the final double result of evaluating function for each element of the iterable and adding the results together. It uses Kahan summation algorithm to reduce numerical error.

Specified by:

sumOfFloat in interface RichIterable<T>

sumOfLong

public long sumOfLong(LongFunction<? super T> longFunction)

Description copied from interface: 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 RichIterable<T>

sumOfDouble

public double sumOfDouble(DoubleFunction<? super T> doubleFunction)

Description copied from interface: RichIterable

Returns the final double result of evaluating function for each element of the iterable and adding the results together. It uses Kahan summation algorithm to reduce numerical error.

Specified by:

sumOfDouble in interface RichIterable<T>

sumByInt

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

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByInt in interface MutableStack<T>

Specified by:

sumByInt in interface RichIterable<T>

sumByFloat

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

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByFloat in interface MutableStack<T>

Specified by:

sumByFloat in interface RichIterable<T>

sumByLong

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

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByLong in interface MutableStack<T>

Specified by:

sumByLong in interface RichIterable<T>

sumByDouble

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

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByDouble in interface MutableStack<T>

Specified by:

sumByDouble in interface RichIterable<T>

makeString

public String makeString()

Description copied from interface: 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 RichIterable<T>

Returns:

a string representation of this collection.

makeString

public String makeString(String separator)

Description copied from interface: 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 RichIterable<T>

Returns:

a string representation of this collection.

makeString

public String makeString(String start,
 String separator,
 String end)

Description copied from interface: RichIterable

Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.

Specified by:

makeString in interface RichIterable<T>

Returns:

a string representation of this collection.

appendString

public void appendString(Appendable appendable)

Description copied from interface: RichIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString().

Specified by:

appendString in interface RichIterable<T>

appendString

public void appendString(Appendable appendable,
 String separator)

Description copied from interface: 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 RichIterable<T>

appendString

public void appendString(Appendable appendable,
 String start,
 String separator,
 String end)

Description copied from interface: 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 RichIterable<T>

groupBy

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

Description copied from interface: RichIterable

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

Example using a Java 8 method reference:

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

Example using an anonymous inner class:

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

Specified by:

groupBy in interface MutableStack<T>

Specified by:

groupBy in interface OrderedIterable<T>

Specified by:

groupBy in interface RichIterable<T>

Specified by:

groupBy in interface StackIterable<T>

groupBy

public <V,
R extends MutableMultimap<V,
T>> R groupBy(Function<? super T,? extends V> function,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.groupBy(Function), except that the results are gathered into the specified target multimap.

Example using a Java 8 method reference:

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

Example using an anonymous inner class:

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

Specified by:

groupBy in interface RichIterable<T>

groupByEach

public <V> MutableListMultimap<V,T> groupByEach(Function<? super T,? extends Iterable<V>> function)

Description copied from interface: RichIterable

Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.

Specified by:

groupByEach in interface MutableStack<T>

Specified by:

groupByEach in interface OrderedIterable<T>

Specified by:

groupByEach in interface RichIterable<T>

Specified by:

groupByEach in interface StackIterable<T>

groupByEach

public <V,
R extends MutableMultimap<V,
T>> R groupByEach(Function<? super T,? extends Iterable<V>> function,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.groupByEach(Function), except that the results are gathered into the specified target multimap.

Specified by:

groupByEach in interface RichIterable<T>

groupByUniqueKey

public <V> MutableMap<V,T> groupByUniqueKey(Function<? super T,? extends V> function)

Description copied from interface: RichIterable

For each element of the iterable, the function is evaluated, and the 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 MutableStack<T>

Specified by:

groupByUniqueKey in interface RichIterable<T>

See Also:

• RichIterable.groupBy(Function)

groupByUniqueKey

public <V,
R extends MutableMapIterable<V,
T>> R groupByUniqueKey(Function<? super T,? extends V> function,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.groupByUniqueKey(Function), except that the results are gathered into the specified target map.

Specified by:

groupByUniqueKey in interface RichIterable<T>

See Also:

• RichIterable.groupByUniqueKey(Function)

zip

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

Description copied from interface: OrderedIterable

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

Specified by:

zip in interface OrderedIterable<T>

Specified by:

zip in interface RichIterable<T>

zipWithIndex

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

Description copied from interface: OrderedIterable

Same as OrderedIterable.zipWithIndex() but uses target for output.

Specified by:

zipWithIndex in interface OrderedIterable<T>

Specified by:

zipWithIndex in interface RichIterable<T>

chunk

public RichIterable<RichIterable<T>> chunk(int size)

Description copied from interface: RichIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface 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.

tap

public MutableStack<T> tap(Procedure<? super T> procedure)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

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

Specified by:

tap in interface MutableStack<T>

Specified by:

tap in interface OrderedIterable<T>

Specified by:

tap in interface RichIterable<T>

Specified by:

tap in interface StackIterable<T>

See Also:

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

each

public void each(Procedure<? super T> procedure)

Description copied from interface: RichIterable

The procedure is executed for each element in the iterable.

Example using a Java 8 lambda expression:

 people.each(person -> LOGGER.info(person.getName()));
 

Example using an anonymous inner class:

 people.each(new Procedure<Person>()
 {
     public void value(Person person)
     {
         LOGGER.info(person.getName());
     }
 });
 

This method is a variant of InternalIterable.forEach(Procedure) that has a signature conflict with Iterable.forEach(java.util.function.Consumer).

Specified by:

each in interface RichIterable<T>

See Also:

• InternalIterable.forEach(Procedure)
• Iterable.forEach(java.util.function.Consumer)

peek

public T peek()

Description copied from interface: StackIterable

Returns the element at the top of the stack, without removing it from the stack.

Specified by:

peek in interface StackIterable<T>

Returns:

the top of the stack.

peek

public ListIterable<T> peek(int count)

Specified by:

peek in interface 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)

Description copied from interface: StackIterable

Returns the element at a specific index, without removing it from the stack.

Specified by:

peekAt in interface StackIterable<T>

Parameters:

index - the location to peek into

Returns:

the element at the specified index

toString

public String toString()

Description copied from interface: StackIterable

Follows the same rules as AbstractCollection.toString() except it processes the elements in the same order as forEach().

 Assert.assertEquals("[3, 2, 1]", Stacks.mutable.with(1, 2, 3).toString());
 

Specified by:

toString in interface RichIterable<T>

Specified by:

toString in interface StackIterable<T>

Overrides:

toString in class Object

Returns:

a string representation of this RichIterable

See Also:

• AbstractCollection.toString()

forEachWithIndex

public void forEachWithIndex(ObjectIntProcedure<? super T> objectIntProcedure)

Description copied from interface: OrderedIterable

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<Person>()
 {
     public void value(Person person, int index)
     {
         LOGGER.info("Index: " + index + " person: " + person.getName());
     }
 });
 

Specified by:

forEachWithIndex in interface InternalIterable<T>

Specified by:

forEachWithIndex in interface OrderedIterable<T>

forEachWithIndex

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

Description copied from interface: OrderedIterable

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

e.g.
 OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally)
 people.forEachWithIndex(0, 1, new ObjectIntProcedure<Person>()
 {
     public void value(Person person, int index)
     {
          LOGGER.info(person.getName());
     }
 });
 

This code would output ted and mary's names.

Specified by:

forEachWithIndex in interface OrderedIterable<T>

collectWithIndex

public <V> MutableStack<V> collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function)

Description copied from interface: OrderedIterable

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

Specified by:

collectWithIndex in interface MutableStack<T>

Specified by:

collectWithIndex in interface OrderedIterable<T>

Specified by:

collectWithIndex in interface StackIterable<T>

forEachWith

public <P> void forEachWith(Procedure2<? super T,? super P> procedure,
 P parameter)

Description copied from interface: InternalIterable

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

Example using a Java 8 lambda:

 people.forEachWith((Person person, Person other) ->
     {
         if (person.isRelatedTo(other))
         {
              LOGGER.info(person.getName());
         }
     }, fred);
 

Example using an anonymous inner class:

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

Specified by:

forEachWith in interface InternalIterable<T>

asUnmodifiable

public MutableStack<T> asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableStack<T>

asSynchronized

public MutableStack<T> asSynchronized()

Specified by:

asSynchronized in interface MutableStack<T>

equals

public boolean equals(Object obj)

Description copied from interface: StackIterable

Follows the same general contract as List.equals(Object), but for Stacks.

Specified by:

equals in interface StackIterable<T>

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: StackIterable

Follows the same general contract as List.hashCode(), but for Stacks.

Specified by:

hashCode in interface StackIterable<T>

Overrides:

hashCode in class Object

indexOf

public int indexOf(Object object)

Description copied from interface: OrderedIterable

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

Specified by:

indexOf in interface OrderedIterable<T>

See Also:

• List.indexOf(Object)

corresponds

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

Description copied from interface: OrderedIterable

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

Specified by:

corresponds in interface OrderedIterable<T>

forEach

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

Description copied from interface: OrderedIterable

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

e.g.
 OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally)
 people.forEach(0, 1, new Procedure<Person>()
 {
     public void value(Person person)
     {
          LOGGER.info(person.getName());
     }
 });
 

This code would output ted and mary's names.

Specified by:

forEach in interface OrderedIterable<T>

takeWhile

public MutableStack<T> takeWhile(Predicate<? super T> predicate)

Description copied from interface: OrderedIterable

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

Specified by:

takeWhile in interface MutableStack<T>

Specified by:

takeWhile in interface OrderedIterable<T>

Specified by:

takeWhile in interface StackIterable<T>

dropWhile

public MutableStack<T> dropWhile(Predicate<? super T> predicate)

Description copied from interface: OrderedIterable

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

Specified by:

dropWhile in interface MutableStack<T>

Specified by:

dropWhile in interface OrderedIterable<T>

Specified by:

dropWhile in interface StackIterable<T>

partitionWhile

public PartitionMutableStack<T> partitionWhile(Predicate<? super T> predicate)

Description copied from interface: OrderedIterable

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

Specified by:

partitionWhile in interface MutableStack<T>

Specified by:

partitionWhile in interface OrderedIterable<T>

Specified by:

partitionWhile in interface StackIterable<T>

distinct

public MutableStack<T> distinct()

Description copied from interface: OrderedIterable

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

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

Specified by:

distinct in interface MutableStack<T>

Specified by:

distinct in interface OrderedIterable<T>

Specified by:

distinct in interface StackIterable<T>

Returns:

OrderedIterable of distinct elements