MutableSet (Goldman Sachs Collections API

All Superinterfaces:

Cloneable, Collection<T>, InternalIterable<T>, Iterable<T>, MutableCollection<T>, MutableSetIterable<T>, RichIterable<T>, Set<T>, SetIterable<T>, UnsortedSetIterable<T>

All Known Subinterfaces:

FixedSizeSet<T>
```
public interface MutableSet<T>
extends UnsortedSetIterable<T>, MutableSetIterable<T>, Cloneable
```
A MutableSet is an implementation of a JCF Set which provides methods matching the Smalltalk Collection protocol.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`MutableSet<T>`	`asSynchronized()` Returns a synchronized (thread-safe) collection backed by this collection.
`MutableSet<T>`	`asUnmodifiable()` Returns an unmodifable view of the set.
`MutableSet<T>`	`clone()`
`<V> MutableSet<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.
`MutableBooleanSet`	`collectBoolean(<any> booleanFunction)` Returns a new primitive `boolean` iterable with the results of applying the specified function on each element of the source collection.
`MutableByteSet`	`collectByte(<any> byteFunction)` Returns a new primitive `byte` iterable with the results of applying the specified function on each element of the source collection.
`MutableCharSet`	`collectChar(<any> charFunction)` Returns a new primitive `char` iterable with the results of applying the specified function on each element of the source collection.
`MutableDoubleSet`	`collectDouble(<any> doubleFunction)` Returns a new primitive `double` iterable with the results of applying the specified function on each element of the source collection.
`MutableFloatSet`	`collectFloat(<any> floatFunction)` Returns a new primitive `float` iterable with the results of applying the specified function on each element of the source collection.
`<V> MutableSet<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.
`MutableIntSet`	`collectInt(<any> intFunction)` Returns a new primitive `int` iterable with the results of applying the specified function on each element of the source collection.
`MutableLongSet`	`collectLong(<any> longFunction)` Returns a new primitive `long` iterable with the results of applying the specified function on each element of the source collection.
`MutableShortSet`	`collectShort(<any> shortFunction)` Returns a new primitive `short` iterable with the results of applying the specified function on each element of the source collection.
`<P,V> MutableSet<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.
`MutableSet<T>`	`difference(SetIterable<? extends T> subtrahendSet)` Returns the set of all members of `this` that are not members of `subtrahendSet`.
`<V> MutableSet<V>`	`flatCollect(Function<? super T,? extends Iterable<V>> function)` `flatCollect` is a special case of `RichIterable.collect(Function)`.
`<V> MutableSetMultimap<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> MutableSetMultimap<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.
`MutableSet<T>`	`intersect(SetIterable<? extends T> set)` Returns the set of all objects that are members of both `this` and `set`.
`MutableSet<T>`	`newEmpty()` Creates a new empty mutable version of the same collection type.
`PartitionMutableSet<T>`	`partition(Predicate<? super T> predicate)` Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
`<P> PartitionMutableSet<T>`	`partitionWith(Predicate2<? super T,? super P> predicate, P parameter)` Filters a collection into a PartitionIterable based on the evaluation of the predicate.
`MutableSet<UnsortedSetIterable<T>>`	`powerSet()` Returns the set whose members are all possible subsets of `this`.
`MutableSet<T>`	`reject(Predicate<? super T> predicate)` Returns all elements of the source collection that return false when evaluating of the predicate.
`<P> MutableSet<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`.
`MutableSet<T>`	`select(Predicate<? super T> predicate)` Returns all elements of the source collection that return true when evaluating the predicate.
`<S> MutableSet<S>`	`selectInstancesOf(Class<S> clazz)` Returns all elements of the source collection that are instances of the Class `clazz`.
`<P> MutableSet<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`.
`MutableSet<T>`	`symmetricDifference(SetIterable<? extends T> setB)` Returns the set of all objects that are a member of exactly one of `this` and `setB` (elements which are in one of the sets, but not in both).
`MutableSet<T>`	`tap(Procedure<? super T> procedure)` Executes the Procedure for each element in the iterable and returns `this`.
`ImmutableSet<T>`	`toImmutable()` Returns an immutable copy of this set.
`MutableSet<T>`	`union(SetIterable<? extends T> set)` Returns the set of all objects that are a member of `this` or `set` or both.
`MutableSet<T>`	`with(T element)` This method allows mutable and fixed size collections the ability to add elements to their existing elements.
`MutableSet<T>`	`withAll(Iterable<? extends T> elements)` This method allows mutable and fixed size collections the ability to add multiple elements to their existing elements.
`MutableSet<T>`	`without(T element)` This method allows mutable and fixed size collections the ability to remove elements from their existing elements.
`MutableSet<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> MutableSet<Pair<T,S>>`	`zip(Iterable<S> that)` Deprecated. in 6.0. Use `OrderedIterable.zip(Iterable)` instead.
`MutableSet<Pair<T,Integer>>`	`zipWithIndex()` Deprecated. in 6.0. Use `OrderedIterable.zipWithIndex()` instead.

Methods inherited from interface com.gs.collections.api.set.UnsortedSetIterable
asParallel

Methods inherited from interface com.gs.collections.api.set.SetIterable
cartesianProduct, differenceInto, equals, hashCode, intersectInto, isProperSubsetOf, isSubsetOf, symmetricDifferenceInto, unionInto

Methods inherited from interface com.gs.collections.api.collection.MutableCollection
addAllIterable, aggregateBy, aggregateInPlaceBy, groupByUniqueKey, injectIntoWith, removeAllIterable, removeIf, removeIfWith, retainAllIterable, selectAndRejectWith

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, each, flatCollect, getFirst, getLast, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

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

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

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

- Method Detail
  - with
```
MutableSet<T> with(T element)
```
    Description copied from interface: MutableCollection
    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.
    Specified by:
    
    with in interface MutableCollection<T>
    
    See Also:
    
    Collection.add(Object)
  - without
```
MutableSet<T> without(T element)
```
    Description copied from interface: MutableCollection
    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.
    Specified by:
    
    without in interface MutableCollection<T>
    
    See Also:
    
    Collection.remove(Object)
  - withAll
```
MutableSet<T> withAll(Iterable<? extends T> elements)
```
    Description copied from interface: MutableCollection
    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.
    Specified by:
    
    withAll in interface MutableCollection<T>
    
    See Also:
    
    Collection.addAll(Collection)
  - withoutAll
```
MutableSet<T> withoutAll(Iterable<? extends T> elements)
```
    Description copied from interface: MutableCollection
    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.
    Specified by:
    
    withoutAll in interface MutableCollection<T>
    
    See Also:
    
    Collection.removeAll(Collection)
  - newEmpty
```
MutableSet<T> newEmpty()
```
    Description copied from interface: MutableCollection
    
    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.
    
    Specified by:
    
    newEmpty in interface MutableCollection<T>
  - clone
```
MutableSet<T> clone()
```
  - tap
```
MutableSet<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()));
 
```
    Example using an anonymous inner class:
```
 RichIterable<Person> tapped =
     people.tap(new Procedure()
     {
         public void value(Person person)
         {
             LOGGER.info(person.getName());
         }
     });
 
```
    Specified by:
    
    tap in interface MutableCollection<T>
    
    Specified by:
    
    tap in interface MutableSetIterable<T>
    
    Specified by:
    
    tap in interface RichIterable<T>
    
    See Also:
    
    RichIterable.each(Procedure), InternalIterable.forEach(Procedure)
  - select
```
MutableSet<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"));
 
```
    Example using an anonymous inner class:
```
 RichIterable<Person> selected =
     people.select(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getAddress().getCity().equals("London");
         }
     });
```
    Specified by:
    
    select in interface MutableCollection<T>
    
    Specified by:
    
    select in interface MutableSetIterable<T>
    
    Specified by:
    
    select in interface RichIterable<T>
    
    Specified by:
    
    select in interface SetIterable<T>
    
    Specified by:
    
    select in interface UnsortedSetIterable<T>
  - selectWith
```
<P> MutableSet<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));
 
```
    Example using an anonymous inner class:
```
 RichIterable<Person> selected =
     people.selectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge() >= age;
         }
     }, Integer.valueOf(18));
 
```
    Specified by:
    
    selectWith in interface MutableCollection<T>
    
    Specified by:
    
    selectWith in interface MutableSetIterable<T>
    
    Specified by:
    
    selectWith in interface RichIterable<T>
    
    Specified by:
    
    selectWith in interface SetIterable<T>
    
    Specified by:
    
    selectWith in interface UnsortedSetIterable<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
```
MutableSet<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"));
 
```
    Example using an anonymous inner class:
```
 RichIterable<Person> rejected =
     people.reject(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.person.getLastName().equals("Smith");
         }
     });
 
```
    Specified by:
    
    reject in interface MutableCollection<T>
    
    Specified by:
    
    reject in interface MutableSetIterable<T>
    
    Specified by:
    
    reject in interface RichIterable<T>
    
    Specified by:
    
    reject in interface SetIterable<T>
    
    Specified by:
    
    reject in interface UnsortedSetIterable<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
```
<P> MutableSet<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));
 
```
    Example using an anonymous inner class:
```
 MutableList<Person> rejected =
     people.rejectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge() < age;
         }
     }, Integer.valueOf(18));
 
```
    Specified by:
    
    rejectWith in interface MutableCollection<T>
    
    Specified by:
    
    rejectWith in interface MutableSetIterable<T>
    
    Specified by:
    
    rejectWith in interface RichIterable<T>
    
    Specified by:
    
    rejectWith in interface SetIterable<T>
    
    Specified by:
    
    rejectWith in interface UnsortedSetIterable<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)
  - partition
