All Superinterfaces:

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

All Known Subinterfaces:

FixedSizeSet<T>, ImmutableSet<T>, MultiReaderSet<T>, MutableSet<T>
```
public interface UnsortedSetIterable<T>
extends SetIterable<T>
```
An iterable whose items are unique.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method	Description
`ParallelUnsortedSetIterable<T>`	`asParallel(ExecutorService executorService, int batchSize)`	Returns a parallel iterable of this SetIterable.
`<V> UnsortedSetIterable<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.
`BooleanSet`	`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.
`ByteSet`	`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.
`CharSet`	`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.
`DoubleSet`	`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.
`FloatSet`	`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> UnsortedSetIterable<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.
`IntSet`	`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.
`LongSet`	`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.
`ShortSet`	`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> UnsortedSetIterable<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.
`UnsortedSetIterable<T>`	`difference(SetIterable<? extends T> subtrahendSet)`	Returns the set of all members of `this` that are not members of `subtrahendSet`.
`<V> UnsortedSetIterable<V>`	`flatCollect(Function<? super T,? extends Iterable<V>> function)`	`flatCollect` is a special case of `RichIterable.collect(Function)`.
`default <P,V> UnsortedSetIterable<V>`	`flatCollectWith(Function2<? super T,? super P,? extends Iterable<V>> function, P parameter)`
`<V> UnsortedSetMultimap<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> UnsortedSetMultimap<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.
`UnsortedSetIterable<T>`	`intersect(SetIterable<? extends T> set)`	Returns the set of all objects that are members of both `this` and `set`.
`UnsortedSetIterable<UnsortedSetIterable<T>>`	`powerSet()`	Returns the set whose members are all possible subsets of `this`.
`UnsortedSetIterable<T>`	`reject(Predicate<? super T> predicate)`	Returns all elements of the source collection that return false when evaluating of the predicate.
`<P> UnsortedSetIterable<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`.
`UnsortedSetIterable<T>`	`select(Predicate<? super T> predicate)`	Returns all elements of the source collection that return true when evaluating the predicate.
`<S> UnsortedSetIterable<S>`	`selectInstancesOf(Class<S> clazz)`	Returns all elements of the source collection that are instances of the Class `clazz`.
`<P> UnsortedSetIterable<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`.
`UnsortedSetIterable<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).
`UnsortedSetIterable<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.
`UnsortedSetIterable<T>`	`union(SetIterable<? extends T> set)`	Returns the set of all objects that are a member of `this` or `set` or both.
`<S> UnsortedSetIterable<Pair<T,S>>`	`zip(Iterable<S> that)`	Deprecated. in 6.0.
`UnsortedSetIterable<Pair<T,Integer>>`	`zipWithIndex()`	Deprecated. in 6.0.

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

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

Methods inherited from interface org.eclipse.collections.api.RichIterable
aggregateBy, aggregateBy, aggregateInPlaceBy, 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, countBy, countByEach, countByEach, countByWith, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getFirst, getLast, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, 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, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, 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 org.eclipse.collections.api.set.SetIterable
cartesianProduct, differenceInto, equals, hashCode, intersectInto, isProperSubsetOf, isSubsetOf, partition, partitionWith, symmetricDifferenceInto, unionInto

- Method Detail
  - powerSet
```
UnsortedSetIterable<UnsortedSetIterable<T>> powerSet()
```
    Returns the set whose members are all possible subsets of this. For example, the powerset of [1, 2] is [[], [1], [2], [1, 2]].
  - tap
```
UnsortedSetIterable<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 RichIterable<T>
    
    Specified by:
    
    tap in interface SetIterable<T>
    
    See Also:
    
    RichIterable.each(Procedure), RichIterable.forEach(Procedure)
  - collect
```
<V> UnsortedSetIterable<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 RichIterable<T>
  - collectBoolean
```
BooleanSet 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 RichIterable<T>
  - collectByte
```
ByteSet 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 RichIterable<T>
  - collectChar
```
CharSet 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 RichIterable<T>
  - collectDouble
```
DoubleSet 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 RichIterable<T>
  - collectFloat
