Package org.eclipse.collections.impl.collection.mutable

Class AbstractSynchronizedMutableCollection<T>

java.lang.Object

org.eclipse.collections.impl.collection.AbstractSynchronizedRichIterable<T>

org.eclipse.collections.impl.collection.mutable.AbstractSynchronizedMutableCollection<T>

All Implemented Interfaces:

java.lang.Iterable<T>, java.util.Collection<T>, MutableCollection<T>, InternalIterable<T>, RichIterable<T>

Direct Known Subclasses:

SynchronizedBag, SynchronizedMutableCollection, SynchronizedMutableList, SynchronizedMutableSet, SynchronizedSortedBag, SynchronizedSortedSet

public abstract class AbstractSynchronizedMutableCollection<T>
extends AbstractSynchronizedRichIterable<T>
implements MutableCollection<T>

Field Summary

Fields inherited from class org.eclipse.collections.impl.collection.AbstractSynchronizedRichIterable

delegate, lock

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSynchronizedMutableCollection(MutableCollection<T> delegate)
protected	AbstractSynchronizedMutableCollection(MutableCollection<T> delegate, java.lang.Object lock)

Method Summary

Modifier and Type	Method	Description
boolean	add(T o)
boolean	addAll(java.util.Collection<? extends T> coll)
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.
void	clear()
<V> MutableCollection<V>	collect(Function<? super T,? extends V> function)	Returns a new collection with the results of applying the specified function on each element of the source collection.
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.
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.
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.
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.
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.
<V> MutableCollection<V>	collectIf(Predicate<? super T> predicate, Function<? super T,? extends V> function)	Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate.
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.
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.
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.
<P,V> MutableCollection<V>	collectWith(Function2<? super T,? super P,? extends V> function, P parameter)	Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.
<V> MutableBag<V>	countBy(Function<? super T,? extends V> function)	This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.
<V> MutableBag<V>	countByEach(Function<? super T,? extends java.lang.Iterable<V>> function)	This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.
<V,P> MutableBag<V>	countByWith(Function2<? super T,? super P,? extends V> function, P parameter)	This method will count the number of occurrences of each value calculated by applying the function to each element of the collection with the specified parameter as the second argument.
<V> MutableCollection<V>	flatCollect(Function<? super T,? extends java.lang.Iterable<V>> function)	flatCollect is a special case of RichIterable.collect(Function).
protected MutableCollection<T>	getDelegate()
<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> 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> MutableMap<V,T>	groupByUniqueKey(Function<? super T,? extends V> function)	For each element of the iterable, the function is evaluated, and the results of these evaluations are collected into a new map, where the transformed value is the key.
<IV,P> IV	injectIntoWith(IV injectValue, Function3<? super IV,? super T,? super P,? extends IV> function, P parameter)	Returns the final result of evaluating function using each element of the iterable, the previous evaluation result and the parameters.
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 all elements of the source collection that return false when evaluating of the predicate.
<P> MutableCollection<T>	rejectWith(Predicate2<? super T,? super P> predicate, P parameter)	Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> coll)
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<?> coll)
boolean	retainAllIterable(java.lang.Iterable<?> iterable)
MutableCollection<T>	select(Predicate<? super T> predicate)	Returns all elements of the source collection that return true when evaluating the predicate.
<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)	Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
<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.
MutableCollection<T>	tap(Procedure<? super T> procedure)	Executes the Procedure for each element in the iterable and returns this.
<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.
MutableCollection<Pair<T,java.lang.Integer>>	zipWithIndex()	Zips this RichIterable with its indices.

Methods inherited from class org.eclipse.collections.impl.collection.AbstractSynchronizedRichIterable

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsAny, containsAnyIterable, containsNone, containsNoneIterable, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, equals, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, forEachWith, forEachWithIndex, getFirst, getLast, getLock, getOnly, groupBy, groupByEach, groupByUniqueKey, hashCode, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, iterator, makeString, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduceBy, reject, rejectWith, select, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableList, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toString, zip, zipWithIndex

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, removeIf, size, spliterator, stream, toArray

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

forEach, forEachWith, forEachWithIndex

Methods inherited from interface org.eclipse.collections.api.collection.MutableCollection

asSynchronized, asUnmodifiable, flatCollectWith, newEmpty, toArray, toArray, toImmutable, with, withAll, without, withoutAll

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

aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getFirst, getLast, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, isEmpty, makeString, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceBy, reduceBy, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toBiMap, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Constructor Detail

AbstractSynchronizedMutableCollection

protected AbstractSynchronizedMutableCollection(MutableCollection<T> delegate)

