Serializable
, Iterable<T>
, Collection<T>
, MutableCollection<T>
, InternalIterable<T>
, RichIterable<T>
@ThreadSafe public class SynchronizedMutableCollection<T> extends AbstractSynchronizedMutableCollection<T> implements Serializable
MutableCollection
. It is imperative that the user manually synchronize on the collection when iterating over it using the
standard JDK iterator or JDK 5 for loop, as per Collections.synchronizedCollection(Collection)
.Modifier and Type | Method | Description |
---|---|---|
MutableCollection<T> |
asSynchronized() |
Returns a synchronized wrapper backed by this collection.
|
MutableCollection<T> |
asUnmodifiable() |
Returns an unmodifiable view of this collection.
|
<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.
|
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 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.
|
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> MutableCollection<V> |
flatCollect(Function<? super T,? extends Iterable<V>> function) |
flatCollect is a special case of RichIterable.collect(Function) . |
<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 Iterable<V>> function) |
Similar to
RichIterable.groupBy(Function) , except the result of evaluating function will return a collection of keys
for each value. |
MutableCollection<T> |
newEmpty() |
Creates a new empty mutable version of the same collection type.
|
static <E,C extends Collection<E>> |
of(C collection) |
This method will take a MutableCollection and wrap it directly in a SynchronizedMutableCollection.
|
static <E,C extends Collection<E>> |
of(C collection,
Object lock) |
This method will take a MutableCollection and wrap it directly in a SynchronizedMutableCollection.
|
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.
|
<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.
|
MutableCollection<T> |
select(Predicate<? super T> predicate) |
Returns a MutableCollection with all elements that evaluate to true for the specified predicate.
|
<S> MutableCollection<S> |
selectInstancesOf(Class<S> clazz) |
Returns all elements of the source collection that are instances of the Class
clazz . |
<P> MutableCollection<T> |
selectWith(Predicate2<? super T,? super P> predicate,
P parameter) |
Returns a MutableCollection with all elements that evaluate to true for the specified predicate2 and parameter.
|
MutableCollection<T> |
tap(Procedure<? super T> procedure) |
Executes the Procedure for each element in the iterable and returns
this . |
ImmutableCollection<T> |
toImmutable() |
Converts this
MutableCollection to an ImmutableCollection . |
MutableCollection<T> |
with(T element) |
This method allows mutable and fixed size collections the ability to add elements to their existing elements.
|
MutableCollection<T> |
withAll(Iterable<? extends T> elements) |
This method allows mutable and fixed size collections the ability to add multiple elements to their existing
elements.
|
MutableCollection<T> |
without(T element) |
This method allows mutable and fixed size collections the ability to remove elements from their existing elements.
|
MutableCollection<T> |
withoutAll(Iterable<? extends T> elements) |
This method allows mutable and fixed size collections the ability to remove multiple elements from their existing
elements.
|
<S> MutableCollection<Pair<T,S>> |
zip(Iterable<S> that) |
Returns a
RichIterable formed from this RichIterable and another RichIterable by
combining corresponding elements in pairs. |
MutableCollection<Pair<T,Integer>> |
zipWithIndex() |
Zips this
RichIterable with its indices. |
add, addAll, addAllIterable, aggregateBy, aggregateInPlaceBy, clear, groupByUniqueKey, injectIntoWith, remove, removeAll, removeAllIterable, removeIf, removeIfWith, retainAll, retainAllIterable, selectAndRejectWith, sumByDouble, sumByFloat, sumByInt, sumByLong
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, equals, flatCollect, forEach, forEachWith, forEachWithIndex, getFirst, getLast, getOnly, groupBy, groupByEach, groupByUniqueKey, hashCode, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, iterator, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex
contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, removeIf, size, spliterator, stream, toArray, toArray
forEach, forEachWith, forEachWithIndex
getClass, hashCode, notify, notifyAll, wait, wait, wait
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, getFirst, getLast, getOnly, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex
public static <E,C extends Collection<E>> SynchronizedMutableCollection<E> of(C collection)
public static <E,C extends Collection<E>> SynchronizedMutableCollection<E> of(C collection, Object lock)
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(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(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 MutableCollection<T> asUnmodifiable()
MutableCollection
Collections.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()
MutableCollection
Collections.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()
MutableCollection
MutableCollection
to an ImmutableCollection
.toImmutable
in interface MutableCollection<T>
public MutableCollection<T> newEmpty()
MutableCollection
newEmpty
in interface MutableCollection<T>
public MutableCollection<T> tap(Procedure<? super T> procedure)
RichIterable
this
.
Example using a Java 8 lambda expression:
RichIterable<Person> tapped = people.tap(person -> LOGGER.info(person.getName()));
Example using an anonymous inner class:
RichIterable<Person> tapped = people.tap(new Procedure<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 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 <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 predicate
RichIterable.select(Predicate)
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 <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 predicate
RichIterable.select(Predicate)
public PartitionMutableCollection<T> partition(Predicate<? super T> predicate)
MutableCollection
Example using a Java 8 lambda expression:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partition(person -> person.getAddress().getState().getName().equals("New York"));
Example using an anonymous inner class:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partition(new Predicate<Person>() { public boolean accept(Person person) { return person.getAddress().getState().getName().equals("New York"); } });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)
MutableCollection
Example using a Java 8 lambda expression:
PartitionIterable<Person>> newYorkersAndNonNewYorkers = people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
Example using an anonymous inner class:
PartitionIterable<Person>> newYorkersAndNonNewYorkers = people.partitionWith(new Predicate2<Person, String>() { public boolean accept(Person person, String state) { return person.getAddress().getState().getName().equals(state); } }, "New York");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 MutableBooleanCollection collectBoolean(BooleanFunction<? super T> booleanFunction)
MutableCollection
boolean
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
BooleanIterable licenses = people.collectBoolean(person -> person.hasDrivingLicense());
Example using an anonymous inner class:
BooleanIterable licenses = people.collectBoolean(new BooleanFunction<Person>() { public boolean booleanValueOf(Person person) { return person.hasDrivingLicense(); } });Co-variant example for MutableCollecton:
MutableBooleanCollection licenses = people.collectBoolean(person -> person.hasDrivingLicense());
collectBoolean
in interface MutableCollection<T>
collectBoolean
in interface RichIterable<T>
public MutableByteCollection collectByte(ByteFunction<? super T> byteFunction)
MutableCollection
byte
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
ByteIterable bytes = people.collectByte(person -> person.getCode());
Example using an anonymous inner class:
ByteIterable bytes = people.collectByte(new ByteFunction<Person>() { public byte byteValueOf(Person person) { return person.getCode(); } });Co-variant example for MutableCollection:
MutableByteCollection bytes = people.collectByte(person -> person.getCode());
collectByte
in interface MutableCollection<T>
collectByte
in interface RichIterable<T>
public MutableCharCollection collectChar(CharFunction<? super T> charFunction)
MutableCollection
char
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
CharIterable chars = people.collectChar(person -> person.getMiddleInitial());
Example using an anonymous inner class:
CharIterable chars = people.collectChar(new CharFunction<Person>() { public char charValueOf(Person person) { return person.getMiddleInitial(); } });Co-variant example for MutableCollection:
MutableCharCollection chars = people.collectChar(person -> person.getMiddleInitial());
collectChar
in interface MutableCollection<T>
collectChar
in interface RichIterable<T>
public MutableDoubleCollection collectDouble(DoubleFunction<? super T> doubleFunction)
MutableCollection
double
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
DoubleIterable doubles = people.collectDouble(person -> person.getMilesFromNorthPole());
Example using an anonymous inner class:
DoubleIterable doubles = people.collectDouble(new DoubleFunction<Person>() { public double doubleValueOf(Person person) { return person.getMilesFromNorthPole(); } });Co-variant example for MutableCollection:
MutableDoubleCollection doubles = people.collectDouble(person -> person.getMilesFromNorthPole());
collectDouble
in interface MutableCollection<T>
collectDouble
in interface RichIterable<T>
public MutableFloatCollection collectFloat(FloatFunction<? super T> floatFunction)
MutableCollection
float
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
FloatIterable floats = people.collectFloat(person -> person.getHeightInInches());
Example using an anonymous inner class:
FloatIterable floats = people.collectFloat(new FloatFunction<Person>() { public float floatValueOf(Person person) { return person.getHeightInInches(); } });Co-variant example for MutableCollection:
MutableFloatCollection floats = people.collectFloat(person -> person.getHeightInInches());
collectFloat
in interface MutableCollection<T>
collectFloat
in interface RichIterable<T>
public MutableIntCollection collectInt(IntFunction<? super T> intFunction)
MutableCollection
int
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
IntIterable ints = people.collectInt(person -> person.getAge());
Example using an anonymous inner class:
IntIterable ints = people.collectInt(new IntFunction<Person>() { public int intValueOf(Person person) { return person.getAge(); } });Co-variant example for MutableCollection:
MutableIntCollection ints = people.collectInt(person -> person.getAge());
collectInt
in interface MutableCollection<T>
collectInt
in interface RichIterable<T>
public MutableLongCollection collectLong(LongFunction<? super T> longFunction)
MutableCollection
long
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
LongIterable longs = people.collectLong(person -> person.getGuid());
Example using an anonymous inner class:
LongIterable longs = people.collectLong(new LongFunction<Person>() { public long longValueOf(Person person) { return person.getGuid(); } });Co-variant example for MutableCollection:
MutableLongCollection longs = people.collectLong(person -> person.getGuid());
collectLong
in interface MutableCollection<T>
collectLong
in interface RichIterable<T>
public MutableShortCollection collectShort(ShortFunction<? super T> shortFunction)
MutableCollection
short
iterable with the results of applying the specified function on each element
of the source collection. This method is also commonly called transform or map.
Example using a Java 8 lambda expression:
ShortIterable shorts = people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
Example using an anonymous inner class:
ShortIterable shorts = people.collectShort(new ShortFunction<Person>() { public short shortValueOf(Person person) { return person.getNumberOfJunkMailItemsReceivedPerMonth(); } });Co-variant example for MutableCollection:
MutableShortCollection shorts = people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
collectShort
in interface MutableCollection<T>
collectShort
in interface RichIterable<T>
public MutableCollection<Pair<T,Integer>> zipWithIndex()
RichIterable
RichIterable
with its indices.zipWithIndex
in interface MutableCollection<T>
zipWithIndex
in interface RichIterable<T>
RichIterable
containing pairs consisting of all elements of this RichIterable
paired with their index. Indices start at 0.RichIterable.zip(Iterable)
public <S> MutableCollection<S> selectInstancesOf(Class<S> clazz)
MutableCollection
clazz
.
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 <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 <P,V> MutableCollection<V> collectWith(Function2<? super T,? super P,? extends V> function, P parameter)
MutableCollection
RichIterable.collect(Function)
with a Function2
and specified parameter which is passed to the block.
Example using a Java 8 lambda expression:
RichIterable<Integer> integers = Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
Example using an anonymous inner class:
Function2<Integer, Integer, Integer> addParameterFunction = new Function2<Integer, Integer, Integer>() { public Integer value(Integer each, Integer parameter) { return each + parameter; } }; RichIterable<Integer> integers = Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));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 function
RichIterable
that contains the transformed elements returned by Function2.value(Object, Object)
RichIterable.collect(Function)
public <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> MutableCollection<V> flatCollect(Function<? super T,? extends Iterable<V>> function)
MutableCollection
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);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 applyfunction
public <V> MutableMultimap<V,T> groupBy(Function<? super T,? extends V> function)
MutableCollection
Example using a Java 8 method reference:
Multimap<String, Person> peopleByLastName = people.groupBy(Person::getLastName);
Example using an anonymous inner class:
Multimap<String, Person> peopleByLastName = people.groupBy(new Function<Person, String>() { public String valueOf(Person person) { return person.getLastName(); } });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> MutableMultimap<V,T> groupByEach(Function<? super T,? extends Iterable<V>> function)
RichIterable
RichIterable.groupBy(Function)
, except the result of evaluating function will return a collection of keys
for each value.groupByEach
in interface MutableCollection<T>
groupByEach
in interface RichIterable<T>
public <S> MutableCollection<Pair<T,S>> zip(Iterable<S> that)
RichIterable
RichIterable
formed from this RichIterable
and another RichIterable
by
combining corresponding elements in pairs. If one of the two RichIterable
s is longer than the other, its
remaining elements are ignored.zip
in interface MutableCollection<T>
zip
in interface RichIterable<T>
S
- the type of the second half of the returned pairsthat
- The RichIterable
providing the second half of each result pairRichIterable
containing pairs consisting of corresponding elements of this
RichIterable
and that. The length of the returned RichIterable
is the minimum of the lengths of
this RichIterable
and that.Copyright © 2004–2017. All rights reserved.