SortedIterable (Goldman Sachs Collections API

All Superinterfaces:

InternalIterable<T>, java.lang.Iterable<T>, RichIterable<T>

All Known Subinterfaces:

ImmutableSortedBag<T>, ImmutableSortedSet<T>, MutableSortedBag<T>, MutableSortedSet<T>, SortedBag<T>, SortedSetIterable<T>
```
public interface SortedIterable<T>
extends RichIterable<T>
```
A SortedIterable is an ordered iterable where the elements are stored in sorted order defined by a non-strict partial order relation. The sort order is determined by the Comparator returned by comparator() or is the natural ordering if comparator() returns null. Operations that would sort the collection can be faster than O(n log n). For example RichIterable.toSortedList() takes O(n) time.

Since:

5.0

Method Summary

Methods
Modifier and Type	Method and Description
`java.util.Comparator<? super T>`	`comparator()` Returns the comparator used to order the elements in this container, or null if this container uses the natural ordering of its elements.
`SortedIterable<T>`	`distinct()` Returns a new `SortedIterable` containing the distinct elements in this iterable.
`SortedIterable<T>`	`dropWhile(Predicate<? super T> predicate)` Returns the final elements that do not satisfy the Predicate.
`<V> SortedIterableMultimap<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> SortedIterableMultimap<V,T>`	`groupByEach(Function<? super T,? extends java.lang.Iterable<V>> function)` Similar to `RichIterable.groupBy(Function)`, except the result of evaluating function will return a collection of keys for each value.
`T`	`max()` Returns the maximum element out of this container based on the natural order, not the order of this container.
`T`	`min()` Returns the minimum element out of this container based on the natural order, not the order of this container.
`PartitionSortedIterable<T>`	`partition(Predicate<? super T> predicate)` Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
`PartitionSortedIterable<T>`	`partitionWhile(Predicate<? super T> predicate)` Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
`SortedIterable<T>`	`reject(Predicate<? super T> predicate)` Returns all elements of the source collection that return false when evaluating of the predicate.
`<P> SortedIterable<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`.
`SortedIterable<T>`	`select(Predicate<? super T> predicate)` Returns all elements of the source collection that return true when evaluating the predicate.
`<S> SortedIterable<S>`	`selectInstancesOf(java.lang.Class<S> clazz)` Returns all elements of the source collection that are instances of the Class `clazz`.
`<P> SortedIterable<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`.
`SortedIterable<T>`	`takeWhile(Predicate<? super T> predicate)` Returns the initial elements that satisfy the Predicate.
`MutableStack<T>`	`toStack()` Converts the SortedIterable to a mutable MutableStack implementation.
`<S> ListIterable<Pair<T,S>>`	`zip(java.lang.Iterable<S> that)` Returns a `RichIterable` formed from this `RichIterable` and another `RichIterable` by combining corresponding elements in pairs.
`SortedIterable<Pair<T,java.lang.Integer>>`	`zipWithIndex()` Zips this `RichIterable` with its indices.

Methods inherited from interface com.gs.collections.api.RichIterable
aggregateBy, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collect, collectBoolean, collectBoolean, collectByte, collectByte, collectChar, collectChar, collectDouble, collectDouble, collectFloat, collectFloat, collectIf, collectIf, collectInt, collectInt, collectLong, collectLong, collectShort, collectShort, collectWith, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, flatCollect, getFirst, getLast, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, maxBy, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, partitionWith, reject, rejectWith, select, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from interface com.gs.collections.api.InternalIterable
forEach, forEachWith, forEachWithIndex

Methods inherited from interface java.lang.Iterable
iterator

- Method Detail
  - comparator
```
java.util.Comparator<? super T> comparator()
```
    Returns the comparator used to order the elements in this container, or null if this container uses the natural ordering of its elements.
  - takeWhile
```
SortedIterable<T> takeWhile(Predicate<? super T> predicate)
```
    Returns the initial elements that satisfy the Predicate. Short circuits at the first element which does not satisfy the Predicate.
  - dropWhile
```
SortedIterable<T> dropWhile(Predicate<? super T> predicate)
```
    Returns the final elements that do not satisfy the Predicate. Short circuits at the first element which does satisfy the Predicate.
  - partitionWhile
```
PartitionSortedIterable<T> partitionWhile(Predicate<? super T> predicate)
```
    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.
  - distinct
```
SortedIterable<T> distinct()
```
    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.
    
    Returns:
    SortedIterable of distinct elements
  - toStack
```
MutableStack<T> toStack()
```
    Converts the SortedIterable to a mutable MutableStack implementation.
  - min
```
T min()
```
    Returns the minimum element out of this container based on the natural order, not the order of this container. If you want the minimum element based on the order of this container, use RichIterable.getFirst().
    
    Specified by:
    
    min in interface RichIterable<T>
    
    Throws:
    
    java.lang.ClassCastException - if the elements are not Comparable
    
    java.util.NoSuchElementException - if the SortedIterable is empty
  - max
```
T max()
```
    Returns the maximum element out of this container based on the natural order, not the order of this container. If you want the maximum element based on the order of this container, use RichIterable.getLast().
    
    Specified by:
    
    max in interface RichIterable<T>
    
    Throws:
    
    java.lang.ClassCastException - if the elements are not Comparable
    
    java.util.NoSuchElementException - if the SortedIterable is empty
  - select
```
SortedIterable<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.
```
e.g.
 return people.select(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.getAddress().getCity().equals("Metuchen");
     }
 });
 
