Interactive (reactive4java 0.98.0 API)

java.lang.Object
- hu.akarnokd.reactive4java.interactive.Interactive

```
public final class Interactive
extends java.lang.Object
```
The interactive (i.e., Iterable based) counterparts of the Reactive operators.
The implementations of the operators are partially derived from the Reactive operators.

See Also:

Reactive

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Interactive.LinkedBuffer<T>
A linked buffer, which can be only filled and queried.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Interactive.LinkedBuffer<T>` A linked buffer, which can be only filled and queried.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T,U,V> java.lang.Iterable<V>`	`aggregate(java.lang.Iterable<? extends T> source, Func2<? super U,? super T,? extends U> sum, Func2<? super U,? super java.lang.Integer,? extends V> divide)` Creates an iterable which traverses the source iterable and maintains a running sum value based on the `sum` function parameter.
`static <T> java.lang.Iterable<java.lang.Boolean>`	`all(java.lang.Iterable<? extends T> source, Func1<? super T,java.lang.Boolean> predicate)` Returns an iterable which contains true if all elements of the source iterable satisfy the predicate.
`static <T> java.lang.Iterable<java.lang.Boolean>`	`any(java.lang.Iterable<? extends T> source, Func1<? super T,java.lang.Boolean> predicate)` Tests if there is any element of the source that satisfies the given predicate function.
`static <T> java.lang.Iterable<java.lang.Boolean>`	`any(java.lang.Iterable<T> source)` Determines if the given source has any elements at all.
`static <T,V extends java.lang.Comparable<? super V>> Pair<T,V>`	`argAndMax(java.lang.Iterable<? extends T> source, Func1<? super T,? extends V> valueSelector)` Returns a pair of the maximum argument and value from the given sequence.
`static <T,V> Pair<T,V>`	`argAndMax(java.lang.Iterable<? extends T> source, Func1<? super T,? extends V> valueSelector, java.util.Comparator<? super V> valueComparator)` Returns a pair of the maximum argument and value from the given sequence.
`static <T,V extends java.lang.Comparable<? super V>> Pair<T,V>`	`argAndMin(java.lang.Iterable<? extends T> source, Func1<? super T,? extends V> valueSelector)` Returns a pair of the maximum argument and value from the given sequence.
`static <T,V> Pair<T,V>`	`argAndMin(java.lang.Iterable<? extends T> source, Func1<? super T,? extends V> valueSelector, java.util.Comparator<? super V> valueComparator)` Returns a pair of the minimum argument and value from the given sequence.
`static java.lang.Iterable<java.math.BigDecimal>`	`averageBigDecimal(java.lang.Iterable<java.math.BigDecimal> source)` Returns an iterable which averages the source BigDecimal values.
`static java.lang.Iterable<java.math.BigDecimal>`	`averageBigInteger(java.lang.Iterable<java.math.BigInteger> source)` Returns an iterable which averages the source BigInteger values.
`static java.lang.Iterable<java.lang.Double>`	`averageDouble(java.lang.Iterable<java.lang.Double> source)` Returns an iterable which averages the source Double values.
`static java.lang.Iterable<java.lang.Float>`	`averageFloat(java.lang.Iterable<java.lang.Float> source)` Returns an iterable which averages the source Float values.
`static java.lang.Iterable<java.lang.Double>`	`averageInt(java.lang.Iterable<java.lang.Integer> source)` Returns an iterable which averages the source Integer values.
`static java.lang.Iterable<java.lang.Double>`	`averageLong(java.lang.Iterable<java.lang.Long> source)` Returns an iterable which averages the source Integer values.
`static <T> java.lang.Iterable<java.util.List<T>>`	`buffer(java.lang.Iterable<? extends T> source, int bufferSize)` Returns an iterable which buffers the source elements into `bufferSize` lists.
`static <T> java.lang.Iterable<T>`	`cast(java.lang.Iterable<?> source, java.lang.Class<T> token)` Casts the source iterable into a different type by using a type token.
`static <T> java.lang.Iterable<T>`	`catchException(java.lang.Iterable<? extends T> source)` Creates an iterable which if iterates over the source and encounters an exception, it simply stops the iteration, consuming the exception.
`static <T> java.lang.Iterable<T>`	`catchException(java.lang.Iterable<? extends T> source, Func1<? super java.lang.Throwable,? extends java.lang.Iterable<? extends T>> handler)` Creates an iterable which if iterates over the source and encounters an exception, the iteration is continued on the new iterable returned by the handler function.
`static <T> java.lang.Iterable<T>`	`concat(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources)` Concatenate the given iterable sources one after another in a way, that calling the second `iterator()` only happens when there is no more element in the first iterator.
`static <T> java.lang.Iterable<T>`	`concat(java.lang.Iterable<? extends T> first, java.lang.Iterable<? extends T> second)` Concatenate the given iterable sources one after another in a way, that calling the second `iterator()` only happens when there is no more element in the first iterator.
`static <T> java.lang.Iterable<java.lang.Boolean>`	`contains(java.lang.Iterable<? extends T> source, T value)` Returns an iterable which checks for the existence of the supplied value by comparing the elements of the source iterable using reference and `equals()`.
`static <T> java.lang.Iterable<java.lang.Integer>`	`count(java.lang.Iterable<T> source)` Counts the elements of the iterable source by using a 32 bit `int`.
`static <T> java.lang.Iterable<java.lang.Long>`	`countLong(java.lang.Iterable<T> source)` Counts the elements of the iterable source by using a 64 bit `long`.
`static <T> java.lang.Iterable<T>`	`defer(Func0<? extends java.lang.Iterable<T>> func)` Defers the source iterable creation to registration time and calls the given `func` for the actual source.
`static <T> java.lang.Iterable<T>`	`dematerialize(java.lang.Iterable<? extends Option<? extends T>> source)` Convert the source materialized elements into normal iterator behavior.
`static <T> java.util.Iterator<T>`	`differentAggregator(java.util.Iterator<? extends T> src, Func2<? super T,? super T,java.lang.Boolean> isDifferent, Action2<T,? super T> aggregate)` Aggregates subsequent elements (in place) as long as `isDifferent` returns false.
`static <T> java.lang.Iterable<T>`	`distinct(java.lang.Iterable<? extends T> source)` Returns an iterable which filters its elements based if they were ever seen before in the current iteration.
`static <T,U,V> java.lang.Iterable<V>`	`distinct(java.lang.Iterable<? extends T> source, Func1<? super T,? extends U> keySelector, Func1<? super T,? extends V> valueSelector)` Returns an iterable which filters its elements by an unique key in a way that when multiple source items produce the same key, only the first one ever seen gets relayed further on.
`static <T> java.lang.Iterable<T>`	`distinctNext(java.lang.Iterable<? extends T> source)` Creates an iterable which ensures that subsequent values of T are not equal (reference and equals).
`static <T,U> java.lang.Iterable<T>`	`distinctNext(java.lang.Iterable<? extends T> source, Func1<T,U> keyExtractor)` Creates an iterable which ensures that subsequent values of T are not equal in respect to the extracted keys (reference and equals).
`static <T> java.lang.Iterable<T>`	`doWhile(java.lang.Iterable<? extends T> source, Func0<java.lang.Boolean> gate)` Returns an iterable which reiterates over and over again on `source` as long as the gate is true.
`static boolean`	`elementsEqual(java.lang.Iterable<?> iterable1, java.lang.Iterable<?> iterable2)` Determines whether two iterables contain equal elements in the same order.
`static boolean`	`elementsEqual(java.util.Iterator<?> iterator1, java.util.Iterator<?> iterator2)` Compares two iterators wether they contain the same element in terms of numbers and nullsafe Object.equals().
`static <T> java.lang.Iterable<T>`	`empty()` Returns an empty iterable which will not produce elements.
`static <T> java.lang.Iterable<T>`	`endWith(java.lang.Iterable<? extends T> source, T value)` Creates an iterable sequence which returns all elements from source followed by the supplied value as last.
`static <T> java.lang.Iterable<T>`	`finish(java.lang.Iterable<? extends T> source, Action0 action)` Returns an iterable which executes the given action after the stream completes.
`static <T> T`	`first(java.lang.Iterable<? extends T> src)` Returns the first element from the iterable sequence or throws a NoSuchElementException.
`static <T,U> java.lang.Iterable<U>`	`forEach(java.lang.Iterable<? extends T> source, Func1<? super T,? extends java.lang.Iterable<? extends U>> selector)` Returns an iterable which runs the source iterable and returns elements from the iterable returned by the function call.
`static <T> java.lang.Iterable<T>`	`generate(T seed, Func1<? super T,java.lang.Boolean> predicate, Func1<? super T,? extends T> next)` A generator function which returns Ts based on the termination condition and the way it computes the next values.
`static <T> java.lang.Iterable<T>`	`generate(T seed, Func1<? super T,java.lang.Boolean> predicate, Func1<? super T,? extends T> next, long initialDelay, long betweenDelay, java.util.concurrent.TimeUnit unit)` A generator function which returns Ts based on the termination condition and the way it computes the next values, but the first T to be returned is preceded by an `initialDelay` amount of wait and each subsequent element is then generated after `betweenDelay` sleep.
`static <T,V> java.lang.Iterable<GroupedIterable<V,T>>`	`groupBy(java.lang.Iterable<? extends T> source, Func1<? super T,? extends V> keySelector)` Creates an iterable which traverses the source iterable, and based on the key selector, groups values of T into GroupedIterables, which can be iterated over later on.
`static <T,U,V> java.lang.Iterable<GroupedIterable<V,U>>`	`groupBy(java.lang.Iterable<? extends T> source, Func1<? super T,? extends V> keySelector, Func1<? super T,? extends U> valueSelector)` Creates an iterable which traverses the source iterable, and based on the key selector, groups values extracted by valueSelector into GroupedIterables, which can be iterated over later on.
`static <T> java.lang.Iterable<T>`	`invoke(java.lang.Iterable<? extends T> source, Action1<? super T> action)` Construct a new iterable which will invoke the specified action before the source value gets relayed through it.
`static <T> java.lang.Iterable<T>`	`invoke(java.lang.Iterable<? extends T> source, Action1<? super T> next, Action0 finish)` Returns an iterable which invokes the given `next` action for each element and the `finish` action when the source completes.
`static <T> java.lang.Iterable<T>`	`invoke(java.lang.Iterable<? extends T> source, Action1<? super T> next, Action1<? super java.lang.Throwable> error)` Returns an iterable which invokes the given `next` action for each element and `error` when an exception is thrown.
`static <T> java.lang.Iterable<T>`	`invoke(java.lang.Iterable<? extends T> source, Action1<? super T> next, Action1<? super java.lang.Throwable> error, Action0 finish)` Returns an iterable which invokes the given `next` action for each element and the `finish` action when the source completes and `error` when an exception is thrown.
`static java.lang.Iterable<java.lang.Boolean>`	`isEmpty(java.lang.Iterable<?> source)` Returns a single true if the target iterable is empty.
`static java.lang.Iterable<java.lang.String>`	`join(java.lang.Iterable<?> source, java.lang.String separator)` Concatenates the source strings one after another and uses the given separator.
`static <T> T`	`last(java.lang.Iterable<? extends T> source)` Returns the last element of the iterable or throws a `NoSuchElementException` if the iterable is empty.
`static <T> java.lang.Iterable<Option<T>>`	`materialize(java.lang.Iterable<? extends T> source)` Transforms the sequence of the source iterable into an option sequence of Option.some(), Option.none() and Option.error() values, depending on what the source's hasNext() and next() produces.
`static <T extends java.lang.Comparable<? super T>> java.lang.Iterable<T>`	`max(java.lang.Iterable<? extends T> source)` Returns the maximum value of the given iterable source.
`static <T> java.lang.Iterable<T>`	`max(java.lang.Iterable<? extends T> source, java.util.Comparator<? super T> comparator)` Returns the maximum value of the given iterable source in respect to the supplied comparator.
`static <T extends java.lang.Comparable<? super T>> java.lang.Iterable<java.util.List<T>>`	`maxBy(java.lang.Iterable<? extends T> source)` Returns an iterator which will produce a single List of the maximum values encountered in the source stream based on the supplied key selector.
`static <T> java.lang.Iterable<java.util.List<T>>`	`maxBy(java.lang.Iterable<? extends T> source, java.util.Comparator<? super T> comparator)` Returns an iterator which will produce a single List of the maximum values encountered in the source stream based on the supplied comparator.
`static <T,U extends java.lang.Comparable<? super U>> java.lang.Iterable<java.util.List<T>>`	`maxBy(java.lang.Iterable<? extends T> source, Func1<? super T,? extends U> keySelector)` Returns an iterator which will produce a single List of the maximum values encountered in the source stream based on the supplied key selector.
`static <T,U> java.lang.Iterable<java.util.List<T>>`	`maxBy(java.lang.Iterable<? extends T> source, Func1<? super T,? extends U> keySelector, java.util.Comparator<? super U> keyComparator)` Returns an iterator which will produce a single List of the minimum values encountered in the source stream based on the supplied key selector and comparator.
`static <T> java.lang.Iterable<T>`	`memoize(java.lang.Iterable<? extends T> source, int bufferSize)` Enumerates the source iterable once and caches its results.
`static <T> java.lang.Iterable<T>`	`memoizeAll(java.lang.Iterable<? extends T> source)` The returned iterable ensures that the source iterable is only traversed once, regardless of how many iterator attaches to it and each iterator see only the values.
`static <T> java.lang.Iterable<T>`	`merge(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources)` Merges a bunch of iterable streams where each of the iterable will run by a scheduler and their events are merged together in a single stream.
`static <T> java.lang.Iterable<T>`	`merge(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources, Scheduler scheduler)` Merges a bunch of iterable streams where each of the iterable will run by a scheduler and their events are merged together in a single stream.
`static <T> java.lang.Iterable<T>`	`merge(java.lang.Iterable<? extends T> first, java.lang.Iterable<? extends T> second)` Merges two iterable streams.
`static <T extends java.lang.Comparable<? super T>> java.lang.Iterable<T>`	`min(java.lang.Iterable<? extends T> source)` Returns the minimum value of the given iterable source.
`static <T> java.lang.Iterable<T>`	`min(java.lang.Iterable<? extends T> source, java.util.Comparator<? super T> comparator)` Returns the minimum value of the given iterable source in respect to the supplied comparator.
`static <T extends java.lang.Comparable<? super T>> java.lang.Iterable<java.util.List<T>>`	`minBy(java.lang.Iterable<? extends T> source)` Returns an iterator which will produce a single List of the minimum values encountered in the source stream based on the supplied key selector.
`static <T> java.lang.Iterable<java.util.List<T>>`	`minBy(java.lang.Iterable<? extends T> source, java.util.Comparator<? super T> comparator)` Returns an iterator which will produce a single List of the minimum values encountered in the source stream based on the supplied comparator.
`static <T,U extends java.lang.Comparable<? super U>> java.lang.Iterable<java.util.List<T>>`	`minBy(java.lang.Iterable<? extends T> source, Func1<? super T,? extends U> keySelector)` Returns an iterator which will produce a single List of the minimum values encountered in the source stream based on the supplied key selector.
`static <T,U> java.lang.Iterable<java.util.List<T>>`	`minBy(java.lang.Iterable<? extends T> source, Func1<? super T,? extends U> keySelector, java.util.Comparator<? super U> keyComparator)` Returns an iterator which will produce a single List of the minimum values encountered in the source stream based on the supplied key selector and comparator.
`static <T> CloseableIterable<T>`	`newCloseableIterable(java.lang.Iterable<? extends T> src, Action0 close)` Wraps the given source sequence into a CloseableIterable instance where the inner CloseableIterator.close() method calls the supplied action.
`static <T> CloseableIterable<T>`	`newCloseableIterable(java.lang.Iterable<? extends T> src, Action1<? super java.util.Iterator<? extends T>> close)` Wraps the given source sequence into a CloseableIterable instance where the inner CloseableIterator.close() method calls the supplied action.
`static <T> CloseableIterable<T>`	`newCloseableIterable(java.lang.Iterable<? extends T> src, java.io.Closeable close)` Wraps the given source sequence into a CloseableIterable instance where the inner CloseableIterator.close() method calls the supplied closeable object.
`static <T> CloseableIterator<T>`	`newCloseableIterator(java.util.Iterator<? extends T> src, Action0 close)` Wraps the supplied iterator into a CloseableIterator which calls the supplied close action.
`static <T> CloseableIterator<T>`	`newCloseableIterator(java.util.Iterator<? extends T> src, Action1<? super java.util.Iterator<? extends T>> close)` Wraps the supplied iterator into a CloseableIterator which calls the supplied close action with the given source iterator object.
`static <T> CloseableIterator<T>`	`newCloseableIterator(java.util.Iterator<? extends T> src, java.io.Closeable close)` Wraps the supplied iterator into a CloseableIterator which calls the supplied closeable instance.
`static <T,U extends java.util.Iterator<T>> java.lang.Iterable<T>`	`newIterable(Func0<U> body)` Creates a new iterable sequence by wrapping the given function to provide the iterator.
`static <T> java.util.Iterator<T>`	`newIterator(Func0<java.lang.Boolean> hasNext, Func0<? extends T> next)` A functional way of creating a new iterator from the supplied hasNext and next callbacks.
`static <T> java.util.Iterator<T>`	`newIterator(Func0<java.lang.Boolean> hasNext, Func0<? extends T> next, Action0 remove)` Constructs an iterator instance by wrapping the supplied functions into the same-named iterator methods.
`static <T extends java.lang.Comparable<? super T>> java.lang.Iterable<T>`	`orderBy(java.lang.Iterable<? extends T> source)` Returns an iterable which traverses the entire source iterable and creates an ordered list of elements.
`static <T> java.lang.Iterable<T>`	`orderBy(java.lang.Iterable<? extends T> source, java.util.Comparator<? super T> comparator)` Returns an iterable which traverses the entire source iterable and creates an ordered list of elements.
`static <T,U extends java.lang.Comparable<? super U>> java.lang.Iterable<T>`	`orderBy(java.lang.Iterable<? extends T> source, Func1<? super T,? extends U> keySelector)` Returns an iterable which traverses the entire source iterable and creates an ordered list of elements.
`static <T,U> java.lang.Iterable<T>`	`orderBy(java.lang.Iterable<? extends T> source, Func1<? super T,? extends U> keySelector, java.util.Comparator<? super U> keyComparator)` Returns an iterable which traverses the entire source iterable and creates an ordered list of elements.
`static <T> Action1<T>`	`print()` Creates an observer with debugging purposes.
`static <T> Action1<T>`	`print(java.lang.String separator, int maxLineLength)` Creates an observer with debugging purposes.
`static <T> Action1<T>`	`println()` Creates an action for debugging purposes.
`static <T> Action1<T>`	`println(java.lang.String prefix)` Creates an action for debugging purposes.
`static <T,U> java.lang.Iterable<U>`	`prune(java.lang.Iterable<? extends T> source, Func1<? super java.lang.Iterable<? extends T>,? extends java.lang.Iterable<U>> func)` Applies the `func` function for a shared instance of the source, e.g., `func.invoke(share(source))`.
`static <T,U> java.lang.Iterable<U>`	`publish(java.lang.Iterable<? extends T> source, Func1<? super java.lang.Iterable<? super T>,? extends java.lang.Iterable<? extends U>> func, U initial)` The returned iterable ensures that the source iterable is only traversed once, regardless of how many iterator attaches to it and each iterator see only the same cached values.
`static <T,U> java.lang.Iterable<U>`	`publish(java.lang.Iterable<? extends T> source, Func1<? super java.lang.Iterable<T>,? extends java.lang.Iterable<U>> func)` The returned iterable ensures that the source iterable is only traversed once, regardless of how many iterator attaches to it and each iterator see only the values.
`static java.lang.Iterable<java.lang.Integer>`	`range(int start, int count)` Creates an integer iterator which returns numbers from the start position in the count size.
`static java.lang.Iterable<java.lang.Long>`	`range(long start, long count)` Creates an long iterator which returns numbers from the start position in the count size.
`static <T> java.lang.Iterable<T>`	`relayWhile(java.lang.Iterable<? extends T> source, Func0<java.lang.Boolean> gate)` Relays the source iterable's values until the gate returns false.
`static <T> java.lang.Iterable<T>`	`repeat(T value)` Creates an iterable sequence which returns the given value indefinitely.
`static <T> java.lang.Iterable<T>`	`repeat(T value, int count)` Returns an iterable which repeats the given single value the specified number of times.
`static <T,U> java.lang.Iterable<U>`	`replay(java.lang.Iterable<? extends T> source, Func1<? super java.lang.Iterable<T>,? extends java.lang.Iterable<U>> func)` The returned iterable ensures that the source iterable is only traversed once, regardless of how many iterator attaches to it and each iterator may only see one source element.
`static <T,U> java.lang.Iterable<U>`	`replay(java.lang.Iterable<? extends T> source, Func1<? super java.lang.Iterable<T>,? extends java.lang.Iterable<U>> func, int bufferSize)` The returned iterable ensures that the source iterable is only traversed once, regardless of how many iterator attaches to it and each iterator see only the some cached values.
`static <T> java.lang.Iterable<T>`	`resumeAlways(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources)` Creates an iterable which resumes with the next iterable from the sources when one throws an exception or completes normally.
`static <T> java.lang.Iterable<T>`	`resumeAlways(java.lang.Iterable<? extends T> first, java.lang.Iterable<? extends T> second)` Creates an iterable which resumes with the next iterable from the sources when one throws an exception.
`static <T> java.lang.Iterable<T>`	`resumeOnError(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources)` Creates an iterable which resumes with the next iterable from the sources when one throws an exception.
`static <T> java.lang.Iterable<T>`	`resumeOnError(java.lang.Iterable<? extends T> first, java.lang.Iterable<? extends T> second)` Creates an iterable which resumes with the next iterable from the sources when one throws an exception.
`static <T> java.lang.Iterable<T>`	`retry(java.lang.Iterable<? extends T> source, int count)` Creates an iterator which attempts to re-iterate the source if it threw an exception.
`static void`	`run(java.lang.Iterable<?> source)` Iterates over the given source without using its returned value.
`static <T> void`	`run(java.lang.Iterable<? extends T> source, Action1<? super T> action)` Iterate over the source and submit each value to the given action.
`static <T,U> java.lang.Iterable<U>`	`scan(java.lang.Iterable<? extends T> source, Func2<? super U,? super T,? extends U> aggregator)` Generates an iterable which acts like a running sum when iterating over the source iterable, e.g., For each element in T, it computes a value by using the current aggregation value and returns it.
`static <T,U> java.lang.Iterable<U>`	`scan(java.lang.Iterable<? extends T> source, U seed, Func2<? super U,? super T,? extends U> aggregator)` Generates an iterable which acts like a running sum when iterating over the source iterable, e.g., For each element in T, it computes a value by using the current aggregation value and returns it.
`static <T,U> java.lang.Iterable<U>`	`select(java.lang.Iterable<? extends T> source, Func1<? super T,? extends U> selector)` Creates an iterable which is a transforms the source elements by using the selector function.
`static <T,U> java.lang.Iterable<U>`	`select(java.lang.Iterable<? extends T> source, Func2<? super java.lang.Integer,? super T,? extends U> selector)` Creates an iterable which is a transforms the source elements by using the selector function.
`static <T,U> java.lang.Iterable<U>`	`selectMany(java.lang.Iterable<? extends T> source, Func1<? super T,? extends java.lang.Iterable<? extends U>> selector)` Creates an iterable which returns a stream of Us for each source Ts.
`static <T> java.lang.Iterable<T>`	`share(java.lang.Iterable<T> source)` Returns an iterable which ensures the source iterable is only traversed once and clients may take values from each other, e.g., they share the same iterator.
`static <T,U> java.lang.Iterable<U>`	`share(java.lang.Iterable<T> source, Func1<? super java.lang.Iterable<T>,? extends java.lang.Iterable<U>> selector)` Shares the source sequence within the specified selector function where each iterator can fetch the next element from the source.
`static <T> java.lang.Iterable<T>`	`singleton(T value)` Creates an iterable which returns only a single element.
`static int`	`size(java.lang.Iterable<?> iterable)` Immediately returns the number of elements in `iterable`.
`static <T> java.lang.Iterable<T>`	`skipLast(java.lang.Iterable<? extends T> source, int num)` Returns an iterable which skips the last `num` elements from the source iterable.
`static <T> java.lang.Iterable<T>`	`startWith(java.lang.Iterable<? extends T> source, T... value)` Returns an iterable which prefixes the source iterable values by a constant.
`static <T> java.lang.Iterable<Pair<T,T>>`	`subsequent(java.lang.Iterable<? extends T> source)` Creates an iterable which returns two subsequent items from the source iterable as pairs of values.
`static <T> java.lang.Iterable<java.lang.Iterable<T>>`	`subsequent(java.lang.Iterable<? extends T> source, int count)` Creates an iterable which returns `count` subsequent items from the source iterable as sequence of values.
`static java.lang.Iterable<java.math.BigDecimal>`	`sumBigDecimal(java.lang.Iterable<java.math.BigDecimal> source)` Sum the source of Integer values and return it as a single element.
`static java.lang.Iterable<java.math.BigInteger>`	`sumBigInteger(java.lang.Iterable<java.math.BigInteger> source)` Sum the source of Integer values and return it as a single element.
`static java.lang.Iterable<java.lang.Double>`	`sumDouble(java.lang.Iterable<java.lang.Double> source)` Sum the source of Double values and returns it as a single element.
`static java.lang.Iterable<java.lang.Float>`	`sumFloat(java.lang.Iterable<java.lang.Float> source)` Sum the source of Float values and returns it as a single element.
`static java.lang.Iterable<java.lang.Integer>`	`sumInt(java.lang.Iterable<java.lang.Integer> source)` Sum the source of Integer values and returns it as a single element.
`static java.lang.Iterable<java.lang.Double>`	`sumIntAsDouble(java.lang.Iterable<java.lang.Integer> source)` Computes and signals the sum of the values of the Integer source by using a double intermediate representation.
`static java.lang.Iterable<java.lang.Long>`	`sumLong(java.lang.Iterable<java.lang.Long> source)` Sum the source of Long values and returns it as a single element.
`static java.lang.Iterable<java.lang.Double>`	`sumLongAsDouble(java.lang.Iterable<java.lang.Long> source)` Computes and signals the sum of the values of the Long sourceby using a double intermediate representation.
`static <T,U> java.lang.Iterable<U>`	`switchCase(Func0<T> selector, java.util.Map<T,java.lang.Iterable<U>> options)` Returns an iterable, which will query the selector for a key, then queries the map for an Iterable.
`static <T> java.lang.Iterable<T>`	`take(java.lang.Iterable<? extends T> source, int num)` Returns the iterable which returns the first `num` element.
`static <T> java.lang.Iterable<T>`	`takeLast(java.lang.Iterable<? extends T> source, int num)` Returns an iterable which takes only the last `num` elements from the source iterable.
`static <T> java.lang.Iterable<T>`	`throwException(java.lang.Throwable t)` Returns an iterator which will throw the given `Throwable` exception when the client invokes `next()` the first time.
`static <T> Enumerable<T>`	`toEnumerable(java.lang.Iterable<? extends T> e)` Convert the source Iterable into the Enumerable semantics.
`static <T> Enumerator<T>`	`toEnumerator(java.util.Iterator<? extends T> it)` Convert the given iterator to the Enumerator semantics.
`static <T> java.lang.Iterable<T>`	`toIterable(Enumerable<? extends T> e)` Convert the source enumerable into the Iterable semantics.
`static <T> java.lang.Iterable<T>`	`toIterable(T... ts)` Takes the input elements and returns an iterable which traverses the array.
`static <T> java.lang.Iterable<T>`	`toIterablePart(int from, int to, T... ts)` Takes the input elements and returns an iterable which traverses the array between the two indexes.
`static <T> java.util.Iterator<T>`	`toIterator(Enumerator<? extends T> en)` Convert the given enumerator to the Iterator semantics.
`static <T,U extends java.io.Closeable> java.lang.Iterable<T>`	`using(Func0<U> resource, Func1<? super U,java.lang.Iterable<? extends T>> usage)` Returns an iterable which is associated with a closeable handler.
`static <T> java.lang.Iterable<T>`	`where(java.lang.Iterable<? extends T> source, Func0<? extends Func2<? super java.lang.Integer,? super T,java.lang.Boolean>> predicateFactory)` Creates an iterable which filters the source iterable with the given predicate factory function.
`static <T> java.lang.Iterable<T>`	`where(java.lang.Iterable<? extends T> source, Func1<? super T,java.lang.Boolean> predicate)` Creates an iterable which filters the source iterable with the given predicate function.
`static <T> java.lang.Iterable<T>`	`where(java.lang.Iterable<? extends T> source, Func2<? super java.lang.Integer,? super T,java.lang.Boolean> predicate)` Creates an iterable which filters the source iterable with the given predicate factory function.
`static <T> CloseableIterable<T>`	`withClosing(java.lang.Iterable<? extends T> source, java.io.Closeable closer)` Wraps the given source iterator into a closeable iterable with the given closeable reference.
`static <T> CloseableIterator<T>`	`withClosing(java.util.Iterator<? extends T> source, java.io.Closeable closer)` Wraps the given source iterator into a closeable iterable with the given closeable reference.
`static <T,U,V> java.lang.Iterable<V>`	`zip(java.lang.Iterable<? extends T> left, java.lang.Iterable<? extends U> right, Func2<? super T,? super U,? extends V> combiner)` Pairs each element from both iterable sources and combines them into a new value by using the `combiner` function.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
 - aggregate
