Top Description Methods
org.eclipse.collections.api.set.sorted

public Interface SortedSetIterable<T>

extends SetIterable<T>, Comparable<SortedSetIterable<T>>, SortedIterable<T>, ReversibleIterable<T>
Known Direct Subinterfaces
org.eclipse.collections.api.set.sorted.ImmutableSortedSet, org.eclipse.collections.api.set.sorted.MutableSortedSet
Imports
java.util.Comparator, java.util.concurrent.ExecutorService, org.eclipse.collections.api.annotation.Beta, org.eclipse.collections.api.block.function.Function, .Function2, org.eclipse.collections.api.block.function.primitive.BooleanFunction, .ByteFunction, .CharFunction, .DoubleFunction, .FloatFunction, .IntFunction, .LongFunction, .ObjectIntToObjectFunction, .ShortFunction, org.eclipse.collections.api.block.predicate.Predicate, .Predicate2, org.eclipse.collections.api.block.procedure.Procedure, org.eclipse.collections.api.list.ListIterable, org.eclipse.collections.api.list.primitive.BooleanList, .ByteList, .CharList, .DoubleList, .FloatList, .IntList, .LongList, .ShortList, org.eclipse.collections.api.multimap.sortedset.SortedSetMultimap, org.eclipse.collections.api.ordered.ReversibleIterable, .SortedIterable, org.eclipse.collections.api.partition.set.sorted.PartitionSortedSet, org.eclipse.collections.api.set.SetIterable, org.eclipse.collections.api.tuple.Pair
An iterable whose items are unique and sorted by some comparator or their natural ordering.

Method Summary

Modifier and TypeMethod and Description
public ParallelSortedSetIterable<T>
asParallel(ExecutorService executorService, int batchSize)

Redeclares org.eclipse.collections.api.set.SetIterable.asParallel.

Returns a parallel iterable of this SortedSetIterable.

public <V> ListIterable<V>
collect(Function<? super T, ? extends V> function)

Redeclares org.eclipse.collections.api.RichIterable.collect, org.eclipse.collections.api.ordered.OrderedIterable.collect, org.eclipse.collections.api.ordered.ReversibleIterable.collect.

Returns a new collection with the results of applying the specified function on each element of the source collection.

public BooleanList
collectBoolean(BooleanFunction<? super T> booleanFunction)

Redeclares org.eclipse.collections.api.RichIterable.collectBoolean, org.eclipse.collections.api.ordered.OrderedIterable.collectBoolean, org.eclipse.collections.api.ordered.ReversibleIterable.collectBoolean.

Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection.

public ByteList
collectByte(ByteFunction<? super T> byteFunction)

Redeclares org.eclipse.collections.api.RichIterable.collectByte, org.eclipse.collections.api.ordered.OrderedIterable.collectByte, org.eclipse.collections.api.ordered.ReversibleIterable.collectByte.

Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection.

public CharList
collectChar(CharFunction<? super T> charFunction)

Redeclares org.eclipse.collections.api.RichIterable.collectChar, org.eclipse.collections.api.ordered.OrderedIterable.collectChar, org.eclipse.collections.api.ordered.ReversibleIterable.collectChar.

Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection.

public DoubleList
collectDouble(DoubleFunction<? super T> doubleFunction)

Redeclares org.eclipse.collections.api.RichIterable.collectDouble, org.eclipse.collections.api.ordered.OrderedIterable.collectDouble, org.eclipse.collections.api.ordered.ReversibleIterable.collectDouble.

Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection.

public FloatList
collectFloat(FloatFunction<? super T> floatFunction)

Redeclares org.eclipse.collections.api.RichIterable.collectFloat, org.eclipse.collections.api.ordered.OrderedIterable.collectFloat, org.eclipse.collections.api.ordered.ReversibleIterable.collectFloat.

Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection.

public <V> ListIterable<V>
collectIf(Predicate<? super T> predicate, Function<? super T, ? extends V> function)

Redeclares org.eclipse.collections.api.RichIterable.collectIf, org.eclipse.collections.api.ordered.OrderedIterable.collectIf, org.eclipse.collections.api.ordered.ReversibleIterable.collectIf.

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.

public IntList
collectInt(IntFunction<? super T> intFunction)

Redeclares org.eclipse.collections.api.RichIterable.collectInt, org.eclipse.collections.api.ordered.OrderedIterable.collectInt, org.eclipse.collections.api.ordered.ReversibleIterable.collectInt.

Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection.

public LongList
collectLong(LongFunction<? super T> longFunction)

Redeclares org.eclipse.collections.api.RichIterable.collectLong, org.eclipse.collections.api.ordered.OrderedIterable.collectLong, org.eclipse.collections.api.ordered.ReversibleIterable.collectLong.

Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection.