AbstractSynchronizedMutableCollection

protected AbstractSynchronizedMutableCollection(MutableCollection<T> delegate,
                                                java.lang.Object lock)

Method Detail

getDelegate

protected MutableCollection<T> getDelegate()

Overrides:

getDelegate in class AbstractSynchronizedRichIterable<T>

select

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

select in interface MutableCollection<T>

Specified by:

select in interface RichIterable<T>

Overrides:

select in class AbstractSynchronizedRichIterable<T>

Since:

9.0

selectInstancesOf

public <S> MutableCollection<S> selectInstancesOf(java.lang.Class<S> clazz)

Description copied from interface: RichIterable

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

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

Specified by:

selectInstancesOf in interface MutableCollection<T>

Specified by:

selectInstancesOf in interface RichIterable<T>

Overrides:

selectInstancesOf in class AbstractSynchronizedRichIterable<T>

Since:

9.0

reject

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

reject in interface MutableCollection<T>

Specified by:

reject in interface RichIterable<T>

Overrides:

reject in class AbstractSynchronizedRichIterable<T>

Parameters:

predicate - a Predicate to use as the reject criteria

Returns:

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

Since:

9.0

flatCollect

public <V> MutableCollection<V> flatCollect(Function<? super T,? extends java.lang.Iterable<V>> function)

Description copied from interface: RichIterable

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

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

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

Using collect returns a collection of collections of addresses.

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

Using flatCollect returns a single flattened list of addresses.

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

Specified by:

flatCollect in interface MutableCollection<T>

Specified by:

flatCollect in interface RichIterable<T>

Overrides:

flatCollect in class AbstractSynchronizedRichIterable<T>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

Since:

9.0

collect

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collect in interface MutableCollection<T>

Specified by:

collect in interface RichIterable<T>

Overrides:

collect in class AbstractSynchronizedRichIterable<T>

Since:

9.0

collectWith

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectWith in interface MutableCollection<T>

Specified by:

collectWith in interface RichIterable<T>

Overrides:

collectWith in class AbstractSynchronizedRichIterable<T>

Parameters:

function - A Function2 to use as the collect transformation function

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

Returns:

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

Since:

9.0

See Also:

RichIterable.collect(Function)

collectBoolean

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectBoolean in interface MutableCollection<T>

Specified by:

collectBoolean in interface RichIterable<T>

Overrides:

collectBoolean in class AbstractSynchronizedRichIterable<T>

Since:

9.0

collectByte

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectByte in interface MutableCollection<T>

Specified by:

collectByte in interface RichIterable<T>

Overrides:

collectByte in class AbstractSynchronizedRichIterable<T>

Since:

9.0

collectChar

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectChar in interface MutableCollection<T>

Specified by:

collectChar in interface RichIterable<T>

Overrides:

collectChar in class AbstractSynchronizedRichIterable<T>

Since:

9.0

collectDouble

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectDouble in interface MutableCollection<T>

Specified by:

collectDouble in interface RichIterable<T>

Overrides:

collectDouble in class AbstractSynchronizedRichIterable<T>

Since:

9.0

collectFloat

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectFloat in interface MutableCollection<T>

Specified by:

collectFloat in interface RichIterable<T>

Overrides:

collectFloat in class AbstractSynchronizedRichIterable<T>

Since:

9.0

collectInt

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectInt in interface MutableCollection<T>

Specified by:

collectInt in interface RichIterable<T>

Overrides:

collectInt in class AbstractSynchronizedRichIterable<T>

Since:

9.0

collectLong

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectLong in interface MutableCollection<T>

Specified by:

collectLong in interface RichIterable<T>

Overrides:

collectLong in class AbstractSynchronizedRichIterable<T>

Since:

9.0

collectShort

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectShort in interface MutableCollection<T>

Specified by:

collectShort in interface RichIterable<T>

Overrides:

collectShort in class AbstractSynchronizedRichIterable<T>

Since:

9.0

selectWith

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

Description copied from interface: RichIterable

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

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

Example using a Java 8 lambda expression:

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

Specified by:

selectWith in interface MutableCollection<T>

Specified by:

selectWith in interface RichIterable<T>

Overrides:

selectWith in class AbstractSynchronizedRichIterable<T>

Parameters:

predicate - a Predicate2 to use as the select criteria

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

Since:

9.0

See Also:

RichIterable.select(Predicate)

rejectWith

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

Description copied from interface: RichIterable

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

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

Example using a Java 8 lambda expression:

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

Specified by:

rejectWith in interface MutableCollection<T>

