Package org.eclipse.collections.api.ordered

Interface SortedIterable<T>

    • Method Detail

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

      • 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

      • 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"));
        Specified by:
        select in interface OrderedIterable<T>
        Specified by:
        select in interface RichIterable<T>

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

      • 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"));
        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);
        Specified by:
        groupBy in interface OrderedIterable<T>
        Specified by:
        groupBy 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.