public ShortList
collectShort(ShortFunction<? super T> shortFunction)

Redeclares org.eclipse.collections.api.RichIterable.collectShort, org.eclipse.collections.api.ordered.OrderedIterable.collectShort, org.eclipse.collections.api.ordered.ReversibleIterable.collectShort.

Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection.

public <P, V> ListIterable<V>
collectWith(Function2<? super T, ? super P, ? extends V> function, P parameter)

Redeclares org.eclipse.collections.api.RichIterable.collectWith, org.eclipse.collections.api.ordered.OrderedIterable.collectWith, org.eclipse.collections.api.ordered.ReversibleIterable.collectWith.

Same as collect(Function) with a Function2 and specified parameter which is passed to the block.

public default <V> ListIterable<V>
collectWithIndex(ObjectIntToObjectFunction<? super T, ? extends V> function)

Overrides default org.eclipse.collections.api.ordered.OrderedIterable.collectWithIndex, org.eclipse.collections.api.ordered.ReversibleIterable.collectWithIndex.

Returns a new OrderedIterable using results obtained by applying the specified function to each element and its corresponding index.

public Comparator<? super T>
comparator()

Redeclares org.eclipse.collections.api.ordered.SortedIterable.comparator.

Returns the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements.

public SortedSetIterable<T>
difference(SetIterable<? extends T> subtrahendSet)

Redeclares org.eclipse.collections.api.set.SetIterable.difference.

Returns the set of all members of this that are not members of subtrahendSet.

public SortedSetIterable<T>
distinct()

Redeclares org.eclipse.collections.api.ordered.SortedIterable.distinct, org.eclipse.collections.api.ordered.ReversibleIterable.distinct.

Returns a new SortedIterable containing the distinct elements in this iterable.

public SortedSetIterable<T>
drop(int count)

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.drop.

Returns an iterable after skipping the first count elements or an empty iterable if the count is greater than the length of the iterable.

public SortedSetIterable<T>
dropWhile(Predicate<? super T> predicate)

Redeclares org.eclipse.collections.api.ordered.SortedIterable.dropWhile, org.eclipse.collections.api.ordered.ReversibleIterable.dropWhile.

Returns the final elements that do not satisfy the Predicate.

public <V> ListIterable<V>
flatCollect(Function<? super T, ? extends Iterable<V>> function)

Redeclares org.eclipse.collections.api.RichIterable.flatCollect, org.eclipse.collections.api.ordered.OrderedIterable.flatCollect, org.eclipse.collections.api.ordered.ReversibleIterable.flatCollect.

flatCollect is a special case of collect(Function).

public default <P, V> ListIterable<V>
flatCollectWith(Function2<? super T, ? super P, ? extends Iterable<V>> function, P parameter)

Overrides default org.eclipse.collections.api.RichIterable.flatCollectWith, org.eclipse.collections.api.ordered.OrderedIterable.flatCollectWith, org.eclipse.collections.api.ordered.ReversibleIterable.flatCollectWith.

Same as flatCollect, only with a Function2 that is passed an extra parameter.

public <V> SortedSetMultimap<V, T>
groupBy(Function<? super T, ? extends V> function)

Redeclares org.eclipse.collections.api.RichIterable.groupBy, org.eclipse.collections.api.ordered.SortedIterable.groupBy, org.eclipse.collections.api.ordered.ReversibleIterable.groupBy.

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.

public <V> SortedSetMultimap<V, T>
groupByEach(Function<? super T, ? extends Iterable<V>> function)

Redeclares org.eclipse.collections.api.RichIterable.groupByEach, org.eclipse.collections.api.ordered.SortedIterable.groupByEach, org.eclipse.collections.api.ordered.ReversibleIterable.groupByEach.

Similar to groupBy(Function), except the result of evaluating function will return a collection of keys for each value.

public SortedSetIterable<T>
intersect(SetIterable<? extends T> set)

Redeclares org.eclipse.collections.api.set.SetIterable.intersect.

Returns the set of all objects that are members of both this and set.

public PartitionSortedSet<T>
partition(Predicate<? super T> predicate)

Redeclares org.eclipse.collections.api.set.SetIterable.partition, org.eclipse.collections.api.ordered.SortedIterable.partition, org.eclipse.collections.api.ordered.ReversibleIterable.partition.

Filters a collection into a PartitionedIterable based on the evaluation of the predicate.

public PartitionSortedSet<T>
partitionWhile(Predicate<? super T> predicate)

Redeclares org.eclipse.collections.api.ordered.SortedIterable.partitionWhile, org.eclipse.collections.api.ordered.ReversibleIterable.partitionWhile.

Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.