Specified by:

rejectWith in interface RichIterable<T>

Overrides:

rejectWith in class AbstractSynchronizedRichIterable<T>

Parameters:

predicate - a Predicate2 to use as the select criteria

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

Since:

9.0

See Also:

RichIterable.select(Predicate)

collectIf

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda and method reference:

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

Example using Predicates factory:

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

Specified by:

collectIf in interface MutableCollection<T>

Specified by:

collectIf in interface RichIterable<T>

Overrides:

collectIf in class AbstractSynchronizedRichIterable<T>

Since:

9.0

tap

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

tap in interface MutableCollection<T>

Specified by:

tap in interface RichIterable<T>

Overrides:

tap in class AbstractSynchronizedRichIterable<T>

Since:

9.0

See Also:

RichIterable.each(Procedure), RichIterable.forEach(Procedure)

zip

public <S> MutableCollection<Pair<T,S>> zip(java.lang.Iterable<S> that)

Description copied from interface: RichIterable

Returns a RichIterable 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.

Specified by:

zip in interface MutableCollection<T>

Specified by:

zip in interface RichIterable<T>

Overrides:

zip in class AbstractSynchronizedRichIterable<T>

Type Parameters:

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

Parameters:

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

Returns:

A new RichIterable 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.

Since:

9.0

zipWithIndex

public MutableCollection<Pair<T,java.lang.Integer>> zipWithIndex()

Description copied from interface: RichIterable

Zips this RichIterable with its indices.

Specified by:

zipWithIndex in interface MutableCollection<T>

Specified by:

zipWithIndex in interface RichIterable<T>

Overrides:

zipWithIndex in class AbstractSynchronizedRichIterable<T>

Returns:

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

Since:

9.0

See Also:

RichIterable.zip(Iterable)

groupBy

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

Description copied from interface: RichIterable

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

Example using a Java 8 method reference:

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

Specified by:

groupBy in interface MutableCollection<T>

Specified by:

groupBy in interface RichIterable<T>

Overrides:

groupBy in class AbstractSynchronizedRichIterable<T>

Since:

9.0

groupByEach

public <V> MutableMultimap<V,T> groupByEach(Function<? super T,? extends java.lang.Iterable<V>> function)

Description copied from interface: RichIterable

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

Specified by:

groupByEach in interface MutableCollection<T>

Specified by:

groupByEach in interface RichIterable<T>

Overrides:

groupByEach in class AbstractSynchronizedRichIterable<T>

Since:

9.0

countBy

public <V> MutableBag<V> countBy(Function<? super T,? extends V> function)

Description copied from interface: RichIterable

This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.

Specified by:

countBy in interface MutableCollection<T>

Specified by:

countBy in interface RichIterable<T>

Overrides:

countBy in class AbstractSynchronizedRichIterable<T>

Since:

9.0

countByWith

public <V,P> MutableBag<V> countByWith(Function2<? super T,? super P,? extends V> function,
                                             P parameter)

Description copied from interface: RichIterable

This method will count the number of occurrences of each value calculated by applying the function to each element of the collection with the specified parameter as the second argument.

Specified by:

countByWith in interface MutableCollection<T>

Specified by:

countByWith in interface RichIterable<T>

Overrides:

countByWith in class AbstractSynchronizedRichIterable<T>

Since:

9.0

countByEach

public <V> MutableBag<V> countByEach(Function<? super T,? extends java.lang.Iterable<V>> function)

Description copied from interface: RichIterable

This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.

Specified by:

countByEach in interface MutableCollection<T>

Specified by:

countByEach in interface RichIterable<T>

Overrides:

countByEach in class AbstractSynchronizedRichIterable<T>

Since:

10.0.0

partition

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

partition in interface MutableCollection<T>

Specified by:

partition in interface RichIterable<T>

Overrides:

partition in class AbstractSynchronizedRichIterable<T>

Since:

9.0

partitionWith

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

partitionWith in interface MutableCollection<T>

Specified by:

partitionWith in interface RichIterable<T>

Overrides:

partitionWith in class AbstractSynchronizedRichIterable<T>

Since:

9.0

add

public boolean add(T o)

Specified by:

add in interface java.util.Collection<T>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<T>

addAll

public boolean addAll(java.util.Collection<? extends T> coll)

Specified by:

addAll in interface java.util.Collection<T>

removeAll

public boolean removeAll(java.util.Collection<?> coll)

Specified by:

removeAll in interface java.util.Collection<T>

retainAll

public boolean retainAll(java.util.Collection<?> coll)

Specified by:

