SetIterable (GS Collections

All Superinterfaces:

InternalIterable<T>, Iterable<T>, RichIterable<T>

All Known Subinterfaces:

FixedSizeSet<T>, ImmutableSet<T>, ImmutableSortedSet<T>, MutableSet<T>, MutableSortedSet<T>, SortedSetIterable<T>, UnsortedSetIterable<T>

All Known Implementing Classes:

AbstractImmutableSet, AbstractMutableSet, MultiReaderUnifiedSet, SetAdapter, SortedSetAdapter, SynchronizedMutableSet, SynchronizedSortedSet, TreeSortedSet, UnifiedSet, UnifiedSetWithHashingStrategy, UnmodifiableMutableSet, UnmodifiableSortedSet
```
public interface SetIterable<T>
extends RichIterable<T>
```
A Read-only Set api, with the minor exception inherited from java.lang.Iterable (iterable.iterator().remove()).

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`<B> LazyIterable<Pair<T,B>>`	`cartesianProduct(SetIterable<B> set)` Returns the set whose members are all possible ordered pairs (a, b) where a is a member of `this` and b is a member of `set`.
`SetIterable<T>`	`difference(SetIterable<? extends T> subtrahendSet)` Returns the set of all members of `this` that are not members of `subtrahendSet`.
`<R extends Set<T>> R`	`differenceInto(SetIterable<? extends T> subtrahendSet, R targetSet)` Same as `difference(SetIterable)` but adds all the objects to `targetSet` and returns it.
`boolean`	`equals(Object o)` Follows the same general contract as `Set.equals(Object)`.
`int`	`hashCode()` Follows the same general contract as `Set.hashCode()`.
`SetIterable<T>`	`intersect(SetIterable<? extends T> set)` Returns the set of all objects that are members of both `this` and `set`.
`<R extends Set<T>> R`	`intersectInto(SetIterable<? extends T> set, R targetSet)` Same as `intersect(SetIterable)` but adds all the objects to `targetSet` and returns it.
`boolean`	`isProperSubsetOf(SetIterable<? extends T> candidateSuperset)` Returns true if all the members of `this` are also members of `candidateSuperset` and the two sets are not equal.
`boolean`	`isSubsetOf(SetIterable<? extends T> candidateSuperset)` Returns true if all the members of `this` are also members of `candidateSuperset`.
`PartitionSet<T>`	`partition(Predicate<? super T> predicate)` Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
`<P> PartitionSet<T>`	`partitionWith(Predicate2<? super T,? super P> predicate, P parameter)` Filters a collection into a PartitionIterable based on the evaluation of the predicate.
`SetIterable<T>`	`reject(Predicate<? super T> predicate)` Returns all elements of the source collection that return false when evaluating of the predicate.
`<P> SetIterable<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`.
`SetIterable<T>`	`select(Predicate<? super T> predicate)` Returns all elements of the source collection that return true when evaluating the predicate.
`<S> SetIterable<S>`	`selectInstancesOf(Class<S> clazz)` Returns all elements of the source collection that are instances of the Class `clazz`.
`<P> SetIterable<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`.
`SetIterable<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).
`<R extends Set<T>> R`	`symmetricDifferenceInto(SetIterable<? extends T> set, R targetSet)` Same as `symmetricDifference(SetIterable)` but adds all the objects to `targetSet` and returns it.
`SetIterable<T>`	`union(SetIterable<? extends T> set)` Returns the set of all objects that are a member of `this` or `set` or both.
`<R extends Set<T>> R`	`unionInto(SetIterable<? extends T> set, R targetSet)` Same as `union(SetIterable)` but adds all the objects to `targetSet` and returns it.
`SetIterable<Pair<T,Integer>>`	`zipWithIndex()` Zips this `RichIterable` with its indices.

Methods inherited from interface com.gs.collections.api.RichIterable
aggregateBy, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collect, collectBoolean, collectBoolean, collectByte, collectByte, collectChar, collectChar, collectDouble, collectDouble, collectFloat, collectFloat, collectIf, collectIf, collectInt, collectInt, collectLong, collectLong, collectShort, collectShort, collectWith, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, flatCollect, getFirst, getLast, groupBy, groupBy, groupByEach, 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, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zip, zipWithIndex

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

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

- Method Detail
 - union
```
SetIterable<T> union(SetIterable<? extends T> set)
```
 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.
 - unionInto
```
<R extends Set<T>> R unionInto(SetIterable<? extends T> set,
 R targetSet)
```
 Same as union(SetIterable) but adds all the objects to targetSet and returns it.
 - intersect
```
SetIterable<T> intersect(SetIterable<? extends T> set)
```
 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.
 - intersectInto
```
<R extends Set<T>> R intersectInto(SetIterable<? extends T> set,
 R targetSet)
```
 Same as intersect(SetIterable) but adds all the objects to targetSet and returns it.
 - difference
```
SetIterable<T> difference(SetIterable<? extends T> subtrahendSet)
```
 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].
 - differenceInto
```
<R extends Set<T>> R differenceInto(SetIterable<? extends T> subtrahendSet,
 R targetSet)
```
 Same as difference(SetIterable) but adds all the objects to targetSet and returns it.
 - symmetricDifference
```
SetIterable<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). 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.
 - symmetricDifferenceInto
```
<R extends Set<T>> R symmetricDifferenceInto(SetIterable<? extends T> set,
 R targetSet)
```
 Same as symmetricDifference(SetIterable) but adds all the objects to targetSet and returns it.
 - isSubsetOf
```
boolean isSubsetOf(SetIterable<? extends T> candidateSuperset)
```
 Returns true if all the members of this are also members of candidateSuperset. For example, [1, 2] is a subset of [1, 2, 3], but [1, 4] is not.
 - isProperSubsetOf
```
boolean isProperSubsetOf(SetIterable<? extends T> candidateSuperset)
```
 Returns true if all the members of this are also members of candidateSuperset and the two sets are not equal. For example, [1, 2] is a proper subset of [1, 2, 3], but [1, 2, 3] is not.
 - cartesianProduct
```
 LazyIterable<Pair<T,B>> cartesianProduct(SetIterable set)
```
 Returns the set whose members are all possible ordered pairs (a, b) where a is a member of this and b is a member of set.
 - select
```
SetIterable<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.
```
e.g.
 return people.select(new Predicate<Person>()
 {
 public boolean accept(Person person)
 {
 return person.getAddress().getCity().equals("Metuchen");
 }
 });
 
```
 Specified by:
 
 select in interface RichIterable<T>
 - selectWith
```
 SetIterable<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.
 
 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
```
SetIterable<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)).
```
e.g.
 return people.reject(new Predicate<Person>()
 {
 public boolean accept(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
```
 SetIterable<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.
 
 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)
 - partition
```
PartitionSet<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
```
 PartitionSet<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> SetIterable<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 RichIterable<T>
 - zipWithIndex
```
SetIterable<Pair<T,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)
 - equals
```
boolean equals(Object o)
```
 Follows the same general contract as Set.equals(Object).
 
 Overrides:
 
 equals in class Object
 - hashCode
```
int hashCode()
```
 Follows the same general contract as Set.hashCode().
 
 Overrides:
 
 hashCode in class Object

Interface SetIterable<T>

Method Summary

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

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

Methods inherited from interface java.lang.Iterable

Method Detail

union

unionInto

intersect

intersectInto

difference

differenceInto

symmetricDifference

symmetricDifferenceInto

isSubsetOf

isProperSubsetOf

cartesianProduct

select

selectWith

reject

rejectWith

partition

partitionWith

selectInstancesOf

zipWithIndex

equals

hashCode