Class ImmutableEmptyStack<T>
- java.lang.Object
-
- org.eclipse.collections.impl.AbstractRichIterable<T>
-
- org.eclipse.collections.impl.stack.immutable.ImmutableEmptyStack<T>
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Iterable<T>
,InternalIterable<T>
,OrderedIterable<T>
,RichIterable<T>
,ImmutableStack<T>
,StackIterable<T>
final class ImmutableEmptyStack<T> extends AbstractRichIterable<T> implements ImmutableStack<T>, java.io.Serializable
-
-
Field Summary
Fields Modifier and Type Field Description private static PartitionImmutableList<?>
EMPTY
(package private) static ImmutableStack<?>
INSTANCE
private static long
serialVersionUID
-
Constructor Summary
Constructors Constructor Description ImmutableEmptyStack()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <K,V>
ImmutableMap<K,V>aggregateBy(Function<? super T,? extends K> groupBy, Function0<? extends V> zeroValueFactory, Function2<? super V,? super T,? extends V> nonMutatingAggregator)
Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function.<K,V>
ImmutableMap<K,V>aggregateInPlaceBy(Function<? super T,? extends K> groupBy, Function0<? extends V> zeroValueFactory, Procedure2<? super V,? super T> mutatingAggregator)
Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function.private void
checkNegativeCount(int count)
private boolean
checkZeroCount(int count)
RichIterable<RichIterable<T>>
chunk(int size)
Partitions elements in fixed size chunks.<V> ImmutableStack<V>
collect(Function<? super T,? extends V> function)
Returns a new collection with the results of applying the specified function on each element of the source collection.<V,R extends java.util.Collection<V>>
Rcollect(Function<? super T,? extends V> function, R target)
Same asRichIterable.collect(Function)
, except that the results are gathered into the specifiedtarget
collection.ImmutableBooleanStack
collectBoolean(BooleanFunction<? super T> booleanFunction)
Returns a new primitiveboolean
iterable with the results of applying the specified function on each element of the source collection.<R extends MutableBooleanCollection>
RcollectBoolean(BooleanFunction<? super T> booleanFunction, R target)
Same asRichIterable.collectBoolean(BooleanFunction)
, except that the results are gathered into the specifiedtarget
collection.ImmutableByteStack
collectByte(ByteFunction<? super T> byteFunction)
Returns a new primitivebyte
iterable with the results of applying the specified function on each element of the source collection.<R extends MutableByteCollection>
RcollectByte(ByteFunction<? super T> byteFunction, R target)
Same asRichIterable.collectByte(ByteFunction)
, except that the results are gathered into the specifiedtarget
collection.ImmutableCharStack
collectChar(CharFunction<? super T> charFunction)
Returns a new primitivechar
iterable with the results of applying the specified function on each element of the source collection.<R extends MutableCharCollection>
RcollectChar(CharFunction<? super T> charFunction, R target)
Same asRichIterable.collectChar(CharFunction)
, except that the results are gathered into the specifiedtarget
collection.ImmutableDoubleStack
collectDouble(DoubleFunction<? super T> doubleFunction)
Returns a new primitivedouble
iterable with the results of applying the specified function on each element of the source collection.<R extends MutableDoubleCollection>
RcollectDouble(DoubleFunction<? super T> doubleFunction, R target)
Same asRichIterable.collectDouble(DoubleFunction)
, except that the results are gathered into the specifiedtarget
collection.ImmutableFloatStack
collectFloat(FloatFunction<? super T> floatFunction)
Returns a new primitivefloat
iterable with the results of applying the specified function on each element of the source collection.<R extends MutableFloatCollection>
RcollectFloat(FloatFunction<? super T> floatFunction, R target)
Same asRichIterable.collectFloat(FloatFunction)
, except that the results are gathered into the specifiedtarget
collection.<V> ImmutableStack<V>
collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function)
Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate.<V,R extends java.util.Collection<V>>
RcollectIf(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.ImmutableIntStack
collectInt(IntFunction<? super T> intFunction)
Returns a new primitiveint
iterable with the results of applying the specified function on each element of the source collection.<R extends MutableIntCollection>
RcollectInt(IntFunction<? super T> intFunction, R target)
Same asRichIterable.collectInt(IntFunction)
, except that the results are gathered into the specifiedtarget
collection.ImmutableLongStack
collectLong(LongFunction<? super T> longFunction)
Returns a new primitivelong
iterable with the results of applying the specified function on each element of the source collection.<R extends MutableLongCollection>
RcollectLong(LongFunction<? super T> longFunction, R target)
Same asRichIterable.collectLong(LongFunction)
, except that the results are gathered into the specifiedtarget
collection.ImmutableShortStack
collectShort(ShortFunction<? super T> shortFunction)
Returns a new primitiveshort
iterable with the results of applying the specified function on each element of the source collection.<R extends MutableShortCollection>
RcollectShort(ShortFunction<? super T> shortFunction, R target)
Same asRichIterable.collectShort(ShortFunction)
, except that the results are gathered into the specifiedtarget
collection.<P,V>
ImmutableStack<V>collectWith(Function2<? super T,? super P,? extends V> function, P parameter)
Same asRichIterable.collect(Function)
with aFunction2
and specified parameter which is passed to the block.<P,V,R extends java.util.Collection<V>>
RcollectWith(Function2<? super T,? super P,? extends V> function, P parameter, R target)
Same as collectWith but with a targetCollection parameter to gather the results.<S> boolean
corresponds(OrderedIterable<S> other, Predicate2<? super T,? super S> predicate)
Returns true if both OrderedIterables have the same length andpredicate
returns true for all corresponding elements e1 of thisOrderedIterable
and e2 ofother
.int
count(Predicate<? super T> predicate)
Return the total number of elements that answer true to the specified predicate.<V> ImmutableBag<V>
countByEach(Function<? super T,? extends java.lang.Iterable<V>> function)
This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.<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 theOrderedIterable
for which thepredicate
evaluates to true.java.util.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> java.util.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.ImmutableStack<T>
distinct()
Returns a newOrderedIterable
containing the distinct elements in this iterable.ImmutableStack<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(java.lang.Object o)
Follows the same general contract asList.equals(Object)
, but for Stacks.<V> ImmutableStack<V>
flatCollect(Function<? super T,? extends java.lang.Iterable<V>> function)
flatCollect
is a special case ofRichIterable.collect(Function)
.<V,R extends java.util.Collection<V>>
RflatCollect(Function<? super T,? extends java.lang.Iterable<V>> function, R target)
Same as flatCollect, only the results are collected into the target collection.<R extends MutableBooleanCollection>
RflatCollectBoolean(Function<? super T,? extends BooleanIterable> function, R target)
Same as flatCollect, only the results are collected into the target collection.<R extends MutableByteCollection>
RflatCollectByte(Function<? super T,? extends ByteIterable> function, R target)
Same as flatCollect, only the results are collected into the target collection.<R extends MutableCharCollection>
RflatCollectChar(Function<? super T,? extends CharIterable> function, R target)
Same as flatCollect, only the results are collected into the target collection.<R extends MutableDoubleCollection>
RflatCollectDouble(Function<? super T,? extends DoubleIterable> function, R target)
Same as flatCollect, only the results are collected into the target collection.<R extends MutableFloatCollection>
RflatCollectFloat(Function<? super T,? extends FloatIterable> function, R target)
Same as flatCollect, only the results are collected into the target collection.<R extends MutableIntCollection>
RflatCollectInt(Function<? super T,? extends IntIterable> function, R target)
Same as flatCollect, only the results are collected into the target collection.<R extends MutableLongCollection>
RflatCollectLong(Function<? super T,? extends LongIterable> function, R target)
Same as flatCollect, only the results are collected into the target collection.<R extends MutableShortCollection>
RflatCollectShort(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.<V> ImmutableListMultimap<V,T>
groupBy(Function<? super T,? extends V> function)
For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.<V,R extends MutableMultimap<V,T>>
RgroupBy(Function<? super T,? extends V> function, R target)
Same asRichIterable.groupBy(Function)
, except that the results are gathered into the specifiedtarget
multimap.<V> ImmutableListMultimap<V,T>
groupByEach(Function<? super T,? extends java.lang.Iterable<V>> function)
Similar toRichIterable.groupBy(Function)
, except the result of evaluating function will return a collection of keys for each value.<V,R extends MutableMultimap<V,T>>
RgroupByEach(Function<? super T,? extends java.lang.Iterable<V>> function, R target)
Same asRichIterable.groupByEach(Function)
, except that the results are gathered into the specifiedtarget
multimap.<V> ImmutableMap<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>>
RgroupByUniqueKey(Function<? super T,? extends V> function, R target)
Same asRichIterable.groupByUniqueKey(Function)
, except that the results are gathered into the specifiedtarget
map.int
hashCode()
Follows the same general contract asList.hashCode()
, but for Stacks.boolean
hasSameElements(OrderedIterable<T> other)
int
indexOf(java.lang.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.<R extends java.util.Collection<T>>
Rinto(R target)
Adds all the elements in this iterable to the specific target Collection.boolean
isEmpty()
Returns true if this iterable has zero items.java.util.Iterator<T>
iterator()
T
max()
Returns the maximum element out of this container based on the natural order.T
max(java.util.Comparator<? super T> comparator)
Returns the maximum element out of this container based on the comparator.<V extends java.lang.Comparable<? super V>>
TmaxBy(Function<? super T,? extends V> function)
Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.T
min()
Returns the minimum element out of this container based on the natural order.T
min(java.util.Comparator<? super T> comparator)
Returns the minimum element out of this container based on the comparator.<V extends java.lang.Comparable<? super V>>
TminBy(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
notEmpty()
The English equivalent of !this.isEmpty()PartitionImmutableStack<T>
partition(Predicate<? super T> predicate)
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.PartitionImmutableStack<T>
partitionWhile(Predicate<? super T> predicate)
Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.<P> PartitionImmutableStack<T>
partitionWith(Predicate2<? super T,? super P> predicate, P parameter)
Filters a collection into a PartitionIterable based on the evaluation of the predicate.T
peek()
Returns the element at the top of the stack, without removing it from the stack.ListIterable<T>
peek(int count)
Pair<T,ImmutableStack<T>>
peekAndPop()
Pair<ListIterable<T>,ImmutableStack<T>>
peekAndPop(int count)
T
peekAt(int index)
Returns the element at a specific index, without removing it from the stack.ImmutableStack<T>
pop()
ImmutableStack<T>
pop(int count)
ImmutableStack<T>
push(T item)
private java.lang.Object
readResolve()
ImmutableStack<T>
reject(Predicate<? super T> predicate)
Returns all elements of the source collection that return false when evaluating of the predicate.<R extends java.util.Collection<T>>
Rreject(Predicate<? super T> predicate, R target)
Same as the reject method with one parameter but uses the specified target collection for the results.<P> ImmutableStack<T>
rejectWith(Predicate2<? super T,? super P> predicate, P parameter)
Similar toRichIterable.reject(Predicate)
, except with an evaluation parameter for the second generic argument inPredicate2
.<P,R extends java.util.Collection<T>>
RrejectWith(Predicate2<? super T,? super P> predicate, P parameter, R target)
Similar toRichIterable.reject(Predicate, Collection)
, except with an evaluation parameter for the second generic argument inPredicate2
.ImmutableStack<T>
select(Predicate<? super T> predicate)
Returns all elements of the source collection that return true when evaluating the predicate.<R extends java.util.Collection<T>>
Rselect(Predicate<? super T> predicate, R target)
Same as the select method with one parameter but uses the specified target collection for the results.<S> ImmutableStack<S>
selectInstancesOf(java.lang.Class<S> clazz)
Returns all elements of the source collection that are instances of the Classclazz
.<P> ImmutableStack<T>
selectWith(Predicate2<? super T,? super P> predicate, P parameter)
Similar toRichIterable.select(Predicate)
, except with an evaluation parameter for the second generic argument inPredicate2
.<P,R extends java.util.Collection<T>>
RselectWith(Predicate2<? super T,? super P> predicate, P parameter, R target)
Similar toRichIterable.select(Predicate, Collection)
, except with an evaluation parameter for the second generic argument inPredicate2
.int
size()
Size takes linear time on ImmutableStacks.<V> ImmutableObjectDoubleMap<V>
sumByDouble(Function<? super T,? extends V> groupBy, DoubleFunction<? super T> function)
Groups and sums the values using the two specified functions.<V> ImmutableObjectDoubleMap<V>
sumByFloat(Function<? super T,? extends V> groupBy, FloatFunction<? super T> function)
Groups and sums the values using the two specified functions.<V> ImmutableObjectLongMap<V>
sumByInt(Function<? super T,? extends V> groupBy, IntFunction<? super T> function)
Groups and sums the values using the two specified functions.<V> ImmutableObjectLongMap<V>
sumByLong(Function<? super T,? extends V> groupBy, LongFunction<? super T> function)
Groups and sums the values using the two specified functions.ImmutableStack<T>
takeWhile(Predicate<? super T> predicate)
Returns the initial elements that satisfy the Predicate.ImmutableStack<T>
tap(Procedure<? super T> procedure)
Executes the Procedure for each element in the iterable and returnsthis
.ImmutableStack<T>
toImmutable()
Converts the StackIterable to an immutable implementation.<NK,NV,R extends java.util.Map<NK,NV>>
RtoMap(Function<? super T,? extends NK> keyFunction, Function<? super T,? extends NV> valueFunction, R target)
Same asRichIterable.toMap(Function, Function)
, except that the results are gathered into the specifiedtarget
map.MutableStack<T>
toStack()
Converts the stack to a MutableStack implementation.private java.lang.Object
writeReplace()
<S> ImmutableStack<Pair<T,S>>
zip(java.lang.Iterable<S> that)
Returns aOrderedIterable
formed from thisOrderedIterable
and anotherIterable
by combining corresponding elements in pairs.<S,R extends java.util.Collection<Pair<T,S>>>
Rzip(java.lang.Iterable<S> that, R target)
Same asRichIterable.zip(Iterable)
but usestarget
for output.ImmutableStack<Pair<T,java.lang.Integer>>
zipWithIndex()
Zips thisRichIterable
with its indices.<R extends java.util.Collection<Pair<T,java.lang.Integer>>>
RzipWithIndex(R target)
Same asRichIterable.zipWithIndex()
but usestarget
for output.-
Methods inherited from class org.eclipse.collections.impl.AbstractRichIterable
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, asLazy, contains, containsAll, containsAllArguments, containsAllIterable, forEach, injectInto, injectInto, injectInto, injectInto, injectInto, noneSatisfy, noneSatisfyWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eclipse.collections.api.stack.ImmutableStack
collectWithIndex, countBy, countByWith, flatCollectWith
-
Methods inherited from interface org.eclipse.collections.api.InternalIterable
forEach
-
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, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, contains, containsAll, containsAllArguments, containsAllIterable, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, countBy, countByEach, countByWith, flatCollectWith, forEach, getAny, getOnly, groupByAndCollect, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, makeString, makeString, makeString, makeString, maxByOptional, maxOptional, maxOptional, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, reduce, reduceInPlace, reduceInPlace, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy
-
Methods inherited from interface org.eclipse.collections.api.stack.StackIterable
toString
-
-
-
-
Field Detail
-
INSTANCE
static final ImmutableStack<?> INSTANCE
-
EMPTY
private static final PartitionImmutableList<?> EMPTY
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
-
Method Detail
-
readResolve
private java.lang.Object readResolve()
-
push
public ImmutableStack<T> push(T item)
- Specified by:
push
in interfaceImmutableStack<T>
-
pop
public ImmutableStack<T> pop()
- Specified by:
pop
in interfaceImmutableStack<T>
-
pop
public ImmutableStack<T> pop(int count)
- Specified by:
pop
in interfaceImmutableStack<T>
-
peekAndPop
public Pair<T,ImmutableStack<T>> peekAndPop()
- Specified by:
peekAndPop
in interfaceImmutableStack<T>
-
peekAndPop
public Pair<ListIterable<T>,ImmutableStack<T>> peekAndPop(int count)
- Specified by:
peekAndPop
in interfaceImmutableStack<T>
-
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 interfaceStackIterable<T>
- Returns:
- the top of the stack.
-
peek
public ListIterable<T> peek(int count)
- Specified by:
peek
in interfaceStackIterable<T>
- Returns:
- a ListIterable of the number of elements specified by the count, beginning with the top of the stack.
-
checkZeroCount
private boolean checkZeroCount(int count)
-
checkNegativeCount
private void checkNegativeCount(int count)
-
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 interfaceStackIterable<T>
- Parameters:
index
- the location to peek into- Returns:
- the element at the specified index
-
getFirst
public T getFirst()
Description copied from interface:StackIterable
Should return the same value as peek().- Specified by:
getFirst
in interfaceOrderedIterable<T>
- Specified by:
getFirst
in interfaceRichIterable<T>
- Specified by:
getFirst
in interfaceStackIterable<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 interfaceOrderedIterable<T>
- Specified by:
getLast
in interfaceRichIterable<T>
- Specified by:
getLast
in interfaceStackIterable<T>
-
toStack
public MutableStack<T> toStack()
Description copied from interface:StackIterable
Converts the stack to a MutableStack implementation.- Specified by:
toStack
in interfaceOrderedIterable<T>
- Specified by:
toStack
in interfaceStackIterable<T>
-
select
public ImmutableStack<T> select(Predicate<? super T> predicate)
Description copied from interface:RichIterable
Returns all elements of the source collection that return true when evaluating the predicate. This method is also commonly called filter.Example using a Java 8 lambda expression:
RichIterable<Person> selected = people.select(person -> person.getAddress().getCity().equals("London"));
Example using an anonymous inner class:
RichIterable<Person> selected = people.select(new Predicate<Person>() { public boolean accept(Person person) { return person.getAddress().getCity().equals("London"); } });
- Specified by:
select
in interfaceImmutableStack<T>
- Specified by:
select
in interfaceOrderedIterable<T>
- Specified by:
select
in interfaceRichIterable<T>
- Specified by:
select
in interfaceStackIterable<T>
-
selectWith
public <P> ImmutableStack<T> selectWith(Predicate2<? super T,? super P> predicate, P parameter)
Description copied from interface:RichIterable
Similar toRichIterable.select(Predicate)
, except with an evaluation parameter for the second generic argument inPredicate2
.E.g. return a
Collection
of Person elements where the person has an age greater than or equal to 18 yearsExample 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 interfaceImmutableStack<T>
- Specified by:
selectWith
in interfaceOrderedIterable<T>
- Specified by:
selectWith
in interfaceRichIterable<T>
- Specified by:
selectWith
in interfaceStackIterable<T>
- Parameters:
predicate
- aPredicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argumentP
inpredicate
- See Also:
RichIterable.select(Predicate)
-
select
public <R extends java.util.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 interfaceRichIterable<T>
- Overrides:
select
in classAbstractRichIterable<T>
- Parameters:
predicate
- aPredicate
to use as the select criteriatarget
- the Collection to append to for all elements in thisRichIterable
that meet select criteriapredicate
- Returns:
target
, which contains appended elements as a result of the select criteria- See Also:
RichIterable.select(Predicate)
-
selectWith
public <P,R extends java.util.Collection<T>> R selectWith(Predicate2<? super T,? super P> predicate, P parameter, R target)
Description copied from interface:RichIterable
Similar toRichIterable.select(Predicate, Collection)
, except with an evaluation parameter for the second generic argument inPredicate2
.E.g. return a
Collection
of Person elements where the person has an age greater than or equal to 18 yearsExample 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 interfaceRichIterable<T>
- Overrides:
selectWith
in classAbstractRichIterable<T>
- Parameters:
predicate
- aPredicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argumentP
inpredicate
target
- the Collection to append to for all elements in thisRichIterable
that meet select criteriapredicate
- Returns:
targetCollection
, which contains appended elements as a result of the select criteria- See Also:
RichIterable.select(Predicate)
,RichIterable.select(Predicate, Collection)
-
reject
public ImmutableStack<T> reject(Predicate<? super T> predicate)
Description copied from interface:RichIterable
Returns all elements of the source collection that return false when evaluating of the predicate. This method is also sometimes called filterNot and is the equivalent of calling iterable.select(Predicates.not(predicate)).Example using a Java 8 lambda expression:
RichIterable<Person> rejected = people.reject(person -> person.person.getLastName().equals("Smith"));
Example using an anonymous inner class:
RichIterable<Person> rejected = people.reject(new Predicate<Person>() { public boolean accept(Person person) { return person.person.getLastName().equals("Smith"); } });
- Specified by:
reject
in interfaceImmutableStack<T>
- Specified by:
reject
in interfaceOrderedIterable<T>
- Specified by:
reject
in interfaceRichIterable<T>
- Specified by:
reject
in interfaceStackIterable<T>
- Parameters:
predicate
- aPredicate
to use as the reject criteria- Returns:
- a RichIterable that contains elements that cause
Predicate.accept(Object)
method to evaluate to false
-
reject
public <R extends java.util.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 interfaceRichIterable<T>
- Overrides:
reject
in classAbstractRichIterable<T>
- Parameters:
predicate
- aPredicate
to use as the reject criteriatarget
- the Collection to append to for all elements in thisRichIterable
that causePredicate#accept(Object)
method to evaluate to false- Returns:
target
, which contains appended elements as a result of the reject criteria
-
rejectWith
public <P> ImmutableStack<T> rejectWith(Predicate2<? super T,? super P> predicate, P parameter)
Description copied from interface:RichIterable
Similar toRichIterable.reject(Predicate)
, except with an evaluation parameter for the second generic argument inPredicate2
.E.g. return a
Collection
of Person elements where the person has an age greater than or equal to 18 yearsExample 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 interfaceImmutableStack<T>
- Specified by:
rejectWith
in interfaceOrderedIterable<T>
- Specified by:
rejectWith
in interfaceRichIterable<T>
- Specified by:
rejectWith
in interfaceStackIterable<T>
- Parameters:
predicate
- aPredicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argumentP
inpredicate
- See Also:
RichIterable.select(Predicate)
-
rejectWith
public <P,R extends java.util.Collection<T>> R rejectWith(Predicate2<? super T,? super P> predicate, P parameter, R target)
Description copied from interface:RichIterable
Similar toRichIterable.reject(Predicate, Collection)
, except with an evaluation parameter for the second generic argument inPredicate2
.E.g. return a
Collection
of Person elements where the person has an age greater than or equal to 18 yearsExample 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 interfaceRichIterable<T>
- Overrides:
rejectWith
in classAbstractRichIterable<T>
- Parameters:
predicate
- aPredicate2
to use as the reject criteriaparameter
- a parameter to pass in for evaluation of the second argumentP
inpredicate
target
- the Collection to append to for all elements in thisRichIterable
that causePredicate#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)
-
partition
public PartitionImmutableStack<T> partition(Predicate<? super T> predicate)
Description copied from interface:RichIterable
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.Example using a Java 8 lambda expression:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partition(person -> person.getAddress().getState().getName().equals("New York"));
Example using an anonymous inner class:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partition(new Predicate<Person>() { public boolean accept(Person person) { return person.getAddress().getState().getName().equals("New York"); } });
- Specified by:
partition
in interfaceImmutableStack<T>
- Specified by:
partition
in interfaceOrderedIterable<T>
- Specified by:
partition
in interfaceRichIterable<T>
- Specified by:
partition
in interfaceStackIterable<T>
-
partitionWith
public <P> PartitionImmutableStack<T> partitionWith(Predicate2<? super T,? super P> predicate, P parameter)
Description copied from interface:RichIterable
Filters a collection into a PartitionIterable based on the evaluation of the predicate.Example using a Java 8 lambda expression:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
Example using an anonymous inner class:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partitionWith(new Predicate2<Person, String>() { public boolean accept(Person person, String state) { return person.getAddress().getState().getName().equals(state); } }, "New York");
- Specified by:
partitionWith
in interfaceImmutableStack<T>
- Specified by:
partitionWith
in interfaceOrderedIterable<T>
- Specified by:
partitionWith
in interfaceRichIterable<T>
- Specified by:
partitionWith
in interfaceStackIterable<T>
-
selectInstancesOf
public <S> ImmutableStack<S> selectInstancesOf(java.lang.Class<S> clazz)
Description copied from interface:RichIterable
Returns all elements of the source collection that are instances of the Classclazz
.RichIterable<Integer> integers = List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
- Specified by:
selectInstancesOf
in interfaceImmutableStack<T>
- Specified by:
selectInstancesOf
in interfaceOrderedIterable<T>
- Specified by:
selectInstancesOf
in interfaceRichIterable<T>
- Specified by:
selectInstancesOf
in interfaceStackIterable<T>
-
collect
public <V> ImmutableStack<V> collect(Function<? super T,? extends V> function)
Description copied from interface:RichIterable
Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
RichIterable<String> names = people.collect(person -> person.getFirstName() + " " + person.getLastName());
Example using an anonymous inner class:
RichIterable<String> names = people.collect(new Function<Person, String>() { public String valueOf(Person person) { return person.getFirstName() + " " + person.getLastName(); } });
- Specified by:
collect
in interfaceImmutableStack<T>
- Specified by:
collect
in interfaceOrderedIterable<T>
- Specified by:
collect
in interfaceRichIterable<T>
- Specified by:
collect
in interfaceStackIterable<T>
-
collectBoolean
public ImmutableBooleanStack collectBoolean(BooleanFunction<? super T> booleanFunction)
Description copied from interface:RichIterable
Returns a new primitiveboolean
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 interfaceImmutableStack<T>
- Specified by:
collectBoolean
in interfaceOrderedIterable<T>
- Specified by:
collectBoolean
in interfaceRichIterable<T>
- Specified by:
collectBoolean
in interfaceStackIterable<T>
-
collectBoolean
public <R extends MutableBooleanCollection> R collectBoolean(BooleanFunction<? super T> booleanFunction, R target)
Description copied from interface:RichIterable
Same asRichIterable.collectBoolean(BooleanFunction)
, except that the results are gathered into the specifiedtarget
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 interfaceRichIterable<T>
- Parameters:
booleanFunction
- aBooleanFunction
to use as the collect transformation functiontarget
- the MutableBooleanCollection to append to for all elements in thisRichIterable
- 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 interfaceRichIterable<T>
- Parameters:
function
- TheFunction
to applytarget
- The collection into which results should be added.- Returns:
target
, which will contain a flattened collection of results produced by applying the givenfunction
- See Also:
RichIterable.flatCollect(Function)
-
collectByte
public ImmutableByteStack collectByte(ByteFunction<? super T> byteFunction)
Description copied from interface:RichIterable
Returns a new primitivebyte
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 interfaceImmutableStack<T>
- Specified by:
collectByte
in interfaceOrderedIterable<T>
- Specified by:
collectByte
in interfaceRichIterable<T>
- Specified by:
collectByte
in interfaceStackIterable<T>
-
collectByte
public <R extends MutableByteCollection> R collectByte(ByteFunction<? super T> byteFunction, R target)
Description copied from interface:RichIterable
Same asRichIterable.collectByte(ByteFunction)
, except that the results are gathered into the specifiedtarget
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 interfaceRichIterable<T>
- Parameters:
byteFunction
- aByteFunction
to use as the collect transformation functiontarget
- the MutableByteCollection to append to for all elements in thisRichIterable
- 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 interfaceRichIterable<T>
- Parameters:
function
- TheFunction
to applytarget
- The collection into which results should be added.- Returns:
target
, which will contain a flattened collection of results produced by applying the givenfunction
- See Also:
RichIterable.flatCollect(Function)
-
collectChar
public ImmutableCharStack collectChar(CharFunction<? super T> charFunction)
Description copied from interface:RichIterable
Returns a new primitivechar
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 interfaceImmutableStack<T>
- Specified by:
collectChar
in interfaceOrderedIterable<T>
- Specified by:
collectChar
in interfaceRichIterable<T>
- Specified by:
collectChar
in interfaceStackIterable<T>
-
collectChar
public <R extends MutableCharCollection> R collectChar(CharFunction<? super T> charFunction, R target)
Description copied from interface:RichIterable
Same asRichIterable.collectChar(CharFunction)
, except that the results are gathered into the specifiedtarget
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 interfaceRichIterable<T>
- Parameters:
charFunction
- aCharFunction
to use as the collect transformation functiontarget
- the MutableCharCollection to append to for all elements in thisRichIterable
- 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 interfaceRichIterable<T>
- Parameters:
function
- TheFunction
to applytarget
- The collection into which results should be added.- Returns:
target
, which will contain a flattened collection of results produced by applying the givenfunction
- See Also:
RichIterable.flatCollect(Function)
-
collectDouble
public ImmutableDoubleStack collectDouble(DoubleFunction<? super T> doubleFunction)
Description copied from interface:RichIterable
Returns a new primitivedouble
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 interfaceImmutableStack<T>
- Specified by:
collectDouble
in interfaceOrderedIterable<T>
- Specified by:
collectDouble
in interfaceRichIterable<T>
- Specified by:
collectDouble
in interfaceStackIterable<T>
-
collectDouble
public <R extends MutableDoubleCollection> R collectDouble(DoubleFunction<? super T> doubleFunction, R target)
Description copied from interface:RichIterable
Same asRichIterable.collectDouble(DoubleFunction)
, except that the results are gathered into the specifiedtarget
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 interfaceRichIterable<T>
- Parameters:
doubleFunction
- aDoubleFunction
to use as the collect transformation functiontarget
- the MutableDoubleCollection to append to for all elements in thisRichIterable
- 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 interfaceRichIterable<T>
- Parameters:
function
- TheFunction
to applytarget
- The collection into which results should be added.- Returns:
target
, which will contain a flattened collection of results produced by applying the givenfunction
- See Also:
RichIterable.flatCollect(Function)
-
collectFloat
public ImmutableFloatStack collectFloat(FloatFunction<? super T> floatFunction)
Description copied from interface:RichIterable
Returns a new primitivefloat
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 interfaceImmutableStack<T>
- Specified by:
collectFloat
in interfaceOrderedIterable<T>
- Specified by:
collectFloat
in interfaceRichIterable<T>
- Specified by:
collectFloat
in interfaceStackIterable<T>
-
collectFloat
public <R extends MutableFloatCollection> R collectFloat(FloatFunction<? super T> floatFunction, R target)
Description copied from interface:RichIterable
Same asRichIterable.collectFloat(FloatFunction)
, except that the results are gathered into the specifiedtarget
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 interfaceRichIterable<T>
- Parameters:
floatFunction
- aFloatFunction
to use as the collect transformation functiontarget
- the MutableFloatCollection to append to for all elements in thisRichIterable
- 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 interfaceRichIterable<T>
- Parameters:
function
- TheFunction
to applytarget
- The collection into which results should be added.- Returns:
target
, which will contain a flattened collection of results produced by applying the givenfunction
- See Also:
RichIterable.flatCollect(Function)
-
collectInt
public ImmutableIntStack collectInt(IntFunction<? super T> intFunction)
Description copied from interface:RichIterable
Returns a new primitiveint
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 interfaceImmutableStack<T>
- Specified by:
collectInt
in interfaceOrderedIterable<T>
- Specified by:
collectInt
in interfaceRichIterable<T>
- Specified by:
collectInt
in interfaceStackIterable<T>
-
collectInt
public <R extends MutableIntCollection> R collectInt(IntFunction<? super T> intFunction, R target)
Description copied from interface:RichIterable
Same asRichIterable.collectInt(IntFunction)
, except that the results are gathered into the specifiedtarget
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 interfaceRichIterable<T>
- Parameters:
intFunction
- aIntFunction
to use as the collect transformation functiontarget
- the MutableIntCollection to append to for all elements in thisRichIterable
- 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 interfaceRichIterable<T>
- Parameters:
function
- TheFunction
to applytarget
- The collection into which results should be added.- Returns:
target
, which will contain a flattened collection of results produced by applying the givenfunction
- See Also:
RichIterable.flatCollect(Function)
-
collectLong
public ImmutableLongStack collectLong(LongFunction<? super T> longFunction)
Description copied from interface:RichIterable
Returns a new primitivelong
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 interfaceImmutableStack<T>
- Specified by:
collectLong
in interfaceOrderedIterable<T>
- Specified by:
collectLong
in interfaceRichIterable<T>
- Specified by:
collectLong
in interfaceStackIterable<T>
-
collectLong
public <R extends MutableLongCollection> R collectLong(LongFunction<? super T> longFunction, R target)
Description copied from interface:RichIterable
Same asRichIterable.collectLong(LongFunction)
, except that the results are gathered into the specifiedtarget
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 interfaceRichIterable<T>
- Parameters:
longFunction
- aLongFunction
to use as the collect transformation functiontarget
- the MutableLongCollection to append to for all elements in thisRichIterable
- 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 interfaceRichIterable<T>
- Parameters:
function
- TheFunction
to applytarget
- The collection into which results should be added.- Returns:
target
, which will contain a flattened collection of results produced by applying the givenfunction
- See Also:
RichIterable.flatCollect(Function)
-
collectShort
public ImmutableShortStack collectShort(ShortFunction<? super T> shortFunction)
Description copied from interface:RichIterable
Returns a new primitiveshort
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 interfaceImmutableStack<T>
- Specified by:
collectShort
in interfaceOrderedIterable<T>
- Specified by:
collectShort
in interfaceRichIterable<T>
- Specified by:
collectShort
in interfaceStackIterable<T>
-
collectShort
public <R extends MutableShortCollection> R collectShort(ShortFunction<? super T> shortFunction, R target)
Description copied from interface:RichIterable
Same asRichIterable.collectShort(ShortFunction)
, except that the results are gathered into the specifiedtarget
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 interfaceRichIterable<T>
- Parameters:
shortFunction
- aShortFunction
to use as the collect transformation functiontarget
- the MutableShortCollection to append to for all elements in thisRichIterable
- 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 interfaceRichIterable<T>
- Parameters:
function
- TheFunction
to applytarget
- The collection into which results should be added.- Returns:
target
, which will contain a flattened collection of results produced by applying the givenfunction
- See Also:
RichIterable.flatCollect(Function)
-
collect
public <V,R extends java.util.Collection<V>> R collect(Function<? super T,? extends V> function, R target)
Description copied from interface:RichIterable
Same asRichIterable.collect(Function)
, except that the results are gathered into the specifiedtarget
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 interfaceRichIterable<T>
- Overrides:
collect
in classAbstractRichIterable<T>
- Parameters:
function
- aFunction
to use as the collect transformation functiontarget
- the Collection to append to for all elements in thisRichIterable
that meet select criteriafunction
- Returns:
target
, which contains appended elements as a result of the collect transformation- See Also:
RichIterable.collect(Function)
-
collectWith
public <P,V> ImmutableStack<V> collectWith(Function2<? super T,? super P,? extends V> function, P parameter)
Description copied from interface:RichIterable
Same asRichIterable.collect(Function)
with aFunction2
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 interfaceImmutableStack<T>
- Specified by:
collectWith
in interfaceOrderedIterable<T>
- Specified by:
collectWith
in interfaceRichIterable<T>
- Specified by:
collectWith
in interfaceStackIterable<T>
- Parameters:
function
- AFunction2
to use as the collect transformation functionparameter
- A parameter to pass in for evaluation of the second argumentP
infunction
- Returns:
- A new
RichIterable
that contains the transformed elements returned byFunction2.value(Object, Object)
- See Also:
RichIterable.collect(Function)
-
collectWith
public <P,V,R extends java.util.Collection<V>> R collectWith(Function2<? super T,? super P,? extends V> function, P parameter, R target)
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 interfaceRichIterable<T>
- Overrides:
collectWith
in classAbstractRichIterable<T>
- Parameters:
function
- aFunction2
to use as the collect transformation functionparameter
- a parameter to pass in for evaluation of the second argumentP
infunction
target
- the Collection to append to for all elements in thisRichIterable
that meet select criteriafunction
- Returns:
targetCollection
, which contains appended elements as a result of the collect transformation
-
collectIf
public <V> ImmutableStack<V> collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function)
Description copied from interface:RichIterable
Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate. This is the 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 interfaceImmutableStack<T>
- Specified by:
collectIf
in interfaceOrderedIterable<T>
- Specified by:
collectIf
in interfaceRichIterable<T>
- Specified by:
collectIf
in interfaceStackIterable<T>
-
collectIf
public <V,R extends java.util.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 interfaceRichIterable<T>
- Overrides:
collectIf
in classAbstractRichIterable<T>
- Parameters:
predicate
- aPredicate
to use as the select criteriafunction
- aFunction
to use as the collect transformation functiontarget
- the Collection to append to for all elements in thisRichIterable
that meet the collect criteriapredicate
- Returns:
targetCollection
, which contains appended elements as a result of the collect criteria and transformation- See Also:
RichIterable.collectIf(Predicate, Function)
-
flatCollect
public <V> ImmutableStack<V> flatCollect(Function<? super T,? extends java.lang.Iterable<V>> function)
Description copied from interface:RichIterable
flatCollect
is a special case ofRichIterable.collect(Function)
. Withcollect
, when theFunction
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 eachPerson
has a list ofAddress
objects. Take the followingFunction
:Function<Person, List<Address>> addressFunction = Person::getAddresses; RichIterable<Person> people = ...;
Usingcollect
returns a collection of collections of addresses.RichIterable<List<Address>> addresses = people.collect(addressFunction);
UsingflatCollect
returns a single flattened list of addresses.RichIterable<Address> addresses = people.flatCollect(addressFunction);
- Specified by:
flatCollect
in interfaceImmutableStack<T>
- Specified by:
flatCollect
in interfaceOrderedIterable<T>
- Specified by:
flatCollect
in interfaceRichIterable<T>
- Specified by:
flatCollect
in interfaceStackIterable<T>
- Parameters:
function
- TheFunction
to apply- Returns:
- a new flattened collection produced by applying the given
function
-
flatCollect
public <V,R extends java.util.Collection<V>> R flatCollect(Function<? super T,? extends java.lang.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 interfaceRichIterable<T>
- Overrides:
flatCollect
in classAbstractRichIterable<T>
- Parameters:
function
- TheFunction
to applytarget
- The collection into which results should be added.- Returns:
target
, which will contain a flattened collection of results produced by applying the givenfunction
- 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 interfaceRichIterable<T>
- Overrides:
detect
in classAbstractRichIterable<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 interfaceRichIterable<T>
- Overrides:
detectWith
in classAbstractRichIterable<T>
-
detectOptional
public java.util.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 interfaceRichIterable<T>
- Overrides:
detectOptional
in classAbstractRichIterable<T>
-
detectWithOptional
public <P> java.util.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 interfaceRichIterable<T>
- Overrides:
detectWithOptional
in classAbstractRichIterable<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 interfaceRichIterable<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 interfaceRichIterable<T>
- Overrides:
detectWithIfNone
in classAbstractRichIterable<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 interfaceRichIterable<T>
- Overrides:
count
in classAbstractRichIterable<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 interfaceRichIterable<T>
- Overrides:
countWith
in classAbstractRichIterable<T>
-
into
public <R extends java.util.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 interfaceRichIterable<T>
- Overrides:
into
in classAbstractRichIterable<T>
-
toMap
public <NK,NV,R extends java.util.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 asRichIterable.toMap(Function, Function)
, except that the results are gathered into the specifiedtarget
map.- Specified by:
toMap
in interfaceRichIterable<T>
-
min
public T min(java.util.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 interfaceRichIterable<T>
- Overrides:
min
in classAbstractRichIterable<T>
-
max
public T max(java.util.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 interfaceRichIterable<T>
- Overrides:
max
in classAbstractRichIterable<T>
-
min
public T min()
Description copied from interface:RichIterable
Returns the minimum element out of this container based on the natural order.- Specified by:
min
in interfaceOrderedIterable<T>
- Specified by:
min
in interfaceRichIterable<T>
- Overrides:
min
in classAbstractRichIterable<T>
-
max
public T max()
Description copied from interface:RichIterable
Returns the maximum element out of this container based on the natural order.- Specified by:
max
in interfaceOrderedIterable<T>
- Specified by:
max
in interfaceRichIterable<T>
- Overrides:
max
in classAbstractRichIterable<T>
-
minBy
public <V extends java.lang.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 interfaceRichIterable<T>
- Overrides:
minBy
in classAbstractRichIterable<T>
-
maxBy
public <V extends java.lang.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 interfaceRichIterable<T>
- Overrides:
maxBy
in classAbstractRichIterable<T>
-
sumByInt
public <V> ImmutableObjectLongMap<V> sumByInt(Function<? super T,? extends V> groupBy, IntFunction<? super T> function)
Description copied from interface:RichIterable
Groups and sums the values using the two specified functions.- Specified by:
sumByInt
in interfaceImmutableStack<T>
- Specified by:
sumByInt
in interfaceRichIterable<T>
-
sumByFloat
public <V> ImmutableObjectDoubleMap<V> sumByFloat(Function<? super T,? extends V> groupBy, FloatFunction<? super T> function)
Description copied from interface:RichIterable
Groups and sums the values using the two specified functions.- Specified by:
sumByFloat
in interfaceImmutableStack<T>
- Specified by:
sumByFloat
in interfaceRichIterable<T>
-
sumByLong
public <V> ImmutableObjectLongMap<V> sumByLong(Function<? super T,? extends V> groupBy, LongFunction<? super T> function)
Description copied from interface:RichIterable
Groups and sums the values using the two specified functions.- Specified by:
sumByLong
in interfaceImmutableStack<T>
- Specified by:
sumByLong
in interfaceRichIterable<T>
-
sumByDouble
public <V> ImmutableObjectDoubleMap<V> sumByDouble(Function<? super T,? extends V> groupBy, DoubleFunction<? super T> function)
Description copied from interface:RichIterable
Groups and sums the values using the two specified functions.- Specified by:
sumByDouble
in interfaceImmutableStack<T>
- Specified by:
sumByDouble
in interfaceRichIterable<T>
-
groupBy
public <V> ImmutableListMultimap<V,T> groupBy(Function<? super T,? extends V> function)
Description copied from interface:RichIterable
For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.Example using a Java 8 method reference:
Multimap<String, Person> peopleByLastName = people.groupBy(Person::getLastName);
Example using an anonymous inner class:
Multimap<String, Person> peopleByLastName = people.groupBy(new Function<Person, String>() { public String valueOf(Person person) { return person.getLastName(); } });
- Specified by:
groupBy
in interfaceImmutableStack<T>
- Specified by:
groupBy
in interfaceOrderedIterable<T>
- Specified by:
groupBy
in interfaceRichIterable<T>
- Specified by:
groupBy
in interfaceStackIterable<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 asRichIterable.groupBy(Function)
, except that the results are gathered into the specifiedtarget
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 interfaceRichIterable<T>
- Overrides:
groupBy
in classAbstractRichIterable<T>
-
groupByEach
public <V> ImmutableListMultimap<V,T> groupByEach(Function<? super T,? extends java.lang.Iterable<V>> function)
Description copied from interface:RichIterable
Similar toRichIterable.groupBy(Function)
, except the result of evaluating function will return a collection of keys for each value.- Specified by:
groupByEach
in interfaceImmutableStack<T>
- Specified by:
groupByEach
in interfaceOrderedIterable<T>
- Specified by:
groupByEach
in interfaceRichIterable<T>
- Specified by:
groupByEach
in interfaceStackIterable<T>
-
groupByEach
public <V,R extends MutableMultimap<V,T>> R groupByEach(Function<? super T,? extends java.lang.Iterable<V>> function, R target)
Description copied from interface:RichIterable
Same asRichIterable.groupByEach(Function)
, except that the results are gathered into the specifiedtarget
multimap.- Specified by:
groupByEach
in interfaceRichIterable<T>
- Overrides:
groupByEach
in classAbstractRichIterable<T>
-
groupByUniqueKey
public <V> ImmutableMap<V,T> groupByUniqueKey(Function<? super T,? extends V> function)
Description copied from interface:RichIterable
For each element of the iterable, the function is evaluated, and 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 interfaceImmutableStack<T>
- Specified by:
groupByUniqueKey
in interfaceRichIterable<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 asRichIterable.groupByUniqueKey(Function)
, except that the results are gathered into the specifiedtarget
map.- Specified by:
groupByUniqueKey
in interfaceRichIterable<T>
- Overrides:
groupByUniqueKey
in classAbstractRichIterable<T>
- See Also:
RichIterable.groupByUniqueKey(Function)
-
zip
public <S> ImmutableStack<Pair<T,S>> zip(java.lang.Iterable<S> that)
Description copied from interface:OrderedIterable
Returns aOrderedIterable
formed from thisOrderedIterable
and anotherIterable
by combining corresponding elements in pairs. The secondIterable
should also be ordered. If one of the twoIterable
s is longer than the other, its remaining elements are ignored.- Specified by:
zip
in interfaceImmutableStack<T>
- Specified by:
zip
in interfaceOrderedIterable<T>
- Specified by:
zip
in interfaceRichIterable<T>
- Specified by:
zip
in interfaceStackIterable<T>
- Type Parameters:
S
- the type of the second half of the returned pairs- Parameters:
that
- TheIterable
providing the second half of each result pair- Returns:
- A new
OrderedIterable
containing pairs consisting of corresponding elements of thisOrderedIterable
and that. The length of the returnedOrderedIterable
is the minimum of the lengths of thisOrderedIterable
and that.
-
zip
public <S,R extends java.util.Collection<Pair<T,S>>> R zip(java.lang.Iterable<S> that, R target)
Description copied from interface:RichIterable
Same asRichIterable.zip(Iterable)
but usestarget
for output.- Specified by:
zip
in interfaceOrderedIterable<T>
- Specified by:
zip
in interfaceRichIterable<T>
- Overrides:
zip
in classAbstractRichIterable<T>
-
zipWithIndex
public ImmutableStack<Pair<T,java.lang.Integer>> zipWithIndex()
Description copied from interface:RichIterable
Zips thisRichIterable
with its indices.- Specified by:
zipWithIndex
in interfaceImmutableStack<T>
- Specified by:
zipWithIndex
in interfaceOrderedIterable<T>
- Specified by:
zipWithIndex
in interfaceRichIterable<T>
- Specified by:
zipWithIndex
in interfaceStackIterable<T>
- Returns:
- A new
RichIterable
containing pairs consisting of all elements of thisRichIterable
paired with their index. Indices start at 0. - See Also:
RichIterable.zip(Iterable)
-
zipWithIndex
public <R extends java.util.Collection<Pair<T,java.lang.Integer>>> R zipWithIndex(R target)
Description copied from interface:RichIterable
Same asRichIterable.zipWithIndex()
but usestarget
for output.- Specified by:
zipWithIndex
in interfaceOrderedIterable<T>
- Specified by:
zipWithIndex
in interfaceRichIterable<T>
- Overrides:
zipWithIndex
in classAbstractRichIterable<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 interfaceStackIterable<T>
-
chunk
public RichIterable<RichIterable<T>> chunk(int size)
Description copied from interface:RichIterable
Partitions elements in fixed size chunks.- Specified by:
chunk
in interfaceRichIterable<T>
- Parameters:
size
- the number of elements per chunk- Returns:
- A
RichIterable
containingRichIterable
s of sizesize
, except the last will be truncated if the elements don't divide evenly.
-
aggregateInPlaceBy
public <K,V> ImmutableMap<K,V> aggregateInPlaceBy(Function<? super T,? extends K> groupBy, Function0<? extends V> zeroValueFactory, Procedure2<? super V,? super T> mutatingAggregator)
Description copied from interface:RichIterable
Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function. Aggregate results are required to be mutable as they will be changed in place by the procedure. A second function specifies the initial "zero" aggregate value to work with (i.e. new AtomicInteger(0)).- Specified by:
aggregateInPlaceBy
in interfaceImmutableStack<T>
- Specified by:
aggregateInPlaceBy
in interfaceRichIterable<T>
-
aggregateBy
public <K,V> ImmutableMap<K,V> aggregateBy(Function<? super T,? extends K> groupBy, Function0<? extends V> zeroValueFactory, Function2<? super V,? super T,? extends V> nonMutatingAggregator)
Description copied from interface:RichIterable
Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function. Aggregate results are allowed to be immutable as they will be replaced in place in the map. A second function specifies the initial "zero" aggregate value to work with (i.e. Integer.valueOf(0)).- Specified by:
aggregateBy
in interfaceImmutableStack<T>
- Specified by:
aggregateBy
in interfaceRichIterable<T>
-
countByEach
public <V> ImmutableBag<V> countByEach(Function<? super T,? extends java.lang.Iterable<V>> function)
Description copied from interface:RichIterable
This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.- Specified by:
countByEach
in interfaceImmutableStack<T>
- Specified by:
countByEach
in interfaceRichIterable<T>
- Overrides:
countByEach
in classAbstractRichIterable<T>
-
size
public int size()
Description copied from interface:ImmutableStack
Size takes linear time on ImmutableStacks.- Specified by:
size
in interfaceImmutableStack<T>
- Specified by:
size
in interfaceRichIterable<T>
-
isEmpty
public boolean isEmpty()
Description copied from interface:RichIterable
Returns true if this iterable has zero items.- Specified by:
isEmpty
in interfaceRichIterable<T>
- Overrides:
isEmpty
in classAbstractRichIterable<T>
-
notEmpty
public boolean notEmpty()
Description copied from interface:RichIterable
The English equivalent of !this.isEmpty()- Specified by:
notEmpty
in interfaceRichIterable<T>
-
tap
public ImmutableStack<T> tap(Procedure<? super T> procedure)
Description copied from interface:RichIterable
Executes the Procedure for each element in the iterable and returnsthis
.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 interfaceImmutableStack<T>
- Specified by:
tap
in interfaceOrderedIterable<T>
- Specified by:
tap
in interfaceRichIterable<T>
- Specified by:
tap
in interfaceStackIterable<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 ofInternalIterable.forEach(Procedure)
that has a signature conflict withIterable.forEach(java.util.function.Consumer)
.- Specified by:
each
in interfaceRichIterable<T>
- See Also:
InternalIterable.forEach(Procedure)
,Iterable.forEach(java.util.function.Consumer)
-
forEachWithIndex
public void forEachWithIndex(ObjectIntProcedure<? super T> objectIntProcedure)
Description copied from interface:InternalIterable
Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure.Example using a Java 8 lambda:
people.forEachWithIndex((Person person, int index) -> LOGGER.info("Index: " + index + " person: " + person.getName()));
Example using an anonymous inner class:
people.forEachWithIndex(new ObjectIntProcedure<Person>() { public void value(Person person, int index) { LOGGER.info("Index: " + index + " person: " + person.getName()); } });
- Specified by:
forEachWithIndex
in interfaceInternalIterable<T>
- Specified by:
forEachWithIndex
in interfaceOrderedIterable<T>
- Overrides:
forEachWithIndex
in classAbstractRichIterable<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 interfaceInternalIterable<T>
- Overrides:
forEachWith
in classAbstractRichIterable<T>
-
takeWhile
public ImmutableStack<T> takeWhile(Predicate<? super T> predicate)
Description copied from interface:OrderedIterable
Returns the initial elements that satisfy the Predicate. Short circuits at the first element which does not satisfy the Predicate.- Specified by:
takeWhile
in interfaceImmutableStack<T>
- Specified by:
takeWhile
in interfaceOrderedIterable<T>
- Specified by:
takeWhile
in interfaceStackIterable<T>
-
dropWhile
public ImmutableStack<T> dropWhile(Predicate<? super T> predicate)
Description copied from interface:OrderedIterable
Returns the final elements that do not satisfy the Predicate. Short circuits at the first element which does satisfy the Predicate.- Specified by:
dropWhile
in interfaceImmutableStack<T>
- Specified by:
dropWhile
in interfaceOrderedIterable<T>
- Specified by:
dropWhile
in interfaceStackIterable<T>
-
partitionWhile
public PartitionImmutableStack<T> partitionWhile(Predicate<? super T> predicate)
Description copied from interface:OrderedIterable
Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements. Short circuits at the first element which does satisfy the Predicate.- Specified by:
partitionWhile
in interfaceImmutableStack<T>
- Specified by:
partitionWhile
in interfaceOrderedIterable<T>
- Specified by:
partitionWhile
in interfaceStackIterable<T>
-
distinct
public ImmutableStack<T> distinct()
Description copied from interface:OrderedIterable
Returns a newOrderedIterable
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 interfaceImmutableStack<T>
- Specified by:
distinct
in interfaceOrderedIterable<T>
- Specified by:
distinct
in interfaceStackIterable<T>
- Returns:
OrderedIterable
of distinct elements
-
indexOf
public int indexOf(java.lang.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 interfaceOrderedIterable<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 andpredicate
returns true for all corresponding elements e1 of thisOrderedIterable
and e2 ofother
. Thepredicate
is evaluated for each element at the same position of eachOrderedIterable
in a forward iteration order. This is a short circuit pattern.- Specified by:
corresponds
in interfaceOrderedIterable<T>
-
hasSameElements
public boolean hasSameElements(OrderedIterable<T> other)
-
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 interfaceOrderedIterable<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 interfaceOrderedIterable<T>
-
detectIndex
public int detectIndex(Predicate<? super T> predicate)
Description copied from interface:OrderedIterable
Returns the index of the first element of theOrderedIterable
for which thepredicate
evaluates to true. Returns -1 if no element evaluates true for thepredicate
.- Specified by:
detectIndex
in interfaceOrderedIterable<T>
-
iterator
public java.util.Iterator<T> iterator()
- Specified by:
iterator
in interfacejava.lang.Iterable<T>
-
equals
public boolean equals(java.lang.Object o)
Description copied from interface:StackIterable
Follows the same general contract asList.equals(Object)
, but for Stacks.- Specified by:
equals
in interfaceStackIterable<T>
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
Description copied from interface:StackIterable
Follows the same general contract asList.hashCode()
, but for Stacks.- Specified by:
hashCode
in interfaceStackIterable<T>
- Overrides:
hashCode
in classjava.lang.Object
-
writeReplace
private java.lang.Object writeReplace()
-
-