```
@Nonnull
public static <T,U,V> java.lang.Iterable<V> aggregate(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func2<? super U,? super T,? extends U> sum,
 @Nonnull
 Func2<? super U,? super java.lang.Integer,? extends V> divide)
```
 Creates an iterable which traverses the source iterable and maintains a running sum value based on the sum function parameter. Once the source is depleted, it applies the divide function and returns its result. This operator is a general base for averaging (where sum(u, t) => u + t, divide(u, index) => u / index), summing (where sum(u, t) => u + t, and divide(u, index) => u)), minimum, maximum, etc. If the traversal of the source fails due an exception, that exception is reflected on the next() call of the returned iterator. The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the source element type
 
 U - the intermediate aggregation type
 
 V - the resulting aggregation type
 
 Parameters:
 
 source - the source of Ts
 
 sum - the function which takes the current intermediate value, the current source value and should produce a new intermediate value. for the first element of T, the U parameter will receive null
 
 divide - the function which takes the last intermediate value and a total count of Ts seen and should return the final aggregation value.
 
 Returns:
 
 the new iterable
 - all
```
@Nonnull
public static <T> java.lang.Iterable<java.lang.Boolean> all(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super T,java.lang.Boolean> predicate)
```
 Returns an iterable which contains true if all elements of the source iterable satisfy the predicate. The operator might return a false before fully iterating the source.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 source - the source of Ts
 
 predicate - the predicate
 
 Returns:
 
 the new iterable
 - any