```
PartitionMutableSet<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"));
 
```
    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");
         }
     });
 
```
    Specified by:
    
    partition in interface MutableCollection<T>
    
    Specified by:
    
    partition in interface MutableSetIterable<T>
    
    Specified by:
    
    partition in interface RichIterable<T>
    
    Specified by:
    
    partition in interface SetIterable<T>
  - partitionWith
```
<P> PartitionMutableSet<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");
 
```
    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");
 
```
    Specified by:
    
    partitionWith in interface MutableCollection<T>
    
    Specified by:
    
    partitionWith in interface MutableSetIterable<T>
    
    Specified by:
    
    partitionWith in interface RichIterable<T>
    
    Specified by:
    
    partitionWith in interface SetIterable<T>
  - selectInstancesOf
```
<S> MutableSet<S> selectInstancesOf(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 MutableCollection<T>
    
    Specified by:
    
    selectInstancesOf in interface MutableSetIterable<T>
    
    Specified by:
    
    selectInstancesOf in interface RichIterable<T>
    
    Specified by:
    
    selectInstancesOf in interface SetIterable<T>
    
    Specified by:
    
    selectInstancesOf in interface UnsortedSetIterable<T>
  - collect
```
<V> MutableSet<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());
 
```
    Example using an anonymous inner class:
```
 RichIterable<String> names =
     people.collect(new Function<Person, String>()
     {
         public String valueOf(Person person)
         {
             return person.getFirstName() + " " + person.getLastName();
         }
     });
 
