All Superinterfaces:

Bag<T>, Comparable<SortedBag<T>>, InternalIterable<T>, Iterable<T>, OrderedIterable<T>, ReversibleIterable<T>, RichIterable<T>, SortedIterable<T>

All Known Subinterfaces:

ImmutableSortedBag<T>, MutableSortedBag<T>
```
public interface SortedBag<T>
extends Bag<T>, Comparable<SortedBag<T>>, SortedIterable<T>, ReversibleIterable<T>
```
An Iterable whose elements are sorted by some comparator or their natural ordering and may contain duplicate entries.

Since:

4.2

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`<V> ListIterable<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.
`BooleanList`	`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.
`ByteList`	`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.
`CharList`	`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.
`DoubleList`	`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.
`FloatList`	`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> ListIterable<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.
`IntList`	`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.
`LongList`	`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.
`ShortList`	`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> ListIterable<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> ListIterable<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.
`<V> ListIterable<V>`	`collectWithOccurrences(ObjectIntToObjectFunction<? super T,? extends V> function)`	Iterates over the unique elements and their occurrences and collects the results of applying the specified function.
`Comparator<? super T>`	`comparator()`	Returns the comparator used to order the elements in this bag, or null if this bag uses the natural ordering of its elements.
`SortedSetIterable<T>`	`distinct()`	Returns a new `SortedIterable` containing the distinct elements in this iterable.
`SortedBag<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.
`SortedBag<T>`	`dropWhile(Predicate<? super T> predicate)`	Returns the final elements that do not satisfy the Predicate.
`<V> ListIterable<V>`	`flatCollect(Function<? super T,? extends Iterable<V>> function)`	`flatCollect` is a special case of `RichIterable.collect(Function)`.
`default <P,V> ListIterable<V>`	`flatCollectWith(Function2<? super T,? super P,? extends Iterable<V>> function, P parameter)`
`<V> SortedBagMultimap<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> SortedBagMultimap<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.
`T`	`max()`	Returns the maximum element out of this container based on the natural order, not the order of this bag.
`T`	`min()`	Returns the minimum element out of this container based on the natural order, not the order of this bag.
`PartitionSortedBag<T>`	`partition(Predicate<? super T> predicate)`	Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
`PartitionSortedBag<T>`	`partitionWhile(Predicate<? super T> predicate)`	Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
`<P> PartitionSortedBag<T>`	`partitionWith(Predicate2<? super T,? super P> predicate, P parameter)`	Filters a collection into a PartitionIterable based on the evaluation of the predicate.
`SortedBag<T>`	`reject(Predicate<? super T> predicate)`	Returns all elements of the source collection that return false when evaluating of the predicate.
`<P> SortedBag<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`.
`SortedBag<T>`	`select(Predicate<? super T> predicate)`	Returns all elements of the source collection that return true when evaluating the predicate.
`SortedBag<T>`	`selectByOccurrences(IntPredicate predicate)`	Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
`default SortedBag<T>`	`selectDuplicates()`	Returns all elements of the bag that have more than one occurrence.
`<S> SortedBag<S>`	`selectInstancesOf(Class<S> clazz)`	Returns all elements of the source collection that are instances of the Class `clazz`.
`SortedSetIterable<T>`	`selectUnique()`	Returns a set containing all elements of the bag that have exactly one occurrence.
`<P> SortedBag<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`.
`SortedBag<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.
`SortedBag<T>`	`takeWhile(Predicate<? super T> predicate)`	Returns the initial elements that satisfy the Predicate.
`SortedBag<T>`	`tap(Procedure<? super T> procedure)`	Executes the Procedure for each element in the iterable and returns `this`.
`ImmutableSortedBag<T>`	`toImmutable()`	Convert the SortedBag to an ImmutableSortedBag.
`SortedMapIterable<T,Integer>`	`toMapOfItemToCount()`	Converts the Bag to a Map of the Item type to its count as an Integer.
`SortedBag<T>`	`toReversed()`	Returns a new ReversibleIterable in reverse order.
`SortedSetIterable<Pair<T,Integer>>`	`zipWithIndex()`	Zips this `RichIterable` with its indices.

Methods inherited from interface org.eclipse.collections.api.bag.Bag
aggregateBy, allSatisfyWithOccurrences, anySatisfyWithOccurrences, bottomOccurrences, collectWithOccurrences, detectWithOccurrences, distinctView, equals, forEachWithOccurrences, hashCode, noneSatisfyWithOccurrences, occurrencesOf, reduceInPlace, reduceInPlace, sizeDistinct, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, topOccurrences, toStringOfItemToCount