```
@Nonnull
public static <T> java.lang.Iterable<java.lang.Boolean> any(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super T,java.lang.Boolean> predicate)
```
 Tests if there is any element of the source that satisfies the given predicate function.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 source - the source of Ts
 
 predicate - the predicate tester function
 
 Returns:
 
 the new iterable
 - any
```
@Nonnull
public static <T> java.lang.Iterable<java.lang.Boolean> any(@Nonnull
 java.lang.Iterable<T> source)
```
 Determines if the given source has any elements at all.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the source element type, irrelevant here
 
 Parameters:
 
 source - the source of Ts
 
 Returns:
 
 the new iterable with a single true or false
 - averageBigDecimal
```
@Nonnull
public static java.lang.Iterable<java.math.BigDecimal> averageBigDecimal(@Nonnull
 java.lang.Iterable<java.math.BigDecimal> source)
```
 Returns an iterable which averages the source BigDecimal values.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Parameters:
 
 source - the source of BigDecimal values
 
 Returns:
 
 the new iterable
 - averageBigInteger
```
@Nonnull
public static java.lang.Iterable<java.math.BigDecimal> averageBigInteger(@Nonnull
 java.lang.Iterable<java.math.BigInteger> source)
```
 Returns an iterable which averages the source BigInteger values.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Parameters:
 
 source - the source of BigInteger values
 
 Returns:
 
 the new iterable
 - averageDouble
```
@Nonnull
public static java.lang.Iterable<java.lang.Double> averageDouble(@Nonnull
 java.lang.Iterable<java.lang.Double> source)
```
 Returns an iterable which averages the source Double values.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Parameters:
 
 source - the source of Double values
 
 Returns:
 
 the new iterable
 - averageFloat
```
@Nonnull
public static java.lang.Iterable<java.lang.Float> averageFloat(@Nonnull
 java.lang.Iterable<java.lang.Float> source)
```
 Returns an iterable which averages the source Float values.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Parameters:
 
 source - the source of Float values
 
 Returns:
 
 the new iterable
 - averageInt
```
@Nonnull
public static java.lang.Iterable<java.lang.Double> averageInt(@Nonnull
 java.lang.Iterable<java.lang.Integer> source)
```
 Returns an iterable which averages the source Integer values.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Parameters:
 
 source - the source of Integer values
 
 Returns:
 
 the new iterable
 - averageLong
```
@Nonnull
public static java.lang.Iterable<java.lang.Double> averageLong(@Nonnull
 java.lang.Iterable<java.lang.Long> source)
```
 Returns an iterable which averages the source Integer values. The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Parameters:
 
 source - the source of Integer values
 
 Returns:
 
 the new iterable
 - buffer
```
@Nonnull
public static <T> java.lang.Iterable<java.util.List<T>> buffer(@Nonnull
 java.lang.Iterable<? extends T> source,
 int bufferSize)
```
 Returns an iterable which buffers the source elements into bufferSize lists. FIXME what to do on empty source or last chunk?
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 source - the source of Ts
 
 bufferSize - the buffer size.
 
 Returns:
 
 the new iterable
 - cast