public <P> PartitionSortedSet<T>
partitionWith(Predicate2<? super T, ? super P> predicate, P parameter)

Redeclares org.eclipse.collections.api.set.SetIterable.partitionWith, org.eclipse.collections.api.ordered.OrderedIterable.partitionWith, org.eclipse.collections.api.ordered.ReversibleIterable.partitionWith.

Filters a collection into a PartitionIterable based on the evaluation of the predicate.

public SortedSetIterable<SortedSetIterable<T>>
powerSet()

Returns the set whose members are all possible subsets of this.

public SortedSetIterable<T>
reject(Predicate<? super T> predicate)

Redeclares org.eclipse.collections.api.set.SetIterable.reject, org.eclipse.collections.api.ordered.SortedIterable.reject, org.eclipse.collections.api.ordered.ReversibleIterable.reject.

Returns all elements of the source collection that return false when evaluating of the predicate.

public <P> SortedSetIterable<T>
rejectWith(Predicate2<? super T, ? super P> predicate, P parameter)

Redeclares org.eclipse.collections.api.set.SetIterable.rejectWith, org.eclipse.collections.api.ordered.SortedIterable.rejectWith, org.eclipse.collections.api.ordered.ReversibleIterable.rejectWith.

Similar to reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.

public SortedSetIterable<T>
select(Predicate<? super T> predicate)

Redeclares org.eclipse.collections.api.set.SetIterable.select, org.eclipse.collections.api.ordered.SortedIterable.select, org.eclipse.collections.api.ordered.ReversibleIterable.select.

Returns all elements of the source collection that return true when evaluating the predicate.

public <S> SortedSetIterable<S>
selectInstancesOf(Class<S> clazz)

Redeclares org.eclipse.collections.api.set.SetIterable.selectInstancesOf, org.eclipse.collections.api.ordered.SortedIterable.selectInstancesOf, org.eclipse.collections.api.ordered.ReversibleIterable.selectInstancesOf.

Returns all elements of the source collection that are instances of the Class clazz.

public <P> SortedSetIterable<T>
selectWith(Predicate2<? super T, ? super P> predicate, P parameter)

Redeclares org.eclipse.collections.api.set.SetIterable.selectWith, org.eclipse.collections.api.ordered.SortedIterable.selectWith, org.eclipse.collections.api.ordered.ReversibleIterable.selectWith.

Similar to select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.

public SortedSetIterable<T>
symmetricDifference(SetIterable<? extends T> setB)

Redeclares org.eclipse.collections.api.set.SetIterable.symmetricDifference.

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).

public SortedSetIterable<T>
take(int count)

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.take.

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.

public SortedSetIterable<T>
takeWhile(Predicate<? super T> predicate)

Redeclares org.eclipse.collections.api.ordered.SortedIterable.takeWhile, org.eclipse.collections.api.ordered.ReversibleIterable.takeWhile.

Returns the initial elements that satisfy the Predicate.

public SortedSetIterable<T>
tap(Procedure<? super T> procedure)

Redeclares org.eclipse.collections.api.set.SetIterable.tap, org.eclipse.collections.api.ordered.SortedIterable.tap, org.eclipse.collections.api.ordered.ReversibleIterable.tap.

Executes the Procedure for each element in the iterable and returns this.

public ImmutableSortedSet<T>
toImmutable()

Redeclares org.eclipse.collections.api.set.SetIterable.toImmutable.

Converts the SortedSetIterable to an immutable implementation.

public SortedSetIterable<T>
toReversed()

Redeclares org.eclipse.collections.api.ordered.ReversibleIterable.toReversed.

Returns a new ReversibleIterable in reverse order.

public SortedSetIterable<T>
union(SetIterable<? extends T> set)

Redeclares org.eclipse.collections.api.set.SetIterable.union.

Returns the set of all objects that are a member of this or set or both.

public SortedSetIterable<Pair<T, Integer>>
zipWithIndex()

Redeclares org.eclipse.collections.api.set.SetIterable.zipWithIndex, org.eclipse.collections.api.ordered.SortedIterable.zipWithIndex, org.eclipse.collections.api.ordered.ReversibleIterable.zipWithIndex.

Zips this RichIterable with its indices.

Inherited from java.lang.Comparable:
compareTo
Inherited from org.eclipse.collections.api.ordered.ReversibleIterable:
asReverseddetectLastIndexreverseForEachreverseForEachWithIndexzip
Inherited from org.eclipse.collections.api.ordered.SortedIterable:
maxminzip
Inherited from org.eclipse.collections.api.set.SetIterable:
cartesianProductdifferenceIntoequalshashCodeintersectIntoisProperSubsetOfisSubsetOfsymmetricDifferenceIntounionInto