Methods inherited from interface java.lang.Comparable
compareTo

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

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

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, zip

Methods inherited from interface org.eclipse.collections.api.RichIterable
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, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, 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, reject, rejectWith, select, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, 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

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

- Method Detail
  - selectByOccurrences
```
SortedBag<T> selectByOccurrences(IntPredicate predicate)
```
    Description copied from interface: Bag
    
    Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
    
    Specified by:
    
    selectByOccurrences in interface Bag<T>
  - selectDuplicates
```
default SortedBag<T> selectDuplicates()
```
    Description copied from interface: Bag
    
    Returns all elements of the bag that have more than one occurrence.
    
    Specified by:
    
    selectDuplicates in interface Bag<T>
    
    Since:
    
    9.2
  - selectUnique
```
SortedSetIterable<T> selectUnique()
```
    Description copied from interface: Bag
    
    Returns a set containing all elements of the bag that have exactly one occurrence.
    
    Specified by:
    
    selectUnique in interface Bag<T>
    
    Since:
    
    9.2
  - toMapOfItemToCount
```
SortedMapIterable<T,Integer> toMapOfItemToCount()
```
    Description copied from interface: Bag
    
    Converts the Bag to a Map of the Item type to its count as an Integer.
    
    Specified by:
    
    toMapOfItemToCount in interface Bag<T>
  - toImmutable
```
ImmutableSortedBag<T> toImmutable()
```
    Convert the SortedBag to an ImmutableSortedBag. If the bag is immutable, it returns itself. Not yet supported.
    
    Specified by:
    
    toImmutable in interface Bag<T>
  - min
```
T min()
```
    Returns the minimum element out of this container based on the natural order, not the order of this bag. If you want the minimum element based on the order of this bag, use RichIterable.getFirst().
    
    Specified by:
    
    min in interface OrderedIterable<T>
    
    Specified by:
    
    min in interface RichIterable<T>
    
    Specified by:
    
    min in interface SortedIterable<T>
    
    Throws:
    
    ClassCastException - if the elements are not Comparable
    
    NoSuchElementException - if the SortedBag is empty
    
    Since:
    
    1.0
  - max
```
T max()
```
    Returns the maximum element out of this container based on the natural order, not the order of this bag. If you want the maximum element based on the order of this bag, use RichIterable.getLast().
    
    Specified by:
    
    max in interface OrderedIterable<T>
    
    Specified by:
    
    max in interface RichIterable<T>
    
    Specified by:
    
    max in interface SortedIterable<T>
    
    Throws:
    
    ClassCastException - if the elements are not Comparable
    
    NoSuchElementException - if the SortedBag is empty
    
    Since:
    
    1.0
  - tap
```
SortedBag<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 Bag<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 SortedIterable<T>
    
    See Also:
    
    RichIterable.each(Procedure), RichIterable.forEach(Procedure)
  - select
```
SortedBag<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 Bag<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 SortedIterable<T>
  - selectWith
```
<P> SortedBag<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 Bag<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 SortedIterable<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
```
SortedBag<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 Bag<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 SortedIterable<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> SortedBag<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 Bag<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 SortedIterable<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
```
PartitionSortedBag<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 Bag<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 SortedIterable<T>
  - partitionWith
```
<P> PartitionSortedBag<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 Bag<T>
    
    Specified by:
    
    partitionWith in interface OrderedIterable<T>
    
    Specified by:
    
    partitionWith in interface ReversibleIterable<T>
    
    Specified by:
    
    partitionWith in interface RichIterable<T>
  - partitionWhile
```
PartitionSortedBag<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>
  - selectInstancesOf
```
<S> SortedBag<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 Bag<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 SortedIterable<T>
  - collect
```
<V> ListIterable<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 OrderedIterable<T>
    
    Specified by:
    
    collect in interface ReversibleIterable<T>
    
    Specified by:
    
    collect in interface RichIterable<T>
  - collectWithIndex
```
default <V> ListIterable<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>
    
    Since:
    
    9.1.
  - collectBoolean
```
BooleanList 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 OrderedIterable<T>
    
    Specified by:
    
    collectBoolean in interface ReversibleIterable<T>
    
    Specified by:
    
    collectBoolean in interface RichIterable<T>
  - collectByte
```
ByteList 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 OrderedIterable<T>
    
    Specified by:
    
    collectByte in interface ReversibleIterable<T>
    
    Specified by:
    
    collectByte in interface RichIterable<T>
  - collectChar