```
@Nonnull
public static <T> java.lang.Iterable<T> cast(@Nonnull
 java.lang.Iterable<?> source,
 @Nonnull
 java.lang.Class<T> token)
```
 Casts the source iterable into a different type by using a type token. If the source contains a wrong element, the next() will throw a ClassCastException.
 The returned iterator forwards all remove() calls to the source.
 
 Type Parameters:
 
 T - the result element type
 
 Parameters:
 
 source - the arbitrary source
 
 token - the type token
 
 Returns:
 
 the new iterable
 - catchException
```
@Nonnull
public static <T> java.lang.Iterable<T> catchException(@Nonnull
 java.lang.Iterable<? extends T> source)
```
 Creates an iterable which if iterates over the source and encounters an exception, it simply stops the iteration, consuming the exception.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 source - the source iterable.
 
 Returns:
 
 the new iterable
 - catchException
```
@Nonnull
public static <T> java.lang.Iterable<T> catchException(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super java.lang.Throwable,? extends java.lang.Iterable<? extends T>> handler)
```
 Creates an iterable which if iterates over the source and encounters an exception, the iteration is continued on the new iterable returned by the handler function.
 The returned iterator forwards all remove() calls to the source.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 source - the source iterable.
 
 handler - the exception handler.
 
 Returns:
 
 the new iterable
 - concat
```
@Nonnull
public static <T> java.lang.Iterable<T> concat(@Nonnull
 java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources)
```
 Concatenate the given iterable sources one after another in a way, that calling the second iterator() only happens when there is no more element in the first iterator.
 The returned iterator forwards all remove() calls to the current source (e.g., you can remove the same elements from multiple collections with a single traversal on the concat result).
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 sources - the list of iterables to concatenate
 
 Returns:
 
 a new iterable
 - concat
```
@Nonnull
public static <T> java.lang.Iterable<T> concat(@Nonnull
 java.lang.Iterable<? extends T> first,
 @Nonnull
 java.lang.Iterable<? extends T> second)
```
 Concatenate the given iterable sources one after another in a way, that calling the second iterator() only happens when there is no more element in the first iterator.
 The returned iterator forwards all remove() calls to the current source (first or next).
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 first - the first iterable
 
 second - the second iterable
 
 Returns:
 
 the new iterable
 - contains
```
@Nonnull
public static <T> java.lang.Iterable<java.lang.Boolean> contains(@Nonnull
 java.lang.Iterable<? extends T> source,
 T value)
```
 Returns an iterable which checks for the existence of the supplied value by comparing the elements of the source iterable using reference and equals(). The iterable then returns a single true or false.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 source - the source
 
 value - the value to check
 
 Returns:
 
 the new iterable
 - count
```
@Nonnull
public static <T> java.lang.Iterable<java.lang.Integer> count(@Nonnull
 java.lang.Iterable<T> source)
```
 Counts the elements of the iterable source by using a 32 bit int.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 source - the source iterable
 
 Returns:
 
 the new iterable
 - countLong
```
@Nonnull
public static <T> java.lang.Iterable<java.lang.Long> countLong(@Nonnull
 java.lang.Iterable<T> source)
```
 Counts the elements of the iterable source by using a 64 bit long.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 source - the source iterable
 
 Returns:
 
 the new iterable
 - defer
```
@Nonnull
public static <T> java.lang.Iterable<T> defer(@Nonnull
 Func0<? extends java.lang.Iterable<T>> func)
```
 Defers the source iterable creation to registration time and calls the given func for the actual source.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 func - the function that returns an iterable.
 
 Returns:
 
 the new iterable
 - dematerialize
```
@Nonnull
public static <T> java.lang.Iterable<T> dematerialize(@Nonnull
 java.lang.Iterable<? extends Option<? extends T>> source)
```
 Convert the source materialized elements into normal iterator behavior. The returned iterator will throw an UnsupportedOperationException for its remove() method.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the source element types
 
 Parameters:
 
 source - the source of T options
 
 Returns:
 
 the new iterable
 - distinctNext
```
@Nonnull
public static <T> java.lang.Iterable<T> distinctNext(@Nonnull
 java.lang.Iterable<? extends T> source)
```
 Creates an iterable which ensures that subsequent values of T are not equal (reference and equals).
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 source - the source iterable
 
 Returns:
 
 the new iterable
 - distinctNext
```
@Nonnull
public static <T,U> java.lang.Iterable<T> distinctNext(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<T,U> keyExtractor)
```
 Creates an iterable which ensures that subsequent values of T are not equal in respect to the extracted keys (reference and equals).
 
 Type Parameters:
 
 T - the element type
 
 U - the key type
 
 Parameters:
 
 source - the source iterable
 
 keyExtractor - the function to extract the keys which will be compared
 
 Returns:
 
 the new iterable
 - distinct
```
@Nonnull
public static <T> java.lang.Iterable<T> distinct(@Nonnull
 java.lang.Iterable<? extends T> source)
```
 Returns an iterable which filters its elements based if they were ever seen before in the current iteration. Value equality is computed by reference equality and equals()
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 source - the source of Ts
 
 Returns:
 
 the new iterable
 - distinct
```
@Nonnull
public static <T,U,V> java.lang.Iterable<V> distinct(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super T,? extends U> keySelector,
 @Nonnull
 Func1<? super T,? extends V> valueSelector)
```
 Returns an iterable which filters its elements by an unique key in a way that when multiple source items produce the same key, only the first one ever seen gets relayed further on. Key equality is computed by reference equality and equals()
 
 Type Parameters:
 
 T - the source element type
 
 U - the key element type
 
 V - the output element type
 
 Parameters:
 
 source - the source of Ts
 
 keySelector - the key selector for only-once filtering
 
 valueSelector - the value select for the output of the first key cases
 
 Returns:
 
 the new iterable
 - doWhile
```
@Nonnull
public static <T> java.lang.Iterable<T> doWhile(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func0<java.lang.Boolean> gate)
```
 Returns an iterable which reiterates over and over again on source as long as the gate is true. The gate function is checked only when a pass over the source stream was completed. Note that using this operator on an empty iterable may result in a direct infinite loop in hasNext() or next() calls depending on the gate function.
 The returned iterator forwards all remove() calls to the source.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 source - the source of Ts
 
 gate - the gate function to stop the repeat
 
 Returns:
 
 the new iterable
 - elementsEqual
```
public static boolean elementsEqual(@Nonnull
 java.lang.Iterable<?> iterable1,
 @Nonnull
 java.lang.Iterable<?> iterable2)
```
 Determines whether two iterables contain equal elements in the same order. More specifically, this method returns true if iterable1 and iterable2 contain the same number of elements and every element of iterable1 is equal to the corresponding element of iterable2.
 
 Parameters:
 
 iterable1 - the first iterable
 
 iterable2 - the second iterable
 
 Returns:
 
 true if both iterables are either empty or contain the same number and equal items
 - elementsEqual
```
public static boolean elementsEqual(@Nonnull
 java.util.Iterator<?> iterator1,
 @Nonnull
 java.util.Iterator<?> iterator2)
```
 Compares two iterators wether they contain the same element in terms of numbers and nullsafe Object.equals().
 
 Parameters:
 
 iterator1 - the first iterator
 
 iterator2 - the second interator
 
 Returns:
 
 true if they are equal
 
 Since:
 
 0.97
 - empty
```
@Nonnull
public static <T> java.lang.Iterable<T> empty()
```
 Returns an empty iterable which will not produce elements. Its hasNext() returns always false, next() throws a NoSuchElementException and remove() throws an IllegalStateException. Note that the Collections.emptyIterable() static method is introduced by Java 7.
 
 Type Parameters:
 
 T - the element type, irrelevant
 
 Returns:
 
 the iterable
 - finish
```
@Nonnull
public static <T> java.lang.Iterable<T> finish(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Action0 action)
```
 Returns an iterable which executes the given action after the stream completes.
 The returned iterator forwards all remove() calls to the source.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 source - the source of Ts
 
 action - the action to invoke
 
 Returns:
 
 the new iterable
 - forEach
```
@Nonnull
public static <T,U> java.lang.Iterable forEach(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super T,? extends java.lang.Iterable<? extends U>> selector)
```
 Returns an iterable which runs the source iterable and returns elements from the iterable returned by the function call. The difference from SelectMany is that the Iterables are created before their concatenation starts.
 
 Type Parameters:
 
 T - the source element type
 
 U - the output element type
 
 Parameters:
 
 source - the source
 
 selector - the result selector
 
 Returns:
 
 the new iterable
 - generate
```
@Nonnull
public static <T> java.lang.Iterable<T> generate(T seed,
 @Nonnull
 Func1<? super T,java.lang.Boolean> predicate,
 @Nonnull
 Func1<? super T,? extends T> next)
```
 A generator function which returns Ts based on the termination condition and the way it computes the next values. This is equivalent to: T value = seed; while (predicate(value)) { yield value; value = next(value); }
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 seed - the initial value
 
 predicate - the predicate to terminate the process
 
 next - the function that computes the next value.
 
 Returns:
 
 the new iterable
 - generate
```
@Nonnull
public static <T> java.lang.Iterable<T> generate(T seed,
 @Nonnull
 Func1<? super T,java.lang.Boolean> predicate,
 @Nonnull
 Func1<? super T,? extends T> next,
 long initialDelay,
 long betweenDelay,
 @Nonnull
 java.util.concurrent.TimeUnit unit)
```
 A generator function which returns Ts based on the termination condition and the way it computes the next values, but the first T to be returned is preceded by an initialDelay amount of wait and each subsequent element is then generated after betweenDelay sleep. The sleeping is blocking the current thread which invokes the hasNext()/next() methods. This is equivalent to: T value = seed; sleep(initialDelay); if (predicate(value)) { yield value; } value = next(value); sleep(betweenDelay); while (predicate(value)) { yield value; value = next(value); sleep(betweenDelay); }
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 seed - the initial value
 
 predicate - the predicate to terminate the process
 
 next - the function that computes the next value.
 
 initialDelay - the initial delay
 
 betweenDelay - the between delay
 
 unit - the time unit for initialDelay and betweenDelay
 
 Returns:
 
 the new iterable
 - groupBy
```
@Nonnull
public static <T,U,V> java.lang.Iterable<GroupedIterable<V,U>> groupBy(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super T,? extends V> keySelector,
 @Nonnull
 Func1<? super T,? extends U> valueSelector)
```
 Creates an iterable which traverses the source iterable, and based on the key selector, groups values extracted by valueSelector into GroupedIterables, which can be iterated over later on. The equivalence of the keys are determined via reference equality and equals() equality.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the source element type
 
 U - the result group element type
 
 V - the result group keys
 
 Parameters:
 
 source - the source of Ts
 
 keySelector - the key selector
 
 valueSelector - the value selector
 
 Returns:
 
 the new iterable
 - invoke
```
@Nonnull
public static <T> java.lang.Iterable<T> invoke(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Action1<? super T> action)
```
 Construct a new iterable which will invoke the specified action before the source value gets relayed through it. Can be used to inject side-effects before returning a value.
 The returned iterator forwards all remove() calls to the source.
 
 Type Parameters:
 
 T - the returned element type
 
 Parameters:
 
 source - the source iterable
 
 action - the action to invoke before each next() is returned.
 
 Returns:
 
 the new iterable
 - invoke
```
@Nonnull
public static <T> java.lang.Iterable<T> invoke(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Action1<? super T> next,
 @Nonnull
 Action0 finish)
```
 Returns an iterable which invokes the given next action for each element and the finish action when the source completes.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 source - the source of Ts
 
 next - the action to invoke on each element
 
 finish - the action to invoke after the last element
 
 Returns:
 
 the new iterable
 - invoke