retainAll in interface java.util.Collection<T>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<T>

removeIf

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

Description copied from interface: MutableCollection

Removes all elements in the collection that evaluate to true for the specified predicate.

e.g.
 return lastNames.removeIf(Predicates.isNull());
 

Specified by:

removeIf in interface MutableCollection<T>

removeIfWith

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

Description copied from interface: MutableCollection

Removes all elements in the collection that evaluate to true for the specified predicate2 and parameter.

 return lastNames.removeIfWith(Predicates2.isNull(), null);
 

Specified by:

removeIfWith in interface MutableCollection<T>

addAllIterable

public boolean addAllIterable(java.lang.Iterable<? extends T> iterable)

Specified by:

addAllIterable in interface MutableCollection<T>

See Also:

Collection.addAll(Collection)

removeAllIterable

public boolean removeAllIterable(java.lang.Iterable<?> iterable)

Specified by:

removeAllIterable in interface MutableCollection<T>

See Also:

Collection.removeAll(Collection)

retainAllIterable

public boolean retainAllIterable(java.lang.Iterable<?> iterable)

Specified by:

retainAllIterable in interface MutableCollection<T>

See Also:

Collection.retainAll(Collection)

selectAndRejectWith

public <P> Twin<MutableList<T>> selectAndRejectWith(Predicate2<? super T,? super P> predicate,
                                                    P parameter)

Description copied from interface: MutableCollection

Filters a collection into two separate collections based on a predicate returned via a Pair.

e.g.
 return lastNames.selectAndRejectWith(Predicates2.lessThan(), "Mason");
 

Specified by:

selectAndRejectWith in interface MutableCollection<T>

injectIntoWith

public <IV,P> IV injectIntoWith(IV injectValue,
                                      Function3<? super IV,? super T,? super P,? extends IV> function,
                                      P parameter)

Description copied from interface: MutableCollection

Returns the final result of evaluating function using each element of the iterable, the previous evaluation result and the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. The parameter value is always used as the third parameter to the function call.

Specified by:

injectIntoWith in interface MutableCollection<T>

See Also:

RichIterable.injectInto(Object, Function2)

groupByUniqueKey

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

Description copied from interface: RichIterable

For each element of the iterable, the function is evaluated, and the results of these evaluations are collected into a new map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown.

Specified by:

groupByUniqueKey in interface MutableCollection<T>

Specified by:

groupByUniqueKey in interface RichIterable<T>

Overrides:

groupByUniqueKey in class AbstractSynchronizedRichIterable<T>

See Also:

RichIterable.groupBy(Function)

aggregateInPlaceBy

public <K,V> MutableMap<K,V> aggregateInPlaceBy(Function<? super T,? extends K> groupBy,
                                                            Function0<? extends V> zeroValueFactory,
                                                            Procedure2<? super V,? super T> mutatingAggregator)

Description copied from interface: RichIterable

Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function. Aggregate results are required to be mutable as they will be changed in place by the procedure. A second function specifies the initial "zero" aggregate value to work with (i.e. new AtomicInteger(0)).

Specified by:

aggregateInPlaceBy in interface MutableCollection<T>

Specified by:

aggregateInPlaceBy in interface RichIterable<T>

Overrides:

aggregateInPlaceBy in class AbstractSynchronizedRichIterable<T>

aggregateBy

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)

Description copied from interface: RichIterable

Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function. Aggregate results are allowed to be immutable as they will be replaced in place in the map. A second function specifies the initial "zero" aggregate value to work with (i.e. Integer.valueOf(0)).

Specified by:

aggregateBy in interface MutableCollection<T>

Specified by:

aggregateBy in interface RichIterable<T>

Overrides:

aggregateBy in class AbstractSynchronizedRichIterable<T>

sumByInt

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

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByInt in interface MutableCollection<T>

Specified by:

sumByInt in interface RichIterable<T>

Overrides:

sumByInt in class AbstractSynchronizedRichIterable<T>

sumByFloat

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

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByFloat in interface MutableCollection<T>

Specified by:

sumByFloat in interface RichIterable<T>

Overrides:

sumByFloat in class AbstractSynchronizedRichIterable<T>

sumByLong

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

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByLong in interface MutableCollection<T>

Specified by:

sumByLong in interface RichIterable<T>

Overrides:

sumByLong in class AbstractSynchronizedRichIterable<T>

sumByDouble

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

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByDouble in interface MutableCollection<T>

Specified by:

sumByDouble in interface RichIterable<T>

Overrides:

sumByDouble in class AbstractSynchronizedRichIterable<T>