```
CharList 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 OrderedIterable<T>
    
    Specified by:
    
    collectChar in interface ReversibleIterable<T>
    
    Specified by:
    
    collectChar in interface RichIterable<T>
  - collectDouble
```
DoubleList 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 OrderedIterable<T>
    
    Specified by:
    
    collectDouble in interface ReversibleIterable<T>
    
    Specified by:
    
    collectDouble in interface RichIterable<T>
  - collectFloat
```
FloatList 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 OrderedIterable<T>
    
    Specified by:
    
    collectFloat in interface ReversibleIterable<T>
    
    Specified by:
    
    collectFloat in interface RichIterable<T>
  - collectInt
```
IntList 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 OrderedIterable<T>
    
    Specified by:
    
    collectInt in interface ReversibleIterable<T>
    
    Specified by:
    
    collectInt in interface RichIterable<T>
  - collectLong
```
LongList 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 OrderedIterable<T>
    
    Specified by:
    
    collectLong in interface ReversibleIterable<T>
    
    Specified by:
    
    collectLong in interface RichIterable<T>
  - collectShort
```
ShortList 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 OrderedIterable<T>
    
    Specified by:
    
    collectShort in interface ReversibleIterable<T>
    
    Specified by:
    
    collectShort in interface RichIterable<T>
  - collectWith
```
<P,V> ListIterable<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 OrderedIterable<T>
    
    Specified by:
    
    collectWith in interface ReversibleIterable<T>
    
    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> ListIterable<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 OrderedIterable<T>
    
    Specified by:
    
    collectIf in interface ReversibleIterable<T>
    
    Specified by:
    
    collectIf in interface RichIterable<T>
  - collectWithOccurrences
```
<V> ListIterable<V> collectWithOccurrences(ObjectIntToObjectFunction<? super T,? extends V> function)
```
    Description copied from interface: Bag
    
    Iterates over the unique elements and their occurrences and collects the results of applying the specified function.
    
    Specified by:
    
    collectWithOccurrences in interface Bag<T>
  - flatCollect
```
<V> ListIterable<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 OrderedIterable<T>
    
    Specified by:
    
    flatCollect in interface ReversibleIterable<T>
    
    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> ListIterable<V> flatCollectWith(Function2<? super T,? super P,? extends Iterable<V>> function,
                                                    P parameter)
```
    Specified by:
    
    flatCollectWith in interface OrderedIterable<T>
    
    Specified by:
    
    flatCollectWith in interface ReversibleIterable<T>
    
    Specified by:
    
    flatCollectWith in interface RichIterable<T>
    
    Since:
    
    9.2
  - distinct
```
SortedSetIterable<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>
    
    Returns:
    
    SortedIterable of distinct elements
  - takeWhile
```
SortedBag<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>
  - dropWhile
```
SortedBag<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>
  - groupBy
```
<V> SortedBagMultimap<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 Bag<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>
  - groupByEach
```
<V> SortedBagMultimap<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 Bag<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>
  - comparator
```
Comparator<? super T> comparator()
```
    Returns the comparator used to order the elements in this bag, or null if this bag uses the natural ordering of its elements.
    
    Specified by:
    
    comparator in interface SortedIterable<T>
  - zipWithIndex
```
SortedSetIterable<Pair<T,Integer>> zipWithIndex()
```
    Description copied from interface: RichIterable
    
    Zips this RichIterable with its indices.
    
    Specified by:
    
    zipWithIndex in interface Bag<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 SortedIterable<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
```
SortedBag<T> toReversed()
```
    Description copied from interface: ReversibleIterable
    
    Returns a new ReversibleIterable in reverse order.
    
    Specified by:
    
    toReversed in interface ReversibleIterable<T>
  - take
```
SortedBag<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>
    
    Parameters:
    
    count - the number of items to take.
  - drop
```
SortedBag<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>
    
    Parameters:
    
    count - the number of items to drop.

Interface SortedBag<T>

Method Summary

Methods inherited from interface org.eclipse.collections.api.bag.Bag

Methods inherited from interface java.lang.Comparable

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.ordered.SortedIterable

Method Detail

selectByOccurrences

selectDuplicates

selectUnique

toMapOfItemToCount

toImmutable

min

max

tap

select

selectWith

reject

rejectWith

partition

partitionWith

partitionWhile

selectInstancesOf

collect

collectWithIndex

collectBoolean

collectByte

collectChar

collectDouble

collectFloat

collectInt

collectLong

collectShort

collectWith

collectIf

collectWithOccurrences

flatCollect

flatCollectWith

distinct

takeWhile

dropWhile

groupBy

groupByEach

comparator

zipWithIndex

toReversed

take

drop