```
@Nonnull
public static <T> java.lang.Iterable<T> invoke(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Action1<? super T> next,
 @Nonnull
 Action1<? super java.lang.Throwable> error)
```
 Returns an iterable which invokes the given next action for each element and error when an exception is thrown.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 source - the source of Ts
 
 next - the action to invoke on each element
 
 error - the error action to invoke for an error
 
 Returns:
 
 the new iterable
 - invoke
```
@Nonnull
public static <T> java.lang.Iterable<T> invoke(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Action1<? super T> next,
 @Nonnull
 Action1<? super java.lang.Throwable> error,
 @Nonnull
 Action0 finish)
```
 Returns an iterable which invokes the given next action for each element and the finish action when the source completes and error when an exception is thrown.
 The returned iterator forwards all remove() calls to the source.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 source - the source of Ts
 
 next - the action to invoke on each element
 
 error - the error action to invoke for an error
 
 finish - the action to invoke after the last element
 
 Returns:
 
 the new iterable
 - isEmpty
```
@Nonnull
public static java.lang.Iterable<java.lang.Boolean> isEmpty(@Nonnull
 java.lang.Iterable<?> source)
```
 Returns a single true if the target iterable is empty.
 
 Parameters:
 
 source - source iterable with any type
 
 Returns:
 
 the new iterable
 - join
```
@Nonnull
public static java.lang.Iterable<java.lang.String> join(@Nonnull
 java.lang.Iterable<?> source,
 java.lang.String separator)
```
 Concatenates the source strings one after another and uses the given separator.
 The returned iterator forwards all remove() calls to the source.
 
 Parameters:
 
 source - the source
 
 separator - the separator to use
 
 Returns:
 
 the new iterable
 - last
```
public static <T> T last(@Nonnull
 java.lang.Iterable<? extends T> source)
```
 Returns the last element of the iterable or throws a NoSuchElementException if the iterable is empty.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 source - the source of Ts
 
 Returns:
 
 the last value
 - materialize
```
@Nonnull
public static <T> java.lang.Iterable<Option<T>> materialize(@Nonnull
 java.lang.Iterable<? extends T> source)
```
 Transforms the sequence of the source iterable into an option sequence of Option.some(), Option.none() and Option.error() values, depending on what the source's hasNext() and next() produces. The returned iterator will throw an UnsupportedOperationException for its remove() method.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 source - the source of at least Ts.
 
 Returns:
 
 the new iterable
 - max
```
@Nonnull
public static <T extends java.lang.Comparable<? super T>> java.lang.Iterable<T> max(@Nonnull
 java.lang.Iterable<? extends T> source)
```
 Returns the maximum value of the given iterable source.
 
 Type Parameters:
 
 T - the element type, which must be self comparable
 
 Parameters:
 
 source - the source elements
 
 Returns:
 
 the new iterable
 - max
```
@Nonnull
public static <T> java.lang.Iterable<T> max(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 java.util.Comparator<? super T> comparator)
```
 Returns the maximum value of the given iterable source in respect to the supplied comparator.
 
 Type Parameters:
 
 T - the element type, which must be self comparable
 
 Parameters:
 
 source - the source elements
 
 comparator - the comparator to use
 
 Returns:
 
 the new iterable
 - maxBy
```
@Nonnull
public static <T extends java.lang.Comparable<? super T>> java.lang.Iterable<java.util.List<T>> maxBy(@Nonnull
 java.lang.Iterable<? extends T> source)
```
 Returns an iterator which will produce a single List of the maximum values encountered in the source stream based on the supplied key selector.
 
 Type Parameters:
 
 T - the source element type, which must be self comparable
 
 Parameters:
 
 source - the source of Ts
 
 Returns:
 
 the new iterable
 - maxBy
```
@Nonnull
public static <T> java.lang.Iterable<java.util.List<T>> maxBy(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 java.util.Comparator<? super T> comparator)
```
 Returns an iterator which will produce a single List of the maximum values encountered in the source stream based on the supplied comparator.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 source - the source of Ts
 
 comparator - the key comparator
 
 Returns:
 
 the new iterable
 - maxBy
```
@Nonnull
public static <T,U extends java.lang.Comparable<? super U>> java.lang.Iterable<java.util.List<T>> maxBy(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super T,? extends U> keySelector)
```
 Returns an iterator which will produce a single List of the maximum values encountered in the source stream based on the supplied key selector.
 
 Type Parameters:
 
 T - the source element type
 
 U - the key type, which must be self-comparable
 
 Parameters:
 
 source - the source of Ts
 
 keySelector - the selector for keys
 
 Returns:
 
 the new iterable
 - maxBy
```
@Nonnull
public static <T,U> java.lang.Iterable<java.util.List<T>> maxBy(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super T,? extends U> keySelector,
 @Nonnull
 java.util.Comparator<? super U> keyComparator)
```
 Returns an iterator which will produce a single List of the minimum values encountered in the source stream based on the supplied key selector and comparator.
 
 Type Parameters:
 
 T - the source element type
 
 U - the key type
 
 Parameters:
 
 source - the source of Ts
 
 keySelector - the selector for keys
 
 keyComparator - the key comparator
 
 Returns:
 
 the new iterable
 - memoize
```
@Nonnull
public static <T> java.lang.Iterable<T> memoize(@Nonnull
 java.lang.Iterable<? extends T> source,
 int bufferSize)
```
 Enumerates the source iterable once and caches its results. Any iterator party will basically drain this cache, e.g., reiterating over this iterable will produce no results. Note: the name is not a misspelling, see Memoization. FIXME not sure about the buffer sizes.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 source - the source of Ts
 
 bufferSize - the size of the buffering
 
 Returns:
 
 the new iterable
 - memoizeAll
```
@Nonnull
public static <T> java.lang.Iterable<T> memoizeAll(@Nonnull
 java.lang.Iterable<? extends T> source)
```
 The returned iterable ensures that the source iterable is only traversed once, regardless of how many iterator attaches to it and each iterator see only the values. Note: the name is not a misspelling, see Memoization.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 source - the source of Ts
 
 Returns:
 
 the new iterable
 - merge
```
@Nonnull
public static <T> java.lang.Iterable<T> merge(@Nonnull
 java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources)
```
 Merges a bunch of iterable streams where each of the iterable will run by a scheduler and their events are merged together in a single stream. The returned iterator throws an UnsupportedOperationException in its remove() method.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 sources - the iterable of source iterables.
 
 Returns:
 
 the new iterable
 - merge
```
@Nonnull
public static <T> java.lang.Iterable<T> merge(@Nonnull
 java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources,
 @Nonnull
 Scheduler scheduler)
```
 Merges a bunch of iterable streams where each of the iterable will run by a scheduler and their events are merged together in a single stream. The returned iterator throws an UnsupportedOperationException in its remove() method.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 sources - the iterable of source iterables.
 
 scheduler - the scheduler for running each inner iterable in parallel
 
 Returns:
 
 the new iterable
 - merge
```
@Nonnull
public static <T> java.lang.Iterable<T> merge(@Nonnull
 java.lang.Iterable<? extends T> first,
 @Nonnull
 java.lang.Iterable<? extends T> second)
```
 Merges two iterable streams.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 first - the first iterable
 
 second - the second iterable
 
 Returns:
 
 the resulting stream of Ts
 - min
```
@Nonnull
public static <T extends java.lang.Comparable<? super T>> java.lang.Iterable<T> min(@Nonnull
 java.lang.Iterable<? extends T> source)
```
 Returns the minimum value of the given iterable source.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the element type, which must be self comparable
 
 Parameters:
 
 source - the source elements
 
 Returns:
 
 the new iterable
 - min
```
@Nonnull
public static <T> java.lang.Iterable<T> min(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 java.util.Comparator<? super T> comparator)
```
 Returns the minimum value of the given iterable source in respect to the supplied comparator.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the element type, which must be self comparable
 
 Parameters:
 
 source - the source elements
 
 comparator - the comparator to use
 
 Returns:
 
 the new iterable
 - minBy
```
@Nonnull
public static <T extends java.lang.Comparable<? super T>> java.lang.Iterable<java.util.List<T>> minBy(@Nonnull
 java.lang.Iterable<? extends T> source)
```
 Returns an iterator which will produce a single List of the minimum values encountered in the source stream based on the supplied key selector.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the source element type, which must be self comparable
 
 Parameters:
 
 source - the source of Ts
 
 Returns:
 
 the new iterable
 - minBy
```
@Nonnull
public static <T> java.lang.Iterable<java.util.List<T>> minBy(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 java.util.Comparator<? super T> comparator)
```
 Returns an iterator which will produce a single List of the minimum values encountered in the source stream based on the supplied comparator.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 source - the source of Ts
 
 comparator - the key comparator
 
 Returns:
 
 the new iterable
 - minBy
```
@Nonnull
public static <T,U extends java.lang.Comparable<? super U>> java.lang.Iterable<java.util.List<T>> minBy(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super T,? extends U> keySelector)
```
 Returns an iterator which will produce a single List of the minimum values encountered in the source stream based on the supplied key selector.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the source element type
 
 U - the key type, which must be self-comparable
 
 Parameters:
 
 source - the source of Ts
 
 keySelector - the selector for keys
 
 Returns:
 
 the new iterable
 - minBy
```
@Nonnull
public static <T,U> java.lang.Iterable<java.util.List<T>> minBy(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super T,? extends U> keySelector,
 @Nonnull
 java.util.Comparator<? super U> keyComparator)
```
 Returns an iterator which will produce a single List of the minimum values encountered in the source stream based on the supplied key selector and comparator.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the source element type
 
 U - the key type
 
 Parameters:
 
 source - the source of Ts
 
 keySelector - the selector for keys
 
 keyComparator - the key comparator
 
 Returns:
 
 the new iterable
 - orderBy
```
@Nonnull
public static <T extends java.lang.Comparable<? super T>> java.lang.Iterable<T> orderBy(@Nonnull
 java.lang.Iterable<? extends T> source)
```
 Returns an iterable which traverses the entire source iterable and creates an ordered list of elements. Once the source iterator completes, the elements are streamed to the output.
 
 Type Parameters:
 
 T - the source element type, must be self comparable
 
 Parameters:
 
 source - the source of Ts
 
 Returns:
 
 the new iterable
 - orderBy
```
@Nonnull
public static <T> java.lang.Iterable<T> orderBy(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 java.util.Comparator<? super T> comparator)
```
 Returns an iterable which traverses the entire source iterable and creates an ordered list of elements. Once the source iterator completes, the elements are streamed to the output.
 
 Type Parameters:
 
 T - the source element type, must be self comparable
 
 Parameters:
 
 source - the source of Ts
 
 comparator - the value comparator
 
 Returns:
 
 the new iterable
 - orderBy
```
@Nonnull
public static <T,U extends java.lang.Comparable<? super U>> java.lang.Iterable<T> orderBy(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super T,? extends U> keySelector)
```
 Returns an iterable which traverses the entire source iterable and creates an ordered list of elements. Once the source iterator completes, the elements are streamed to the output.
 
 Type Parameters:
 
 T - the source element type
 
 U - the key type for the ordering, must be self comparable
 
 Parameters:
 
 source - the source of Ts
 
 keySelector - the key selector for comparison
 
 Returns:
 
 the new iterable
 - orderBy
```
@Nonnull
public static <T,U> java.lang.Iterable<T> orderBy(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super T,? extends U> keySelector,
 @Nonnull
 java.util.Comparator<? super U> keyComparator)
```
 Returns an iterable which traverses the entire source iterable and creates an ordered list of elements. Once the source iterator completes, the elements are streamed to the output.
 
 Type Parameters:
 
 T - the source element type
 
 U - the key type for the ordering
 
 Parameters:
 
 source - the source of Ts
 
 keySelector - the key selector for comparison
 
 keyComparator - the key comparator function
 
 Returns:
 
 the new iterable
 - print
```
@Nonnull
public static <T> Action1<T> print()
```
 Creates an observer with debugging purposes. It prints the submitted values to STDOUT separated by commas and line-broken by 80 characters, the exceptions to STDERR and prints an empty newline when it receives a finish().
 
 Type Parameters:
 
 T - the value type
 
 Returns:
 
 the observer
 - print
```
@Nonnull
public static <T> Action1<T> print(java.lang.String separator,
 int maxLineLength)
```
 Creates an observer with debugging purposes. It prints the submitted values to STDOUT, the exceptions to STDERR and prints an empty newline when it receives a finish().
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 separator - the separator to use between subsequent values
 
 maxLineLength - how many characters to print into each line
 
 Returns:
 
 the observer
 - println
```
@Nonnull
public static <T> Action1<T> println()
```
 Creates an action for debugging purposes. It prints the submitted values to STDOUT with a line break.
 
 Type Parameters:
 
 T - the value type
 
 Returns:
 
 the observer
 - println
```
@Nonnull
public static <T> Action1<T> println(java.lang.String prefix)
```
 Creates an action for debugging purposes. It prints the submitted values to STDOUT with a line break.
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 prefix - the prefix to use when printing
 
 Returns:
 
 the action
 - prune
```
@Nonnull
public static <T,U> java.lang.Iterable prune(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super java.lang.Iterable<? extends T>,? extends java.lang.Iterable> func)
```
 Applies the func function for a shared instance of the source, e.g., func.invoke(share(source)).
 
 Type Parameters:
 
 T - the source element type
 
 U - the return types
 
 Parameters:
 
 source - the source of Ts
 
 func - invoke the function on the buffering iterable and return an iterator over it.
 
 Returns:
 
 the new iterable
 - publish
```
@Nonnull
public static <T,U> java.lang.Iterable publish(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super java.lang.Iterable<? super T>,? extends java.lang.Iterable<? extends U>> func,
 U initial)
```
 The returned iterable ensures that the source iterable is only traversed once, regardless of how many iterator attaches to it and each iterator see only the same cached values.
 The returned iterator will throw an UnsupportedOperationException for remove() method of its first element, then it might throw for any subsequent element, depending on the source iterable.
 
 Type Parameters:
 
 T - the source element type
 
 U - the return types
 
 Parameters:
 
 source - the source of Ts
 
 func - invoke the function on the buffering iterable and return an iterator over it.
 
 initial - the initial value to append to the output stream
 
 Returns:
 
 the new iterable
 - publish
```
@Nonnull
public static <T,U> java.lang.Iterable publish(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super java.lang.Iterable<T>,? extends java.lang.Iterable> func)
```
 The returned iterable ensures that the source iterable is only traversed once, regardless of how many iterator attaches to it and each iterator see only the values.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the source element type
 
 U - the return types
 
 Parameters:
 
 source - the source of Ts
 
 func - invoke the function on the buffering iterable and return an iterator over it.
 
 Returns:
 
 the new iterable TODO check
 - range
```
@Nonnull
public static java.lang.Iterable<java.lang.Integer> range(int start,
 int count)
```
 Creates an integer iterator which returns numbers from the start position in the count size.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Parameters:
 
 start - the starting value.
 
 count - the number of elements to return, negative count means counting down from the start.
 
 Returns:
 
 the iterator.
 - range
```
@Nonnull
public static java.lang.Iterable<java.lang.Long> range(long start,
 long count)
```
 Creates an long iterator which returns numbers from the start position in the count size.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Parameters:
 
 start - the starting value.
 
 count - the number of elements to return, negative count means counting down from the start.
 
 Returns:
 
 the iterator.
 - relayWhile
```
@Nonnull
public static <T> java.lang.Iterable<T> relayWhile(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func0<java.lang.Boolean> gate)
```
 Relays the source iterable's values until the gate returns false.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 source - the source of Ts
 
 gate - the gate to stop the relaying
 
 Returns:
 
 the new iterable
 - replay
```
@Nonnull
public static <T,U> java.lang.Iterable replay(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super java.lang.Iterable<T>,? extends java.lang.Iterable> func)
```
 The returned iterable ensures that the source iterable is only traversed once, regardless of how many iterator attaches to it and each iterator may only see one source element.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the source element type
 
 U - the return types
 
 Parameters:
 
 source - the source of Ts
 
 func - invoke the function on the buffering iterable and return an iterator over it.
 
 Returns:
 
 the new iterable
 - replay
```
@Nonnull
public static <T,U> java.lang.Iterable replay(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super java.lang.Iterable<T>,? extends java.lang.Iterable> func,
 int bufferSize)
```
 The returned iterable ensures that the source iterable is only traversed once, regardless of how many iterator attaches to it and each iterator see only the some cached values.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the source element type
 
 U - the return types
 
 Parameters:
 
 source - the source of Ts
 
 func - invoke the function on the buffering iterable and return an iterator over it.
 
 bufferSize - the buffer size
 
 Returns:
 
 the new iterable
 - resumeAlways
```
@Nonnull
public static <T> java.lang.Iterable<T> resumeAlways(@Nonnull
 java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources)
```
 Creates an iterable which resumes with the next iterable from the sources when one throws an exception or completes normally.
 The returned iterator forwards all remove() calls to the source.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 sources - the list of sources to try one after another
 
 Returns:
 
 the new iterable
 - resumeAlways
```
@Nonnull
public static <T> java.lang.Iterable<T> resumeAlways(@Nonnull
 java.lang.Iterable<? extends T> first,
 @Nonnull
 java.lang.Iterable<? extends T> second)
```
 Creates an iterable which resumes with the next iterable from the sources when one throws an exception.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 first - the first source
 
 second - the second source
 
 Returns:
 
 the new iterable
 - resumeOnError
```
@Nonnull
public static <T> java.lang.Iterable<T> resumeOnError(@Nonnull
 java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources)
```
 Creates an iterable which resumes with the next iterable from the sources when one throws an exception.
 The returned iterator forwards all remove() calls to the source.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 sources - the list of sources to try one after another
 
 Returns:
 
 the new iterable
 - resumeOnError
```
@Nonnull
public static <T> java.lang.Iterable<T> resumeOnError(@Nonnull
 java.lang.Iterable<? extends T> first,
 @Nonnull
 java.lang.Iterable<? extends T> second)
```
 Creates an iterable which resumes with the next iterable from the sources when one throws an exception.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 first - the first source
 
 second - the second source
 
 Returns:
 
 the new iterable
 - retry
```
@Nonnull
public static <T> java.lang.Iterable<T> retry(@Nonnull
 java.lang.Iterable<? extends T> source,
 int count)
```
 Creates an iterator which attempts to re-iterate the source if it threw an exception. while (count-- > 0) { try { for (T t : source) { yield t; } break; } catch (Throwable t) { if (count <= 0) { throw t; } } }
 The returned iterator forwards all remove() calls to the source.
 Type Parameters:
 
 T - the source type
 
 Parameters:
 
 source - the source of Ts
 
 count - the number of retry attempts
 
 Returns:
 
 the new iterable
 - run
```
public static <T> void run(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Action1<? super T> action)
```
 Iterate over the source and submit each value to the given action. Basically, a for-each loop with pluggable action. This method is useful when the concrete values from the iterator are not needed but the iteration itself implies some side effects.
 
 Type Parameters:
 
 T - the element type of the iterable
 
 Parameters:
 
 source - the iterable
 
 action - the action to invoke on with element
 - run
```
public static void run(@Nonnull
 java.lang.Iterable<?> source)
```
 Iterates over the given source without using its returned value. This method is useful when the concrete values from the iterator are not needed but the iteration itself implies some side effects.
 
 Parameters:
 
 source - the source iterable to run through
 - scan
```
@Nonnull
public static <T,U> java.lang.Iterable scan(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func2<? super U,? super T,? extends U> aggregator)
```
 Generates an iterable which acts like a running sum when iterating over the source iterable, e.g., For each element in T, it computes a value by using the current aggregation value and returns it. The first call to the aggregator function will receive a zero for its first argument.
 
 Type Parameters:
 
 T - the source element type
 
 U - the destination element type
 
 Parameters:
 
 source - the source of Ts
 
 aggregator - the function which takes the current running aggregation value, the current element and produces a new aggregation value.
 
 Returns:
 
 the new iterable TODO rework
 - scan
```
@Nonnull
public static <T,U> java.lang.Iterable scan(@Nonnull
 java.lang.Iterable<? extends T> source,
 U seed,
 @Nonnull
 Func2<? super U,? super T,? extends U> aggregator)
```
 Generates an iterable which acts like a running sum when iterating over the source iterable, e.g., For each element in T, it computes a value by using the current aggregation value and returns it. The first call to the aggregator function will receive a zero for its first argument.
 The returned iterator forwards all remove() calls to the source.
 
 Type Parameters:
 
 T - the source element type
 
 U - the destination element type
 
 Parameters:
 
 source - the source of Ts
 
 seed - the initial value of the running aggregation
 
 aggregator - the function which takes the current running aggregation value, the current element and produces a new aggregation value.
 
 Returns:
 
 the new iterable
 - select
```
@Nonnull
public static <T,U> java.lang.Iterable select(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super T,? extends U> selector)
```
 Creates an iterable which is a transforms the source elements by using the selector function. The function receives the current index and the current element.
 
 Type Parameters:
 
 T - the source element type
 
 U - the output element type
 
 Parameters:
 
 source - the source iterable
 
 selector - the selector function
 
 Returns:
 
 the new iterable
 - select
```
@Nonnull
public static <T,U> java.lang.Iterable select(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func2<? super java.lang.Integer,? super T,? extends U> selector)
```
 Creates an iterable which is a transforms the source elements by using the selector function. The function receives the current index and the current element.
 The returned iterator forwards all remove() calls to the source.
 
 Type Parameters:
 
 T - the source element type
 
 U - the output element type
 
 Parameters:
 
 source - the source iterable
 
 selector - the selector function
 
 Returns:
 
 the new iterable
 - selectMany
```
@Nonnull
public static <T,U> java.lang.Iterable selectMany(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super T,? extends java.lang.Iterable<? extends U>> selector)
```
 Creates an iterable which returns a stream of Us for each source Ts. The iterable stream of Us is returned by the supplied selector function.
 The returned iterator forwards all remove() calls to the current source (which might not accept it).
 
 Type Parameters:
 
 T - the source element type
 
 U - the output element type
 
 Parameters:
 
 source - the source
 
 selector - the selector for multiple Us for each T
 
 Returns:
 
 the new iterable
 - share
```
@Nonnull
public static <T> java.lang.Iterable<T> share(@Nonnull
 java.lang.Iterable<T> source)
```
 Returns an iterable which ensures the source iterable is only traversed once and clients may take values from each other, e.g., they share the same iterator.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 source - the source iterable
 
 Returns:
 
 the new iterable
 - share
```
@Nonnull
public static <T,U> java.lang.Iterable share(@Nonnull
 java.lang.Iterable<T> source,
 @Nonnull
 Func1<? super java.lang.Iterable<T>,? extends java.lang.Iterable> selector)
```
 Shares the source sequence within the specified selector function where each iterator can fetch the next element from the source.
 
 Type Parameters:
 
 T - the source element type
 
 U - the result element type
 
 Parameters:
 
 source - the source sequence
 
 selector - the selector function
 
 Returns:
 
 the new iterable
 
 Since:
 
 0.97 TODO Builder
 - singleton
```
@Nonnull
public static <T> java.lang.Iterable<T> singleton(T value)
```
 Creates an iterable which returns only a single element.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 value - the value to return
 
 Returns:
 
 the new iterable
 - size
```
public static int size(@Nonnull
 java.lang.Iterable<?> iterable)
```
 Immediately returns the number of elements in iterable.
 
 Parameters:
 
 iterable - the input sequence
 
 Returns:
 
 the number of elements in the sequence
 - skipLast
```
@Nonnull
public static <T> java.lang.Iterable<T> skipLast(@Nonnull
 java.lang.Iterable<? extends T> source,
 int num)
```
 Returns an iterable which skips the last num elements from the source iterable.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 source - the source iterable
 
 num - the number of elements to skip at the end
 
 Returns:
 
 the new iterable
 - startWith
```
@Nonnull
public static <T> java.lang.Iterable<T> startWith(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 T... value)
```
 Returns an iterable which prefixes the source iterable values by a constant. It is equivalent to concat(singleton(value), source).
 The returned iterator will throw an UnsupportedOperationException for its remove() method for the first element, and might throw for subsequent elements, depending on the source iterable.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 source - the source iterable
 
 value - the value to prefix
 
 Returns:
 
 the new iterable.
 - sumBigDecimal
```
@Nonnull
public static java.lang.Iterable<java.math.BigDecimal> sumBigDecimal(@Nonnull
 java.lang.Iterable<java.math.BigDecimal> source)
```
 Sum the source of Integer values and return it as a single element.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Parameters:
 
 source - the source
 
 Returns:
 
 the new iterable
 - sumBigInteger
```
@Nonnull
public static java.lang.Iterable<java.math.BigInteger> sumBigInteger(@Nonnull
 java.lang.Iterable<java.math.BigInteger> source)
```
 Sum the source of Integer values and return it as a single element.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Parameters:
 
 source - the source
 
 Returns:
 
 the new iterable
 - sumDouble
```
@Nonnull
public static java.lang.Iterable<java.lang.Double> sumDouble(@Nonnull
 java.lang.Iterable<java.lang.Double> source)
```
 Sum the source of Double values and returns it as a single element.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Parameters:
 
 source - the source
 
 Returns:
 
 the new iterable
 - sumFloat
```
@Nonnull
public static java.lang.Iterable<java.lang.Float> sumFloat(@Nonnull
 java.lang.Iterable<java.lang.Float> source)
```
 Sum the source of Float values and returns it as a single element.
 
 Parameters:
 
 source - the source
 
 Returns:
 
 the new iterable
 - sumInt
```
@Nonnull
public static java.lang.Iterable<java.lang.Integer> sumInt(@Nonnull
 java.lang.Iterable<java.lang.Integer> source)
```
 Sum the source of Integer values and returns it as a single element.
 
 Parameters:
 
 source - the source
 
 Returns:
 
 the new iterable
 - sumLong
```
@Nonnull
public static java.lang.Iterable<java.lang.Long> sumLong(@Nonnull
 java.lang.Iterable<java.lang.Long> source)
```
 Sum the source of Long values and returns it as a single element.
 
 Parameters:
 
 source - the source
 
 Returns:
 
 the new iterable
 - switchCase
```
@Nonnull
public static <T,U> java.lang.Iterable switchCase(@Nonnull
 Func0<T> selector,
 @Nonnull
 java.util.Map<T,java.lang.Iterable> options)
```
 Returns an iterable, which will query the selector for a key, then queries the map for an Iterable. The returned iterator will then traverse that Iterable. If the map does not contain an element, az empty iterable is used.
 
 Type Parameters:
 
 T - the key type
 
 U - the output type
 
 Parameters:
 
 selector - the key selector
 
 options - the available options in
 
 Returns:
 
 the new iterable
 - take
```
@Nonnull
public static <T> java.lang.Iterable<T> take(@Nonnull
 java.lang.Iterable<? extends T> source,
 int num)
```
 Returns the iterable which returns the first num element. from the source iterable.
 The returned iterator forwards all remove() calls to the source.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 source - the source of Ts
 
 num - the number of items to take
 
 Returns:
 
 the new iterable
 - takeLast
```
@Nonnull
public static <T> java.lang.Iterable<T> takeLast(@Nonnull
 java.lang.Iterable<? extends T> source,
 int num)
```
 Returns an iterable which takes only the last num elements from the source iterable.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 source - the source iterable
 
 num - the number of elements to skip at the end
 
 Returns:
 
 the new iterable
 - throwException
```
@Nonnull
public static <T> java.lang.Iterable<T> throwException(@Nonnull
 java.lang.Throwable t)
```
 Returns an iterator which will throw the given Throwable exception when the client invokes next() the first time. Any subsequent next() call will simply throw a NoSuchElementException. Calling remove() will always throw a IllegalStateException. If the given Throwable instance extends a RuntimeException, it is throws as is, but when the throwable is a checked exception, it is wrapped into a RuntimeException. FIXME not sure about next() semantics
 
 Type Parameters:
 
 T - the element type, irrelevant
 
 Parameters:
 
 t - the exception to throw
 
 Returns:
 
 the new iterable
 - toEnumerable
```
@Nonnull
public static <T> Enumerable<T> toEnumerable(@Nonnull
 java.lang.Iterable<? extends T> e)
```
 Convert the source Iterable into the Enumerable semantics.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 e - the iterable
 
 Returns:
 
 the new enumerable
 - toEnumerator
```
@Nonnull
public static <T> Enumerator<T> toEnumerator(@Nonnull
 java.util.Iterator<? extends T> it)
```
 Convert the given iterator to the Enumerator semantics.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 it - the source iterator
 
 Returns:
 
 the new enumerator
 - toIterable
```
@Nonnull
public static <T> java.lang.Iterable<T> toIterable(@Nonnull
 Enumerable<? extends T> e)
```
 Convert the source enumerable into the Iterable semantics.
 
 Type Parameters:
 
 T - the source element type
 
 Parameters:
 
 e - the enumerable
 
 Returns:
 
 the new iterable
 - toIterator
```
@Nonnull
public static <T> java.util.Iterator<T> toIterator(@Nonnull
 Enumerator<? extends T> en)
```
 Convert the given enumerator to the Iterator semantics.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 en - the source enumerator
 
 Returns:
 
 the new iterator
 - using
```
@Nonnull
public static <T,U extends java.io.Closeable> java.lang.Iterable<T> using(@Nonnull
 Func0 resource,
 @Nonnull
 Func1<? super U,java.lang.Iterable<? extends T>> usage)
```
 Returns an iterable which is associated with a closeable handler. Once the source iterable is completed, it invokes the Closeable.close() on the handler.
 The returned iterator forwards all remove() calls to the source.
 
 Type Parameters:
 
 T - the source element type
 
 U - the closeable type
 
 Parameters:
 
 resource - the function which returns a resource token
 
 usage - the function which gives an iterable for a resource token.
 
 Returns:
 
 the new iterable
 - where
```
@Nonnull
public static <T> java.lang.Iterable<T> where(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func0<? extends Func2<? super java.lang.Integer,? super T,java.lang.Boolean>> predicateFactory)
```
 Creates an iterable which filters the source iterable with the given predicate factory function. The predicate returned by the factory receives an index telling how many elements were processed thus far. Use this construct if you want to use some memorizing predicate function (e.g., filter by subsequent distinct, filter by first occurrences only) which need to be invoked per iterator() basis.
 The returned iterator forwards all remove() calls to the source.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 source - the source iterable
 
 predicateFactory - the predicate factory which should return a new predicate function for each iterator.
 
 Returns:
 
 the new iterable
 - where
```
@Nonnull
public static <T> java.lang.Iterable<T> where(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super T,java.lang.Boolean> predicate)
```
 Creates an iterable which filters the source iterable with the given predicate function. The predicate receives the value and must return a boolean whether to accept that entry.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 source - the source iterable
 
 predicate - the predicate function
 
 Returns:
 
 the new iterable
 - where
```
@Nonnull
public static <T> java.lang.Iterable<T> where(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func2<? super java.lang.Integer,? super T,java.lang.Boolean> predicate)
```
 Creates an iterable which filters the source iterable with the given predicate factory function. The predicate returned by the factory receives an index telling how many elements were processed thus far.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 source - the source iterable
 
 predicate - the predicate
 
 Returns:
 
 the new iterable
 - zip
```
@Nonnull
public static <T,U,V> java.lang.Iterable<V> zip(@Nonnull
 java.lang.Iterable<? extends T> left,
 @Nonnull
 java.lang.Iterable<? extends U> right,
 @Nonnull
 Func2<? super T,? super U,? extends V> combiner)
```
 Pairs each element from both iterable sources and combines them into a new value by using the combiner function.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the left source type
 
 U - the right source type
 
 V - the result type
 
 Parameters:
 
 left - the left source
 
 right - the right source
 
 combiner - the combiner function
 
 Returns:
 
 the new iterable
 - first
```
public static <T> T first(@Nonnull
 java.lang.Iterable<? extends T> src)
```
 Returns the first element from the iterable sequence or throws a NoSuchElementException.
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 src - the source sequence
 
 Returns:
 
 the first element
 
 Since:
 
 0.96
 - toIterable
```
@Nonnull
public static <T> java.lang.Iterable<T> toIterable(@Nonnull
 T... ts)
```
 Takes the input elements and returns an iterable which traverses the array. The supplied array is shared by the iterator. Any changes to the array will be reflected by the iterator
 The resulting Iterable does not support remove().
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 ts - the input array
 
 Returns:
 
 the iterable for the array
 
 Since:
 
 0.96
 - toIterablePart
```
@Nonnull
public static <T> java.lang.Iterable<T> toIterablePart(int from,
 int to,
 @Nonnull
 T... ts)
```
 Takes the input elements and returns an iterable which traverses the array between the two indexes. The supplied array is shared by the iterator. Any changes to the array will be reflected by the iterator.
 The resulting Iterable does not support remove().
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 from - the starting index inclusive
 
 to - the end index exclusive
 
 ts - the input array
 
 Returns:
 
 the iterable for the array
 
 Since:
 
 0.96
 - argAndMax
```
public static <T,V> Pair<T,V> argAndMax(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super T,? extends V> valueSelector,
 @Nonnull
 java.util.Comparator<? super V> valueComparator)
```
 Returns a pair of the maximum argument and value from the given sequence.
 
 Type Parameters:
 
 T - the element type
 
 V - the value type
 
 Parameters:
 
 source - the source sequence of Ts
 
 valueSelector - the selector to extract the value from T
 
 valueComparator - the comparator to compare two values
 
 Returns:
 
 the first pair of max argument and value or null if the source sequence was empty
 
 Since:
 
 0.96
 - argAndMax
```
public static <T,V extends java.lang.Comparable<? super V>> Pair<T,V> argAndMax(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super T,? extends V> valueSelector)
```
 Returns a pair of the maximum argument and value from the given sequence.
 
 Type Parameters:
 
 T - the element type of the sequence
 
 V - the value type for the comparison, must be self comparable
 
 Parameters:
 
 source - the source sequence
 
 valueSelector - the value selector function
 
 Returns:
 
 the pair of the first maximum element and value, null if the sequence was empty
 
 Since:
 
 0.96
 - argAndMin
