public final class UnmodifiableStack<T> extends Object implements MutableStack<T>, Serializable
Modifier and Type | Method and Description |
---|---|
<K,V> MutableMap<K,V> |
aggregateBy(Function<? super T,? extends K> groupBy,
Function0<? extends V> zeroValueFactory,
Function2<? super V,? super T,? extends V> nonMutatingAggregator)
Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function.
|
<K,V> MutableMap<K,V> |
aggregateInPlaceBy(Function<? super T,? extends K> groupBy,
Function0<? extends V> zeroValueFactory,
Procedure2<? super V,? super T> mutatingAggregator)
Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function.
|
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>> |
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> |
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> |
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> |
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> |
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> |
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>> |
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> |
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> |
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> |
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>> |
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) |
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>> |
flatCollect(Function<? super T,? extends Iterable<V>> 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.
|
void |
forEach(Procedure<? super T> procedure)
The procedure is executed for each element in the iterable.
|
<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>> |
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>> |
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 he results of these evaluations are collected
into a new map, where the transformed value is the key.
|
<V,R extends MutableMap<V,T>> |
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.
|
<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.
|
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.
|
<R extends Collection<T>> |
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.
|
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>> |
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>> |
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>> |
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() |
ListIterable<T> |
peek(int count) |
T |
peekAt(int index) |
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>> |
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.
|
<R extends MutableStack<T>> |
pop(int count,
R targetStack)
Removes and returns a ListIterable of the number of elements specified by the count,
beginning with the top of the stack and puts them into a new stack.
|
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>> |
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>> |
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>> |
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>> |
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.
|
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.
|
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.
|
<V extends Comparable<? super V>> |
toSortedBagBy(Function<? super T,? extends V> function)
Converts the collection to a MutableSortedBag implementation and sorts it based on the natural order of the
attribute returned by
function . |
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.
|
<V extends Comparable<? super V>> |
toSortedListBy(Function<? super T,? extends V> function)
Converts the collection to a MutableList implementation and sorts it based on the natural order of the
attribute returned by
function . |
<NK,NV> 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.
|
<V extends Comparable<? super V>> |
toSortedSetBy(Function<? super T,? extends V> function)
Converts the collection to a MutableSortedSet implementation and sorts it based on the natural order of the
attribute returned by
function . |
MutableStack<T> |
toStack()
Converts the stack to a MutableStack implementation.
|
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>>> |
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>>> |
zipWithIndex(R target)
Same as
OrderedIterable.zipWithIndex() but uses target for output. |
reduce, reduceInPlace, reduceInPlace, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong
forEach, spliterator
public static <T,S extends MutableStack<T>> UnmodifiableStack<T> of(S stack)
public T pop()
MutableStack
pop
in interface MutableStack<T>
public ListIterable<T> pop(int count)
MutableStack
pop
in interface MutableStack<T>
public <R extends Collection<T>> R pop(int count, R targetCollection)
MutableStack
pop
in interface MutableStack<T>
public <R extends MutableStack<T>> R pop(int count, R targetStack)
MutableStack
pop
in interface MutableStack<T>
public void clear()
clear
in interface MutableStack<T>
public void push(T item)
MutableStack
push
in interface MutableStack<T>
public MutableStack<T> select(Predicate<? super T> predicate)
RichIterable
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"); } });
select
in interface OrderedIterable<T>
select
in interface RichIterable<T>
select
in interface MutableStack<T>
select
in interface StackIterable<T>
public <P> MutableStack<T> selectWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterable
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));
selectWith
in interface OrderedIterable<T>
selectWith
in interface RichIterable<T>
selectWith
in interface MutableStack<T>
selectWith
in interface StackIterable<T>
predicate
- a Predicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argument P
in predicate
RichIterable.select(Predicate)
public MutableStack<T> reject(Predicate<? super T> predicate)
RichIterable
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"); } });
reject
in interface OrderedIterable<T>
reject
in interface RichIterable<T>
reject
in interface MutableStack<T>
reject
in interface StackIterable<T>
predicate
- a Predicate
to use as the reject criteriaPredicate.accept(Object)
method to evaluate to falsepublic <P> MutableStack<T> rejectWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterable
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));
rejectWith
in interface OrderedIterable<T>
rejectWith
in interface RichIterable<T>
rejectWith
in interface MutableStack<T>
rejectWith
in interface StackIterable<T>
predicate
- a Predicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argument P
in predicate
RichIterable.select(Predicate)
public PartitionMutableStack<T> partition(Predicate<? super T> predicate)
RichIterable
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"); } });
partition
in interface OrderedIterable<T>
partition
in interface RichIterable<T>
partition
in interface MutableStack<T>
partition
in interface StackIterable<T>
public <P> PartitionMutableStack<T> partitionWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterable
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");
partitionWith
in interface OrderedIterable<T>
partitionWith
in interface RichIterable<T>
partitionWith
in interface MutableStack<T>
partitionWith
in interface StackIterable<T>
public <S> MutableStack<S> selectInstancesOf(Class<S> clazz)
RichIterable
clazz
.selectInstancesOf
in interface OrderedIterable<T>
selectInstancesOf
in interface RichIterable<T>
selectInstancesOf
in interface MutableStack<T>
selectInstancesOf
in interface StackIterable<T>
public <V> MutableStack<V> collect(Function<? super T,? extends V> function)
RichIterable
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(); } });
collect
in interface OrderedIterable<T>
collect
in interface RichIterable<T>
collect
in interface MutableStack<T>
collect
in interface StackIterable<T>
public MutableBooleanStack collectBoolean(BooleanFunction<? super T> booleanFunction)
RichIterable
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(); } });
collectBoolean
in interface OrderedIterable<T>
collectBoolean
in interface RichIterable<T>
collectBoolean
in interface MutableStack<T>
collectBoolean
in interface StackIterable<T>
public <R extends MutableBooleanCollection> R collectBoolean(BooleanFunction<? super T> booleanFunction, R target)
RichIterable
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());
collectBoolean
in interface RichIterable<T>
booleanFunction
- a BooleanFunction
to use as the collect transformation functiontarget
- the MutableBooleanCollection to append to for all elements in this RichIterable
target
, which contains appended elements as a result of the collect transformationpublic MutableByteStack collectByte(ByteFunction<? super T> byteFunction)
RichIterable
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(); } });
collectByte
in interface OrderedIterable<T>
collectByte
in interface RichIterable<T>
collectByte
in interface MutableStack<T>
collectByte
in interface StackIterable<T>
public <R extends MutableByteCollection> R collectByte(ByteFunction<? super T> byteFunction, R target)
RichIterable
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());
collectByte
in interface RichIterable<T>
byteFunction
- a ByteFunction
to use as the collect transformation functiontarget
- the MutableByteCollection to append to for all elements in this RichIterable
target
, which contains appended elements as a result of the collect transformationpublic MutableCharStack collectChar(CharFunction<? super T> charFunction)
RichIterable
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(); } });
collectChar
in interface OrderedIterable<T>
collectChar
in interface RichIterable<T>
collectChar
in interface MutableStack<T>
collectChar
in interface StackIterable<T>
public <R extends MutableCharCollection> R collectChar(CharFunction<? super T> charFunction, R target)
RichIterable
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());
collectChar
in interface RichIterable<T>
charFunction
- a CharFunction
to use as the collect transformation functiontarget
- the MutableCharCollection to append to for all elements in this RichIterable
target
, which contains appended elements as a result of the collect transformationpublic MutableDoubleStack collectDouble(DoubleFunction<? super T> doubleFunction)
RichIterable
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(); } });
collectDouble
in interface OrderedIterable<T>
collectDouble
in interface RichIterable<T>
collectDouble
in interface MutableStack<T>
collectDouble
in interface StackIterable<T>
public <R extends MutableDoubleCollection> R collectDouble(DoubleFunction<? super T> doubleFunction, R target)
RichIterable
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());
collectDouble
in interface RichIterable<T>
doubleFunction
- a DoubleFunction
to use as the collect transformation functiontarget
- the MutableDoubleCollection to append to for all elements in this RichIterable
target
, which contains appended elements as a result of the collect transformationpublic MutableFloatStack collectFloat(FloatFunction<? super T> floatFunction)
RichIterable
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(); } });
collectFloat
in interface OrderedIterable<T>
collectFloat
in interface RichIterable<T>
collectFloat
in interface MutableStack<T>
collectFloat
in interface StackIterable<T>
public <R extends MutableFloatCollection> R collectFloat(FloatFunction<? super T> floatFunction, R target)
RichIterable
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());
collectFloat
in interface RichIterable<T>
floatFunction
- a FloatFunction
to use as the collect transformation functiontarget
- the MutableFloatCollection to append to for all elements in this RichIterable
target
, which contains appended elements as a result of the collect transformationpublic MutableIntStack collectInt(IntFunction<? super T> intFunction)
RichIterable
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(); } });
collectInt
in interface OrderedIterable<T>
collectInt
in interface RichIterable<T>
collectInt
in interface MutableStack<T>
collectInt
in interface StackIterable<T>
public <R extends MutableIntCollection> R collectInt(IntFunction<? super T> intFunction, R target)
RichIterable
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());
collectInt
in interface RichIterable<T>
intFunction
- a IntFunction
to use as the collect transformation functiontarget
- the MutableIntCollection to append to for all elements in this RichIterable
target
, which contains appended elements as a result of the collect transformationpublic MutableLongStack collectLong(LongFunction<? super T> longFunction)
RichIterable
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(); } });
collectLong
in interface OrderedIterable<T>
collectLong
in interface RichIterable<T>
collectLong
in interface MutableStack<T>
collectLong
in interface StackIterable<T>
public <R extends MutableLongCollection> R collectLong(LongFunction<? super T> longFunction, R target)
RichIterable
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());
collectLong
in interface RichIterable<T>
longFunction
- a LongFunction
to use as the collect transformation functiontarget
- the MutableLongCollection to append to for all elements in this RichIterable
target
, which contains appended elements as a result of the collect transformationpublic MutableShortStack collectShort(ShortFunction<? super T> shortFunction)
RichIterable
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(); } });
collectShort
in interface OrderedIterable<T>
collectShort
in interface RichIterable<T>
collectShort
in interface MutableStack<T>
collectShort
in interface StackIterable<T>
public <R extends MutableShortCollection> R collectShort(ShortFunction<? super T> shortFunction, R target)
RichIterable
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());
collectShort
in interface RichIterable<T>
shortFunction
- a ShortFunction
to use as the collect transformation functiontarget
- the MutableShortCollection to append to for all elements in this RichIterable
target
, which contains appended elements as a result of the collect transformationpublic <P,V> MutableStack<V> collectWith(Function2<? super T,? super P,? extends V> function, P parameter)
RichIterable
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));
collectWith
in interface OrderedIterable<T>
collectWith
in interface RichIterable<T>
collectWith
in interface MutableStack<T>
collectWith
in interface StackIterable<T>
function
- A Function2
to use as the collect transformation functionparameter
- A parameter to pass in for evaluation of the second argument P
in function
RichIterable
that contains the transformed elements returned by Function2.value(Object, Object)
RichIterable.collect(Function)
public <V> MutableStack<V> collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function)
RichIterable
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());
collectIf
in interface OrderedIterable<T>
collectIf
in interface RichIterable<T>
collectIf
in interface MutableStack<T>
collectIf
in interface StackIterable<T>
public <V> MutableStack<V> flatCollect(Function<? super T,? extends Iterable<V>> function)
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; MutableList<Person> people = ...;Using
collect
returns a collection of collections of addresses.
MutableList<List<Address>> addresses = people.collect(addressFunction);Using
flatCollect
returns a single flattened list of addresses.
MutableList<Address> addresses = people.flatCollect(addressFunction);
flatCollect
in interface OrderedIterable<T>
flatCollect
in interface RichIterable<T>
flatCollect
in interface MutableStack<T>
flatCollect
in interface StackIterable<T>
function
- The Function
to applyfunction
public <S> MutableStack<Pair<T,S>> zip(Iterable<S> that)
OrderedIterable
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 Iterable
s is longer than the other, its
remaining elements are ignored.zip
in interface OrderedIterable<T>
zip
in interface RichIterable<T>
zip
in interface MutableStack<T>
zip
in interface StackIterable<T>
S
- the type of the second half of the returned pairsthat
- The Iterable
providing the second half of each result pairOrderedIterable
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.public MutableStack<Pair<T,Integer>> zipWithIndex()
RichIterable
RichIterable
with its indices.zipWithIndex
in interface OrderedIterable<T>
zipWithIndex
in interface RichIterable<T>
zipWithIndex
in interface MutableStack<T>
zipWithIndex
in interface StackIterable<T>
RichIterable
containing pairs consisting of all elements of this RichIterable
paired with their index. Indices start at 0.RichIterable.zip(Iterable)
public int size()
RichIterable
size
in interface RichIterable<T>
public boolean isEmpty()
RichIterable
isEmpty
in interface RichIterable<T>
public boolean notEmpty()
RichIterable
notEmpty
in interface RichIterable<T>
public T getFirst()
StackIterable
getFirst
in interface OrderedIterable<T>
getFirst
in interface RichIterable<T>
getFirst
in interface StackIterable<T>
public T getLast()
StackIterable
getLast
in interface OrderedIterable<T>
getLast
in interface RichIterable<T>
getLast
in interface StackIterable<T>
public T getOnly()
RichIterable
IllegalStateException
.getOnly
in interface RichIterable<T>
public boolean contains(Object object)
RichIterable
contains
in interface RichIterable<T>
public boolean containsAllIterable(Iterable<?> source)
RichIterable
containsAllIterable
in interface RichIterable<T>
public boolean containsAll(Collection<?> source)
RichIterable
containsAll
in interface RichIterable<T>
Collection.containsAll(Collection)
public boolean containsAllArguments(Object... elements)
RichIterable
containsAllArguments
in interface RichIterable<T>
public <R extends Collection<T>> R select(Predicate<? super T> predicate, R target)
RichIterable
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());
select
in interface RichIterable<T>
predicate
- a Predicate
to use as the select criteriatarget
- the Collection to append to for all elements in this RichIterable
that meet select criteria predicate
target
, which contains appended elements as a result of the select criteriaRichIterable.select(Predicate)
public <P,R extends Collection<T>> R selectWith(Predicate2<? super T,? super P> predicate, P parameter, R targetCollection)
RichIterable
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());
selectWith
in interface RichIterable<T>
predicate
- a Predicate2
to use as the select criteriaparameter
- 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
targetCollection
, which contains appended elements as a result of the select criteriaRichIterable.select(Predicate)
,
RichIterable.select(Predicate, Collection)
public <R extends Collection<T>> R reject(Predicate<? super T> predicate, R target)
RichIterable
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());
reject
in interface RichIterable<T>
predicate
- a Predicate
to use as the reject criteriatarget
- the Collection to append to for all elements in this RichIterable
that cause Predicate#accept(Object)
method to evaluate to falsetarget
, which contains appended elements as a result of the reject criteriapublic <P,R extends Collection<T>> R rejectWith(Predicate2<? super T,? super P> predicate, P parameter, R targetCollection)
RichIterable
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());
rejectWith
in interface RichIterable<T>
predicate
- a Predicate2
to use as the reject criteriaparameter
- 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 falsetargetCollection
, which contains appended elements as a result of the reject criteriaRichIterable.reject(Predicate)
,
RichIterable.reject(Predicate, Collection)
public <V,R extends Collection<V>> R collect(Function<? super T,? extends V> function, R target)
RichIterable
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());
collect
in interface RichIterable<T>
function
- a Function
to use as the collect transformation functiontarget
- the Collection to append to for all elements in this RichIterable
that meet select criteria function
target
, which contains appended elements as a result of the collect transformationRichIterable.collect(Function)
public <P,V,R extends Collection<V>> R collectWith(Function2<? super T,? super P,? extends V> function, P parameter, R targetCollection)
RichIterable
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:
Function2addParameterFunction = new Function2 () { 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());
collectWith
in interface RichIterable<T>
function
- a Function2
to use as the collect transformation functionparameter
- 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
targetCollection
, which contains appended elements as a result of the collect transformationpublic <V,R extends Collection<V>> R collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function, R target)
RichIterable
collectIf
in interface RichIterable<T>
predicate
- a Predicate
to use as the select criteriafunction
- a Function
to use as the collect transformation functiontarget
- the Collection to append to for all elements in this RichIterable
that meet the collect criteria predicate
targetCollection
, which contains appended elements as a result of the collect criteria and transformationRichIterable.collectIf(Predicate, Function)
public <V,R extends Collection<V>> R flatCollect(Function<? super T,? extends Iterable<V>> function, R target)
RichIterable
flatCollect
in interface RichIterable<T>
function
- The Function
to applytarget
- The collection into which results should be added.target
, which will contain a flattened collection of results produced by applying the given function
RichIterable.flatCollect(Function)
public T detect(Predicate<? super T> predicate)
RichIterable
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"); } });
detect
in interface RichIterable<T>
public <P> T detectWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterable
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");
detectWith
in interface RichIterable<T>
public Optional<T> detectOptional(Predicate<? super T> predicate)
RichIterable
Example using a Java 8 lambda expression:
Person person = people.detectOptional(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));
detectOptional
in interface RichIterable<T>
public <P> Optional<T> detectWithOptional(Predicate2<? super T,? super P> predicate, P parameter)
RichIterable
Example using a Java 8 lambda expression:
Optional<Person> person = people.detectWithOptional((person, fullName) -> person.getFullName().equals(fullName), "John Smith");
detectWithOptional
in interface RichIterable<T>
public T detectIfNone(Predicate<? super T> predicate, Function0<? extends T> function)
RichIterable
detectIfNone
in interface RichIterable<T>
public <P> T detectWithIfNone(Predicate2<? super T,? super P> predicate, P parameter, Function0<? extends T> function)
RichIterable
detectWithIfNone
in interface RichIterable<T>
public int count(Predicate<? super T> predicate)
RichIterable
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"); } });
count
in interface RichIterable<T>
public <P> int countWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterable
e.g. return lastNames.countWith(PredicatesLite.equal(), "Smith");
countWith
in interface RichIterable<T>
public boolean anySatisfy(Predicate<? super T> predicate)
RichIterable
anySatisfy
in interface RichIterable<T>
public <P> boolean anySatisfyWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterable
anySatisfyWith
in interface RichIterable<T>
public boolean allSatisfy(Predicate<? super T> predicate)
RichIterable
allSatisfy
in interface RichIterable<T>
public <P> boolean allSatisfyWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterable
allSatisfyWith
in interface RichIterable<T>
public boolean noneSatisfy(Predicate<? super T> predicate)
RichIterable
noneSatisfy
in interface RichIterable<T>
public <P> boolean noneSatisfyWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterable
noneSatisfyWith
in interface RichIterable<T>
public <IV> IV injectInto(IV injectedValue, Function2<? super IV,? super T,? extends IV> function)
RichIterable
injectInto
in interface RichIterable<T>
public int injectInto(int injectedValue, IntObjectToIntFunction<? super T> intObjectToIntFunction)
RichIterable
injectInto
in interface RichIterable<T>
public long injectInto(long injectedValue, LongObjectToLongFunction<? super T> longObjectToLongFunction)
RichIterable
injectInto
in interface RichIterable<T>
public float injectInto(float injectedValue, FloatObjectToFloatFunction<? super T> floatObjectToFloatFunction)
RichIterable
injectInto
in interface RichIterable<T>
public double injectInto(double injectedValue, DoubleObjectToDoubleFunction<? super T> doubleObjectToDoubleFunction)
RichIterable
injectInto
in interface RichIterable<T>
public <R extends Collection<T>> R into(R target)
RichIterable
into
in interface RichIterable<T>
public MutableList<T> toList()
RichIterable
toList
in interface RichIterable<T>
public MutableList<T> toSortedList()
RichIterable
toSortedList
in interface RichIterable<T>
public MutableList<T> toSortedList(Comparator<? super T> comparator)
RichIterable
toSortedList
in interface RichIterable<T>
public <V extends Comparable<? super V>> MutableList<T> toSortedListBy(Function<? super T,? extends V> function)
RichIterable
function
.toSortedListBy
in interface RichIterable<T>
public MutableSet<T> toSet()
RichIterable
toSet
in interface RichIterable<T>
public MutableSortedSet<T> toSortedSet()
RichIterable
toSortedSet
in interface RichIterable<T>
public MutableSortedSet<T> toSortedSet(Comparator<? super T> comparator)
RichIterable
toSortedSet
in interface RichIterable<T>
public MutableStack<T> toStack()
StackIterable
toStack
in interface OrderedIterable<T>
toStack
in interface StackIterable<T>
public ImmutableStack<T> toImmutable()
StackIterable
toImmutable
in interface StackIterable<T>
public <V extends Comparable<? super V>> MutableSortedSet<T> toSortedSetBy(Function<? super T,? extends V> function)
RichIterable
function
.toSortedSetBy
in interface RichIterable<T>
public MutableBag<T> toBag()
RichIterable
toBag
in interface RichIterable<T>
public MutableSortedBag<T> toSortedBag()
RichIterable
toSortedBag
in interface RichIterable<T>
public MutableSortedBag<T> toSortedBag(Comparator<? super T> comparator)
RichIterable
toSortedBag
in interface RichIterable<T>
public <V extends Comparable<? super V>> MutableSortedBag<T> toSortedBagBy(Function<? super T,? extends V> function)
RichIterable
function
.toSortedBagBy
in interface RichIterable<T>
public <NK,NV> MutableMap<NK,NV> toMap(Function<? super T,? extends NK> keyFunction, Function<? super T,? extends NV> valueFunction)
RichIterable
toMap
in interface RichIterable<T>
public <NK,NV> MutableSortedMap<NK,NV> toSortedMap(Function<? super T,? extends NK> keyFunction, Function<? super T,? extends NV> valueFunction)
RichIterable
toSortedMap
in interface RichIterable<T>
public <NK,NV> MutableSortedMap<NK,NV> toSortedMap(Comparator<? super NK> comparator, Function<? super T,? extends NK> keyFunction, Function<? super T,? extends NV> valueFunction)
RichIterable
toSortedMap
in interface RichIterable<T>
public LazyIterable<T> asLazy()
RichIterable
asLazy
in interface RichIterable<T>
public Object[] toArray()
RichIterable
toArray
in interface RichIterable<T>
Collection.toArray()
public <T> T[] toArray(T[] a)
RichIterable
toArray
in interface RichIterable<T>
Collection.toArray(Object[])
public T min(Comparator<? super T> comparator)
RichIterable
min
in interface RichIterable<T>
public T max(Comparator<? super T> comparator)
RichIterable
max
in interface RichIterable<T>
public T min()
OrderedIterable
OrderedIterable.getFirst()
.min
in interface OrderedIterable<T>
min
in interface RichIterable<T>
public T max()
OrderedIterable
OrderedIterable.getLast()
.max
in interface OrderedIterable<T>
max
in interface RichIterable<T>
public int detectIndex(Predicate<? super T> predicate)
OrderedIterable
OrderedIterable
for which the predicate
evaluates to true.
Returns -1 if no element evaluates true for the predicate
.detectIndex
in interface OrderedIterable<T>
public <V extends Comparable<? super V>> T minBy(Function<? super T,? extends V> function)
RichIterable
minBy
in interface RichIterable<T>
public <V extends Comparable<? super V>> T maxBy(Function<? super T,? extends V> function)
RichIterable
maxBy
in interface RichIterable<T>
public long sumOfInt(IntFunction<? super T> intFunction)
RichIterable
sumOfInt
in interface RichIterable<T>
public double sumOfFloat(FloatFunction<? super T> floatFunction)
RichIterable
sumOfFloat
in interface RichIterable<T>
public long sumOfLong(LongFunction<? super T> longFunction)
RichIterable
sumOfLong
in interface RichIterable<T>
public double sumOfDouble(DoubleFunction<? super T> doubleFunction)
RichIterable
sumOfDouble
in interface RichIterable<T>
public <V> MutableObjectLongMap<V> sumByInt(Function<? super T,? extends V> groupBy, IntFunction<? super T> function)
RichIterable
sumByInt
in interface RichIterable<T>
sumByInt
in interface MutableStack<T>
public <V> MutableObjectDoubleMap<V> sumByFloat(Function<? super T,? extends V> groupBy, FloatFunction<? super T> function)
RichIterable
sumByFloat
in interface RichIterable<T>
sumByFloat
in interface MutableStack<T>
public <V> MutableObjectLongMap<V> sumByLong(Function<? super T,? extends V> groupBy, LongFunction<? super T> function)
RichIterable
sumByLong
in interface RichIterable<T>
sumByLong
in interface MutableStack<T>
public <V> MutableObjectDoubleMap<V> sumByDouble(Function<? super T,? extends V> groupBy, DoubleFunction<? super T> function)
RichIterable
sumByDouble
in interface RichIterable<T>
sumByDouble
in interface MutableStack<T>
public String makeString()
RichIterable
RichIterable.makeString(String)
and defaulting
the separator parameter to the characters ", " (comma and space).makeString
in interface RichIterable<T>
public String makeString(String separator)
RichIterable
RichIterable.makeString(String, String, String)
and defaulting the start and end parameters to "" (the empty String).makeString
in interface RichIterable<T>
public String makeString(String start, String separator, String end)
RichIterable
makeString
in interface RichIterable<T>
public void appendString(Appendable appendable)
RichIterable
Appendable
. Prints the string returned
by RichIterable.makeString()
.appendString
in interface RichIterable<T>
public void appendString(Appendable appendable, String separator)
RichIterable
Appendable
. Prints the string returned
by RichIterable.makeString(String)
.appendString
in interface RichIterable<T>
public void appendString(Appendable appendable, String start, String separator, String end)
RichIterable
Appendable
. Prints the string returned
by RichIterable.makeString(String, String, String)
.appendString
in interface RichIterable<T>
public <V> MutableListMultimap<V,T> groupBy(Function<? super T,? extends V> function)
RichIterable
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(); } });
groupBy
in interface OrderedIterable<T>
groupBy
in interface RichIterable<T>
groupBy
in interface MutableStack<T>
groupBy
in interface StackIterable<T>
public <V,R extends MutableMultimap<V,T>> R groupBy(Function<? super T,? extends V> function, R target)
RichIterable
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>());
groupBy
in interface RichIterable<T>
public <V> MutableListMultimap<V,T> groupByEach(Function<? super T,? extends Iterable<V>> function)
RichIterable
RichIterable.groupBy(Function)
, except the result of evaluating function will return a collection of keys
for each value.groupByEach
in interface OrderedIterable<T>
groupByEach
in interface RichIterable<T>
groupByEach
in interface MutableStack<T>
groupByEach
in interface StackIterable<T>
public <V,R extends MutableMultimap<V,T>> R groupByEach(Function<? super T,? extends Iterable<V>> function, R target)
RichIterable
RichIterable.groupByEach(Function)
, except that the results are gathered into the specified target
multimap.groupByEach
in interface RichIterable<T>
public <V> MutableMap<V,T> groupByUniqueKey(Function<? super T,? extends V> function)
RichIterable
groupByUniqueKey
in interface RichIterable<T>
groupByUniqueKey
in interface MutableStack<T>
RichIterable.groupBy(Function)
public <V,R extends MutableMap<V,T>> R groupByUniqueKey(Function<? super T,? extends V> function, R target)
RichIterable
RichIterable.groupByUniqueKey(Function)
, except that the results are gathered into the specified target
map.groupByUniqueKey
in interface RichIterable<T>
RichIterable.groupByUniqueKey(Function)
public <S,R extends Collection<Pair<T,S>>> R zip(Iterable<S> that, R target)
OrderedIterable
OrderedIterable.zip(Iterable)
but uses target
for output.zip
in interface OrderedIterable<T>
zip
in interface RichIterable<T>
public <R extends Collection<Pair<T,Integer>>> R zipWithIndex(R target)
OrderedIterable
OrderedIterable.zipWithIndex()
but uses target
for output.zipWithIndex
in interface OrderedIterable<T>
zipWithIndex
in interface RichIterable<T>
public RichIterable<RichIterable<T>> chunk(int size)
RichIterable
chunk
in interface RichIterable<T>
size
- the number of elements per chunkRichIterable
containing RichIterable
s of size size
, except the last will be
truncated if the elements don't divide evenly.public MutableStack<T> tap(Procedure<? super T> procedure)
RichIterable
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() { public void value(Person person) { LOGGER.info(person.getName()); } });
tap
in interface OrderedIterable<T>
tap
in interface RichIterable<T>
tap
in interface MutableStack<T>
tap
in interface StackIterable<T>
RichIterable.each(Procedure)
,
InternalIterable.forEach(Procedure)
public void forEach(Procedure<? super T> procedure)
InternalIterable
Example using a Java 8 lambda:
people.forEach(Procedures.cast(person -> LOGGER.info(person.getName())));
Example using an anonymous inner class:
people.forEach(new ProcedureNOTE: This method started to conflict with() { public void value(Person person) { LOGGER.info(person.getName()); } });
Iterable.forEach(java.util.function.Consumer)
since Java 1.8. It is recommended to use RichIterable.each(Procedure)
instead to avoid casting to Procedure.forEach
in interface InternalIterable<T>
RichIterable.each(Procedure)
,
Iterable.forEach(java.util.function.Consumer)
public void each(Procedure<? super T> procedure)
RichIterable
Example using a Java 8 lambda expression:
people.each(person -> LOGGER.info(person.getName()));
Example using an anonymous inner class:
people.each(new ProcedureThis method is a variant of() { public void value(Person person) { LOGGER.info(person.getName()); } });
InternalIterable.forEach(Procedure)
that has a signature conflict with Iterable.forEach(java.util.function.Consumer)
.each
in interface RichIterable<T>
InternalIterable.forEach(Procedure)
,
Iterable.forEach(java.util.function.Consumer)
public T peek()
peek
in interface StackIterable<T>
public ListIterable<T> peek(int count)
peek
in interface StackIterable<T>
public T peekAt(int index)
peekAt
in interface StackIterable<T>
index
- the location to peek intopublic String toString()
StackIterable
AbstractCollection.toString()
except it processes the elements
in the same order as forEach()
.toString
in interface RichIterable<T>
toString
in interface StackIterable<T>
toString
in class Object
public void forEachWithIndex(ObjectIntProcedure<? super T> objectIntProcedure)
OrderedIterable
e.g. people.forEachWithIndex(new ObjectIntProcedure() { public void value(Person person, int index) { LOGGER.info("Index: " + index + " person: " + person.getName()); } });
forEachWithIndex
in interface InternalIterable<T>
forEachWithIndex
in interface OrderedIterable<T>
public void forEachWithIndex(int fromIndex, int toIndex, ObjectIntProcedure<? super T> objectIntProcedure)
OrderedIterable
e.g. OrderedIterablepeople = FastList.newListWith(ted, mary, bob, sally) people.forEachWithIndex(0, 1, new ObjectIntProcedure () { public void value(Person person, int index) { LOGGER.info(person.getName()); } });
This code would output ted and mary's names.
forEachWithIndex
in interface OrderedIterable<T>
public <V> MutableStack<V> collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function)
collectWithIndex
in interface MutableStack<T>
collectWithIndex
in interface StackIterable<T>
public <P> void forEachWith(Procedure2<? super T,? super P> procedure, P parameter)
InternalIterable
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() { public void value(Person person, Person other) { if (person.isRelatedTo(other)) { LOGGER.info(person.getName()); } } }, fred);
forEachWith
in interface InternalIterable<T>
public MutableStack<T> asUnmodifiable()
asUnmodifiable
in interface MutableStack<T>
public MutableStack<T> asSynchronized()
asSynchronized
in interface MutableStack<T>
public boolean equals(Object obj)
StackIterable
List.equals(Object)
, but for Stacks.equals
in interface StackIterable<T>
equals
in class Object
public int hashCode()
StackIterable
List.hashCode()
, but for Stacks.hashCode
in interface StackIterable<T>
hashCode
in class Object
public <K,V> MutableMap<K,V> aggregateInPlaceBy(Function<? super T,? extends K> groupBy, Function0<? extends V> zeroValueFactory, Procedure2<? super V,? super T> mutatingAggregator)
RichIterable
aggregateInPlaceBy
in interface RichIterable<T>
aggregateInPlaceBy
in interface MutableStack<T>
public <K,V> MutableMap<K,V> aggregateBy(Function<? super T,? extends K> groupBy, Function0<? extends V> zeroValueFactory, Function2<? super V,? super T,? extends V> nonMutatingAggregator)
RichIterable
aggregateBy
in interface RichIterable<T>
aggregateBy
in interface MutableStack<T>
public int indexOf(Object object)
OrderedIterable
indexOf
in interface OrderedIterable<T>
List.indexOf(Object)
public <S> boolean corresponds(OrderedIterable<S> other, Predicate2<? super T,? super S> predicate)
OrderedIterable
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.corresponds
in interface OrderedIterable<T>
public void forEach(int startIndex, int endIndex, Procedure<? super T> procedure)
OrderedIterable
e.g. OrderedIterablepeople = FastList.newListWith(ted, mary, bob, sally) people.forEach(0, 1, new Procedure () { public void value(Person person) { LOGGER.info(person.getName()); } });
This code would output ted and mary's names.
forEach
in interface OrderedIterable<T>
public MutableStack<T> takeWhile(Predicate<? super T> predicate)
OrderedIterable
takeWhile
in interface OrderedIterable<T>
takeWhile
in interface MutableStack<T>
takeWhile
in interface StackIterable<T>
public MutableStack<T> dropWhile(Predicate<? super T> predicate)
OrderedIterable
dropWhile
in interface OrderedIterable<T>
dropWhile
in interface MutableStack<T>
dropWhile
in interface StackIterable<T>
public PartitionMutableStack<T> partitionWhile(Predicate<? super T> predicate)
OrderedIterable
partitionWhile
in interface OrderedIterable<T>
partitionWhile
in interface MutableStack<T>
partitionWhile
in interface StackIterable<T>
public MutableStack<T> distinct()
OrderedIterable
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.
distinct
in interface OrderedIterable<T>
distinct
in interface MutableStack<T>
distinct
in interface StackIterable<T>
OrderedIterable
of distinct elementsCopyright © 2004–2016. All rights reserved.