```
    Specified by:
    
    collect in interface MutableCollection<T>
    
    Specified by:
    
    collect in interface RichIterable<T>
    
    Specified by:
    
    collect in interface UnsortedSetIterable<T>
  - collectBoolean
```
MutableBooleanSet collectBoolean(<any> 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());
 
```
    Example using an anonymous inner class:
```
 BooleanIterable licenses =
     people.collectBoolean(new BooleanFunction<Person>()
     {
         public boolean booleanValueOf(Person person)
         {
             return person.hasDrivingLicense();
         }
     });
 
```
    Specified by:
    
    collectBoolean in interface MutableCollection<T>
    
    Specified by:
    
    collectBoolean in interface RichIterable<T>
    
    Specified by:
    
    collectBoolean in interface UnsortedSetIterable<T>
  - collectByte
```
MutableByteSet collectByte(<any> 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());
 
```
    Example using an anonymous inner class:
```
 ByteIterable bytes =
     people.collectByte(new ByteFunction<Person>()
     {
         public byte byteValueOf(Person person)
         {
             return person.getCode();
         }
     });
 
```
    Specified by:
    
    collectByte in interface MutableCollection<T>
    
    Specified by:
    
    collectByte in interface RichIterable<T>
    
    Specified by:
    
    collectByte in interface UnsortedSetIterable<T>
  - collectChar
```
MutableCharSet collectChar(<any> 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());
 
```
    Example using an anonymous inner class:
```
 CharIterable chars =
     people.collectChar(new CharFunction<Person>()
     {
         public char charValueOf(Person person)
         {
             return person.getMiddleInitial();
         }
     });
 
```
    Specified by:
    
    collectChar in interface MutableCollection<T>
    
    Specified by:
    
    collectChar in interface RichIterable<T>
    
    Specified by:
    
    collectChar in interface UnsortedSetIterable<T>
  - collectDouble
```
MutableDoubleSet collectDouble(<any> 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());
 
```
    Example using an anonymous inner class:
```
 DoubleIterable doubles =
     people.collectDouble(new DoubleFunction<Person>()
     {
         public double doubleValueOf(Person person)
         {
             return person.getMilesFromNorthPole();
         }
     });
 
```
    Specified by:
    
    collectDouble in interface MutableCollection<T>
    
    Specified by:
    
    collectDouble in interface RichIterable<T>
    
    Specified by:
    
    collectDouble in interface UnsortedSetIterable<T>
  - collectFloat
```
MutableFloatSet collectFloat(<any> 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());
 