```
public static <T,V extends java.lang.Comparable<? super V>> Pair<T,V> argAndMin(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super T,? extends V> valueSelector)
```
 Returns a pair of the maximum argument and value from the given sequence.
 
 Type Parameters:
 
 T - the element type of the sequence
 
 V - the value type for the comparison, must be self comparable
 
 Parameters:
 
 source - the source sequence
 
 valueSelector - the value selector function
 
 Returns:
 
 the pair of the first maximum element and value, null if the sequence was empty
 
 Since:
 
 0.96
 - argAndMin
```
public static <T,V> Pair<T,V> argAndMin(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super T,? extends V> valueSelector,
 @Nonnull
 java.util.Comparator<? super V> valueComparator)
```
 Returns a pair of the minimum argument and value from the given sequence.
 
 Type Parameters:
 
 T - the element type
 
 V - the value type
 
 Parameters:
 
 source - the source sequence of Ts
 
 valueSelector - the selector to extract the value from T
 
 valueComparator - the comparator to compare two values
 
 Returns:
 
 the first pair of min argument and value or null if the source sequence was empty
 
 Since:
 
 0.96
 - repeat
```
public static <T> java.lang.Iterable<T> repeat(T value)
```
 Creates an iterable sequence which returns the given value indefinitely.
 (E.g., having the hasNext() always return true and the next() always return the value.
 
 The returned iterable does not support the remove() method.
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 value - the value to repeat
 
 Returns:
 
 the iterable
 
 Since:
 
 0.96
 - repeat
```
public static <T> java.lang.Iterable<T> repeat(T value,
 int count)
```
 Returns an iterable which repeats the given single value the specified number of times.
 The returned iterable does not support the remove() method.
 
 Type Parameters:
 
 T - the value type
 
 Parameters:
 
 value - the value to repeat
 
 count - the repeat amount
 
 Returns:
 
 the iterable
 
 Since:
 
 0.96
 - endWith
```
@Nonnull
public static <T> java.lang.Iterable<T> endWith(@Nonnull
 java.lang.Iterable<? extends T> source,
 T value)
```
 Creates an iterable sequence which returns all elements from source followed by the supplied value as last.
 The returned iterable forwards all remove() methods to the source iterable, except the last element where it throws UnsupportedOperationException.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 source - the source sequence
 
 value - the value to append
 
 Returns:
 
 the new iterable
 
 Since:
 
 0.96
 - sumIntAsDouble
```
@Nonnull
public static java.lang.Iterable<java.lang.Double> sumIntAsDouble(@Nonnull
 java.lang.Iterable<java.lang.Integer> source)
```
 Computes and signals the sum of the values of the Integer source by using a double intermediate representation. The source may not send nulls. An empty source produces an empty sum
 
 Parameters:
 
 source - the source of integers to aggregate.
 
 Returns:
 
 the observable for the sum value
 
 Since:
 
 0.96
 - sumLongAsDouble
```
@Nonnull
public static java.lang.Iterable<java.lang.Double> sumLongAsDouble(@Nonnull
 java.lang.Iterable<java.lang.Long> source)
```
 Computes and signals the sum of the values of the Long sourceby using a double intermediate representation. The source may not send nulls.
 
 Parameters:
 
 source - the source of longs to aggregate.
 
 Returns:
 
 the observable for the sum value
 
 Since:
 
 0.96
 - groupBy
```
@Nonnull
public static <T,V> java.lang.Iterable<GroupedIterable<V,T>> groupBy(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 Func1<? super T,? extends V> keySelector)
```
 Creates an iterable which traverses the source iterable, and based on the key selector, groups values of T into GroupedIterables, which can be iterated over later on. The equivalence of the keys are determined via reference equality and equals() equality.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the source element type
 
 V - the result group keys
 
 Parameters:
 
 source - the source of Ts
 
 keySelector - the key selector
 
 Returns:
 
 the new iterable
 
 Since:
 
 0.96.1
 - subsequent
```
public static <T> java.lang.Iterable<Pair<T,T>> subsequent(@Nonnull
 java.lang.Iterable<? extends T> source)
```
 Creates an iterable which returns two subsequent items from the source iterable as pairs of values. If the source contains zero or one elements, this iterable will be empty.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 source - the source iterable
 
 Returns:
 
 the new iterable
 
 Since:
 
 0.96.1
 - subsequent
```
public static <T> java.lang.Iterable<java.lang.Iterable<T>> subsequent(@Nonnull
 java.lang.Iterable<? extends T> source,
 int count)
```
 Creates an iterable which returns count subsequent items from the source iterable as sequence of values. If the source contains less than count elements, this iterable will be empty.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 source - the source iterable
 
 count - the element count
 
 Returns:
 
 the new iterable
 
 Since:
 
 0.96.1
 - newIterable
```
public static <T,U extends java.util.Iterator<T>> java.lang.Iterable<T> newIterable(@Nonnull
 Func0 body)
```
 Creates a new iterable sequence by wrapping the given function to provide the iterator.
 
 Type Parameters:
 
 T - the element type
 
 U - the iterator type
 
 Parameters:
 
 body - the body function returning an iterator
 
 Returns:
 
 the iterable sequence
 
 Since:
 
 0.97
 - newIterator
```
public static <T> java.util.Iterator<T> newIterator(@Nonnull
 Func0<java.lang.Boolean> hasNext,
 @Nonnull
 Func0<? extends T> next)
```
 A functional way of creating a new iterator from the supplied hasNext and next callbacks.
 The returned iterator throws a UnsupportedOperationException in its remove method.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 hasNext - function that returns true if more elements are available.
 
 next - function that returns the next element
 
 Returns:
 
 the created iterator
 
 Since:
 
 0.97
 - newIterator
```
public static <T> java.util.Iterator<T> newIterator(@Nonnull
 Func0<java.lang.Boolean> hasNext,
 @Nonnull
 Func0<? extends T> next,
 @Nonnull
 Action0 remove)
```
 Constructs an iterator instance by wrapping the supplied functions into the same-named iterator methods.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 hasNext - function that returns true if more elements are available.
 
 next - function that returns the next element
 
 remove - function to remove the current element
 
 Returns:
 
 the created iterator
 
 Since:
 
 0.97
 - newCloseableIterable
```
@Nonnull
public static <T> CloseableIterable<T> newCloseableIterable(@Nonnull
 java.lang.Iterable<? extends T> src,
 @Nonnull
 Action1<? super java.util.Iterator<? extends T>> close)
```
 Wraps the given source sequence into a CloseableIterable instance where the inner CloseableIterator.close() method calls the supplied action.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 src - the source sequence
 
 close - the close action.
 
 Returns:
 
 the new closeable iterable
 
 Since:
 
 0.97
 - newCloseableIterable
```
@Nonnull
public static <T> CloseableIterable<T> newCloseableIterable(@Nonnull
 java.lang.Iterable<? extends T> src,
 @Nonnull
 Action0 close)
```
 Wraps the given source sequence into a CloseableIterable instance where the inner CloseableIterator.close() method calls the supplied action.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 src - the source sequence
 
 close - the close action.
 
 Returns:
 
 the new closeable iterable
 
 Since:
 
 0.97
 - newCloseableIterable
```
@Nonnull
public static <T> CloseableIterable<T> newCloseableIterable(@Nonnull
 java.lang.Iterable<? extends T> src,
 @Nonnull
 java.io.Closeable close)
```
 Wraps the given source sequence into a CloseableIterable instance where the inner CloseableIterator.close() method calls the supplied closeable object.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 src - the source sequence
 
 close - the closeable object.
 
 Returns:
 
 the new closeable iterable
 
 Since:
 
 0.97
 - newCloseableIterator
```
@Nonnull
public static <T> CloseableIterator<T> newCloseableIterator(@Nonnull
 java.util.Iterator<? extends T> src,
 @Nonnull
 Action0 close)
```
 Wraps the supplied iterator into a CloseableIterator which calls the supplied close action.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 src - the source iterator
 
 close - the close action
 
 Returns:
 
 the new closeable iterator
 
 Since:
 
 0.97
 - newCloseableIterator
```
@Nonnull
public static <T> CloseableIterator<T> newCloseableIterator(@Nonnull
 java.util.Iterator<? extends T> src,
 @Nonnull
 java.io.Closeable close)
```
 Wraps the supplied iterator into a CloseableIterator which calls the supplied closeable instance.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 src - the source iterator
 
 close - the closeable instance
 
 Returns:
 
 the new closeable iterator
 
 Since:
 
 0.97
 - newCloseableIterator
```
@Nonnull
public static <T> CloseableIterator<T> newCloseableIterator(@Nonnull
 java.util.Iterator<? extends T> src,
 @Nonnull
 Action1<? super java.util.Iterator<? extends T>> close)
```
 Wraps the supplied iterator into a CloseableIterator which calls the supplied close action with the given source iterator object.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 src - the source iterator
 
 close - the close action
 
 Returns:
 
 the new closeable iterator
 - differentAggregator
```
@Nonnull
public static <T> java.util.Iterator<T> differentAggregator(@Nonnull
 java.util.Iterator<? extends T> src,
 @Nonnull
 Func2<? super T,? super T,java.lang.Boolean> isDifferent,
 @Nonnull
 Action2<T,? super T> aggregate)
```
 Aggregates subsequent elements (in place) as long as isDifferent returns false. Once two different subsequent elements are found or the stream terminates, a single, aggregated value is emitted.
 For example, given a stream of [1, 1, 2, 2, 3, 3], the output will be [2, 4, 6].
 
 The returned iterator does not support remove().
 
 Type Parameters:
 
 T - the source and result type
 
 Parameters:
 
 src - the source sequence
 
 isDifferent - the difference
 
 aggregate - the aggregator
 
 Returns:
 
 the iterator sequence containing the aggregated values
 
 Since:
 
 0.97.1
 - withClosing
```
@Nonnull
public static <T> CloseableIterator<T> withClosing(@Nonnull
 java.util.Iterator<? extends T> source,
 @Nonnull
 java.io.Closeable closer)
```
 Wraps the given source iterator into a closeable iterable with the given closeable reference.
 
 Type Parameters:
 
 T - the source and result type
 
 Parameters:
 
 source - the source iterator
 
 closer - the close handle
 
 Returns:
 
 the new closeable iterator
 
 Since:
 
 0.97.1
 - withClosing
```
@Nonnull
public static <T> CloseableIterable<T> withClosing(@Nonnull
 java.lang.Iterable<? extends T> source,
 @Nonnull
 java.io.Closeable closer)
```
 Wraps the given source iterator into a closeable iterable with the given closeable reference.
 
 Type Parameters:
 
 T - the source and result type
 
 Parameters:
 
 source - the source iterator
 
 closer - the close handle
 
 Returns:
 
 the new closeable iterator
 
 Since:
 
 0.97.1

Class Interactive

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

aggregate

all

any

any

averageBigDecimal

averageBigInteger

averageDouble

averageFloat

averageInt

averageLong

buffer

cast

catchException

catchException

concat

concat

contains

count

countLong

defer

dematerialize

distinctNext

distinctNext

distinct

distinct

doWhile

elementsEqual

elementsEqual

empty

finish

forEach

generate

generate

groupBy

invoke

invoke

invoke

invoke

isEmpty

join

last

materialize

max

max

maxBy

maxBy

maxBy

maxBy

memoize

memoizeAll

merge

merge

merge

min

min

minBy

minBy

minBy

minBy

orderBy

orderBy

orderBy

orderBy

print

print

println

println

prune

publish

publish

range

range

relayWhile

replay

replay