java.lang.Iterable<T>, java.util.Collection<T>, MutableCollection<T>, InternalIterable<T>, RichIterable<T>UnmodifiableBag, UnmodifiableMutableCollection, UnmodifiableMutableList, UnmodifiableMutableSet, UnmodifiableSortedBag, UnmodifiableSortedSetpublic class AbstractUnmodifiableMutableCollection<T> extends java.lang.Object implements MutableCollection<T>
| Modifier and Type | Method | Description |
|---|---|---|
boolean |
add(T o) |
|
boolean |
addAll(java.util.Collection<? extends T> c) |
|
boolean |
addAllIterable(java.lang.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(java.lang.Appendable appendable) |
Prints a string representation of this collection onto the given
Appendable. |
void |
appendString(java.lang.Appendable appendable,
java.lang.String separator) |
Prints a string representation of this collection onto the given
Appendable. |
void |
appendString(java.lang.Appendable appendable,
java.lang.String start,
java.lang.String separator,
java.lang.String end) |
Prints a string representation of this collection onto the given
Appendable. |
LazyIterable<T> |
asLazy() |
Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).
|
MutableCollection<T> |
asSynchronized() |
Returns a synchronized wrapper 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 java.util.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 java.util.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 java.util.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(java.lang.Object o) |
Returns true if the iterable has an element which responds true to element.equals(object).
|
boolean |
containsAll(java.util.Collection<?> c) |
Returns true if all elements in source are contained in this collection.
|
boolean |
containsAllArguments(java.lang.Object... elements) |
Returns true if all elements in the specified var arg array are contained in this collection.
|
boolean |
containsAllIterable(java.lang.Iterable<?> source) |
Returns true if all elements in source are contained in this collection.
|
int |
count(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.
|
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.
|
void |
each(Procedure<? super T> procedure) |
The procedure is executed for each element in the iterable.
|
<V> MutableCollection<V> |
flatCollect(Function<? super T,? extends java.lang.Iterable<V>> function) |
flatCollect is a special case of RichIterable.collect(Function). |
<V,R extends java.util.Collection<V>> |
flatCollect(Function<? super T,? extends java.lang.Iterable<V>> function,
R target) |
Same as flatCollect, only the results are collected into the target collection.
|
void |
forEach(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.
|
T |
getOnly() |
Returns the element if the iterable has exactly one element.
|
<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 java.lang.Iterable<V>> function) |
Similar to
RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys
for each value. |
<V,R extends MutableMultimap<V,T>> |
groupByEach(Function<? super T,? extends java.lang.Iterable<V>> function,
R target) |
Same as
RichIterable.groupByEach(Function), except that the results are gathered into the specified target
multimap. |
<V> 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.
|
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> 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.
|
<IV,P> IV |
injectIntoWith(IV injectValue,
Function3<? super IV,? super T,? super P,? extends IV> function,
P parameter) |
|
<R extends java.util.Collection<T>> |
into(R target) |
Adds all the elements in this iterable to the specific target Collection.
|
boolean |
isEmpty() |
Returns true if this iterable has zero items.
|
java.util.Iterator<T> |
iterator() |
|
java.lang.String |
makeString() |
Returns a string representation of this collection by delegating to
RichIterable.makeString(String) and defaulting
the separator parameter to the characters ", " (comma and space). |
java.lang.String |
makeString(java.lang.String separator) |
Returns a string representation of this collection by delegating to
RichIterable.makeString(String, String, String)
and defaulting the start and end parameters to "" (the empty String). |
java.lang.String |
makeString(java.lang.String start,
java.lang.String separator,
java.lang.String end) |
Returns a string representation of this collection with the elements separated by the specified
separator and enclosed between the start and end strings.
|
T |
max() |
Returns the maximum element out of this container based on the natural order.
|
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>> |
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(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>> |
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 java.util.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 java.util.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(java.lang.Object o) |
|
boolean |
removeAll(java.util.Collection<?> c) |
|
boolean |
removeAllIterable(java.lang.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(java.util.Collection<?> c) |
|
boolean |
retainAllIterable(java.lang.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 java.util.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(java.lang.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 java.util.Collection<T>> |
selectWith(Predicate2<? super T,? super P> predicate,
P parameter,
R targetCollection) |
Similar to
RichIterable.select(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2. |
int |
size() |
Returns the number of items in this iterable.
|
<V> MutableObjectDoubleMap<V> |
sumByDouble(Function<? super T,? extends V> groupBy,
DoubleFunction<? super T> function) |
Groups and sums the values using the two specified functions.
|
<V> MutableObjectDoubleMap<V> |
sumByFloat(Function<? super T,? extends V> groupBy,
FloatFunction<? super T> function) |
Groups and sums the values using the two specified functions.
|
<V> MutableObjectLongMap<V> |
sumByInt(Function<? super T,? extends V> groupBy,
IntFunction<? super T> function) |
Groups and sums the values using the two specified functions.
|
<V> MutableObjectLongMap<V> |
sumByLong(Function<? super T,? extends V> groupBy,
LongFunction<? super T> function) |
Groups and sums the values using the two specified functions.
|
double |
sumOfDouble(DoubleFunction<? super T> 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. |
java.lang.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(java.util.Comparator<? super T> comparator) |
Converts the collection to the MutableSortedBag implementation and sorts it using the specified comparator.
|
<V extends java.lang.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(java.util.Comparator<? super T> comparator) |
Converts the collection to a MutableList implementation and sorts it using the specified comparator.
|
<V extends java.lang.Comparable<? super V>> |
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(java.util.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(java.util.Comparator<? super T> comparator) |
Converts the collection to a MutableSortedSet implementation and sorts it using the specified comparator.
|
<V extends java.lang.Comparable<? super V>> |
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. |
java.lang.String |
toString() |
Returns a string with the elements of this iterable separated by commas with spaces and
enclosed in square brackets.
|
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(java.lang.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(java.lang.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(java.lang.Iterable<S> that) |
Returns a
RichIterable formed from this RichIterable and another RichIterable by
combining corresponding elements in pairs. |
<S,R extends java.util.Collection<Pair<T,S>>> |
zip(java.lang.Iterable<S> that,
R target) |
Same as
RichIterable.zip(Iterable) but uses target for output. |
MutableCollection<Pair<T,java.lang.Integer>> |
zipWithIndex() |
Zips this
RichIterable with its indices. |
<R extends java.util.Collection<Pair<T,java.lang.Integer>>> |
zipWithIndex(R target) |
Same as
RichIterable.zipWithIndex() but uses target for output. |
equals, hashCode, parallelStream, removeIf, spliterator, streamforEachcountBy, countByWithequals, getClass, hashCode, notify, notifyAll, wait, wait, waitcountBy, countByWith, maxByOptional, maxOptional, maxOptional, minByOptional, minOptional, minOptional, reduce, reduceInPlace, reduceInPlace, summarizeDouble, summarizeFloat, summarizeInt, summarizeLongpublic int size()
RichIterablesize in interface java.util.Collection<T>size in interface RichIterable<T>public boolean isEmpty()
RichIterableisEmpty in interface java.util.Collection<T>isEmpty in interface RichIterable<T>public boolean contains(java.lang.Object o)
RichIterablecontains in interface java.util.Collection<T>contains in interface RichIterable<T>public java.util.Iterator<T> iterator()
public java.lang.Object[] toArray()
RichIterabletoArray in interface java.util.Collection<T>toArray in interface RichIterable<T>Collection.toArray()public <S> S[] toArray(S[] a)
RichIterabletoArray in interface java.util.Collection<T>toArray in interface RichIterable<T>Collection.toArray(Object[])public boolean remove(java.lang.Object o)
remove in interface java.util.Collection<T>public boolean containsAll(java.util.Collection<?> c)
RichIterablecontainsAll in interface java.util.Collection<T>containsAll in interface RichIterable<T>Collection.containsAll(Collection)public boolean addAll(java.util.Collection<? extends T> c)
addAll in interface java.util.Collection<T>public boolean retainAll(java.util.Collection<?> c)
retainAll in interface java.util.Collection<T>public boolean removeAll(java.util.Collection<?> c)
removeAll in interface java.util.Collection<T>public void clear()
clear in interface java.util.Collection<T>public boolean addAllIterable(java.lang.Iterable<? extends T> iterable)
addAllIterable in interface MutableCollection<T>Collection.addAll(Collection)public boolean removeAllIterable(java.lang.Iterable<?> iterable)
removeAllIterable in interface MutableCollection<T>Collection.removeAll(Collection)public boolean retainAllIterable(java.lang.Iterable<?> iterable)
retainAllIterable in interface MutableCollection<T>Collection.retainAll(Collection)public MutableCollection<T> asUnmodifiable()
MutableCollectionCollections.unmodifiableCollection(this) with a return type that supports the full
iteration protocols available on MutableCollection. Methods which would
mutate the underlying collection will throw UnsupportedOperationExceptions.asUnmodifiable in interface MutableCollection<T>Collections.unmodifiableCollection(Collection)public MutableCollection<T> asSynchronized()
MutableCollectionCollections.synchronizedCollection(this) only with a return type that supports the full
iteration protocols available on MutableCollection.
The preferred way of iterating over a synchronized collection is to use the internal iteration
methods which are properly synchronized internally.
MutableCollection synchedCollection = collection.asSynchronized();
...
synchedCollection.forEach(each -> ... );
synchedCollection.select(each -> ... );
synchedCollection.collect(each -> ... );
If you want to iterate using an imperative style, you must protect external iterators using
a synchronized block. This includes explicit iterators as well as JDK 5 style for loops.
asSynchronized in interface MutableCollection<T>Collections.synchronizedCollection(Collection)public ImmutableCollection<T> toImmutable()
MutableCollectionMutableCollection to an ImmutableCollection.toImmutable in interface MutableCollection<T>public LazyIterable<T> asLazy()
RichIterableasLazy in interface RichIterable<T>public MutableCollection<T> tap(Procedure<? super T> procedure)
RichIterablethis.
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());
}
});
tap in interface MutableCollection<T>tap in interface RichIterable<T>RichIterable.each(Procedure),
InternalIterable.forEach(Procedure)public void forEach(Procedure<? super T> procedure)
InternalIterableExample using a Java 8 lambda:
people.forEach(Procedures.cast(person -> LOGGER.info(person.getName())));
Example using an anonymous inner class:
people.forEach(new Procedure<Person>()
{
public void value(Person person)
{
LOGGER.info(person.getName());
}
});
NOTE: This method started to conflict with 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)
RichIterableExample using a Java 8 lambda expression:
people.each(person -> LOGGER.info(person.getName()));
Example using an anonymous inner class:
people.each(new Procedure<Person>()
{
public void value(Person person)
{
LOGGER.info(person.getName());
}
});
This method is a variant of InternalIterable.forEach(Procedure)
that has a signature conflict with Iterable.forEach(java.util.function.Consumer).each in interface RichIterable<T>InternalIterable.forEach(Procedure),
Iterable.forEach(java.util.function.Consumer)public void forEachWithIndex(ObjectIntProcedure<? super T> objectIntProcedure)
InternalIterableExample 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());
}
});
forEachWithIndex in interface InternalIterable<T>public <P> void forEachWith(Procedure2<? super T,? super P> procedure, P parameter)
InternalIterableExample 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);
forEachWith in interface InternalIterable<T>public boolean containsAllIterable(java.lang.Iterable<?> source)
RichIterablecontainsAllIterable in interface RichIterable<T>public boolean containsAllArguments(java.lang.Object... elements)
RichIterablecontainsAllArguments in interface RichIterable<T>public boolean notEmpty()
RichIterablenotEmpty in interface RichIterable<T>public MutableCollection<T> newEmpty()
MutableCollectionnewEmpty in interface MutableCollection<T>public T getFirst()
RichIterableThe 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()
RichIterableThe 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 T getOnly()
RichIterableIllegalStateException.getOnly in interface RichIterable<T>public MutableCollection<T> select(Predicate<? super T> predicate)
MutableCollection
MutableCollection<Integer> livesInLondon =
people.select(person -> person.getAddress().getCity().equals("London"));
select in interface MutableCollection<T>select in interface RichIterable<T>public <R extends java.util.Collection<T>> R select(Predicate<? super T> predicate, R target)
RichIterableExample 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 predicatetarget, 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
MutableCollection<Integer> fives =
integers.selectWith(Predicates2.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 predicateRichIterable.select(Predicate)public <P,R extends java.util.Collection<T>> R selectWith(Predicate2<? super T,? super P> predicate, P parameter, R targetCollection)
RichIterableRichIterable.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 predicatetargetCollection - the Collection to append to for all elements in this RichIterable that meet select criteria predicatetargetCollection, 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
MutableCollection<Person> notSmiths =
people.reject(person -> person.person.getLastName().equals("Smith"));
Using the Predicates factory:
MutableCollection<Person> notSmiths = 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 java.util.Collection<T>> R reject(Predicate<? super T> predicate, R target)
RichIterableExample 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.
MutableCollection<Integer> selected =
integers.rejectWith(Predicates2.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 predicateRichIterable.select(Predicate)public <P,R extends java.util.Collection<T>> R rejectWith(Predicate2<? super T,? super P> predicate, P parameter, R targetCollection)
RichIterableRichIterable.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 predicatetargetCollection - 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(Predicates2.lessThan(), "Mason");
selectAndRejectWith in interface MutableCollection<T>public PartitionMutableCollection<T> partition(Predicate<? super T> predicate)
MutableCollectionExample 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");
}
});
Co-variant example for MutableCollection:
PartitionMutableCollection<Person> newYorkersAndNonNewYorkers =
people.partition(person -> 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)
MutableCollectionExample 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");
Co-variant example for MutableCollection:
PartitionMutableCollection<Person>> newYorkersAndNonNewYorkers =
people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
partitionWith in interface MutableCollection<T>partitionWith in interface RichIterable<T>public <S> MutableCollection<S> selectInstancesOf(java.lang.Class<S> clazz)
MutableCollectionclazz.
RichIterable<Integer> integers =
List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
Co-variant example for MutableCollection:
MutableCollection<Integer> integers =
List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
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
return lastNames.removeIfWith(Predicates2.isNull(), null);
removeIfWith in interface MutableCollection<T>public <V> MutableCollection<V> collect(Function<? super T,? extends V> function)
MutableCollection
MutableCollection<String> names =
people.collect(person -> person.getFirstName() + " " + person.getLastName());
collect in interface MutableCollection<T>collect in interface RichIterable<T>public MutableBooleanCollection collectBoolean(BooleanFunction<? super T> booleanFunction)
MutableCollectionboolean 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();
}
});
Co-variant example for MutableCollection:
MutableBooleanCollection licenses =
people.collectBoolean(person -> person.hasDrivingLicense());
collectBoolean in interface MutableCollection<T>collectBoolean in interface RichIterable<T>public <R extends MutableBooleanCollection> R collectBoolean(BooleanFunction<? super T> booleanFunction, R target)
RichIterableRichIterable.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 RichIterabletarget, which contains appended elements as a result of the collect transformationpublic MutableByteCollection collectByte(ByteFunction<? super T> byteFunction)
MutableCollectionbyte 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();
}
});
Co-variant example for MutableCollection:
MutableByteCollection bytes =
people.collectByte(person -> person.getCode());
collectByte in interface MutableCollection<T>collectByte in interface RichIterable<T>public <R extends MutableByteCollection> R collectByte(ByteFunction<? super T> byteFunction, R target)
RichIterableRichIterable.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 RichIterabletarget, which contains appended elements as a result of the collect transformationpublic MutableCharCollection collectChar(CharFunction<? super T> charFunction)
MutableCollectionchar 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();
}
});
Co-variant example for MutableCollection:
MutableCharCollection chars =
people.collectChar(person -> person.getMiddleInitial());
collectChar in interface MutableCollection<T>collectChar in interface RichIterable<T>public <R extends MutableCharCollection> R collectChar(CharFunction<? super T> charFunction, R target)
RichIterableRichIterable.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 RichIterabletarget, which contains appended elements as a result of the collect transformationpublic MutableDoubleCollection collectDouble(DoubleFunction<? super T> doubleFunction)
MutableCollectiondouble 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();
}
});
Co-variant example for MutableCollection:
MutableDoubleCollection doubles =
people.collectDouble(person -> person.getMilesFromNorthPole());
collectDouble in interface MutableCollection<T>collectDouble in interface RichIterable<T>public <R extends MutableDoubleCollection> R collectDouble(DoubleFunction<? super T> doubleFunction, R target)
RichIterableRichIterable.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 RichIterabletarget, which contains appended elements as a result of the collect transformationpublic MutableFloatCollection collectFloat(FloatFunction<? super T> floatFunction)
MutableCollectionfloat 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();
}
});
Co-variant example for MutableCollection:
MutableFloatCollection floats =
people.collectFloat(person -> person.getHeightInInches());
collectFloat in interface MutableCollection<T>collectFloat in interface RichIterable<T>public <R extends MutableFloatCollection> R collectFloat(FloatFunction<? super T> floatFunction, R target)
RichIterableRichIterable.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 RichIterabletarget, which contains appended elements as a result of the collect transformationpublic MutableIntCollection collectInt(IntFunction<? super T> intFunction)
MutableCollectionint 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();
}
});
Co-variant example for MutableCollection:
MutableIntCollection ints =
people.collectInt(person -> person.getAge());
collectInt in interface MutableCollection<T>collectInt in interface RichIterable<T>public <R extends MutableIntCollection> R collectInt(IntFunction<? super T> intFunction, R target)
RichIterableRichIterable.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 RichIterabletarget, which contains appended elements as a result of the collect transformationpublic MutableLongCollection collectLong(LongFunction<? super T> longFunction)
MutableCollectionlong 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();
}
});
Co-variant example for MutableCollection:
MutableLongCollection longs =
people.collectLong(person -> person.getGuid());
collectLong in interface MutableCollection<T>collectLong in interface RichIterable<T>public <R extends MutableLongCollection> R collectLong(LongFunction<? super T> longFunction, R target)
RichIterableRichIterable.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 RichIterabletarget, which contains appended elements as a result of the collect transformationpublic MutableShortCollection collectShort(ShortFunction<? super T> shortFunction)
MutableCollectionshort 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();
}
});
Co-variant example for MutableCollection:
MutableShortCollection shorts =
people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
collectShort in interface MutableCollection<T>collectShort in interface RichIterable<T>public <R extends MutableShortCollection> R collectShort(ShortFunction<? super T> shortFunction, R target)
RichIterableRichIterable.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 RichIterabletarget, which contains appended elements as a result of the collect transformationpublic <V,R extends java.util.Collection<V>> R collect(Function<? super T,? extends V> function, R target)
RichIterableRichIterable.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 functiontarget, which contains appended elements as a result of the collect transformationRichIterable.collect(Function)public <V> MutableCollection<V> flatCollect(Function<? super T,? extends java.lang.Iterable<V>> function)
MutableCollectionflatCollect is a special case of RichIterable.collect(Function). With collect, when the Function returns
a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection
instead. This method is commonly called flatMap.
Consider the following example where we have a Person class, and each Person has a list of Address objects. Take the following Function:
Function<Person, List<Address>> addressFunction = Person::getAddresses; RichIterable<Person> people = ...;Using
collect returns a collection of collections of addresses.
RichIterable<List<Address>> addresses = people.collect(addressFunction);Using
flatCollect returns a single flattened list of addresses.
RichIterable<Address> addresses = people.flatCollect(addressFunction);Co-variant example for MutableCollection:
Function<Person, List<Address>> addressFunction = Person::getAddresses; MutableCollection<Person> people = ...; MutableCollection<List<Address>> addresses = people.collect(addressFunction); MutableCollection<Address> addresses = people.flatCollect(addressFunction);
flatCollect in interface MutableCollection<T>flatCollect in interface RichIterable<T>function - The Function to applyfunctionpublic <V,R extends java.util.Collection<V>> R flatCollect(Function<? super T,? extends java.lang.Iterable<V>> function, R target)
RichIterableflatCollect 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 functionRichIterable.flatCollect(Function)public <P,A> MutableCollection<A> collectWith(Function2<? super T,? super P,? extends A> function, P parameter)
MutableCollectionRichIterable.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));
Co-variant example for MutableCollection:
MutableCollection<Integer> integers =
Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, 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 functionRichIterable that contains the transformed elements returned by Function2.value(Object, Object)RichIterable.collect(Function)public <P,A,R extends java.util.Collection<A>> R collectWith(Function2<? super T,? super P,? extends A> function, P parameter, R targetCollection)
RichIterableExample 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());
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 functiontargetCollection - the Collection to append to for all elements in this RichIterable that meet select criteria functiontargetCollection, 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
MutableCollection<String> collected =
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 java.util.Collection<V>> R collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function, R target)
RichIterablecollectIf 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 predicatetargetCollection, which contains appended elements as a result of the collect criteria and transformationRichIterable.collectIf(Predicate, Function)public T detect(Predicate<? super T> predicate)
RichIterableExample using a Java 8 lambda expression:
Person person =
people.detect(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));
Example using an anonymous inner class:
Person person =
people.detect(new Predicate<Person>()
{
public boolean accept(Person person)
{
return person.getFirstName().equals("John") && person.getLastName().equals("Smith");
}
});
detect in interface RichIterable<T>public <P> T detectWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterableExample using a Java 8 lambda expression:
Person person =
people.detectWith((person, fullName) -> person.getFullName().equals(fullName), "John Smith");
Example using an anonymous inner class:
Person person =
people.detectWith(new Predicate2<Person, String>()
{
public boolean accept(Person person, String fullName)
{
return person.getFullName().equals(fullName);
}
}, "John Smith");
detectWith in interface RichIterable<T>public java.util.Optional<T> detectOptional(Predicate<? super T> predicate)
RichIterableExample using a Java 8 lambda expression:
Person person =
people.detectOptional(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));
detectOptional in interface RichIterable<T>public <P> java.util.Optional<T> detectWithOptional(Predicate2<? super T,? super P> predicate, P parameter)
RichIterableExample using a Java 8 lambda expression:
Optional<Person> person =
people.detectWithOptional((person, fullName) -> person.getFullName().equals(fullName), "John Smith");
detectWithOptional in interface RichIterable<T>public T detectIfNone(Predicate<? super T> predicate, Function0<? extends T> function)
RichIterabledetectIfNone in interface RichIterable<T>public <P> T detectWithIfNone(Predicate2<? super T,? super P> predicate, P parameter, Function0<? extends T> function)
RichIterabledetectWithIfNone in interface RichIterable<T>public T min(java.util.Comparator<? super T> comparator)
RichIterablemin in interface RichIterable<T>public T max(java.util.Comparator<? super T> comparator)
RichIterablemax in interface RichIterable<T>public T min()
RichIterablemin in interface RichIterable<T>public T max()
RichIterablemax in interface RichIterable<T>public <V extends java.lang.Comparable<? super V>> T minBy(Function<? super T,? extends V> function)
RichIterableminBy in interface RichIterable<T>public <V extends java.lang.Comparable<? super V>> T maxBy(Function<? super T,? extends V> function)
RichIterablemaxBy in interface RichIterable<T>public int count(Predicate<? super T> predicate)
RichIterableExample 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(Predicates2.equal(), "Smith");
countWith in interface RichIterable<T>public boolean anySatisfy(Predicate<? super T> predicate)
RichIterableanySatisfy in interface RichIterable<T>public <P> boolean anySatisfyWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterableanySatisfyWith in interface RichIterable<T>public boolean allSatisfy(Predicate<? super T> predicate)
RichIterableallSatisfy in interface RichIterable<T>public <P> boolean allSatisfyWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterableallSatisfyWith in interface RichIterable<T>public boolean noneSatisfy(Predicate<? super T> predicate)
RichIterablenoneSatisfy in interface RichIterable<T>public <P> boolean noneSatisfyWith(Predicate2<? super T,? super P> predicate, P parameter)
RichIterablenoneSatisfyWith in interface RichIterable<T>public <IV> IV injectInto(IV injectedValue,
Function2<? super IV,? super T,? extends IV> function)
RichIterableinjectInto in interface RichIterable<T>public int injectInto(int injectedValue,
IntObjectToIntFunction<? super T> function)
RichIterableinjectInto in interface RichIterable<T>public long injectInto(long injectedValue,
LongObjectToLongFunction<? super T> function)
RichIterableinjectInto in interface RichIterable<T>public double injectInto(double injectedValue,
DoubleObjectToDoubleFunction<? super T> function)
RichIterableinjectInto in interface RichIterable<T>public float injectInto(float injectedValue,
FloatObjectToFloatFunction<? super T> function)
RichIterableinjectInto in interface RichIterable<T>public long sumOfInt(IntFunction<? super T> function)
RichIterablesumOfInt in interface RichIterable<T>public double sumOfFloat(FloatFunction<? super T> function)
RichIterablesumOfFloat in interface RichIterable<T>public long sumOfLong(LongFunction<? super T> function)
RichIterablesumOfLong in interface RichIterable<T>public double sumOfDouble(DoubleFunction<? super T> function)
RichIterablesumOfDouble in interface RichIterable<T>public <V> MutableObjectLongMap<V> sumByInt(Function<? super T,? extends V> groupBy, IntFunction<? super T> function)
RichIterablesumByInt in interface MutableCollection<T>sumByInt in interface RichIterable<T>public <V> MutableObjectDoubleMap<V> sumByFloat(Function<? super T,? extends V> groupBy, FloatFunction<? super T> function)
RichIterablesumByFloat in interface MutableCollection<T>sumByFloat in interface RichIterable<T>public <V> MutableObjectLongMap<V> sumByLong(Function<? super T,? extends V> groupBy, LongFunction<? super T> function)
RichIterablesumByLong in interface MutableCollection<T>sumByLong in interface RichIterable<T>public <V> MutableObjectDoubleMap<V> sumByDouble(Function<? super T,? extends V> groupBy, DoubleFunction<? super T> function)
RichIterablesumByDouble in interface MutableCollection<T>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 <R extends java.util.Collection<T>> R into(R target)
RichIterableinto in interface RichIterable<T>public MutableList<T> toList()
RichIterabletoList in interface RichIterable<T>public MutableList<T> toSortedList()
RichIterabletoSortedList in interface RichIterable<T>public MutableList<T> toSortedList(java.util.Comparator<? super T> comparator)
RichIterabletoSortedList in interface RichIterable<T>public <V extends java.lang.Comparable<? super V>> MutableList<T> toSortedListBy(Function<? super T,? extends V> function)
RichIterablefunction.toSortedListBy in interface RichIterable<T>public MutableSortedSet<T> toSortedSet()
RichIterabletoSortedSet in interface RichIterable<T>public MutableSortedSet<T> toSortedSet(java.util.Comparator<? super T> comparator)
RichIterabletoSortedSet in interface RichIterable<T>public <V extends java.lang.Comparable<? super V>> MutableSortedSet<T> toSortedSetBy(Function<? super T,? extends V> function)
RichIterablefunction.toSortedSetBy in interface RichIterable<T>public MutableSet<T> toSet()
RichIterabletoSet in interface RichIterable<T>public MutableBag<T> toBag()
RichIterabletoBag in interface RichIterable<T>public MutableSortedBag<T> toSortedBag()
RichIterabletoSortedBag in interface RichIterable<T>public MutableSortedBag<T> toSortedBag(java.util.Comparator<? super T> comparator)
RichIterabletoSortedBag in interface RichIterable<T>public <V extends java.lang.Comparable<? super V>> MutableSortedBag<T> toSortedBagBy(Function<? super T,? extends V> function)
RichIterablefunction.toSortedBagBy in interface RichIterable<T>public <NK,NV> MutableMap<NK,NV> toMap(Function<? super T,? extends NK> keyFunction, Function<? super T,? extends NV> valueFunction)
RichIterabletoMap in interface RichIterable<T>public <NK,NV> MutableSortedMap<NK,NV> toSortedMap(Function<? super T,? extends NK> keyFunction, Function<? super T,? extends NV> valueFunction)
RichIterabletoSortedMap in interface RichIterable<T>public <NK,NV> MutableSortedMap<NK,NV> toSortedMap(java.util.Comparator<? super NK> comparator, Function<? super T,? extends NK> keyFunction, Function<? super T,? extends NV> valueFunction)
RichIterabletoSortedMap in interface RichIterable<T>public java.lang.String toString()
RichIterable
Assert.assertEquals("[]", Lists.mutable.empty().toString());
Assert.assertEquals("[1]", Lists.mutable.with(1).toString());
Assert.assertEquals("[1, 2, 3]", Lists.mutable.with(1, 2, 3).toString());
toString in interface RichIterable<T>toString in class java.lang.ObjectAbstractCollection.toString()public java.lang.String makeString()
RichIterableRichIterable.makeString(String) and defaulting
the separator parameter to the characters ", " (comma and space).makeString in interface RichIterable<T>public java.lang.String makeString(java.lang.String separator)
RichIterableRichIterable.makeString(String, String, String)
and defaulting the start and end parameters to "" (the empty String).makeString in interface RichIterable<T>public java.lang.String makeString(java.lang.String start,
java.lang.String separator,
java.lang.String end)
RichIterablemakeString in interface RichIterable<T>public void appendString(java.lang.Appendable appendable)
RichIterableAppendable. Prints the string returned
by RichIterable.makeString().appendString in interface RichIterable<T>public void appendString(java.lang.Appendable appendable,
java.lang.String separator)
RichIterableAppendable. Prints the string returned
by RichIterable.makeString(String).appendString in interface RichIterable<T>public void appendString(java.lang.Appendable appendable,
java.lang.String start,
java.lang.String separator,
java.lang.String end)
RichIterableAppendable. 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)
MutableCollectionExample 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();
}
});
Co-variant example for MutableCollection:
MutableMultimap<String, Person> peopleByLastName =
people.groupBy(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)
RichIterableRichIterable.groupBy(Function), except that the results are gathered into the specified target
multimap.
Example using a Java 8 method reference:
FastListMultimap<String, Person> peopleByLastName =
people.groupBy(Person::getLastName, new FastListMultimap<String, Person>());
Example using an anonymous inner class:
FastListMultimap<String, Person> peopleByLastName =
people.groupBy(new Function<Person, String>()
{
public String valueOf(Person person)
{
return person.getLastName();
}
}, new FastListMultimap<String, Person>());
groupBy in interface RichIterable<T>public <V> MutableMultimap<V,T> groupByEach(Function<? super T,? extends java.lang.Iterable<V>> function)
RichIterableRichIterable.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 java.lang.Iterable<V>> function, R target)
RichIterableRichIterable.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)
RichIterablegroupByUniqueKey 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)
RichIterableRichIterable.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(java.lang.Iterable<S> that)
RichIterableRichIterable formed from this RichIterable and another RichIterable by
combining corresponding elements in pairs. If one of the two RichIterables is longer than the other, its
remaining elements are ignored.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 java.util.Collection<Pair<T,S>>> R zip(java.lang.Iterable<S> that, R target)
RichIterableRichIterable.zip(Iterable) but uses target for output.zip in interface RichIterable<T>public MutableCollection<Pair<T,java.lang.Integer>> zipWithIndex()
RichIterableRichIterable 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 java.util.Collection<Pair<T,java.lang.Integer>>> R zipWithIndex(R target)
RichIterableRichIterable.zipWithIndex() but uses target for output.zipWithIndex in interface RichIterable<T>public RichIterable<RichIterable<T>> chunk(int size)
RichIterablechunk in interface RichIterable<T>size - the number of elements per chunkRichIterable containing RichIterables of size size, except the last will be
truncated if the elements don't divide evenly.public MutableCollection<T> with(T element)
MutableCollection
MutableCollection<String> list = list.with("1");
list = list.with("2");
return list;
In the case of 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
MutableCollection<String> list = list.without("1");
list = list.without("2");
return list;
In the case of 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(java.lang.Iterable<? extends T> elements)
MutableCollection
MutableCollection<String> list = list.withAll(FastList.newListWith("1", "2"));
In the case of 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(java.lang.Iterable<? extends T> elements)
MutableCollection
MutableCollection<String> list = list.withoutAll(FastList.newListWith("1", "2"));
In the case of 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)
RichIterableaggregateInPlaceBy 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)
RichIterableaggregateBy in interface MutableCollection<T>aggregateBy in interface RichIterable<T>Copyright © 2004–2018. All rights reserved.