```
    Example using an anonymous inner class:
```
 FloatIterable floats =
     people.collectFloat(new FloatFunction<Person>()
     {
         public float floatValueOf(Person person)
         {
             return person.getHeightInInches();
         }
     });
 
```
    Specified by:
    
    collectFloat in interface MutableCollection<T>
    
    Specified by:
    
    collectFloat in interface RichIterable<T>
    
    Specified by:
    
    collectFloat in interface UnsortedSetIterable<T>
  - collectInt
```
MutableIntSet collectInt(<any> 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());
 
```
    Example using an anonymous inner class:
```
 IntIterable ints =
     people.collectInt(new IntFunction<Person>()
     {
         public int intValueOf(Person person)
         {
             return person.getAge();
         }
     });
 
```
    Specified by:
    
    collectInt in interface MutableCollection<T>
    
    Specified by:
    
    collectInt in interface RichIterable<T>
    
    Specified by:
    
    collectInt in interface UnsortedSetIterable<T>
  - collectLong
```
MutableLongSet collectLong(<any> 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());
 
```
    Example using an anonymous inner class:
```
 LongIterable longs =
     people.collectLong(new LongFunction<Person>()
     {
         public long longValueOf(Person person)
         {
             return person.getGuid();
         }
     });
 
```
    Specified by:
    
    collectLong in interface MutableCollection<T>
    
    Specified by:
    
    collectLong in interface RichIterable<T>
    
    Specified by:
    
    collectLong in interface UnsortedSetIterable<T>
  - collectShort
```
MutableShortSet collectShort(<any> 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());
 
```
    Example using an anonymous inner class:
```
 ShortIterable shorts =
     people.collectShort(new ShortFunction<Person>()
     {
         public short shortValueOf(Person person)
         {
             return person.getNumberOfJunkMailItemsReceivedPerMonth();
         }
     });
 
```
    Specified by:
    
    collectShort in interface MutableCollection<T>
    
    Specified by:
    
    collectShort in interface RichIterable<T>
    
    Specified by:
    
    collectShort in interface UnsortedSetIterable<T>
  - collectWith
```
<P,V> MutableSet<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));
 
```
    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));
 
```
    Specified by:
    
    collectWith in interface MutableCollection<T>
    
    Specified by:
    
    collectWith in interface RichIterable<T>
    
    Specified by:
    
    collectWith in interface UnsortedSetIterable<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> MutableSet<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 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>
    
    Specified by:
    
    collectIf in interface UnsortedSetIterable<T>
  - flatCollect
```
<V> MutableSet<V> flatCollect(Function<? super T,? extends 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;
 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 MutableCollection<T>
    
    Specified by:
    
    flatCollect in interface RichIterable<T>
    
    Specified by:
    
    flatCollect in interface UnsortedSetIterable<T>
    
    Parameters:
    
    function - The Function to apply
    
    Returns:
    
    a new flattened collection produced by applying the given function
  - asUnmodifiable
```
MutableSet<T> asUnmodifiable()
```
    Returns an unmodifable view of the set. The returned set will be Serializable if this set is Serializable.
    
    Specified by:
    
    asUnmodifiable in interface MutableCollection<T>
    
    Returns:
    
    an unmodifiable view of this set
  - asSynchronized
```
MutableSet<T> asSynchronized()
```
    Description copied from interface: MutableCollection
    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.
    Specified by:
    
    asSynchronized in interface MutableCollection<T>
    
    Returns:
    
    a synchronized view of this collection.
  - toImmutable
```
ImmutableSet<T> toImmutable()
```
    Returns an immutable copy of this set. If the set is immutable, it returns itself.
    The returned set will be Serializable if this set is Serializable.
    
    Specified by:
    
    toImmutable in interface MutableCollection<T>
    
    Specified by:
    
    toImmutable in interface SetIterable<T>
    
    Specified by:
    
    toImmutable in interface UnsortedSetIterable<T>
  - groupBy
```
<V> MutableSetMultimap<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);
 
```
    Example using an anonymous inner class:
```
 Multimap<String, Person> peopleByLastName =
     people.groupBy(new Function<Person, String>()
     {
         public String value(Person person)
         {
             return person.getLastName();
         }
     });
 