```
FloatSet 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 RichIterable<T>
  - collectInt
```
IntSet 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 RichIterable<T>
  - collectLong
```
LongSet 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 RichIterable<T>
  - collectShort
```
ShortSet 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 RichIterable<T>
  - collectWith
```
<P,V> UnsortedSetIterable<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 RichIterable<T>
    
    Parameters:
    
    function - A Function2 to use as the collect transformation function
    
    parameter - A parameter to pass in for evaluation of the second argument P in function
    
    Returns:
    
    A new RichIterable that contains the transformed elements returned by Function2.value(Object, Object)
    
    See Also:
    
    RichIterable.collect(Function)
  - collectIf
```
<V> UnsortedSetIterable<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 RichIterable<T>
  - flatCollect
```
<V> UnsortedSetIterable<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; 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 RichIterable<T>
    
    Parameters:
    
    function - The Function to apply
    
    Returns:
    
    a new flattened collection produced by applying the given function
  - flatCollectWith
```
default <P,V> UnsortedSetIterable<V> flatCollectWith(Function2<? super T,? super P,? extends Iterable<V>> function,
                                                           P parameter)
```
    Specified by:
    
    flatCollectWith in interface RichIterable<T>
    
    Since:
    
    9.2
  - groupBy
```
<V> UnsortedSetMultimap<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 RichIterable<T>
  - groupByEach
```
<V> UnsortedSetMultimap<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 RichIterable<T>
  - union
```
UnsortedSetIterable<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>
  - intersect
```
UnsortedSetIterable<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>
  - difference
```
UnsortedSetIterable<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>
  - symmetricDifference
```
UnsortedSetIterable<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>
  - select
```
UnsortedSetIterable<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 RichIterable<T>
    
    Specified by:
    
    select in interface SetIterable<T>
  - selectWith
```
<P> UnsortedSetIterable<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 RichIterable<T>
    
    Specified by:
    
    selectWith in interface SetIterable<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
```
UnsortedSetIterable<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 RichIterable<T>
    
    Specified by:
    
    reject in interface SetIterable<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> UnsortedSetIterable<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 RichIterable<T>
    
    Specified by:
    
    rejectWith in interface SetIterable<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)
  - selectInstancesOf
```
<S> UnsortedSetIterable<S> selectInstancesOf(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 RichIterable<T>
    
    Specified by:
    
    selectInstancesOf in interface SetIterable<T>
  - zip
```
@Deprecated
<S> UnsortedSetIterable<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 RichIterable<T>
    
    Type Parameters:
    
    S - the type of the second half of the returned pairs
    
    Parameters:
    
    that - The RichIterable providing the second half of each result pair
    
    Returns:
    
    A new RichIterable containing pairs consisting of corresponding elements of this RichIterable and that. The length of the returned RichIterable is the minimum of the lengths of this RichIterable and that.
  - zipWithIndex
```
@Deprecated
UnsortedSetIterable<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 RichIterable<T>
    
    Specified by:
    
    zipWithIndex in interface SetIterable<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)
  - toImmutable
```
ImmutableSet<T> toImmutable()
```
    Converts the UnsortedSetIterable to an immutable implementation. Returns this for immutable sets.
    
    Specified by:
    
    toImmutable in interface SetIterable<T>
    
    Since:
    
    5.0
  - asParallel
```
ParallelUnsortedSetIterable<T> asParallel(ExecutorService executorService,
                                          int batchSize)
```
    Description copied from interface: SetIterable
    
    Returns a parallel iterable of this SetIterable.
    
    Specified by:
    
    asParallel in interface SetIterable<T>

Interface UnsortedSetIterable<T>

Method Summary

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

Methods inherited from interface java.lang.Iterable

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

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

Method Detail

powerSet

tap

collect

collectBoolean

collectByte

collectChar

collectDouble

collectFloat

collectInt

collectLong

collectShort

collectWith

collectIf

flatCollect

flatCollectWith

groupBy

groupByEach

union

intersect

difference

symmetricDifference

select

selectWith

reject

rejectWith

selectInstancesOf

zip

zipWithIndex

toImmutable

asParallel