```
    Specified by:
    
    select in interface RichIterable<T>
  - selectWith
```
<P> SortedIterable<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.
    
    Specified by:
    
    selectWith in interface RichIterable<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
```
SortedIterable<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)).
```
e.g.
 return people.reject(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.person.getLastName().equals("Smith");
     }
 });
 
```
```
e.g.
 return people.reject(Predicates.attributeEqual("lastName", "Smith"));
 
```
    Specified by:
    
    reject in interface RichIterable<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> SortedIterable<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.
    
    Specified by:
    
    rejectWith in interface RichIterable<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
```
PartitionSortedIterable<T> partition(Predicate<? super T> predicate)
```
    Description copied from interface: RichIterable
    Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
```
e.g.
 return people.partition(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.getAddress().getState().getName().equals("New York");
     }
 });
 
```
    Specified by:
    
    partition in interface RichIterable<T>
  - selectInstancesOf
```
<S> SortedIterable<S> selectInstancesOf(java.lang.Class<S> clazz)
```
    Description copied from interface: RichIterable
    
    Returns all elements of the source collection that are instances of the Class clazz.
    
    Specified by:
    
    selectInstancesOf in interface RichIterable<T>
  - groupBy
```
<V> SortedIterableMultimap<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.
```
e.g.
 return people.groupBy(new Function<Person, String>()
 {
     public String value(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 });
 
```
    Specified by:
    
    groupBy in interface RichIterable<T>
  - groupByEach
```
<V> SortedIterableMultimap<V,T> groupByEach(Function<? super T,? extends java.lang.Iterable<V>> function)
```
    Description copied from interface: RichIterable
    
    Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
    
    Specified by:
    
    groupByEach in interface RichIterable<T>
  - zip
```
<S> ListIterable<Pair<T,S>> zip(java.lang.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 RichIterable<T>
    
    Type Parameters:
    S - the type of the second half of the returned pairs
    Parameters:
    that - The RichIterable providing the second half of each result pair
    
    Returns:
    A new RichIterable containing pairs consisting of corresponding elements of this RichIterable and that. The length of the returned RichIterable is the minimum of the lengths of this RichIterable and that.
  - zipWithIndex
```
SortedIterable<Pair<T,java.lang.Integer>> zipWithIndex()
```
    Description copied from interface: RichIterable
    
    Zips this RichIterable with its indices.
    
    Specified by:
    
    zipWithIndex in interface RichIterable<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)

Interface SortedIterable<T>

Method Summary

Methods inherited from interface com.gs.collections.api.RichIterable

Methods inherited from interface com.gs.collections.api.InternalIterable

Methods inherited from interface java.lang.Iterable

Method Detail

comparator

takeWhile

dropWhile

partitionWhile

distinct

toStack

min

max

select

selectWith

reject

rejectWith

partition

selectInstancesOf

groupBy

groupByEach

zip

zipWithIndex