java.lang.Object
- org.eclipse.collections.impl.AbstractRichIterable<T>
- - org.eclipse.collections.impl.collection.immutable.AbstractImmutableCollection<T>
 - - org.eclipse.collections.impl.set.immutable.AbstractImmutableSet<T>

All Implemented Interfaces:

java.lang.Iterable<T>, java.util.Collection<T>, java.util.Set<T>, ImmutableCollection<T>, InternalIterable<T>, RichIterable<T>, ImmutableSet<T>, ImmutableSetIterable<T>, SetIterable<T>, UnsortedSetIterable<T>

Direct Known Subclasses:

ImmutableDoubletonSet, ImmutableEmptySet, ImmutableEmptySetWithHashingStrategy, ImmutableQuadrupletonSet, ImmutableSingletonSet, ImmutableTripletonSet, ImmutableUnifiedSet, ImmutableUnifiedSetWithHashingStrategy
```
public abstract class AbstractImmutableSet<T>
extends AbstractImmutableCollection<T>
implements ImmutableSet<T>, java.util.Set<T>
```
This class is the parent class for all ImmutableSets. All implementations of ImmutableSet must implement the Set interface so anArraySet.equals(anImmutableSet) can return true when the contents and order are the same.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

protected class AbstractImmutableSet.ImmutableSetIterator

Constructor Summary

Constructors
Constructor Description

AbstractImmutableSet()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`ParallelUnsortedSetIterable<T>`	`asParallel(java.util.concurrent.ExecutorService executorService, int batchSize)`	Returns a parallel iterable of this SetIterable.
`<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`.
`java.util.Set<T>`	`castToSet()`
`<V> ImmutableSet<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.
`ImmutableBooleanSet`	`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.
`ImmutableByteSet`	`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.
`ImmutableCharSet`	`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.
`ImmutableDoubleSet`	`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.
`ImmutableFloatSet`	`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> ImmutableSet<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.
`ImmutableIntSet`	`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.
`ImmutableLongSet`	`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.
`ImmutableShortSet`	`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> ImmutableSet<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.
`ImmutableSet<T>`	`difference(SetIterable<? extends T> subtrahendSet)`	Returns the set of all members of `this` that are not members of `subtrahendSet`.
`<R extends java.util.Set<T>> R`	`differenceInto(SetIterable<? extends T> subtrahendSet, R targetSet)`	Same as `SetIterable.difference(SetIterable)` but adds all the objects to `targetSet` and returns it.
`<V> ImmutableSet<V>`	`flatCollect(Function<? super T,? extends java.lang.Iterable<V>> function)`	`flatCollect` is a special case of `RichIterable.collect(Function)`.
`<V> ImmutableSetMultimap<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,R extends MutableMultimap<V,T>> R`	`groupBy(Function<? super T,? extends V> function, R target)`	Same as `RichIterable.groupBy(Function)`, except that the results are gathered into the specified `target` multimap.
`<V> ImmutableSetMultimap<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,R extends MutableMultimap<V,T>> R`	`groupByEach(Function<? super T,? extends java.lang.Iterable<V>> function, R target)`	Same as `RichIterable.groupByEach(Function)`, except that the results are gathered into the specified `target` multimap.
`ImmutableSet<T>`	`intersect(SetIterable<? extends T> set)`	Returns the set of all objects that are members of both `this` and `set`.
`<R extends java.util.Set<T>> R`	`intersectInto(SetIterable<? extends T> set, R targetSet)`	Same as `SetIterable.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`.
`protected MutableCollection<T>`	`newMutable(int size)`
`ImmutableSet<T>`	`newWith(T element)`	This method is similar to the `with` method in `MutableCollection` with the difference that a new copy of this collection with the element appended will be returned.
`ImmutableSet<T>`	`newWithAll(java.lang.Iterable<? extends T> elements)`	This method is similar to the `withAll` method in `MutableCollection` with the difference that a new copy of this collection with the elements appended will be returned.
`ImmutableSet<T>`	`newWithout(T element)`	This method is similar to the `without` method in `MutableCollection` with the difference that a new copy of this collection with the element removed will be returned.
`ImmutableSet<T>`	`newWithoutAll(java.lang.Iterable<? extends T> elements)`	This method is similar to the `withoutAll` method in `MutableCollection` with the difference that a new copy of this collection with the elements removed will be returned.
`protected int`	`nullSafeHashCode(java.lang.Object element)`
`PartitionImmutableSet<T>`	`partition(Predicate<? super T> predicate)`	Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
`<P> PartitionImmutableSet<T>`	`partitionWith(Predicate2<? super T,? super P> predicate, P parameter)`	Filters a collection into a PartitionIterable based on the evaluation of the predicate.
`ImmutableSet<UnsortedSetIterable<T>>`	`powerSet()`	Returns the set whose members are all possible subsets of `this`.
`ImmutableSet<T>`	`reject(Predicate<? super T> predicate)`	Returns all elements of the source collection that return false when evaluating of the predicate.
`<P> ImmutableSet<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`.
`ImmutableSet<T>`	`select(Predicate<? super T> predicate)`	Returns all elements of the source collection that return true when evaluating the predicate.
`<S> ImmutableSet<S>`	`selectInstancesOf(java.lang.Class<S> clazz)`	Returns all elements of the source collection that are instances of the Class `clazz`.
`<P> ImmutableSet<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`.
`ImmutableSet<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 java.util.Set<T>> R`	`symmetricDifferenceInto(SetIterable<? extends T> set, R targetSet)`	Same as `SetIterable.symmetricDifference(SetIterable)` but adds all the objects to `targetSet` and returns it.
`ImmutableSet<T>`	`tap(Procedure<? super T> procedure)`	Executes the Procedure for each element in the iterable and returns `this`.
`ImmutableSet<T>`	`toImmutable()`	Converts the UnsortedSetIterable to an immutable implementation.
`ImmutableSet<T>`	`union(SetIterable<? extends T> set)`	Returns the set of all objects that are a member of `this` or `set` or both.
`<R extends java.util.Set<T>> R`	`unionInto(SetIterable<? extends T> set, R targetSet)`	Same as `SetIterable.union(SetIterable)` but adds all the objects to `targetSet` and returns it.
`<S> ImmutableSet<Pair<T,S>>`	`zip(java.lang.Iterable<S> that)`	Deprecated. in 6.0.
`ImmutableSet<Pair<T,java.lang.Integer>>`	`zipWithIndex()`	Deprecated. in 6.0.

Methods inherited from class org.eclipse.collections.impl.collection.immutable.AbstractImmutableCollection
add, addAll, castToCollection, chunk, clear, countBy, countByEach, countByWith, groupByUniqueKey, parallelStream, reduce, remove, removeAll, removeAllFrom, retainAll, spliterator, stream, sumByDouble, sumByFloat, sumByInt, sumByLong, toArray, toArray

Methods inherited from class org.eclipse.collections.impl.AbstractRichIterable
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, asLazy, collect, collectIf, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectOptional, detectWith, detectWithIfNone, detectWithOptional, flatCollect, forEach, forEachWith, forEachWithIndex, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toBiMap, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Methods inherited from interface org.eclipse.collections.api.collection.ImmutableCollection
aggregateBy, aggregateInPlaceBy, castToCollection, countBy, countByEach, countByWith, flatCollectWith, groupByUniqueKey, parallelStream, reduceBy, spliterator, stream, sumByDouble, sumByFloat, sumByInt, sumByLong

Methods inherited from interface org.eclipse.collections.api.set.ImmutableSet
flatCollectWith, toImmutableSet

Methods inherited from interface org.eclipse.collections.api.InternalIterable
forEach, forEachWith, forEachWithIndex

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

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 org.eclipse.collections.api.set.SetIterable
equals, hashCode

- Constructor Detail
 - AbstractImmutableSet
```
public AbstractImmutableSet()
```
- Method Detail
 - castToSet
```
public java.util.Set<T> castToSet()
```
 Specified by:
 
 castToSet in interface ImmutableSet<T>
 - nullSafeHashCode
```
protected int nullSafeHashCode(java.lang.Object element)
```
 - newWith
```
public ImmutableSet<T> newWith(T element)
```
 Description copied from interface: ImmutableCollection
 
 This method is similar to the with method in MutableCollection with the difference that a new copy of this collection with the element appended will be returned.
 
 Specified by:
 
 newWith in interface ImmutableCollection<T>
 
 Specified by:
 
 newWith in interface ImmutableSet<T>
 - newWithout
```
public ImmutableSet<T> newWithout(T element)
```
 Description copied from interface: ImmutableCollection
 
 This method is similar to the without method in MutableCollection with the difference that a new copy of this collection with the element removed will be returned.
 
 Specified by:
 
 newWithout in interface ImmutableCollection<T>
 
 Specified by:
 
 newWithout in interface ImmutableSet<T>
 - newWithAll
```
public ImmutableSet<T> newWithAll(java.lang.Iterable<? extends T> elements)
```
 Description copied from interface: ImmutableCollection
 
 This method is similar to the withAll method in MutableCollection with the difference that a new copy of this collection with the elements appended will be returned.
 
 Specified by:
 
 newWithAll in interface ImmutableCollection<T>
 
 Specified by:
 
 newWithAll in interface ImmutableSet<T>
 - newWithoutAll
```
public ImmutableSet<T> newWithoutAll(java.lang.Iterable<? extends T> elements)
```
 Description copied from interface: ImmutableCollection
 
 This method is similar to the withoutAll method in MutableCollection with the difference that a new copy of this collection with the elements removed will be returned.
 
 Specified by:
 
 newWithoutAll in interface ImmutableCollection<T>
 
 Specified by:
 
 newWithoutAll in interface ImmutableSet<T>
 - tap
```
public ImmutableSet<T> tap(Procedure<? super T> procedure)
```
 Description copied from interface: RichIterable
 Executes the Procedure for each element in the iterable and returns this.
 Example using a Java 8 lambda expression:
 RichIterable<Person> tapped = people.tap(person -> LOGGER.info(person.getName()));
 Specified by:
 
 tap in interface ImmutableCollection<T>
 
 Specified by:
 
 tap in interface ImmutableSet<T>
 
 Specified by:
 
 tap in interface ImmutableSetIterable<T>
 
 Specified by:
 
 tap in interface RichIterable<T>
 
 Specified by:
 
 tap in interface SetIterable<T>
 
 Specified by:
 
 tap in interface UnsortedSetIterable<T>
 
 See Also:
 
 RichIterable.each(Procedure), RichIterable.forEach(Procedure)
 - select
```
public ImmutableSet<T> select(Predicate<? super T> predicate)
```
 Description copied from interface: RichIterable
 Returns all elements of the source collection that return true when evaluating the predicate. This method is also commonly called filter.
 Example using a Java 8 lambda expression:
 RichIterable<Person> selected = people.select(person -> person.getAddress().getCity().equals("London"));
 Specified by:
 
 select in interface ImmutableCollection<T>
 
 Specified by:
 
 select in interface ImmutableSet<T>
 
 Specified by:
 
 select in interface ImmutableSetIterable<T>
 
 Specified by:
 
 select in interface RichIterable<T>
 
 Specified by:
 
 select in interface SetIterable<T>
 
 Specified by:
 
 select in interface UnsortedSetIterable<T>
 - selectWith
```
public  ImmutableSet<T> selectWith(Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: RichIterable
 Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
 E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years
 Example using a Java 8 lambda expression:
 RichIterable<Person> selected = people.selectWith((Person person, Integer age) -> person.getAge()>= age, Integer.valueOf(18));
 Specified by:
 
 selectWith in interface ImmutableCollection<T>
 
 Specified by:
 
 selectWith in interface ImmutableSet<T>
 
 Specified by:
 
 selectWith in interface ImmutableSetIterable<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
```
public ImmutableSet<T> reject(Predicate<? super T> predicate)
```
 Description copied from interface: RichIterable
 Returns all elements of the source collection that return false when evaluating of the predicate. This method is also sometimes called filterNot and is the equivalent of calling iterable.select(Predicates.not(predicate)).
 Example using a Java 8 lambda expression:
 RichIterable<Person> rejected = people.reject(person -> person.person.getLastName().equals("Smith"));
 Specified by:
 
 reject in interface ImmutableCollection<T>
 
 Specified by:
 
 reject in interface ImmutableSet<T>
 
 Specified by:
 
 reject in interface ImmutableSetIterable<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
```
public  ImmutableSet<T> rejectWith(Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: RichIterable
 Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
 E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years
 Example using a Java 8 lambda expression:
 RichIterable<Person> rejected = people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18));
 Specified by:
 
 rejectWith in interface ImmutableCollection<T>
 
 Specified by:
 
 rejectWith in interface ImmutableSet<T>
 
 Specified by:
 
 rejectWith in interface ImmutableSetIterable<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
```
public PartitionImmutableSet<T> partition(Predicate<? super T> predicate)
```
 Description copied from interface: RichIterable
 Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
 Example using a Java 8 lambda expression:
 PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partition(person -> person.getAddress().getState().getName().equals("New York"));
 Specified by:
 
 partition in interface ImmutableCollection<T>
 
 Specified by:
 
 partition in interface ImmutableSet<T>
 
 Specified by:
 
 partition in interface ImmutableSetIterable<T>
 
 Specified by:
 
 partition in interface RichIterable<T>
 
 Specified by:
 
 partition in interface SetIterable<T>
 - partitionWith
```
public  PartitionImmutableSet<T> partitionWith(Predicate2<? super T,? super P> predicate,
 P parameter)
```
 Description copied from interface: RichIterable
 Filters a collection into a PartitionIterable based on the evaluation of the predicate.
 Example using a Java 8 lambda expression:
 PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
 Specified by:
 
 partitionWith in interface ImmutableCollection<T>
 
 Specified by:
 
 partitionWith in interface ImmutableSet<T>
 
 Specified by:
 
 partitionWith in interface ImmutableSetIterable<T>
 
 Specified by:
 
 partitionWith in interface RichIterable<T>
 
 Specified by:
 
 partitionWith in interface SetIterable<T>
 - selectInstancesOf
```
public <S> ImmutableSet<S> selectInstancesOf(java.lang.Class<S> clazz)
```
 Description copied from interface: RichIterable
 Returns all elements of the source collection that are instances of the Class clazz.
 RichIterable<Integer> integers = List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
 Specified by:
 
 selectInstancesOf in interface ImmutableCollection<T>
 
 Specified by:
 
 selectInstancesOf in interface ImmutableSet<T>
 
 Specified by:
 
 selectInstancesOf in interface ImmutableSetIterable<T>
 
 Specified by:
 
 selectInstancesOf in interface RichIterable<T>
 
 Specified by:
 
 selectInstancesOf in interface SetIterable<T>
 
 Specified by:
 
 selectInstancesOf in interface UnsortedSetIterable<T>
 - collect
```
public <V> ImmutableSet<V> collect(Function<? super T,? extends V> function)
```
 Description copied from interface: RichIterable
 Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
 Example using a Java 8 lambda expression:
 RichIterable<String> names = people.collect(person -> person.getFirstName() + " " + person.getLastName());
 Specified by:
 
 collect in interface ImmutableCollection<T>
 
 Specified by:
 
 collect in interface ImmutableSet<T>
 
 Specified by:
 
 collect in interface RichIterable<T>
 
 Specified by:
 
 collect in interface UnsortedSetIterable<T>
 - collectBoolean
```
public ImmutableBooleanSet collectBoolean(BooleanFunction<? super T> booleanFunction)
```
 Description copied from interface: RichIterable
 Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
 Example using a Java 8 lambda expression:
 BooleanIterable licenses = people.collectBoolean(person -> person.hasDrivingLicense());
 Specified by:
 
 collectBoolean in interface ImmutableCollection<T>
 
 Specified by:
 
 collectBoolean in interface ImmutableSet<T>
 
 Specified by:
 
 collectBoolean in interface RichIterable<T>
 
 Specified by:
 
 collectBoolean in interface UnsortedSetIterable<T>
 - collectByte
```
public ImmutableByteSet collectByte(ByteFunction<? super T> byteFunction)
```
 Description copied from interface: RichIterable
 Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
 Example using a Java 8 lambda expression:
 ByteIterable bytes = people.collectByte(person -> person.getCode());
 Specified by:
 
 collectByte in interface ImmutableCollection<T>
 
 Specified by:
 
 collectByte in interface ImmutableSet<T>
 
 Specified by:
 
 collectByte in interface RichIterable<T>
 
 Specified by:
 
 collectByte in interface UnsortedSetIterable<T>
 - collectChar
```
public ImmutableCharSet collectChar(CharFunction<? super T> charFunction)
```
 Description copied from interface: RichIterable
 Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
 Example using a Java 8 lambda expression:
 CharIterable chars = people.collectChar(person -> person.getMiddleInitial());
 Specified by:
 
 collectChar in interface ImmutableCollection<T>
 
 Specified by:
 
 collectChar in interface ImmutableSet<T>
 
 Specified by:
 
 collectChar in interface RichIterable<T>
 
 Specified by:
 
 collectChar in interface UnsortedSetIterable<T>
 - collectDouble
```
public ImmutableDoubleSet collectDouble(DoubleFunction<? super T> doubleFunction)
```
 Description copied from interface: RichIterable
 Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
 Example using a Java 8 lambda expression:
 DoubleIterable doubles = people.collectDouble(person -> person.getMilesFromNorthPole());
 Specified by:
 
 collectDouble in interface ImmutableCollection<T>
 
 Specified by:
 
 collectDouble in interface ImmutableSet<T>
 
 Specified by:
 
 collectDouble in interface RichIterable<T>
 
 Specified by:
 
 collectDouble in interface UnsortedSetIterable<T>
 - collectFloat
```
public ImmutableFloatSet collectFloat(FloatFunction<? super T> floatFunction)
```
 Description copied from interface: RichIterable
 Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
 Example using a Java 8 lambda expression:
 FloatIterable floats = people.collectFloat(person -> person.getHeightInInches());
 Specified by:
 
 collectFloat in interface ImmutableCollection<T>
 
 Specified by:
 
 collectFloat in interface ImmutableSet<T>
 
 Specified by:
 
 collectFloat in interface RichIterable<T>
 
 Specified by:
 
 collectFloat in interface UnsortedSetIterable<T>
 - collectInt
```
public ImmutableIntSet collectInt(IntFunction<? super T> intFunction)
```
 Description copied from interface: RichIterable
 Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
 Example using a Java 8 lambda expression:
 IntIterable ints = people.collectInt(person -> person.getAge());
 Specified by:
 
 collectInt in interface ImmutableCollection<T>
 
 Specified by:
 
 collectInt in interface ImmutableSet<T>
 
 Specified by:
 
 collectInt in interface RichIterable<T>
 
 Specified by:
 
 collectInt in interface UnsortedSetIterable<T>
 - collectLong
```
public ImmutableLongSet collectLong(LongFunction<? super T> longFunction)
```
 Description copied from interface: RichIterable
 Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
 Example using a Java 8 lambda expression:
 LongIterable longs = people.collectLong(person -> person.getGuid());
 Specified by:
 
 collectLong in interface ImmutableCollection<T>
 
 Specified by:
 
 collectLong in interface ImmutableSet<T>
 
 Specified by:
 
 collectLong in interface RichIterable<T>
 
 Specified by:
 
 collectLong in interface UnsortedSetIterable<T>
 - collectShort
```
public ImmutableShortSet collectShort(ShortFunction<? super T> shortFunction)
```
 Description copied from interface: RichIterable
 Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
 Example using a Java 8 lambda expression:
 ShortIterable shorts = people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
 Specified by:
 
 collectShort in interface ImmutableCollection<T>
 
 Specified by:
 
 collectShort in interface ImmutableSet<T>
 
 Specified by:
 
 collectShort in interface RichIterable<T>
 
 Specified by:
 
 collectShort in interface UnsortedSetIterable<T>
 - collectWith
```
public <P,V> ImmutableSet<V> collectWith(Function2<? super T,? super P,? extends V> function,
 P parameter)
```
 Description copied from interface: RichIterable
 Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.
 Example using a Java 8 lambda expression:
 RichIterable<Integer> integers = Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
 Specified by:
 
 collectWith in interface ImmutableCollection<T>
 
 Specified by:
 
 collectWith in interface ImmutableSet<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
```
public <V> ImmutableSet<V> collectIf(Predicate<? super T> predicate,
 Function<? super T,? extends V> function)
```
 Description copied from interface: RichIterable
 Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate. This is the optimized equivalent of calling iterable.select(predicate).collect(function).
 Example using a Java 8 lambda and method reference:
 RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(e -> e != null, Object::toString);
 
 Example using Predicates factory:
 RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString());
 Specified by:
 
 collectIf in interface ImmutableCollection<T>
 
 Specified by:
 
 collectIf in interface ImmutableSet<T>
 
 Specified by:
 
 collectIf in interface RichIterable<T>
 
 Specified by:
 
 collectIf in interface UnsortedSetIterable<T>
 - flatCollect
```
public <V> ImmutableSet<V> flatCollect(Function<? super T,? extends java.lang.Iterable<V>> function)
```
 Description copied from interface: RichIterable
 flatCollect is a special case of RichIterable.collect(Function). With collect, when the Function returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.
 Consider the following example where we have a Person class, and each Person has a list of Address objects. Take the following Function:
 Function<Person, List<Address>> addressFunction = Person::getAddresses; RichIterable<Person> people = ...;
 Using collect returns a collection of collections of addresses.
 RichIterable<List<Address>> addresses = people.collect(addressFunction);
 Using flatCollect returns a single flattened list of addresses.
 RichIterable<Address> addresses = people.flatCollect(addressFunction);
 Specified by:
 
 flatCollect in interface ImmutableCollection<T>
 
 Specified by:
 
 flatCollect in interface ImmutableSet<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
 - toImmutable
```
public ImmutableSet<T> toImmutable()
```
 Description copied from interface: UnsortedSetIterable
 
 Converts the UnsortedSetIterable to an immutable implementation. Returns this for immutable sets.
 
 Specified by:
 
 toImmutable in interface SetIterable<T>
 
 Specified by:
 
 toImmutable in interface UnsortedSetIterable<T>
 - groupBy
```
public <V> ImmutableSetMultimap<V,T> groupBy(Function<? super T,? extends V> function)
```
 Description copied from interface: RichIterable
 For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
 Example using a Java 8 method reference:
 Multimap<String, Person> peopleByLastName = people.groupBy(Person::getLastName);
 Specified by:
 
 groupBy in interface ImmutableCollection<T>
 
 Specified by:
 
 groupBy in interface ImmutableSet<T>
 
 Specified by:
 
 groupBy in interface ImmutableSetIterable<T>
 
 Specified by:
 
 groupBy in interface RichIterable<T>
 
 Specified by:
 
 groupBy in interface UnsortedSetIterable<T>
 - groupBy
```
public <V,R extends MutableMultimap<V,T>> R groupBy(Function<? super T,? extends V> function,
 R target)
```
 Description copied from interface: RichIterable
 Same as RichIterable.groupBy(Function), except that the results are gathered into the specified target multimap.
 Example using a Java 8 method reference:
 FastListMultimap<String, Person> peopleByLastName = people.groupBy(Person::getLastName, new FastListMultimap<String, Person>());
 Specified by:
 
 groupBy in interface RichIterable<T>
 
 Overrides:
 
 groupBy in class AbstractRichIterable<T>
 - groupByEach
```
public <V> ImmutableSetMultimap<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 ImmutableCollection<T>
 
 Specified by:
 
 groupByEach in interface ImmutableSet<T>
 
 Specified by:
 
 groupByEach in interface ImmutableSetIterable<T>
 
 Specified by:
 
 groupByEach in interface RichIterable<T>
 
 Specified by:
 
 groupByEach in interface UnsortedSetIterable<T>
 - groupByEach
```
public <V,R extends MutableMultimap<V,T>> R groupByEach(Function<? super T,? extends java.lang.Iterable<V>> function,
 R target)
```
 Description copied from interface: RichIterable
 
 Same as RichIterable.groupByEach(Function), except that the results are gathered into the specified target multimap.
 
 Specified by:
 
 groupByEach in interface RichIterable<T>
 
 Overrides:
 
 groupByEach in class AbstractRichIterable<T>
 - zip
```
@Deprecated
public <S> ImmutableSet<Pair<T,S>> zip(java.lang.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 ImmutableCollection<T>
 
 Specified by:
 
 zip in interface ImmutableSet<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
public ImmutableSet<Pair<T,java.lang.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 ImmutableCollection<T>
 
 Specified by:
 
 zipWithIndex in interface ImmutableSet<T>
 
 Specified by:
 
 zipWithIndex in interface ImmutableSetIterable<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)
 - newMutable
```
protected MutableCollection<T> newMutable(int size)
```
 Specified by:
 
 newMutable in class AbstractImmutableCollection<T>
 - union
```
public ImmutableSet<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 ImmutableSet<T>
 
 Specified by:
 
 union in interface SetIterable<T>
 
 Specified by:
 
 union in interface UnsortedSetIterable<T>
 - unionInto
```
public <R extends java.util.Set<T>> R unionInto(SetIterable<? extends T> set,
 R targetSet)
```
 Description copied from interface: SetIterable
 
 Same as SetIterable.union(SetIterable) but adds all the objects to targetSet and returns it.
 
 Specified by:
 
 unionInto in interface SetIterable<T>
 - intersect
```
public ImmutableSet<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 the smaller of the two sets (this or set) based on the size. If the sizes are equal, the output will contain instances from this.
 Note: If you need to ensure that the memory references from this are preserved in the resulting set, consider using this.select(that::contains) instead.
 
 Specified by:
 
 intersect in interface ImmutableSet<T>
 
 Specified by:
 
 intersect in interface SetIterable<T>
 
 Specified by:
 
 intersect in interface UnsortedSetIterable<T>
 - intersectInto
```
public <R extends java.util.Set<T>> R intersectInto(SetIterable<? extends T> set,
 R targetSet)
```
 Description copied from interface: SetIterable
 
 Same as SetIterable.intersect(SetIterable) but adds all the objects to targetSet and returns it.
 
 Specified by:
 
 intersectInto in interface SetIterable<T>
 - difference
```
public ImmutableSet<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 ImmutableSet<T>
 
 Specified by:
 
 difference in interface SetIterable<T>
 
 Specified by:
 
 difference in interface UnsortedSetIterable<T>
 - differenceInto
```
public <R extends java.util.Set<T>> R differenceInto(SetIterable<? extends T> subtrahendSet,
 R targetSet)
```
 Description copied from interface: SetIterable
 
 Same as SetIterable.difference(SetIterable) but adds all the objects to targetSet and returns it.
 
 Specified by:
 
 differenceInto in interface SetIterable<T>
 - symmetricDifference
```
public ImmutableSet<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 ImmutableSet<T>
 
 Specified by:
 
 symmetricDifference in interface SetIterable<T>
 
 Specified by:
 
 symmetricDifference in interface UnsortedSetIterable<T>
 - symmetricDifferenceInto
```
public <R extends java.util.Set<T>> R symmetricDifferenceInto(SetIterable<? extends T> set,
 R targetSet)
```
 Description copied from interface: SetIterable
 
 Same as SetIterable.symmetricDifference(SetIterable) but adds all the objects to targetSet and returns it.
 
 Specified by:
 
 symmetricDifferenceInto in interface SetIterable<T>
 - isSubsetOf
```
public boolean isSubsetOf(SetIterable<? extends T> candidateSuperset)
```
 Description copied from interface: SetIterable
 
 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.
 
 Specified by:
 
 isSubsetOf in interface SetIterable<T>
 - isProperSubsetOf
```
public boolean isProperSubsetOf(SetIterable<? extends T> candidateSuperset)
```
 Description copied from interface: SetIterable
 
 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.
 
 Specified by:
 
 isProperSubsetOf in interface SetIterable<T>
 - powerSet
```
public ImmutableSet<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 ImmutableSet<T>
 
 Specified by:
 
 powerSet in interface UnsortedSetIterable<T>
 - cartesianProduct
```
public  LazyIterable<Pair<T,B>> cartesianProduct(SetIterable set)
```
 Description copied from interface: SetIterable
 
 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.
 
 Specified by:
 
 cartesianProduct in interface SetIterable<T>
 - asParallel
```
public ParallelUnsortedSetIterable<T> asParallel(java.util.concurrent.ExecutorService executorService,
 int batchSize)
```
 Description copied from interface: SetIterable
 
 Returns a parallel iterable of this SetIterable.
 
 Specified by:
 
 asParallel in interface SetIterable<T>
 
 Specified by:
 
 asParallel in interface UnsortedSetIterable<T>

Class AbstractImmutableSet<T>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.collections.impl.collection.immutable.AbstractImmutableCollection

Methods inherited from class org.eclipse.collections.impl.AbstractRichIterable

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

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

Methods inherited from interface org.eclipse.collections.api.set.ImmutableSet

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

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

Methods inherited from interface java.util.Set

Methods inherited from interface org.eclipse.collections.api.set.SetIterable

Constructor Detail

AbstractImmutableSet

Method Detail

castToSet

nullSafeHashCode

newWith

newWithout

newWithAll

newWithoutAll

tap

select

selectWith

reject

rejectWith

partition

partitionWith

selectInstancesOf

collect

collectBoolean

collectByte

collectChar

collectDouble

collectFloat

collectInt

collectLong

collectShort

collectWith

collectIf

flatCollect

toImmutable

groupBy

groupBy

groupByEach

groupByEach

zip

zipWithIndex

newMutable

union

unionInto

intersect

intersectInto

difference

differenceInto

symmetricDifference

symmetricDifferenceInto

isSubsetOf

isProperSubsetOf

powerSet

cartesianProduct

asParallel