de.javagl.common.iteration

Class Iterables

java.lang.Object

de.javagl.common.iteration.Iterables

public class Iterables
extends Object

Utility methods related to Iterables.

Unless otherwise noted, none of the parameters of these methods may be null.

Method Summary

Modifier and Type	Method and Description
static <T> Iterable<T>	filteringIterable(Iterable<? extends T> iterable, Predicate<? super T> predicate) Returns an iterable that provides an iterator that only returns the elements provided by the iterator of the given iterable to which the given predicate applies.
static <T> boolean	isSorted(Iterable<? extends T> iterable, Comparator<? super T> comparator) Returns whether the given iterable is sorted according to the given comparator.
static <T> Iterable<T>	iterableOverIterables(Iterable<? extends Iterable<? extends T>> iterablesIterable) Returns an iterator that combines the iterators that are provided by the iterables that are provided by the iterator of the given iterable.
static <T,C extends Collection<? super T>> C	toCollection(Iterable<T> iterable, C collection) Drains all elements that are provided by the iterator of the given iterable into the given collection
static <T> List<T>	toList(Iterable<T> iterable) Drains all elements that are provided by the iterator of the given iterable into a list
static <T> Set<T>	toSet(Iterable<T> iterable) Drains all elements that are provided by the iterator of the given iterable into a set
static <S,T> Iterable<T>	transformingIterable(Iterable<? extends S> iterable, Function<S,? extends T> function) Returns an iterable that provides iterators that are transforming the elements provided by the iterators of the given iterable using the given function

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

toList

public static <T> List<T> toList(Iterable<T> iterable)

Drains all elements that are provided by the iterator of the given iterable into a list

Type Parameters:

T - The element type

Parameters:

iterable - The iterable

Returns:

The list

toSet

public static <T> Set<T> toSet(Iterable<T> iterable)

Drains all elements that are provided by the iterator of the given iterable into a set

Type Parameters:

T - The element type

Parameters:

iterable - The iterable

Returns:

The set

toCollection

public static <T,C extends Collection<? super T>> C toCollection(Iterable<T> iterable,
                                                                 C collection)

Drains all elements that are provided by the iterator of the given iterable into the given collection

Type Parameters:

T - The element type

C - The collection type

Parameters:

iterable - The iterable

collection - The target collection

Returns:

The given collection

iterableOverIterables

public static <T> Iterable<T> iterableOverIterables(Iterable<? extends Iterable<? extends T>> iterablesIterable)

Returns an iterator that combines the iterators that are provided by the iterables that are provided by the iterator of the given iterable. Fancy stuff, he?

Type Parameters:

T - The element type

Parameters:

iterablesIterable - The iterable over the iterables. May not provide null iterables.

Returns:

The iterator

transformingIterable

public static <S,T> Iterable<T> transformingIterable(Iterable<? extends S> iterable,
                                                     Function<S,? extends T> function)

Returns an iterable that provides iterators that are transforming the elements provided by the iterators of the given iterable using the given function

Type Parameters:

S - The element type

T - The value type

Parameters:

iterable - The delegate iterable

function - The function

Returns:

The iterator

filteringIterable

public static <T> Iterable<T> filteringIterable(Iterable<? extends T> iterable,
                                                Predicate<? super T> predicate)

Returns an iterable that provides an iterator that only returns the elements provided by the iterator of the given iterable to which the given predicate applies.

Type Parameters:

T - The element type

Parameters:

iterable - The delegate iterable

predicate - The predicate

Returns:

The iterator

isSorted

public static <T> boolean isSorted(Iterable<? extends T> iterable,
                                   Comparator<? super T> comparator)

Returns whether the given iterable is sorted according to the given comparator. Returns true if the sequence is empty.

Type Parameters:

T - The element type

Parameters:

iterable - The iterable

comparator - The comparator

Returns:

Whether the iterable is sorted