All Superinterfaces:

Comparable<SortedSetIterable<T>>, ImmutableCollection<T>, ImmutableSetIterable<T>, InternalIterable<T>, Iterable<T>, OrderedIterable<T>, ReversibleIterable<T>, RichIterable<T>, SetIterable<T>, SortedIterable<T>, SortedSetIterable<T>
```
public interface ImmutableSortedSet<T>
extends SortedSetIterable<T>, ImmutableSetIterable<T>
```
ImmutableSortedSet is the non-modifiable equivalent interface to MutableSortedSet. MutableSortedSet.toImmutable() will give you an appropriately trimmed implementation of ImmutableSortedSet. All ImmutableSortedSet implementations must implement the SortedSet interface in order to satisfy the Set.equals(Object) contract and be compared against other Sets.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`SortedSet<T>`	`castToSortedSet()`
`<V> ImmutableList<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.
`ImmutableBooleanList`	`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.
`ImmutableByteList`	`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.
`ImmutableCharList`	`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.
`ImmutableDoubleList`	`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.
`ImmutableFloatList`	`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> ImmutableList<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.
`ImmutableIntList`	`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.
`ImmutableLongList`	`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.
`ImmutableShortList`	`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> ImmutableList<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.
`default <V> ImmutableList<V>`	`collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function)`	Returns a new OrderedIterable using results obtained by applying the specified function to each element and its corresponding index.
`ImmutableSortedSet<T>`	`difference(SetIterable<? extends T> subtrahendSet)`	Returns the set of all members of `this` that are not members of `subtrahendSet`.
`ImmutableSortedSet<T>`	`distinct()`	Returns a new `SortedIterable` containing the distinct elements in this iterable.
`ImmutableSortedSet<T>`	`drop(int count)`	Returns an iterable after skipping the first `count` elements or an empty iterable if the `count` is greater than the length of the iterable.
`ImmutableSortedSet<T>`	`dropWhile(Predicate<? super T> predicate)`	Returns the final elements that do not satisfy the Predicate.
`<V> ImmutableList<V>`	`flatCollect(Function<? super T,? extends Iterable<V>> function)`	`flatCollect` is a special case of `RichIterable.collect(Function)`.
`default <P,V> ImmutableList<V>`	`flatCollectWith(Function2<? super T,? super P,? extends Iterable<V>> function, P parameter)`
`<V> ImmutableSortedSetMultimap<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> ImmutableSortedSetMultimap<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.
`ImmutableSortedSet<T>`	`intersect(SetIterable<? extends T> set)`	Returns the set of all objects that are members of both `this` and `set`.
`ImmutableSortedSet<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.
`ImmutableSortedSet<T>`	`newWithAll(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.
`ImmutableSortedSet<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.
`ImmutableSortedSet<T>`	`newWithoutAll(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.
`PartitionImmutableSortedSet<T>`	`partition(Predicate<? super T> predicate)`	Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
`PartitionImmutableSortedSet<T>`	`partitionWhile(Predicate<? super T> predicate)`	Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
`<P> PartitionImmutableSortedSet<T>`	`partitionWith(Predicate2<? super T,? super P> predicate, P parameter)`	Filters a collection into a PartitionIterable based on the evaluation of the predicate.
`ImmutableSortedSet<SortedSetIterable<T>>`	`powerSet()`	Returns the set whose members are all possible subsets of `this`.
`ImmutableSortedSet<T>`	`reject(Predicate<? super T> predicate)`	Returns all elements of the source collection that return false when evaluating of the predicate.
`<P> ImmutableSortedSet<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`.
`ImmutableSortedSet<T>`	`select(Predicate<? super T> predicate)`	Returns all elements of the source collection that return true when evaluating the predicate.
`<S> ImmutableSortedSet<S>`	`selectInstancesOf(Class<S> clazz)`	Returns all elements of the source collection that are instances of the Class `clazz`.
`<P> ImmutableSortedSet<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`.
`ImmutableSortedSet<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).
`ImmutableSortedSet<T>`	`take(int count)`	Returns the first `count` elements of the iterable or all the elements in the iterable if `count` is greater than the length of the iterable.
`ImmutableSortedSet<T>`	`takeWhile(Predicate<? super T> predicate)`	Returns the initial elements that satisfy the Predicate.
`ImmutableSortedSet<T>`	`tap(Procedure<? super T> procedure)`	Executes the Procedure for each element in the iterable and returns `this`.
`default ImmutableSortedSet<T>`	`toImmutableSortedSet()`	Converts the RichIterable to the default ImmutableSortedSet implementation.
`ImmutableSortedSet<T>`	`toReversed()`	Returns a new ReversibleIterable in reverse order.
`ImmutableSortedSet<T>`	`union(SetIterable<? extends T> set)`	Returns the set of all objects that are a member of `this` or `set` or both.
`<S> ImmutableList<Pair<T,S>>`	`zip(Iterable<S> that)`	Returns a `RichIterable` formed from this `RichIterable` and another `RichIterable` by combining corresponding elements in pairs.
`ImmutableSortedSet<Pair<T,Integer>>`	`zipWithIndex()`	Zips this `RichIterable` with its indices.

Methods inherited from interface java.lang.Comparable
compareTo

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

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

Methods inherited from interface java.lang.Iterable
iterator

Methods inherited from interface org.eclipse.collections.api.ordered.OrderedIterable
collectWithIndex, corresponds, detectIndex, forEach, forEachWithIndex, forEachWithIndex, getFirst, getFirstOptional, getLast, getLastOptional, indexOf, rejectWithIndex, selectWithIndex, toStack, zip, zipWithIndex

Methods inherited from interface org.eclipse.collections.api.ordered.ReversibleIterable
asReversed, detectLastIndex, reverseForEach, reverseForEachWithIndex

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, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, isEmpty, makeString, makeString, makeString, makeString, max, maxBy, maxByOptional, maxOptional, maxOptional, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString

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

Methods inherited from interface org.eclipse.collections.api.ordered.SortedIterable
max, min

Methods inherited from interface org.eclipse.collections.api.set.sorted.SortedSetIterable
asParallel, comparator, toImmutable

- Method Detail
  - newWith
```
ImmutableSortedSet<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>
  - newWithout
```
ImmutableSortedSet<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>
  - newWithAll
```
ImmutableSortedSet<T> newWithAll(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>
  - newWithoutAll
```
ImmutableSortedSet<T> newWithoutAll(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>
  - tap
```
ImmutableSortedSet<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 ImmutableSetIterable<T>
    
    Specified by:
    
    tap in interface OrderedIterable<T>
    
    Specified by:
    
    tap in interface ReversibleIterable<T>
    
    Specified by:
    
    tap in interface RichIterable<T>
    
    Specified by:
    
    tap in interface SetIterable<T>
    
    Specified by:
    
    tap in interface SortedIterable<T>
    
    Specified by:
    
    tap in interface SortedSetIterable<T>
    
    See Also:
    
    RichIterable.each(Procedure), RichIterable.forEach(Procedure)
  - select
```
ImmutableSortedSet<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 ImmutableSetIterable<T>
    
    Specified by:
    
    select in interface OrderedIterable<T>
    
    Specified by:
    
    select in interface ReversibleIterable<T>
    
    Specified by:
    
    select in interface RichIterable<T>
    
    Specified by:
    
    select in interface SetIterable<T>
    
    Specified by:
    
    select in interface SortedIterable<T>
    
    Specified by:
    
    select in interface SortedSetIterable<T>
  - selectWith
```
<P> ImmutableSortedSet<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 ImmutableSetIterable<T>
    
    Specified by:
    
    selectWith in interface OrderedIterable<T>
    
    Specified by:
    
    selectWith in interface ReversibleIterable<T>
    
    Specified by:
    
    selectWith in interface RichIterable<T>
    
    Specified by:
    
    selectWith in interface SetIterable<T>
    
    Specified by:
    
    selectWith in interface SortedIterable<T>
    
    Specified by:
    
    selectWith in interface SortedSetIterable<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
```
ImmutableSortedSet<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 ImmutableSetIterable<T>
    
    Specified by:
    
    reject in interface OrderedIterable<T>
    
    Specified by:
    
    reject in interface ReversibleIterable<T>
    
    Specified by:
    
    reject in interface RichIterable<T>
    
    Specified by:
    
    reject in interface SetIterable<T>
    
    Specified by:
    
    reject in interface SortedIterable<T>
    
    Specified by:
    
    reject in interface SortedSetIterable<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> ImmutableSortedSet<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 ImmutableSetIterable<T>
    
    Specified by:
    
    rejectWith in interface OrderedIterable<T>
    
    Specified by:
    
    rejectWith in interface ReversibleIterable<T>
    
    Specified by:
    
    rejectWith in interface RichIterable<T>
    
    Specified by:
    
    rejectWith in interface SetIterable<T>
    
    Specified by:
    
    rejectWith in interface SortedIterable<T>
    
    Specified by:
    
    rejectWith in interface SortedSetIterable<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
```
PartitionImmutableSortedSet<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 ImmutableSetIterable<T>
    
    Specified by:
    
    partition in interface OrderedIterable<T>
    
    Specified by:
    
    partition in interface ReversibleIterable<T>
    
    Specified by:
    
    partition in interface RichIterable<T>
    
    Specified by:
    
    partition in interface SetIterable<T>
    
    Specified by:
    
    partition in interface SortedIterable<T>
    
    Specified by:
    
    partition in interface SortedSetIterable<T>
  - partitionWith
```
<P> PartitionImmutableSortedSet<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 ImmutableSetIterable<T>
    
    Specified by:
    
    partitionWith in interface OrderedIterable<T>
    
    Specified by:
    
    partitionWith in interface ReversibleIterable<T>
    
    Specified by:
    
    partitionWith in interface RichIterable<T>
    
    Specified by:
    
    partitionWith in interface SetIterable<T>
    
    Specified by:
    
    partitionWith in interface SortedSetIterable<T>
  - partitionWhile
```
PartitionImmutableSortedSet<T> partitionWhile(Predicate<? super T> predicate)
```
    Description copied from interface: SortedIterable
    
    Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements. Short circuits at the first element which does satisfy the Predicate.
    
    Specified by:
    
    partitionWhile in interface OrderedIterable<T>
    
    Specified by:
    
    partitionWhile in interface ReversibleIterable<T>
    
    Specified by:
    
    partitionWhile in interface SortedIterable<T>
    
    Specified by:
    
    partitionWhile in interface SortedSetIterable<T>
  - selectInstancesOf
```
<S> ImmutableSortedSet<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 ImmutableCollection<T>
    
    Specified by:
    
    selectInstancesOf in interface ImmutableSetIterable<T>
    
    Specified by:
    
    selectInstancesOf in interface OrderedIterable<T>
    
    Specified by:
    
    selectInstancesOf in interface ReversibleIterable<T>
    
    Specified by:
    
    selectInstancesOf in interface RichIterable<T>
    
    Specified by:
    
    selectInstancesOf in interface SetIterable<T>
    
    Specified by:
    
    selectInstancesOf in interface SortedIterable<T>
    
    Specified by:
    
    selectInstancesOf in interface SortedSetIterable<T>
  - collect
```
<V> ImmutableList<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 OrderedIterable<T>
    
    Specified by:
    
    collect in interface ReversibleIterable<T>
    
    Specified by:
    
    collect in interface RichIterable<T>
    
    Specified by:
    
    collect in interface SortedSetIterable<T>
  - collectWithIndex
```
default <V> ImmutableList<V> collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function)
```
    Description copied from interface: OrderedIterable
    
    Returns a new OrderedIterable using results obtained by applying the specified function to each element and its corresponding index.
    
    Specified by:
    
    collectWithIndex in interface OrderedIterable<T>
    
    Specified by:
    
    collectWithIndex in interface ReversibleIterable<T>
    
    Specified by:
    
    collectWithIndex in interface SortedSetIterable<T>
    
    Since:
    
    9.1.
  - collectBoolean
```
ImmutableBooleanList 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 OrderedIterable<T>
    
    Specified by:
    
    collectBoolean in interface ReversibleIterable<T>
    
    Specified by:
    
    collectBoolean in interface RichIterable<T>
    
    Specified by:
    
    collectBoolean in interface SortedSetIterable<T>
  - collectByte
```
ImmutableByteList 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 OrderedIterable<T>
    
    Specified by:
    
    collectByte in interface ReversibleIterable<T>
    
    Specified by:
    
    collectByte in interface RichIterable<T>
    
    Specified by:
    
    collectByte in interface SortedSetIterable<T>
  - collectChar
```
ImmutableCharList 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 OrderedIterable<T>
    
    Specified by:
    
    collectChar in interface ReversibleIterable<T>
    
    Specified by:
    
    collectChar in interface RichIterable<T>
    
    Specified by:
    
    collectChar in interface SortedSetIterable<T>
  - collectDouble
```
ImmutableDoubleList 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 OrderedIterable<T>
    
    Specified by:
    
    collectDouble in interface ReversibleIterable<T>
    
    Specified by:
    
    collectDouble in interface RichIterable<T>
    
    Specified by:
    
    collectDouble in interface SortedSetIterable<T>
  - collectFloat
```
ImmutableFloatList 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 OrderedIterable<T>
    
    Specified by:
    
    collectFloat in interface ReversibleIterable<T>
    
    Specified by:
    
    collectFloat in interface RichIterable<T>
    
    Specified by:
    
    collectFloat in interface SortedSetIterable<T>
  - collectInt
```
ImmutableIntList 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 OrderedIterable<T>
    
    Specified by:
    
    collectInt in interface ReversibleIterable<T>
    
    Specified by:
    
    collectInt in interface RichIterable<T>
    
    Specified by:
    
    collectInt in interface SortedSetIterable<T>
  - collectLong
```
ImmutableLongList 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 OrderedIterable<T>
    
    Specified by:
    
    collectLong in interface ReversibleIterable<T>
    
    Specified by:
    
    collectLong in interface RichIterable<T>
    
    Specified by:
    
    collectLong in interface SortedSetIterable<T>
  - collectShort
```
ImmutableShortList 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 OrderedIterable<T>
    
    Specified by:
    
    collectShort in interface ReversibleIterable<T>
    
    Specified by:
    
    collectShort in interface RichIterable<T>
    
    Specified by:
    
    collectShort in interface SortedSetIterable<T>
  - collectWith
```
<P,V> ImmutableList<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 OrderedIterable<T>
    
    Specified by:
    
    collectWith in interface ReversibleIterable<T>
    
    Specified by:
    
    collectWith in interface RichIterable<T>
    
    Specified by:
    
    collectWith in interface SortedSetIterable<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> ImmutableList<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 OrderedIterable<T>
    
    Specified by:
    
    collectIf in interface ReversibleIterable<T>
    
    Specified by:
    
    collectIf in interface RichIterable<T>
    
    Specified by:
    
    collectIf in interface SortedSetIterable<T>
  - flatCollect
```
<V> ImmutableList<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 ImmutableCollection<T>
    
    Specified by:
    
    flatCollect in interface OrderedIterable<T>
    
    Specified by:
    
    flatCollect in interface ReversibleIterable<T>
    
    Specified by:
    
    flatCollect in interface RichIterable<T>
    
    Specified by:
    
    flatCollect in interface SortedSetIterable<T>
    
    Parameters:
    
    function - The Function to apply
    
    Returns:
    
    a new flattened collection produced by applying the given function
  - flatCollectWith
```
default <P,V> ImmutableList<V> flatCollectWith(Function2<? super T,? super P,? extends Iterable<V>> function,
                                                     P parameter)
```
    Specified by:
    
    flatCollectWith in interface ImmutableCollection<T>
    
    Specified by:
    
    flatCollectWith in interface OrderedIterable<T>
    
    Specified by:
    
    flatCollectWith in interface ReversibleIterable<T>
    
    Specified by:
    
    flatCollectWith in interface RichIterable<T>
    
    Specified by:
    
    flatCollectWith in interface SortedSetIterable<T>
    
    Since:
    
    9.2
  - distinct
```
ImmutableSortedSet<T> distinct()
```
    Description copied from interface: SortedIterable
    
    Returns a new SortedIterable containing the distinct elements in this iterable.
    Conceptually similar to RichIterable.toSet().RichIterable.toList() but retains the original order. If an element appears multiple times in this iterable, the first one will be copied into the result.
    
    Specified by:
    
    distinct in interface OrderedIterable<T>
    
    Specified by:
    
    distinct in interface ReversibleIterable<T>
    
    Specified by:
    
    distinct in interface SortedIterable<T>
    
    Specified by:
    
    distinct in interface SortedSetIterable<T>
    
    Returns:
    
    SortedIterable of distinct elements
  - takeWhile
```
ImmutableSortedSet<T> takeWhile(Predicate<? super T> predicate)
```
    Description copied from interface: SortedIterable
    
    Returns the initial elements that satisfy the Predicate. Short circuits at the first element which does not satisfy the Predicate.
    
    Specified by:
    
    takeWhile in interface OrderedIterable<T>
    
    Specified by:
    
    takeWhile in interface ReversibleIterable<T>
    
    Specified by:
    
    takeWhile in interface SortedIterable<T>
    
    Specified by:
    
    takeWhile in interface SortedSetIterable<T>
  - dropWhile
```
ImmutableSortedSet<T> dropWhile(Predicate<? super T> predicate)
```
    Description copied from interface: SortedIterable
    
    Returns the final elements that do not satisfy the Predicate. Short circuits at the first element which does satisfy the Predicate.
    
    Specified by:
    
    dropWhile in interface OrderedIterable<T>
    
    Specified by:
    
    dropWhile in interface ReversibleIterable<T>
    
    Specified by:
    
    dropWhile in interface SortedIterable<T>
    
    Specified by:
    
    dropWhile in interface SortedSetIterable<T>
  - groupBy
```
<V> ImmutableSortedSetMultimap<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 ImmutableSetIterable<T>
    
    Specified by:
    
    groupBy in interface OrderedIterable<T>
    
    Specified by:
    
    groupBy in interface ReversibleIterable<T>
    
    Specified by:
    
    groupBy in interface RichIterable<T>
    
    Specified by:
    
    groupBy in interface SortedIterable<T>
    
    Specified by:
    
    groupBy in interface SortedSetIterable<T>
  - groupByEach
```
<V> ImmutableSortedSetMultimap<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 ImmutableCollection<T>
    
    Specified by:
    
    groupByEach in interface ImmutableSetIterable<T>
    
    Specified by:
    
    groupByEach in interface OrderedIterable<T>
    
    Specified by:
    
    groupByEach in interface ReversibleIterable<T>
    
    Specified by:
    
    groupByEach in interface RichIterable<T>
    
    Specified by:
    
    groupByEach in interface SortedIterable<T>
    
    Specified by:
    
    groupByEach in interface SortedSetIterable<T>
  - zip
```
<S> ImmutableList<Pair<T,S>> zip(Iterable<S> that)
```
    Description copied from interface: RichIterable
    
    Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs. If one of the two RichIterables is longer than the other, its remaining elements are ignored.
    
    Specified by:
    
    zip in interface ImmutableCollection<T>
    
    Specified by:
    
    zip in interface OrderedIterable<T>
    
    Specified by:
    
    zip in interface ReversibleIterable<T>
    
    Specified by:
    
    zip in interface RichIterable<T>
    
    Specified by:
    
    zip in interface SortedIterable<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
```
ImmutableSortedSet<Pair<T,Integer>> zipWithIndex()
```
    Description copied from interface: RichIterable
    
    Zips this RichIterable with its indices.
    
    Specified by:
    
    zipWithIndex in interface ImmutableCollection<T>
    
    Specified by:
    
    zipWithIndex in interface ImmutableSetIterable<T>
    
    Specified by:
    
    zipWithIndex in interface OrderedIterable<T>
    
    Specified by:
    
    zipWithIndex in interface ReversibleIterable<T>
    
    Specified by:
    
    zipWithIndex in interface RichIterable<T>
    
    Specified by:
    
    zipWithIndex in interface SetIterable<T>
    
    Specified by:
    
    zipWithIndex in interface SortedIterable<T>
    
    Specified by:
    
    zipWithIndex in interface SortedSetIterable<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)
  - toReversed
```
ImmutableSortedSet<T> toReversed()
```
    Description copied from interface: ReversibleIterable
    
    Returns a new ReversibleIterable in reverse order.
    
    Specified by:
    
    toReversed in interface ReversibleIterable<T>
    
    Specified by:
    
    toReversed in interface SortedSetIterable<T>
  - take
```
ImmutableSortedSet<T> take(int count)
```
    Description copied from interface: ReversibleIterable
    
    Returns the first count elements of the iterable or all the elements in the iterable if count is greater than the length of the iterable.
    
    Specified by:
    
    take in interface ReversibleIterable<T>
    
    Specified by:
    
    take in interface SortedSetIterable<T>
    
    Parameters:
    
    count - the number of items to take.
  - drop
```
ImmutableSortedSet<T> drop(int count)
```
    Description copied from interface: ReversibleIterable
    
    Returns an iterable after skipping the first count elements or an empty iterable if the count is greater than the length of the iterable.
    
    Specified by:
    
    drop in interface ReversibleIterable<T>
    
    Specified by:
    
    drop in interface SortedSetIterable<T>
    
    Parameters:
    
    count - the number of items to drop.
  - castToSortedSet
```
SortedSet<T> castToSortedSet()
```
  - union
```
ImmutableSortedSet<T> union(SetIterable<? extends T> set)
```
    Description copied from interface: SortedSetIterable
    
    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 SortedSetIterable<T>
  - intersect
```
ImmutableSortedSet<T> intersect(SetIterable<? extends T> set)
```
    Description copied from interface: SortedSetIterable
    
    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 SortedSetIterable<T>
  - difference
```
ImmutableSortedSet<T> difference(SetIterable<? extends T> subtrahendSet)
```
    Description copied from interface: SortedSetIterable
    
    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 SortedSetIterable<T>
  - symmetricDifference
```
ImmutableSortedSet<T> symmetricDifference(SetIterable<? extends T> setB)
```
    Description copied from interface: SortedSetIterable
    
    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 SortedSetIterable<T>
  - powerSet
```
ImmutableSortedSet<SortedSetIterable<T>> powerSet()
```
    Description copied from interface: SortedSetIterable
    
    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 SortedSetIterable<T>
  - toImmutableSortedSet
```
default ImmutableSortedSet<T> toImmutableSortedSet()
```
    Description copied from interface: RichIterable
    
    Converts the RichIterable to the default ImmutableSortedSet implementation.
    
    Specified by:
    
    toImmutableSortedSet in interface RichIterable<T>
    
    Since:
    
    11.0

Interface ImmutableSortedSet<T>

Method Summary

Methods inherited from interface java.lang.Comparable

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

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

Methods inherited from interface java.lang.Iterable

Methods inherited from interface org.eclipse.collections.api.ordered.OrderedIterable

Methods inherited from interface org.eclipse.collections.api.ordered.ReversibleIterable

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

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

Methods inherited from interface org.eclipse.collections.api.ordered.SortedIterable

Methods inherited from interface org.eclipse.collections.api.set.sorted.SortedSetIterable

Method Detail

newWith

newWithout

newWithAll

newWithoutAll

tap

select

selectWith

reject

rejectWith

partition

partitionWith

partitionWhile

selectInstancesOf

collect

collectWithIndex

collectBoolean

collectByte

collectChar

collectDouble

collectFloat

collectInt

collectLong

collectShort

collectWith

collectIf

flatCollect

flatCollectWith

distinct

takeWhile

dropWhile

groupBy

groupByEach

zip

zipWithIndex

toReversed

take

drop

castToSortedSet

union

intersect

difference

symmetricDifference

powerSet

toImmutableSortedSet