public class AbstractUnmodifiableMutableCollection<T> extends Object implements MutableCollection<T>
Modifier and Type | Method and Description |
---|---|
boolean |
add(T o) |
boolean |
addAll(Collection<? extends T> c) |
boolean |
addAllIterable(Iterable<? extends T> iterable) |
<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).
|
MutableCollection<T> |
asSynchronized()
Returns a synchronized (thread-safe) collection backed by this collection.
|
MutableCollection<T> |
asUnmodifiable()
Returns an unmodifiable view of this collection.
|
RichIterable<RichIterable<T>> |
chunk(int size)
Partitions elements in fixed size chunks.
|
void |
clear() |
<V> MutableCollection<V> |
collect(Function<? super T,? extends V> function)
Returns a new MutableCollection with the results of applying the specified function to 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. |
MutableBooleanCollection |
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. |
MutableByteCollection |
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. |
MutableCharCollection |
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. |
MutableDoubleCollection |
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. |
MutableFloatCollection |
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> MutableCollection<V> |
collectIf(Predicate<? super T> predicate,
Function<? super T,? extends V> function)
Returns a new MutableCollection with the results of applying the specified function to each element of the source
collection, but only for elements that evaluate to true for the specified 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.
|
MutableIntCollection |
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. |
MutableLongCollection |
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. |
MutableShortCollection |
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,A> MutableCollection<A> |
collectWith(Function2<? super T,? super P,? extends A> function,
P parameter)
Same as
RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block. |
<P,A,R extends Collection<A>> |
collectWith(Function2<? super T,? super P,? extends A> function,
P parameter,
R targetCollection)
Same as collectWith but with a targetCollection parameter to gather the results.
|
boolean |
contains(Object o)
Returns true if the iterable has an element which responds true to element.equals(object).
|
boolean |
containsAll(Collection<?> c)
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.
|
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.
|
<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.
|
void |
each(Procedure<? super T> procedure)
The procedure is executed for each element in the iterable.
|
<V> MutableCollection<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(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(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()
Returns the first element of an iterable.
|
T |
getLast()
Returns the last element of an iterable.
|
<V> MutableMultimap<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> MutableMultimap<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. |
double |
injectInto(double injectedValue,
DoubleObjectToDoubleFunction<? super T> function)
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> function)
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> function)
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> function)
Returns the final long result of evaluating function using each element of the iterable and the previous evaluation
result as the parameters.
|
<IV,P> IV |
injectIntoWith(IV injectValue,
Function3<? super IV,? super T,? super P,? extends IV> function,
P parameter) |
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.
|
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.
|
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.
|
MutableCollection<T> |
newEmpty()
Creates a new empty mutable version of the same collection type.
|
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()
|
PartitionMutableCollection<T> |
partition(Predicate<? super T> predicate)
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
|
<P> PartitionMutableCollection<T> |
partitionWith(Predicate2<? super T,? super P> predicate,
P parameter)
Filters a collection into a PartitionIterable based on the evaluation of the predicate.
|
MutableCollection<T> |
reject(Predicate<? super T> predicate)
Returns a MutableCollection with all elements that evaluate to false for the specified 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> MutableCollection<T> |
rejectWith(Predicate2<? super T,? super P> predicate,
P parameter)
Returns a MutableCollection with all elements that evaluate to false for the specified predicate2 and parameter.
|
<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 . |
boolean |
remove(Object o) |
boolean |
removeAll(Collection<?> c) |
boolean |
removeAllIterable(Iterable<?> iterable) |
boolean |
removeIf(Predicate<? super T> predicate)
Removes all elements in the collection that evaluate to true for the specified predicate.
|
<P> boolean |
removeIfWith(Predicate2<? super T,? super P> predicate,
P parameter)
Removes all elements in the collection that evaluate to true for the specified predicate2 and parameter.
|
boolean |
retainAll(Collection<?> c) |
boolean |
retainAllIterable(Iterable<?> iterable) |
MutableCollection<T> |
select(Predicate<? super T> predicate)
Returns a MutableCollection with all elements that evaluate to true for the specified 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.
|
<P> Twin<MutableList<T>> |
selectAndRejectWith(Predicate2<? super T,? super P> predicate,
P parameter)
Filters a collection into two separate collections based on a predicate returned via a Pair.
|
<S> MutableCollection<S> |
selectInstancesOf(Class<S> clazz)
Returns all elements of the source collection that are instances of the Class
clazz . |
<P> MutableCollection<T> |
selectWith(Predicate2<? super T,? super P> predicate,
P parameter)
Returns a MutableCollection with all elements that evaluate to true for the specified predicate2 and parameter.
|
<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> ObjectDoubleMap<V> |
sumByDouble(Function<T,V> groupBy,
DoubleFunction<? super T> function)
Groups and sums the values using the two specified functions.
|
<V> ObjectDoubleMap<V> |
sumByFloat(Function<T,V> groupBy,
FloatFunction<? super T> function)
Groups and sums the values using the two specified functions.
|
<V> ObjectLongMap<V> |
sumByInt(Function<T,V> groupBy,
IntFunction<? super T> function)
Groups and sums the values using the two specified functions.
|
<V> ObjectLongMap<V> |
sumByLong(Function<T,V> groupBy,
LongFunction<? super T> function)
Groups and sums the values using the two specified functions.
|
double |
sumOfDouble(DoubleFunction<? super T> function)
Returns the final double result of evaluating function for each element of the iterable and adding the results
together.
|
double |
sumOfFloat(FloatFunction<? super T> function)
Returns the final double result of evaluating function for each element of the iterable and adding the results
together.
|
long |
sumOfInt(IntFunction<? super T> function)
Returns the final long result of evaluating function for each element of the iterable and adding the results
together.
|
long |
sumOfLong(LongFunction<? super T> function)
Returns the final long result of evaluating function for each element of the iterable and adding the results
together.
|
MutableCollection<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.
|
<S> S[] |
toArray(S[] 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.
|
ImmutableCollection<T> |
toImmutable()
Converts this MutableCollection to an ImmutableCollection.
|
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 . |
String |
toString()
Returns a string representation of this RichIterable.
|
MutableCollection<T> |
with(T element)
This method allows mutable and fixed size collections the ability to add elements to their existing elements.
|
MutableCollection<T> |
withAll(Iterable<? extends T> elements)
This method allows mutable and fixed size collections the ability to add multiple elements to their existing
elements.
|
MutableCollection<T> |
without(T element)
This method allows mutable and fixed size collections the ability to remove elements from their existing elements.
|
MutableCollection<T> |
withoutAll(Iterable<? extends T> elements)
This method allows mutable and fixed size collections the ability to remove multiple elements from their existing
elements.
|
<S> MutableCollection<Pair<T,S>> |
zip(Iterable<S> that)
Returns a
RichIterable formed from this RichIterable and another RichIterable by
combining corresponding elements in pairs. |
<S,R extends Collection<Pair<T,S>>> |
zip(Iterable<S> that,
R target)
Same as
RichIterable.zip(Iterable) but uses target for output. |
MutableCollection<Pair<T,Integer>> |
zipWithIndex()
Zips this
RichIterable with its indices. |
<R extends Collection<Pair<T,Integer>>> |
zipWithIndex(R target)
Same as
RichIterable.zipWithIndex() but uses target for output. |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
equals, hashCode, parallelStream, removeIf, spliterator, stream
public int size()
RichIterable
size
in interface Collection<T>
size
in interface RichIterable<T>
public boolean isEmpty()
RichIterable
isEmpty
in interface Collection<T>
isEmpty
in interface RichIterable<T>
public boolean contains(Object o)
RichIterable
contains
in interface Collection<T>
contains
in interface RichIterable<T>
public Object[] toArray()
RichIterable
toArray
in interface Collection<T>
toArray
in interface RichIterable<T>
Collection.toArray()
public <S> S[] toArray(S[] a)
RichIterable
toArray
in interface Collection<T>
toArray
in interface RichIterable<T>
Collection.toArray(Object[])
public boolean add(T o)
add
in interface Collection<T>
public boolean remove(Object o)
remove
in interface Collection<T>
public boolean containsAll(Collection<?> c)
RichIterable
containsAll
in interface Collection<T>
containsAll
in interface RichIterable<T>
Collection.containsAll(Collection)
public boolean addAll(Collection<? extends T> c)
addAll
in interface Collection<T>
public boolean retainAll(Collection<?> c)
retainAll
in interface Collection<T>
public boolean removeAll(Collection<?> c)
removeAll
in interface Collection<T>
public void clear()
clear
in interface Collection<T>
public boolean addAllIterable(Iterable<? extends T> iterable)
addAllIterable
in interface MutableCollection<T>
Collection.addAll(Collection)
public boolean removeAllIterable(Iterable<?> iterable)
removeAllIterable
in interface MutableCollection<T>
Collection.removeAll(Collection)
public boolean retainAllIterable(Iterable<?> iterable)
retainAllIterable
in interface MutableCollection<T>
Collection.retainAll(Collection)
public MutableCollection<T> asUnmodifiable()
MutableCollection
The returned collection does not pass the hashCode and equals operations through to the backing collection, but relies on Object's equals and hashCode methods. This is necessary to preserve the contracts of these operations in the case that the backing collection is a set or a list.
The returned collection will be serializable if this collection is serializable.
asUnmodifiable
in interface MutableCollection<T>
public MutableCollection<T> asSynchronized()
MutableCollection
It is imperative that the user manually synchronize on the returned collection when iterating over it using the standard JDK iterator or JDK 5 for loop.
MutableCollection collection = myCollection.asSynchronized(); ... synchronized(collection) { Iterator i = c.iterator(); // Must be in the synchronized block while (i.hasNext()) foo(i.next()); }Failure to follow this advice may result in non-deterministic behavior.
The preferred way of iterating over a synchronized collection is to use the collection.forEach() method which is properly synchronized internally.
MutableCollection collection = myCollection.asSynchronized(); ... collection.forEach(new Procedure() { public void value(Object each) { ... } });
The returned collection does not pass the hashCode and equals operations through to the backing collection, but relies on Object's equals and hashCode methods. This is necessary to preserve the contracts of these operations in the case that the backing collection is a set or a list.
The returned collection will be serializable if this collection is serializable.
asSynchronized
in interface MutableCollection<T>
public ImmutableCollection<T> toImmutable()
MutableCollection
toImmutable
in interface MutableCollection<T>
public LazyIterable<T> asLazy()
RichIterable
asLazy
in interface RichIterable<T>
public MutableCollection<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 MutableCollection<T>
tap
in interface RichIterable<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 void forEachWithIndex(ObjectIntProcedure<? super T> objectIntProcedure)
InternalIterable
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() { public void value(Person person, int index) { LOGGER.info("Index: " + index + " person: " + person.getName()); } });
forEachWithIndex
in interface InternalIterable<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 boolean containsAllIterable(Iterable<?> source)
RichIterable
containsAllIterable
in interface RichIterable<T>
public boolean containsAllArguments(Object... elements)
RichIterable
containsAllArguments
in interface RichIterable<T>
public boolean notEmpty()
RichIterable
notEmpty
in interface RichIterable<T>
public MutableCollection<T> newEmpty()
MutableCollection
newEmpty
in interface MutableCollection<T>
public T getFirst()
RichIterable
The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the first element could be any element from the Set.
getFirst
in interface RichIterable<T>
public T getLast()
RichIterable
The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the last element could be any element from the Set.
getLast
in interface RichIterable<T>
public MutableCollection<T> select(Predicate<? super T> predicate)
MutableCollection
e.g. return people.select(new Predicate<Person>() { public boolean value(Person person) { return person.getAddress().getCity().equals("Metuchen"); } });
select
in interface MutableCollection<T>
select
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> MutableCollection<T> selectWith(Predicate2<? super T,? super P> predicate, P parameter)
MutableCollection
e.g. return integers.selectWith(PredicatesLite.equal(), Integer.valueOf(5));
selectWith
in interface MutableCollection<T>
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
RichIterable.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 MutableCollection<T> reject(Predicate<? super T> predicate)
MutableCollection
e.g. return people.reject(new Predicate<Person>() { public boolean value(Person person) { return person.person.getLastName().equals("Smith"); } });
e.g. return people.reject(Predicates.attributeEqual("lastName", "Smith"));
reject
in interface MutableCollection<T>
reject
in interface RichIterable<T>
predicate
- a Predicate
to use as the reject criteriaPredicate.accept(Object)
method to evaluate to falsepublic <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> MutableCollection<T> rejectWith(Predicate2<? super T,? super P> predicate, P parameter)
MutableCollection
e.g. return integers.rejectWith(PredicatesLite.equal(), Integer.valueOf(5));
rejectWith
in interface MutableCollection<T>
rejectWith
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
RichIterable.select(Predicate)
public <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 <P> Twin<MutableList<T>> selectAndRejectWith(Predicate2<? super T,? super P> predicate, P parameter)
MutableCollection
e.g. return lastNames.selectAndRejectWith(PredicatesLite.lessThan(), "Mason");
selectAndRejectWith
in interface MutableCollection<T>
public PartitionMutableCollection<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 MutableCollection<T>
partition
in interface RichIterable<T>
public <P> PartitionMutableCollection<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 MutableCollection<T>
partitionWith
in interface RichIterable<T>
public <S> MutableCollection<S> selectInstancesOf(Class<S> clazz)
RichIterable
clazz
.selectInstancesOf
in interface MutableCollection<T>
selectInstancesOf
in interface RichIterable<T>
public boolean removeIf(Predicate<? super T> predicate)
MutableCollection
e.g. return lastNames.removeIf(Predicates.isNull());
removeIf
in interface MutableCollection<T>
public <P> boolean removeIfWith(Predicate2<? super T,? super P> predicate, P parameter)
MutableCollection
e.g. return lastNames.removeIfWith(PredicatesLite.isNull(), null);
removeIfWith
in interface MutableCollection<T>
public <V> MutableCollection<V> collect(Function<? super T,? extends V> function)
MutableCollection
e.g. return people.collect(new Function<Person, String>() { public String value(Person person) { return person.getFirstName() + " " + person.getLastName(); } });
collect
in interface MutableCollection<T>
collect
in interface RichIterable<T>
public MutableBooleanCollection 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 MutableCollection<T>
collectBoolean
in interface RichIterable<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 MutableByteCollection 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 MutableCollection<T>
collectByte
in interface RichIterable<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 MutableCharCollection 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 MutableCollection<T>
collectChar
in interface RichIterable<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 MutableDoubleCollection 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 MutableCollection<T>
collectDouble
in interface RichIterable<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 MutableFloatCollection 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 MutableCollection<T>
collectFloat
in interface RichIterable<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 MutableIntCollection 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 MutableCollection<T>
collectInt
in interface RichIterable<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 MutableLongCollection 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 MutableCollection<T>
collectLong
in interface RichIterable<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 MutableShortCollection 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 MutableCollection<T>
collectShort
in interface RichIterable<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 <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 <V> MutableCollection<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 MutableCollection<T>
flatCollect
in interface RichIterable<T>
function
- The Function
to applyfunction
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 <P,A> MutableCollection<A> collectWith(Function2<? super T,? super P,? extends A> 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 MutableCollection<T>
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
RichIterable
that contains the transformed elements returned by Function2.value(Object, Object)
RichIterable.collect(Function)
public <P,A,R extends Collection<A>> R collectWith(Function2<? super T,? super P,? extends A> 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> MutableCollection<V> collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function)
MutableCollection
e.g. Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
collectIf
in interface MutableCollection<T>
collectIf
in interface RichIterable<T>
public <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 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 value(Person person) { return person.getFirstName().equals("John") && person.getLastName().equals("Smith"); } });
detect
in interface RichIterable<T>
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()
RichIterable
min
in interface RichIterable<T>
public T max()
RichIterable
max
in interface RichIterable<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 T detectIfNone(Predicate<? super T> predicate, Function0<? extends T> function)
RichIterable
detectIfNone
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 value(Person person, String fullName) { return person.getFullName().equals(fullName); } }, "John Smith");
detectWith
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> function)
RichIterable
injectInto
in interface RichIterable<T>
public long injectInto(long injectedValue, LongObjectToLongFunction<? super T> function)
RichIterable
injectInto
in interface RichIterable<T>
public double injectInto(double injectedValue, DoubleObjectToDoubleFunction<? super T> function)
RichIterable
injectInto
in interface RichIterable<T>
public float injectInto(float injectedValue, FloatObjectToFloatFunction<? super T> function)
RichIterable
injectInto
in interface RichIterable<T>
public long sumOfInt(IntFunction<? super T> function)
RichIterable
sumOfInt
in interface RichIterable<T>
public double sumOfFloat(FloatFunction<? super T> function)
RichIterable
sumOfFloat
in interface RichIterable<T>
public long sumOfLong(LongFunction<? super T> function)
RichIterable
sumOfLong
in interface RichIterable<T>
public double sumOfDouble(DoubleFunction<? super T> function)
RichIterable
sumOfDouble
in interface RichIterable<T>
public <V> ObjectLongMap<V> sumByInt(Function<T,V> groupBy, IntFunction<? super T> function)
RichIterable
sumByInt
in interface RichIterable<T>
public <V> ObjectDoubleMap<V> sumByFloat(Function<T,V> groupBy, FloatFunction<? super T> function)
RichIterable
sumByFloat
in interface RichIterable<T>
public <V> ObjectLongMap<V> sumByLong(Function<T,V> groupBy, LongFunction<? super T> function)
RichIterable
sumByLong
in interface RichIterable<T>
public <V> ObjectDoubleMap<V> sumByDouble(Function<T,V> groupBy, DoubleFunction<? super T> function)
RichIterable
sumByDouble
in interface RichIterable<T>
public <IV,P> IV injectIntoWith(IV injectValue, Function3<? super IV,? super T,? super P,? extends IV> function, P parameter)
injectIntoWith
in interface MutableCollection<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 MutableSortedSet<T> toSortedSet()
RichIterable
toSortedSet
in interface RichIterable<T>
public MutableSortedSet<T> toSortedSet(Comparator<? super T> comparator)
RichIterable
toSortedSet
in interface RichIterable<T>
public <V extends Comparable<? super V>> MutableSortedSet<T> toSortedSetBy(Function<? super T,? extends V> function)
RichIterable
function
.toSortedSetBy
in interface RichIterable<T>
public MutableSet<T> toSet()
RichIterable
toSet
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 String toString()
RichIterable
String.valueOf(Object)
.toString
in interface RichIterable<T>
toString
in class Object
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> MutableMultimap<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 value(Person person) { return person.getLastName(); } });
groupBy
in interface MutableCollection<T>
groupBy
in interface RichIterable<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 value(Person person) { return person.getLastName(); } }, new FastListMultimap<String, Person>());
groupBy
in interface RichIterable<T>
public <V> MutableMultimap<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 MutableCollection<T>
groupByEach
in interface RichIterable<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 MutableCollection<T>
groupByUniqueKey
in interface RichIterable<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> MutableCollection<Pair<T,S>> zip(Iterable<S> that)
RichIterable
RichIterable
formed from this RichIterable
and another RichIterable
by
combining corresponding elements in pairs. If one of the two RichIterable
s is longer than the other, its
remaining elements are ignored.zip
in interface MutableCollection<T>
zip
in interface RichIterable<T>
S
- the type of the second half of the returned pairsthat
- The RichIterable
providing the second half of each result pairRichIterable
containing pairs consisting of corresponding elements of this RichIterable
and that. The length of the returned RichIterable
is the minimum of the lengths of
this RichIterable
and that.public <S,R extends Collection<Pair<T,S>>> R zip(Iterable<S> that, R target)
RichIterable
RichIterable.zip(Iterable)
but uses target
for output.zip
in interface RichIterable<T>
public MutableCollection<Pair<T,Integer>> zipWithIndex()
RichIterable
RichIterable
with its indices.zipWithIndex
in interface MutableCollection<T>
zipWithIndex
in interface RichIterable<T>
RichIterable
containing pairs consisting of all elements of this RichIterable
paired with their index. Indices start at 0.RichIterable.zip(Iterable)
public <R extends Collection<Pair<T,Integer>>> R zipWithIndex(R target)
RichIterable
RichIterable.zipWithIndex()
but uses target
for output.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 MutableCollection<T> with(T element)
MutableCollection
MutableCollectionIn the case oflist; list = list.with("1"); list = list.with("2"); return list;
FixedSizeCollection
a new instance of MutableCollection will be returned by with, and any
variables that previously referenced the original collection will need to be redirected to reference the
new instance. For other MutableCollection types you will replace the reference to collection with the same
collection, since the instance will return "this" after calling add on itself.with
in interface MutableCollection<T>
Collection.add(Object)
public MutableCollection<T> without(T element)
MutableCollection
MutableCollectionIn the case oflist; list = list.without("1"); list = list.without("2"); return list;
FixedSizeCollection
a new instance of MutableCollection will be returned by without, and
any variables that previously referenced the original collection will need to be redirected to reference the
new instance. For other MutableCollection types you will replace the reference to collection with the same
collection, since the instance will return "this" after calling remove on itself.without
in interface MutableCollection<T>
Collection.remove(Object)
public MutableCollection<T> withAll(Iterable<? extends T> elements)
MutableCollection
MutableCollectionIn the case oflist; list = list.withAll(FastList.newListWith("1", "2")); return list;
FixedSizeCollection
a new instance of MutableCollection will be returned by withAll, and
any variables that previously referenced the original collection will need to be redirected to reference the
new instance. For other MutableCollection types you will replace the reference to collection with the same
collection, since the instance will return "this" after calling addAll on itself.withAll
in interface MutableCollection<T>
Collection.addAll(Collection)
public MutableCollection<T> withoutAll(Iterable<? extends T> elements)
MutableCollection
MutableCollectionIn the case oflist; list = list.withoutAll(FastList.newListWith("1", "2")); return list;
FixedSizeCollection
a new instance of MutableCollection will be returned by withoutAll,
and any variables that previously referenced the original collection will need to be redirected to reference the
new instance. For other MutableCollection types you will replace the reference to collection with the same
collection, since the instance will return "this" after calling removeAll on itself.withoutAll
in interface MutableCollection<T>
Collection.removeAll(Collection)
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 MutableCollection<T>
aggregateInPlaceBy
in interface RichIterable<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 MutableCollection<T>
aggregateBy
in interface RichIterable<T>
Copyright © 2004–2016. All rights reserved.