```
    Specified by:
    
    groupBy in interface MutableCollection<T>
    
    Specified by:
    
    groupBy in interface MutableSetIterable<T>
    
    Specified by:
    
    groupBy in interface RichIterable<T>
    
    Specified by:
    
    groupBy in interface UnsortedSetIterable<T>
  - groupByEach
```
<V> MutableSetMultimap<V,T> groupByEach(Function<? super T,? extends 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 MutableSetIterable<T>
    
    Specified by:
    
    groupByEach in interface RichIterable<T>
    
    Specified by:
    
    groupByEach in interface UnsortedSetIterable<T>
  - zip
```
@Deprecated
<S> MutableSet<Pair<T,S>> zip(Iterable<S> that)
```
    Deprecated. in 6.0. Use OrderedIterable.zip(Iterable) instead.
    
    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 MutableSetIterable<T>
    
    Specified by:
    
    zip in interface RichIterable<T>
    
    Specified by:
    
    zip in interface UnsortedSetIterable<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
```
@Deprecated
MutableSet<Pair<T,Integer>> zipWithIndex()
```
    Deprecated. in 6.0. Use OrderedIterable.zipWithIndex() instead.
    
    Description copied from interface: RichIterable
    
    Zips this RichIterable with its indices.
    
    Specified by:
    
    zipWithIndex in interface MutableCollection<T>
    
    Specified by:
    
    zipWithIndex in interface MutableSetIterable<T>
    
    Specified by:
    
    zipWithIndex in interface RichIterable<T>
    
    Specified by:
    
    zipWithIndex in interface SetIterable<T>
    
    Specified by:
    
    zipWithIndex in interface UnsortedSetIterable<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)
  - union
```
MutableSet<T> union(SetIterable<? extends T> set)
```
    Description copied from interface: SetIterable
    
    Returns the set of all objects that are a member of this or set or both. The union of [1, 2, 3] and [2, 3, 4] is the set [1, 2, 3, 4]. If equal elements appear in both sets, then the output will contain the copy from this.
    
    Specified by:
    
    union in interface SetIterable<T>
    
    Specified by:
    
    union in interface UnsortedSetIterable<T>
  - intersect
```
MutableSet<T> intersect(SetIterable<? extends T> set)
```
    Description copied from interface: SetIterable
    
    Returns the set of all objects that are members of both this and set. The intersection of [1, 2, 3] and [2, 3, 4] is the set [2, 3]. The output will contain instances from this, not set.
    
    Specified by:
    
    intersect in interface SetIterable<T>
    
    Specified by:
    
    intersect in interface UnsortedSetIterable<T>
  - difference
```
MutableSet<T> difference(SetIterable<? extends T> subtrahendSet)
```
    Description copied from interface: SetIterable
    
    Returns the set of all members of this that are not members of subtrahendSet. The difference of [1, 2, 3] and [2, 3, 4] is [1].
    
    Specified by:
    
    difference in interface SetIterable<T>
    
    Specified by:
    
    difference in interface UnsortedSetIterable<T>
  - symmetricDifference
```
MutableSet<T> symmetricDifference(SetIterable<? extends T> setB)
```
    Description copied from interface: SetIterable
    
    Returns the set of all objects that are a member of exactly one of this and setB (elements which are in one of the sets, but not in both). For instance, for the sets [1, 2, 3] and [2, 3, 4], the symmetric difference set is [1, 4] . It is the set difference of the union and the intersection.
    
    Specified by:
    
    symmetricDifference in interface SetIterable<T>
    
    Specified by:
    
    symmetricDifference in interface UnsortedSetIterable<T>
  - powerSet
```
MutableSet<UnsortedSetIterable<T>> powerSet()
```
    Description copied from interface: UnsortedSetIterable
    
    Returns the set whose members are all possible subsets of this. For example, the powerset of [1, 2] is [[], [1], [2], [1, 2]].
    
    Specified by:
    
    powerSet in interface UnsortedSetIterable<T>

Interface MutableSet<T>

Method Summary

Methods inherited from interface com.gs.collections.api.set.UnsortedSetIterable

Methods inherited from interface com.gs.collections.api.set.SetIterable

Methods inherited from interface com.gs.collections.api.collection.MutableCollection

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

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

Methods inherited from interface java.util.Set

Methods inherited from interface java.util.Collection

Method Detail

with

without

withAll

withoutAll

newEmpty

clone

tap

select

selectWith

reject

rejectWith

partition

partitionWith

selectInstancesOf

collect

collectBoolean

collectByte

collectChar

collectDouble

collectFloat

collectInt

collectLong

collectShort

collectWith

collectIf

flatCollect

asUnmodifiable

asSynchronized

toImmutable

groupBy

groupByEach

zip

zipWithIndex

union

intersect

difference

symmetricDifference

powerSet