Package org.eclipse.collections.api.ordered

Interface SortedIterable<T>

All Superinterfaces:
InternalIterable<T>, Iterable<T>, OrderedIterable<T>, RichIterable<T>
All Known Subinterfaces:
ImmutableSortedBag<T>, ImmutableSortedSet<T>, MutableSortedBag<T>, MutableSortedSet<T>, SortedBag<T>, SortedSetIterable<T>
All Known Implementing Classes:
AbstractMutableSortedBag, SortedSetAdapter, SynchronizedSortedBag, SynchronizedSortedSet, TreeBag, TreeSortedSet, UnmodifiableSortedBag, UnmodifiableSortedSet
public interface SortedIterable<T> extends OrderedIterable<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 Details

    • comparator

      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.

    • tap

      SortedIterable<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()));

      Example using an anonymous inner class: 

       RichIterable<Person> tapped =
     people.tap(new Procedure<Person>()
     {
         public void value(Person person)
         {
             LOGGER.info(person.getName());
         }
     });
      Specified by:
      tap in interface OrderedIterable<T>
      Specified by:
      tap in interface RichIterable<T>
      See Also:

    • 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.
      Specified by:
      takeWhile in interface OrderedIterable<T>

    • 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.
      Specified by:
      dropWhile in interface OrderedIterable<T>

    • 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.
      Specified by:
      partitionWhile in interface OrderedIterable<T>

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

      Specified by:
      distinct in interface OrderedIterable<T>
      Returns:
      SortedIterable of distinct elements

    • 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 OrderedIterable.getFirst().
      Specified by:
      min in interface OrderedIterable<T>
      Specified by:
      min in interface RichIterable<T>
      Throws:
      ClassCastException - if the elements are not Comparable
      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 OrderedIterable.getLast().
      Specified by:
      max in interface OrderedIterable<T>
      Specified by:
      max in interface RichIterable<T>
      Throws:
      ClassCastException - if the elements are not Comparable
      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.

      Example using a Java 8 lambda expression: 

       RichIterable<Person> selected =
     people.select(person -> person.getAddress().getCity().equals("London"));

      Example using an anonymous inner class: 

       RichIterable<Person> selected =
     people.select(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getAddress().getCity().equals("London");
         }
     });
      Specified by:
      select in interface OrderedIterable<T>
      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.

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

      Example using an anonymous inner class: 

       RichIterable<Person> selected =
     people.selectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge()>= age;
         }
     }, Integer.valueOf(18));
      Specified by:
      selectWith in interface OrderedIterable<T>
      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:

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

      Example using a Java 8 lambda expression: 

       RichIterable<Person> rejected =
     people.reject(person -> person.person.getLastName().equals("Smith"));

      Example using an anonymous inner class: 

       RichIterable<Person> rejected =
     people.reject(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.person.getLastName().equals("Smith");
         }
     });
      Specified by:
      reject in interface OrderedIterable<T>
      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.

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

      Example using an anonymous inner class: 

       MutableList<Person> rejected =
     people.rejectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge() < age;
         }
     }, Integer.valueOf(18));
      Specified by:
      rejectWith in interface OrderedIterable<T>
      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:

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

      Example using a Java 8 lambda expression: 

       PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partition(person -> person.getAddress().getState().getName().equals("New York"));

      Example using an anonymous inner class: 

       PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partition(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getAddress().getState().getName().equals("New York");
         }
     });
      Specified by:
      partition in interface OrderedIterable<T>
      Specified by:
      partition in interface RichIterable<T>

    • selectInstancesOf

      <S> SortedIterable<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 OrderedIterable<T>
      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.

      Example using a Java 8 method reference: 

       Multimap<String, Person> peopleByLastName =
     people.groupBy(Person::getLastName);

      Example using an anonymous inner class: 

       Multimap<String, Person> peopleByLastName =
     people.groupBy(new Function<Person, String>()
     {
         public String valueOf(Person person)
         {
             return person.getLastName();
         }
     });
      Specified by:
      groupBy in interface OrderedIterable<T>
      Specified by:
      groupBy in interface RichIterable<T>

    • groupByEach

      <V> SortedIterableMultimap<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 OrderedIterable<T>
      Specified by:
      groupByEach in interface RichIterable<T>

    • zip

      <S> ListIterable<Pair<T,S>> zip(Iterable<S> that)
      Description copied from interface: OrderedIterable
      Returns a OrderedIterable formed from this OrderedIterable and another Iterable by combining corresponding elements in pairs. The second Iterable should also be ordered. If one of the two Iterables is longer than the other, its remaining elements are ignored.
      Specified by:
      zip in interface OrderedIterable<T>
      Specified by:
      zip in interface RichIterable<T>
      Type Parameters:
      S - the type of the second half of the returned pairs
      Parameters:
      that - The Iterable providing the second half of each result pair
      Returns:
      A new OrderedIterable containing pairs consisting of corresponding elements of this OrderedIterable and that. The length of the returned OrderedIterable is the minimum of the lengths of this OrderedIterable and that.

    • zipWithIndex

      SortedIterable<Pair<T,Integer>> zipWithIndex()
      Description copied from interface: RichIterable
      Zips this RichIterable with its indices.
      Specified by:
      zipWithIndex in interface OrderedIterable<T>
      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: