MutableCollection (Goldman Sachs Collections API

All Superinterfaces:

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

All Known Subinterfaces:

FixedSizeCollection<T>, FixedSizeList<T>, FixedSizeSet<T>, MutableBag<T>, MutableList<T>, MutableSet<T>, MutableSortedBag<T>, MutableSortedSet<T>
```
public interface MutableCollection<T>
extends java.util.Collection<T>, RichIterable<T>
```
MutableCollection is an interface which extends the base java.util.Collection interface and adds several internal iterator methods, from the Smalltalk Collection protocol. These include variations of forEach, select, reject, detect, collect, injectInto, anySatisfy, allSatisfy. These include count, remove, partition, collectIf. The API also includes converter methods to convert a MutableCollection to a List (toList), to a sorted List (toSortedList), to a Set (toSet), and to a Map (toMap).
There are several extensions to MutableCollection, including MutableList, MutableSet, and MutableBag.

Method Summary

Methods
Modifier and Type	Method and Description
`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.
`MutableCollection<T>`	`asSynchronized()` Returns a synchronized (thread-safe) collection 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 collect with a `Function2` and specified parameter which is passed to the block
`<V> MutableCollection<V>`	`flatCollect(Function<? super T,? extends java.lang.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 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 he 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)`
`MutableCollection<T>`	`newEmpty()` Creates a new empty mutable version of the same collection type.
`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.
`boolean`	`removeAllIterable(java.lang.Iterable<?> iterable)`
`void`	`removeIf(Predicate<? super T> predicate)` Removes all elements in the collection that evaluate to true for the specified predicate.
`<P> void`	`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`	`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.
`<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.
`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(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.
`MutableCollection<Pair<T,java.lang.Integer>>`	`zipWithIndex()` Zips this `RichIterable` with its indices.

Methods inherited from interface java.util.Collection
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface com.gs.collections.api.RichIterable
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, detectWith, detectWithIfNone, flatCollect, getFirst, getLast, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from interface com.gs.collections.api.InternalIterable
forEach, forEachWith, forEachWithIndex

- Method Detail
 - with
```
MutableCollection<T> with(T element)
```
 This method allows mutable and fixed size collections the ability to add elements to their existing elements. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new element to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:
```
 MutableCollection list;
 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.
 See Also:
 Collection.add(Object)
 - without
```
MutableCollection<T> without(T element)
```
 This method allows mutable and fixed size collections the ability to remove elements from their existing elements. In order to support fixed size a new instance of a collection would have to be returned contaning the elements that would be left from the original collection after calling remove. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:
```
 MutableCollection list;
 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.
 See Also:
 Collection.remove(Object)
 - withAll
```
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. In order to support fixed size a new instance of a collection would have to be returned taking the elements of the original collection and appending the new elements to form the new collection. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:
```
 MutableCollection list;
 list = list.withAll(FastList.newListWith("1", "2"));
 return list;
 
```
 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.
 See Also:
 Collection.addAll(Collection)
 - withoutAll
```
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. In order to support fixed size a new instance of a collection would have to be returned contaning the elements that would be left from the original collection after calling removeAll. In the case of mutable collections, the original collection is modified, and is returned. In order to use this method properly with mutable and fixed size collections the following approach must be taken:
```
 MutableCollection list;
 list = list.withoutAll(FastList.newListWith("1", "2"));
 return list;
 
```
 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.
 See Also:
 Collection.removeAll(Collection)
 - newEmpty
```
MutableCollection<T> newEmpty()
```
 Creates a new empty mutable version of the same collection type. For example, if this instance is a FastList, this method will return a new empty FastList. If the class of this instance is immutable or fixed size (i.e. SingletonList) then a mutable alternative to the class will be provided.
 - select
```
MutableCollection<T> select(Predicate<? super T> predicate)
```
 Returns a MutableCollection with all elements that evaluate to true for the specified predicate.
```
e.g.
 return people.select(new Predicate<Person>()
 {
 public boolean value(Person person)
 {
 return person.getAddress().getCity().equals("Metuchen");
 }
 });
 
```
 Specified by:
 
 select in interface RichIterable<T>
 - selectWith
```
 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.
```
e.g.
 return integers.selectWith(PredicatesLite.equal(), Integer.valueOf(5));
 
```
 Specified by:
 
 selectWith in interface RichIterable<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
 See Also:
 RichIterable.select(Predicate)
 - reject
```
MutableCollection<T> reject(Predicate<? super T> predicate)
```
 Returns a MutableCollection with all elements that evaluate to false for the specified predicate.
```
e.g.
 return people.reject(new Predicate<Person>()
 {
 public boolean value(Person person)
 {
 return person.person.getLastName().equals("Smith");
 }
 });
 
```
```
e.g.
 return people.reject(Predicates.attributeEqual("lastName", "Smith"));
 
```
 Specified by:
 
 reject in interface RichIterable<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
 - rejectWith
```
 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.
```
e.g.
 return integers.rejectWith(PredicatesLite.equal(), Integer.valueOf(5));
 
```
 Specified by:
 
 rejectWith in interface RichIterable<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
 See Also:
 RichIterable.select(Predicate)
 - selectAndRejectWith
```
 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.
```
e.g.
 return lastNames.selectAndRejectWith(PredicatesLite.lessThan(), "Mason");
 
```
 - partition
```
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.
```
e.g.
 return people.partition(new Predicate<Person>()
 {
 public boolean accept(Person person)
 {
 return person.getAddress().getState().getName().equals("New York");
 }
 });
 
```
 Specified by:
 
 partition in interface RichIterable<T>
 - partitionWith
```
 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.
```
e.g.
 return people.partitionWith(new Predicate2<Person, String>()
 {
 public boolean accept(Person person, String state)
 {
 return person.getAddress().getState().getName().equals(state);
 }
 }, "New York");
 
```
 Specified by:
 
 partitionWith in interface RichIterable<T>
 - selectInstancesOf
```
<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.
 
 Specified by:
 
 selectInstancesOf in interface RichIterable<T>
 - removeIf
```
void removeIf(Predicate<? super T> predicate)
```
 Removes all elements in the collection that evaluate to true for the specified predicate.
```
e.g.
 return lastNames.removeIf(Predicates.isNull());
 
```
 - removeIfWith
```
 void 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.
```
e.g.
 return lastNames.removeIfWith(PredicatesLite.isNull(), null);
 
```
 - collect
```
<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.
```
e.g.
 return people.collect(new Function<Person, String>()
 {
 public String value(Person person)
 {
 return person.getFirstName() + " " + person.getLastName();
 }
 });
 
```
 Specified by:
 
 collect in interface RichIterable<T>
 - collectBoolean
```
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.
```
e.g.
 return people.collectBoolean(new BooleanFunction<Person>()
 {
 public boolean booleanValueOf(Person person)
 {
 return person.hasDrivingLicense();
 }
 });
 
```
 Specified by:
 
 collectBoolean in interface RichIterable<T>
 - collectByte
```
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.
```
e.g.
 return people.collectByte(new ByteFunction<Person>()
 {
 public byte byteValueOf(Person person)
 {
 return person.getCode();
 }
 });
 
```
 Specified by:
 
 collectByte in interface RichIterable<T>
 - collectChar
```
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.
```
e.g.
 return people.collectChar(new CharFunction<Person>()
 {
 public char charValueOf(Person person)
 {
 return person.getMiddleInitial();
 }
 });
 
```
 Specified by:
 
 collectChar in interface RichIterable<T>
 - collectDouble
```
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.
```
e.g.
 return people.collectDouble(new DoubleFunction<Person>()
 {
 public double doubleValueOf(Person person)
 {
 return person.getMilesFromNorthPole();
 }
 });
 
```
 Specified by:
 
 collectDouble in interface RichIterable<T>
 - collectFloat
```
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.
```
e.g.
 return people.collectFloat(new FloatFunction<Person>()
 {
 public float floatValueOf(Person person)
 {
 return person.getHeightInInches();
 }
 });
 
```
 Specified by:
 
 collectFloat in interface RichIterable<T>
 - collectInt
```
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.
```
e.g.
 return people.collectInt(new IntFunction<Person>()
 {
 public int intValueOf(Person person)
 {
 return person.getAge();
 }
 });
 
```
 Specified by:
 
 collectInt in interface RichIterable<T>
 - collectLong
```
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.
```
e.g.
 return people.collectLong(new LongFunction<Person>()
 {
 public long longValueOf(Person person)
 {
 return person.getGuid();
 }
 });
 
```
 Specified by:
 
 collectLong in interface RichIterable<T>
 - collectShort
```
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.
```
e.g.
 return people.collectShort(new ShortFunction<Person>()
 {
 public short shortValueOf(Person person)
 {
 return person.getNumberOfJunkMailItemsReceivedPerMonth();
 }
 });
 
```
 Specified by:
 
 collectShort in interface RichIterable<T>
 - collectWith
```
<P,V> MutableCollection<V> collectWith(Function2<? super T,? super P,? extends V> function,
 P parameter)
```
 Description copied from interface: RichIterable
 Same as collect with a Function2 and specified parameter which is passed to the block
```
e.g.
 Function2 addParameterFunction =
 new Function2()
 {
 public Integer value(final Integer each, final Integer parameter)
 {
 return each + parameter;
 }
 };
 FastList.newListWith(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
 
```
 Specified by:
 
 collectWith in interface RichIterable<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)
 See Also:
 RichIterable.collect(Function)
 - collectIf
```
<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.
```
e.g.
 Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
 
```
 Specified by:
 
 collectIf in interface RichIterable<T>
 - flatCollect
```
<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 = new Function<Person, List<Address>>() {
 public List<Address> valueOf(Person person) {
 return person.getAddresses();
 }
 };
 MutableList<Person> people = ...;
 
```
 Using collect returns a collection of collections of addresses.
```
 MutableList<List<Address>> addresses = people.collect(addressFunction);
 
```
 Using flatCollect returns a single flattened list of addresses.
```
 MutableList<Address> addresses = people.flatCollect(addressFunction);
 
```
 Specified by:
 
 flatCollect in interface RichIterable<T>
 
 Parameters:
 function - The Function to apply
 
 Returns:
 a new flattened collection produced by applying the given function
 - injectIntoWith
```
<IV,P> IV injectIntoWith(IV injectValue,
 Function3<? super IV,? super T,? super P,? extends IV> function,
 P parameter)
```
 - asUnmodifiable
```
MutableCollection<T> asUnmodifiable()
```
 Returns an unmodifiable view of this collection. This method allows modules to provide users with "read-only" access to internal collections. Query operations on the returned collection "read through" to this collection, and attempts to modify the returned collection, whether direct or via its iterator, result in an UnsupportedOperationException.
 The returned collection does not pass the hashCode and equals operations through to the backing collection, but relies on Object's equals and hashCode methods. This is necessary to preserve the contracts of these operations in the case that the backing collection is a set or a list.
 
 The returned collection will be serializable if this collection is serializable.
 
 Returns:
 an unmodifiable view of this collection.
 Since:
 
 1.0
 - asSynchronized
```
MutableCollection<T> asSynchronized()
```
 Returns a synchronized (thread-safe) collection backed by this collection. In order to guarantee serial access, it is critical that all access to the backing collection is accomplished through the returned collection.
 It is imperative that the user manually synchronize on the returned collection when iterating over it using the standard JDK iterator or JDK 5 for loop.
```
 MutableCollection collection = myCollection.asSynchronized();
 ...
 synchronized(collection)
 {
 Iterator i = c.iterator(); // Must be in the synchronized block
 while (i.hasNext())
 foo(i.next());
 }
 
```
 Failure to follow this advice may result in non-deterministic behavior.
 The preferred way of iterating over a synchronized collection is to use the collection.forEach() method which is properly synchronized internally.
```
 MutableCollection collection = myCollection.asSynchronized();
 ...
 collection.forEach(new Procedure()
 {
 public void value(Object each)
 {
 ...
 }
 });
 
```
 The returned collection does not pass the hashCode and equals operations through to the backing collection, but relies on Object's equals and hashCode methods. This is necessary to preserve the contracts of these operations in the case that the backing collection is a set or a list.
 The returned collection will be serializable if this collection is serializable.
 Returns:
 a synchronized view of this collection.
 Since:
 
 1.0
 - toImmutable
```
ImmutableCollection<T> toImmutable()
```
 Converts this MutableCollection to an ImmutableCollection.
 
 Since:
 
 1.0
 - groupBy
```
<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.
```
e.g.
 return people.groupBy(new Function<Person, String>()
 {
 public String value(Person person)
 {
 return person.getFirstName() + " " + person.getLastName();
 }
 });
 
```
 Specified by:
 
 groupBy in interface RichIterable<T>
 - groupByEach
```
<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 RichIterable<T>
 - groupByUniqueKey
```
<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 he 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 RichIterable<T>
 
 See Also:
 RichIterable.groupBy(Function)
 - zip
```
<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 RichIterable<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.
 - zipWithIndex
```
MutableCollection<Pair<T,java.lang.Integer>> zipWithIndex()
```
 Description copied from interface: RichIterable
 
 Zips this RichIterable with its indices.
 
 Specified by:
 
 zipWithIndex in interface RichIterable<T>
 
 Returns:
 A new RichIterable containing pairs consisting of all elements of this RichIterable paired with their index. Indices start at 0.
 See Also:
 RichIterable.zip(Iterable)
 - addAllIterable
```
boolean addAllIterable(java.lang.Iterable<? extends T> iterable)
```
 Since:
 
 1.0
 
 See Also:
 Collection.addAll(Collection)
 - removeAllIterable
```
boolean removeAllIterable(java.lang.Iterable<?> iterable)
```
 Since:
 
 1.0
 
 See Also:
 Collection.removeAll(Collection)
 - retainAllIterable
```
boolean retainAllIterable(java.lang.Iterable<?> iterable)
```
 Since:
 
 1.0
 
 See Also:
 Collection.retainAll(Collection)
 - aggregateInPlaceBy
```
<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 RichIterable<T>
 - aggregateBy
```
<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 RichIterable<T>

Interface MutableCollection<T>

Method Summary

Methods inherited from interface java.util.Collection

Methods inherited from interface com.gs.collections.api.RichIterable

Methods inherited from interface com.gs.collections.api.InternalIterable

Method Detail

with

without

withAll

withoutAll

newEmpty

select

selectWith

reject

rejectWith

selectAndRejectWith

partition

partitionWith

selectInstancesOf

removeIf

removeIfWith

collect

collectBoolean

collectByte

collectChar

collectDouble

collectFloat

collectInt

collectLong

collectShort

collectWith

collectIf

flatCollect

injectIntoWith

asUnmodifiable

asSynchronized

toImmutable

groupBy

groupByEach

groupByUniqueKey

zip

zipWithIndex

addAllIterable

removeAllIterable

retainAllIterable

aggregateInPlaceBy

aggregateBy