IterableBuilder (reactive4java 0.98.0 API)

java.lang.Object
- hu.akarnokd.reactive4java.query.IterableBuilder<T>

Type Parameters:

T - the element type

All Implemented Interfaces:

java.lang.Iterable<T>
```
public final class IterableBuilder<T>
extends java.lang.Object
implements java.lang.Iterable<T>
```
An iterable builder which offers methods to chain the sequence of some Interactive operations.
This builder is the dual of the ObservableBuilder class.

Since:

0.96

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.Iterable<T> it
The backing iterable.

Fields
Modifier and Type	Field and Description
`protected java.lang.Iterable<T>`	`it` The backing iterable.

Constructor Summary

Constructors
Modifier Constructor and Description

protected IterableBuilder(java.lang.Iterable<T> source)
Constructor.

Constructors
Modifier	Constructor and Description
`protected`	`IterableBuilder(java.lang.Iterable<T> source)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<U,V> IterableBuilder<V>`	`aggregate(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.
`IterableBuilder<java.lang.Boolean>`	`all(Func1<? super T,java.lang.Boolean> predicate)` Returns an iterable which contains true if all elements of the source iterable satisfy the predicate.
`IterableBuilder<java.lang.Boolean>`	`any()` Determines if the given source has any elements at all.
`IterableBuilder<java.lang.Boolean>`	`any(Func1<? super T,java.lang.Boolean> predicate)` Tests if there is any element of the source that satisfies the given predicate function.
`<V extends java.lang.Comparable<? super V>> Pair<T,V>`	`argAndMax(Func1<? super T,? extends V> valueSelector)` Returns a pair of the maximum argument and value from the given sequence.
`<V> Pair<T,V>`	`argAndMax(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.
`<V extends java.lang.Comparable<? super V>> Pair<T,V>`	`argAndMin(Func1<? super T,? extends V> valueSelector)` Returns a pair of the minimum argument and value from the given sequence.
`<V> Pair<T,V>`	`argAndMin(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.
`IterableBuilder<java.math.BigDecimal>`	`averageBigDecimal()` Computes and signals the average value of the BigDecimal source.
`IterableBuilder<java.math.BigDecimal>`	`averageBigInteger()` Computes and signals the average value of the BigInteger source.
`IterableBuilder<java.lang.Double>`	`averageDouble()` Computes and signals the average value of the Double source.
`IterableBuilder<java.lang.Float>`	`averageFloat()` Computes and signals the average value of the Float source.
`IterableBuilder<java.lang.Double>`	`averageInt()` Computes and signals the average value of the integer source.
`IterableBuilder<java.lang.Double>`	`averageLong()` Computes and signals the average value of the Long source.
`IterableBuilder<java.util.List<T>>`	`buffer(int bufferSize)` Returns an iterable which buffers the source elements into `bufferSize` lists.
`<U> IterableBuilder<U>`	`cast(java.lang.Class<U> token)` Casts the source iterable into a different typ by using a type token.
`<U> ObservableBuilder<U>`	`concat(Func1<? super T,? extends Observable<? extends U>> resultSelector)` Perform the concatenation of observable sequences based on this iterable and the given result selector function.
`IterableBuilder<T>`	`concat(java.lang.Iterable<? extends T> other)` Concatenate this iterable with the other iterable in a way, that calling the second `iterator()` only happens when there is no more element in the first iterator.
`IterableBuilder<T>`	`concat(T... values)` Concatenate this iterable with the sequence of array values.
`IterableBuilder<T>`	`concatAll(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> others)` Creates an iterable builder which contains the concatenation of this iterable and the rest iterable provided.
`IterableBuilder<java.lang.Boolean>`	`contains(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()`.
`IterableBuilder<java.lang.Integer>`	`count()` Counts the elements of the iterable source by using a 32 bit `int`.
`IterableBuilder<java.lang.Long>`	`countLong()` Counts the elements of the iterable source by using a 64 bit `long`.
`static <T> IterableBuilder<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.
`IterableBuilder<T>`	`dematerialize()` Convert the source materialized elements into normal iterator behavior.
`IterableBuilder<T>`	`distinct()` Returns an iterable which filters its elements based if they vere ever seen before in the current iteration.
`<U> IterableBuilder<T>`	`distinct(Func1<? super T,? extends U> keySelector)` 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.
`IterableBuilder<T>`	`distinctNext()` Creates an iterable which ensures that subsequent values of T are not equal (reference and equals).
`<U> IterableBuilder<T>`	`distinctNext(Func1<T,U> keySelector)` Creates an iterable which ensures that subsequent values of T are not equal in respect to the extracted keys (reference and equals).
`IterableBuilder<T>`	`doWhile(Func0<java.lang.Boolean> gate)` Returns an iterable which reiterates over and over again on `source` as long as the gate is true.
`IterableBuilder<T>`	`endWith(T value)` Creates an iterable sequence which returns all elements from source followed by the supplied value as last.
`IterableBuilder<T>`	`finish(Action0 action)` Returns an iterable which executes the given action after the stream completes.
`T`	`first()` Returns the first element from the iterable sequence or throws a NoSuchElementException.
`static <T> IterableBuilder<T>`	`from(java.lang.Iterable<T> source)` Creates a new iterable builder instance by wrapping the given source sequence, if not already a builder.
`static <T> IterableBuilder<T>`	`from(Observable<T> source)` Creates a new iterable builder by wrapping the given observable.
`static <T> IterableBuilder<T>`	`from(T... ts)` Creates a new iterable builder instance by wrapping the given array.
`static <T> IterableBuilder<T>`	`fromPart(int from, int to, T... ts)` Creates a new iterable builder instance by wrapping the given array.
`static <T> IterableBuilder<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.
`<K> IterableBuilder<Pair<K,IterableBuilder<T>>>`	`groupBy(Func1<? super T,? extends K> keySelector)` Creates an iterable which traverses the source iterable, and based on the key selector, groups values the elements into GroupedIterables, which can be interated over later on.
`<K,V> IterableBuilder<Pair<K,IterableBuilder<V>>>`	`groupBy(Func1<? super T,? extends K> keySelector, Func1<? super T,? extends V> valueSelector)` Creates an iterable which traverses the source iterable, and based on the key selector, groups values extracted by valueSelector into a pair of Key and IterableBuilder instances, which can be interated over later on.
`<K> IterableBuilder<GroupedIterable<K,T>>`	`groupBy0(Func1<? super T,? extends K> keySelector)` Creates an iterable which traverses the source iterable, and based on the key selector, groups values the elements into GroupedIterables, which can be interated over later on.
`<K,V> IterableBuilder<GroupedIterable<K,V>>`	`groupBy0(Func1<? super T,? extends K> keySelector, Func1<? super T,? extends V> 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 interated over later on.
`<U extends java.util.Collection<? super T>> U`	`into(U out)` Add the elements of the sequence into the supplied collection.
`IterableBuilder<T>`	`invoke(Action1<? super T> action)` Construct a new iterable which will invoke the specified action before the source value gets relayed through it.
`IterableBuilder<java.lang.Boolean>`	`isEmpty()` Returns a single true if the target iterable is empty.
`java.util.Iterator<T>`	`iterator()`
`IterableBuilder<java.lang.String>`	`join(java.lang.String separator)` Concatenates the source strings one after another and uses the given separator.
`T`	`last()` Returns the last element of the iterable or throws a `NoSuchElementException` if the iterable is empty.
`IterableBuilder<Option<T>>`	`materialize()` 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.
`<U extends java.lang.Comparable<? super U>> IterableBuilder<U>`	`max()` Returns the maximum value of the given iterable source.
`IterableBuilder<T>`	`max(java.util.Comparator<? super T> comparator)` Returns the maximum value of the given iterable source in respect to the supplied comparator.
`<U extends java.lang.Comparable<? super U>> IterableBuilder<java.util.List<U>>`	`maxBy()` Returns an iterator which will produce a single List of the maximum values encountered in the source stream based on the supplied key selector.
`IterableBuilder<java.util.List<T>>`	`maxBy(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.
`<U extends java.lang.Comparable<? super U>> IterableBuilder<java.util.List<T>>`	`mayBy(Func1<? super T,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.
`<U> IterableBuilder<java.util.List<T>>`	`mayBy(Func1<? super T,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.
`IterableBuilder<T>`	`memoize(int bufferSize)` Enumerates the source iterable once and caches its results.
`IterableBuilder<T>`	`memoizeAll()` 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.
`<U extends java.lang.Comparable<? super U>> IterableBuilder<U>`	`min()` Returns the maximum value of the given iterable source.
`IterableBuilder<T>`	`min(java.util.Comparator<? super T> comparator)` Returns the minimum value of the given iterable source in respect to the supplied comparator.
`IterableBuilder<java.util.List<T>>`	`minBy(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.
`<U extends java.lang.Comparable<? super U>> IterableBuilder<java.util.List<T>>`	`minBy(Func1<? super T,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.
`<U> IterableBuilder<java.util.List<T>>`	`minBy(Func1<? super T,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.
`<U extends java.lang.Comparable<? super U>> IterableBuilder<java.util.List<U>>`	`minxBy()` 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> IterableBuilder<T>`	`newBuilder(java.lang.Iterable<T> source)` Creates a new iterable builder instance by wrapping the given source sequence.
`<U extends java.lang.Comparable<? super U>> IterableBuilder<U>`	`orderBy()` Returns an iterable which traverses the entire source iterable and creates an ordered list of elements.
`IterableBuilder<T>`	`orderBy(java.util.Comparator<? super T> comparator)` Returns an iterable which traverses the entire source iterable and creates an ordered list of elements.
`<U extends java.lang.Comparable<? super U>> IterableBuilder<T>`	`orderBy(Func1<? super T,? extends U> keySelector)` Returns an iterable which traverses the entire source iterable and creates an ordered list of elements.
`<U> IterableBuilder<T>`	`orderBy(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.
`void`	`print()` Runs this iterable and prints the values.
`void`	`println()` Runs this iterable and prints the values.
`<U> IterableBuilder<U>`	`prune(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))`.
`<U> IterableBuilder<U>`	`publish(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.
`<U> IterableBuilder<U>`	`publish(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 IterableBuilder<java.lang.Integer>`	`range(int start, int count)` Creates an integer iteratable builder which returns numbers from the start position in the count size.
`static IterableBuilder<java.lang.Long>`	`range(long start, long count)` Creates an long iterable builder which returns numbers from the start position in the count size.
`void`	`removeAll()` Consumes the sequence and removes all items via the Iterator.remove().
`static <T> IterableBuilder<T>`	`repeat(T t)` Creates an iterable builder which repeats the given value indefinitely.
`static <T> IterableBuilder<T>`	`repeat(T t, int count)` Returns an iterable builder which repeats the given single value the specified number of times.
`<U> IterableBuilder<U>`	`replay(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.
`<U> IterableBuilder<U>`	`replay(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.
`void`	`run()` Iterates over the given source without using its returned value.
`void`	`run(Action1<? super T> action)` Iterate over the source and submit each value to the given action.
`<U> IterableBuilder<U>`	`scan(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.
`<U> IterableBuilder<U>`	`scan(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.
`<U> IterableBuilder<U>`	`select(Func1<? super T,? extends U> selector)` Creates an iterable which is a transforms the source elements by using the selector function.
`<U> IterableBuilder<U>`	`select(Func2<java.lang.Integer,? super T,? extends U> selector)` Creates an iterable which is a transforms the source elements by using the selector function.
`<U> IterableBuilder<U>`	`selectMany(Func1<? super T,? extends java.lang.Iterable<? extends U>> selector)` Creates an iterable which returns a stream of Us for each source Ts.
`IterableBuilder<T>`	`share()` 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.
`IterableBuilder<T>`	`skipLast(int num)` Returns an iterable which skips the last `num` elements from the source iterable.
`IterableBuilder<T>`	`startWith(T value)` Returns an iterable which prefixes the source iterable values by a constant.
`IterableBuilder<Pair<T,T>>`	`subsequent()` Returns each pair of subsequent elements as pairs.
`IterableBuilder<IterableBuilder<T>>`	`subsequent(int count)` Returns each pair of subsequent elements as pairs.
`IterableBuilder<java.math.BigDecimal>`	`sumBigDecimal()` Computes and signals the sum of the values of the BigDecimal source.
`IterableBuilder<java.math.BigInteger>`	`sumBigInteger()` Computes and signals the sum of the values of the BigInteger source.
`IterableBuilder<java.lang.Double>`	`sumDouble()` Computes and signals the sum of the values of the Double source.
`IterableBuilder<java.lang.Float>`	`sumFloat()` Computes and signals the sum of the values of the Float source.
`IterableBuilder<java.lang.Integer>`	`sumInt()` Computes and signals the sum of the values of the Integer source.
`IterableBuilder<java.lang.Double>`	`sumIntAsDouble()` Computes and signals the sum of the values of the Integer source by using a double intermediate representation.
`IterableBuilder<java.lang.Long>`	`sumLong()` Computes and signals the sum of the values of the Long source.
`IterableBuilder<java.lang.Double>`	`sumLongAsDouble()` Computes and signals the sum of the values of the Long sourceby using a double intermediate representation.
`IterableBuilder<T>`	`take(int num)` Returns the iterable which returns the first `num` element.
`IterableBuilder<T>`	`takeLast(int num)` Returns an iterable which takes only the last `num` elements from the source iterable.
`java.lang.Object[]`	`toArray()` Returns an object array of all elements in this iterable.
`T[]`	`toArray(T[] a)` Returns all elements from this iterable into either the given array or a new array if the size requires.
`static <T> Func1<java.lang.Iterable<T>,IterableBuilder<T>>`	`toBuilder()`
`<K> java.util.Map<K,T>`	`toHashMap(Func1<? super T,? extends K> keySelector)` Convinience method to create a hashmap from the elements.
`<K> java.util.Map<K,java.util.List<T>>`	`toHashMultimap(Func1<? super T,? extends K> keySelector)` Convinience method to create a hash-multimap with list from the elements.
`java.util.List<T>`	`toList()` Iterates over and returns all elements in a list.
`<K> java.util.Map<K,T>`	`toMap(Func1<? super T,? extends K> keySelector, Func0<? extends java.util.Map<K,T>> mapProvider)` Convert the iterable values into a map representation.
`<K,V> java.util.Map<K,V>`	`toMap(Func1<? super T,? extends K> keySelector, Func1<? super T,? extends V> valueSelector, Func0<? extends java.util.Map<K,V>> mapProvider)` Convert the iterable values into a map representation.
`<K,V,C extends java.util.Collection<V>> java.util.Map<K,C>`	`toMultimap(Func1<? super T,? extends K> keySelector, Func1<? super T,? extends V> valueSelector, Func0<? extends java.util.Map<K,C>> mapProvider, Func0<? extends C> collectionProvider)` Convert the values into a multimap representation where each key can have multiple values.
`ObservableBuilder<T>`	`toObservable()` Converts this iterable into an observable builder which uses the default scheduler of `Reactive` to emit values.
`ObservableBuilder<T>`	`toObservable(Scheduler scheduler)` Converts this iterable into an observable builder which uses the supplied Scheduler to emit values.
`IterableBuilder<T>`	`where(Func1<? super T,java.lang.Boolean> filter)` Creates an iterable which filters this iterable with the given predicate factory function.
`IterableBuilder<T>`	`where(Func2<java.lang.Integer,? super T,java.lang.Boolean> predicate)` Creates an iterable which filters this iterable with the given predicate factory function.
`<U,V> IterableBuilder<V>`	`zip(java.lang.Iterable<? extends U> right, Func2<? super T,? super U,? extends V> combiner)` Pairs each element from this and the oher iterable source 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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
 - it
```
protected final java.lang.Iterable<T> it
```
 The backing iterable.
- Constructor Detail
 - IterableBuilder
```
protected IterableBuilder(@Nonnull
 java.lang.Iterable<T> source)
```
 Constructor.
 
 Parameters:
 
 source - the backing iterable
- Method Detail
 - defer
```
public static <T> IterableBuilder<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
 - fromPart
```
public static <T> IterableBuilder<T> fromPart(int from,
 int to,
 @Nonnull
 T... ts)
```
 Creates a new iterable builder instance by wrapping the given array. Changes to the array will be visible through the iterator.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 from - the source index inclusive
 
 to - the destination index exclusive
 
 ts - the array of ts
 
 Returns:
 
 the created iterable builder
 - from
```
public static <T> IterableBuilder<T> from(@Nonnull
 java.lang.Iterable<T> source)
```
 Creates a new iterable builder instance by wrapping the given source sequence, if not already a builder.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 source - the source sequence
 
 Returns:
 
 the created iterable builder
 - newBuilder
```
public static <T> IterableBuilder<T> newBuilder(@Nonnull
 java.lang.Iterable<T> source)
```
 Creates a new iterable builder instance by wrapping the given source sequence.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 source - the source sequence
 
 Returns:
 
 the created iterable builder
 
 Since:
 
 0.97
 - from
```
public static <T> IterableBuilder<T> from(@Nonnull
 Observable<T> source)
```
 Creates a new iterable builder by wrapping the given observable.
 The resulting iterable does not support the remove() method.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 source - the source observable
 
 Returns:
 
 the created iterable builder
 - from
```
public static <T> IterableBuilder<T> from(@Nonnull
 T... ts)
```
 Creates a new iterable builder instance by wrapping the given array. Changes to the array will be visible through the iterator.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 ts - the array of ts
 
 Returns:
 
 the created iterable builder
 - generate
```
public static <T> IterableBuilder<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
 - range
```
public static IterableBuilder<java.lang.Integer> range(int start,
 int count)
```
 Creates an integer iteratable builder 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
```
public static IterableBuilder<java.lang.Long> range(long start,
 long count)
```
 Creates an long iterable builder 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.
 - repeat
```
public static <T> IterableBuilder<T> repeat(T t)
```
 Creates an iterable builder which repeats the given value indefinitely.
 The resulting iterable does not support the remove() method.
 
 Type Parameters:
 
 T - the element type
 
 Parameters:
 
 t - the value to repeat
 
 Returns:
 
 the created iterable builder
 - repeat
```
public static <T> IterableBuilder<T> repeat(T t,
 int count)
```
 Returns an iterable builder 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:
 
 t - the value to repeat
 
 count - the repeat amount
 
 Returns:
 
 the iterable
 
 Since:
 
 0.96
 - aggregate
```
public <U,V> IterableBuilder<V> aggregate(@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:
 
 U - the itermediate aggregation type
 
 V - the resulting aggregation type
 
 Parameters:
 
 sum - the function which takes the current itermediate 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
```
public IterableBuilder<java.lang.Boolean> all(@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.
 
 Parameters:
 
 predicate - the predicate
 
 Returns:
 
 the new iterable
 - any
```
public IterableBuilder<java.lang.Boolean> any()
```
 Determines if the given source has any elements at all.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Returns:
 
 the new iterable with a single true or false
 - any
```
public IterableBuilder<java.lang.Boolean> any(@Nonnull
 Func1<? super T,java.lang.Boolean> predicate)
```
 Tests if there is any element of the source that satisfies the given predicate function.
 
 Parameters:
 
 predicate - the predicate tester function
 
 Returns:
 
 the new iterable
 - argAndMax
```
public <V extends java.lang.Comparable<? super V>> Pair<T,V> argAndMax(@Nonnull
 Func1<? super T,? extends V> valueSelector)
```
 Returns a pair of the maximum argument and value from the given sequence.
 
 Type Parameters:
 
 V - the value type for the comparison, must be self comparable
 
 Parameters:
 
 valueSelector - the value selector function
 
 Returns:
 
 the pair of the first maximum element and value, null if the sequence was empty
 
 Since:
 
 0.96
 - argAndMax
```
public <V> Pair<T,V> argAndMax(@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:
 
 V - the value type
 
 Parameters:
 
 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
 - argAndMin
```
public <V extends java.lang.Comparable<? super V>> Pair<T,V> argAndMin(@Nonnull
 Func1<? super T,? extends V> valueSelector)
```
 Returns a pair of the minimum argument and value from the given sequence.
 
 Type Parameters:
 
 V - the value type for the comparison, must be self comparable
 
 Parameters:
 
 valueSelector - the value selector function
 
 Returns:
 
 the pair of the first minimum element and value, null if the sequence was empty
 
 Since:
 
 0.96
 - argAndMin
```
public <V> Pair<T,V> argAndMin(@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:
 
 V - the value type
 
 Parameters:
 
 valueSelector - the selector to extract the value from T
 
 valueComparator - the comparator to compare two values
 
 Returns:
 
 the first pair of minimum argument and value or null if the source sequence was empty
 
 Since:
 
 0.96
 - averageBigDecimal
```
@Nonnull
public IterableBuilder<java.math.BigDecimal> averageBigDecimal()
```
 Computes and signals the average value of the BigDecimal source. The source may not send nulls.
 Note that it uses forced cast of this sequence. If T != BigDecimal this method is guaranteed to throw ClassCastException.
 
 Returns:
 
 the observable for the average value
 - averageBigInteger
```
@Nonnull
public IterableBuilder<java.math.BigDecimal> averageBigInteger()
```
 Computes and signals the average value of the BigInteger source. The source may not send nulls.
 Note that it uses forced cast of this sequence. If T != BigInteger this method is guaranteed to throw ClassCastException.
 
 Returns:
 
 the observable for the average value
 - averageDouble
```
@Nonnull
public IterableBuilder<java.lang.Double> averageDouble()
```
 Computes and signals the average value of the Double source. The source may not send nulls.
 
 Returns:
 
 the observable for the average value
 - averageFloat
```
@Nonnull
public IterableBuilder<java.lang.Float> averageFloat()
```
 Computes and signals the average value of the Float source. The source may not send nulls.
 
 Returns:
 
 the observable for the average value
 - averageInt
```
@Nonnull
public IterableBuilder<java.lang.Double> averageInt()
```
 Computes and signals the average value of the integer source. The source may not send nulls. The intermediate aggregation used double values.
 
 Returns:
 
 the observable for the average value
 - averageLong
```
@Nonnull
public IterableBuilder<java.lang.Double> averageLong()
```
 Computes and signals the average value of the Long source. The source may not send nulls. The intermediate aggregation used double values.
 
 Returns:
 
 the observable for the average value
 - buffer
```
public IterableBuilder<java.util.List<T>> buffer(int bufferSize)
```
 Returns an iterable which buffers the source elements into bufferSize lists.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Parameters:
 
 bufferSize - the buffer size.
 
 Returns:
 
 the new iterable
 - cast
```
public  IterableBuilder cast(@Nonnull
 java.lang.Class token)
```
 Casts the source iterable into a different typ 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:
 
 U - the result element type
 
 Parameters:
 
 token - the type token
 
 Returns:
 
 the new iterable
 - concat
```
public IterableBuilder<T> concat(@Nonnull
 java.lang.Iterable<? extends T> other)
```
 Concatenate this iterable with the other iterable 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).
 
 Parameters:
 
 other - the second iterable
 
 Returns:
 
 the new iterable
 - concat
```
public IterableBuilder<T> concat(@Nonnull
 T... values)
```
 Concatenate this iterable with the sequence of array values.
 
 Parameters:
 
 values - the array values
 
 Returns:
 
 the created iterable builder
 - concatAll
```
public IterableBuilder<T> concatAll(@Nonnull
 java.lang.Iterable<? extends java.lang.Iterable<? extends T>> others)
```
 Creates an iterable builder which contains the concatenation of this iterable and the rest iterable provided.
 
 Parameters:
 
 others - the other iterables
 
 Returns:
 
 the created iterable
 - contains
```
public IterableBuilder<java.lang.Boolean> contains(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.
 
 Parameters:
 
 value - the value to check
 
 Returns:
 
 the new iterable
 - count
```
public IterableBuilder<java.lang.Integer> count()
```
 Counts the elements of the iterable source by using a 32 bit int.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Returns:
 
 the new iterable
 - countLong
```
public IterableBuilder<java.lang.Long> countLong()
```
 Counts the elements of the iterable source by using a 64 bit long.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Returns:
 
 the new iterable
 - dematerialize
```
public IterableBuilder<T> dematerialize()
```
 Convert the source materialized elements into normal iterator behavior.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Returns:
 
 the new iterable
 - distinctNext
```
public IterableBuilder<T> distinctNext()
```
 Creates an iterable which ensures that subsequent values of T are not equal (reference and equals).
 
 Returns:
 
 the new iterable
 - distinctNext
```
public  IterableBuilder<T> distinctNext(@Nonnull
 Func1<T,U> keySelector)
```
 Creates an iterable which ensures that subsequent values of T are not equal in respect to the extracted keys (reference and equals).
 
 Type Parameters:
 
 U - the key type
 
 Parameters:
 
 keySelector - the function to extract the keys which will be compared
 
 Returns:
 
 the new iterable
 - distinct
```
public IterableBuilder<T> distinct()
```
 Returns an iterable which filters its elements based if they vere ever seen before in the current iteration. Value equality is computed by reference equality and equals()
 
 Returns:
 
 the new iterable
 - distinct
```
public  IterableBuilder<T> distinct(@Nonnull
 Func1<? super T,? extends U> keySelector)
```
 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:
 
 U - the key element type
 
 Parameters:
 
 keySelector - the key selector for only-once filtering
 
 Returns:
 
 the new iterable
 - doWhile
```
@Nonnull
public IterableBuilder<T> doWhile(@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.
 
 Parameters:
 
 gate - the gate function to stop the repeat
 
 Returns:
 
 the new iterable
 - endWith
```
public IterableBuilder<T> endWith(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.
 
 Parameters:
 
 value - the value to append
 
 Returns:
 
 the new iterable
 - finish
```
public IterableBuilder<T> finish(@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.
 
 Parameters:
 
 action - the action to invoke
 
 Returns:
 
 the new iterable
 - first
```
public T first()
```
 Returns the first element from the iterable sequence or throws a NoSuchElementException.
 
 Returns:
 
 the first element
 - groupBy0
```
public <K,V> IterableBuilder<GroupedIterable<K,V>> groupBy0(@Nonnull
 Func1<? super T,? extends K> keySelector,
 Func1<? super T,? extends V> 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 interated 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:
 
 K - the result group element type
 
 V - the result group keys
 
 Parameters:
 
 keySelector - the key selector
 
 valueSelector - the value selector
 
 Returns:
 
 the new iterable
 
 Since:
 
 0.96.1
 - groupBy0
```
public <K> IterableBuilder<GroupedIterable<K,T>> groupBy0(@Nonnull
 Func1<? super T,? extends K> keySelector)
```
 Creates an iterable which traverses the source iterable, and based on the key selector, groups values the elements into GroupedIterables, which can be interated 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:
 
 K - the result group element type
 
 Parameters:
 
 keySelector - the key selector
 
 Returns:
 
 the new iterable
 
 Since:
 
 0.96.1
 - groupBy
```
public <K> IterableBuilder<Pair<K,IterableBuilder<T>>> groupBy(@Nonnull
 Func1<? super T,? extends K> keySelector)
```
 Creates an iterable which traverses the source iterable, and based on the key selector, groups values the elements into GroupedIterables, which can be interated 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:
 
 K - the result group element type
 
 Parameters:
 
 keySelector - the key selector
 
 Returns:
 
 the new iterable
 
 Since:
 
 0.96.1
 - groupBy
```
public <K,V> IterableBuilder<Pair<K,IterableBuilder<V>>> groupBy(@Nonnull
 Func1<? super T,? extends K> keySelector,
 Func1<? super T,? extends V> valueSelector)
```
 Creates an iterable which traverses the source iterable, and based on the key selector, groups values extracted by valueSelector into a pair of Key and IterableBuilder instances, which can be interated 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:
 
 K - the result group element type
 
 V - the result group keys
 
 Parameters:
 
 keySelector - the key selector
 
 valueSelector - the value selector
 
 Returns:
 
 the new iterable
 
 Since:
 
 0.96.1
 - invoke
```
public IterableBuilder<T> invoke(@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.
 
 Parameters:
 
 action - the action to invoke before each next() is returned.
 
 Returns:
 
 the new iterable
 - isEmpty
```
public IterableBuilder<java.lang.Boolean> isEmpty()
```
 Returns a single true if the target iterable is empty.
 
 Returns:
 
 the new iterable
 - iterator
```
public java.util.Iterator<T> iterator()
```
 Specified by:
 
 iterator in interface java.lang.Iterable<T>
 - join
```
public IterableBuilder<java.lang.String> join(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:
 
 separator - the separator to use
 
 Returns:
 
 the new iterable
 - last
```
public T last()
```
 Returns the last element of the iterable or throws a NoSuchElementException if the iterable is empty.
 
 Returns:
 
 the last value
 - materialize
```
public IterableBuilder<Option<T>> materialize()
```
 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.
 
 Returns:
 
 the new iterable
 - max
```
public > IterableBuilder max()
```
 Returns the maximum value of the given iterable source.
 
 Type Parameters:
 
 U - the self comparable type
 
 Returns:
 
 the new iterable
 - max
```
public IterableBuilder<T> max(@Nonnull
 java.util.Comparator<? super T> comparator)
```
 Returns the maximum value of the given iterable source in respect to the supplied comparator.
 
 Parameters:
 
 comparator - the comparator to use
 
 Returns:
 
 the new iterable
 - maxBy
```
public > IterableBuilder<java.util.List> maxBy()
```
 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:
 
 U - the source element type, which must be self comparable
 
 Returns:
 
 the new iterable
 - maxBy
```
public IterableBuilder<java.util.List<T>> maxBy(@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.
 
 Parameters:
 
 comparator - the key comparator
 
 Returns:
 
 the new iterable
 - mayBy
```
public > IterableBuilder<java.util.List<T>> mayBy(@Nonnull
 Func1<? super T,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:
 
 U - the key type, which must be self-comparable
 
 Parameters:
 
 keySelector - the selector for keys
 
 Returns:
 
 the new iterable
 - mayBy
```
public  IterableBuilder<java.util.List<T>> mayBy(@Nonnull
 Func1<? super T,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:
 
 U - the key type
 
 Parameters:
 
 keySelector - the selector for keys
 
 keyComparator - the key comparator
 
 Returns:
 
 the new iterable
 - memoize
```
public IterableBuilder<T> memoize(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.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Parameters:
 
 bufferSize - the size of the buffering
 
 Returns:
 
 the new iterable
 - memoizeAll
```
public IterableBuilder<T> memoizeAll()
```
 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.
 
 Returns:
 
 the new iterable
 - min
```
public > IterableBuilder min()
```
 Returns the maximum value of the given iterable source.
 
 Type Parameters:
 
 U - the self comparable type
 
 Returns:
 
 the new iterable
 - min
```
public IterableBuilder<T> min(@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.
 
 Parameters:
 
 comparator - the comparator to use
 
 Returns:
 
 the new iterable
 - minBy
```
public IterableBuilder<java.util.List<T>> minBy(@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.
 
 Parameters:
 
 comparator - the key comparator
 
 Returns:
 
 the new iterable
 - minBy
```
public > IterableBuilder<java.util.List<T>> minBy(@Nonnull
 Func1<? super T,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:
 
 U - the key type, which must be self-comparable
 
 Parameters:
 
 keySelector - the selector for keys
 
 Returns:
 
 the new iterable
 - minBy
```
public  IterableBuilder<java.util.List<T>> minBy(@Nonnull
 Func1<? super T,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:
 
 U - the key type
 
 Parameters:
 
 keySelector - the selector for keys
 
 keyComparator - the key comparator
 
 Returns:
 
 the new iterable
 - minxBy
```
public > IterableBuilder<java.util.List> minxBy()
```
 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:
 
 U - the source element type, which must be self comparable
 
 Returns:
 
 the new iterable
 - orderBy
```
public > IterableBuilder orderBy()
```
 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.
 Note: the element type should be self comparable or a ClassCastException is thrown.
 
 Type Parameters:
 
 U - the source element type, which must be self comparable
 
 Returns:
 
 the new iterable
 - orderBy
```
public IterableBuilder<T> orderBy(@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.
 
 Parameters:
 
 comparator - the value comparator
 
 Returns:
 
 the new iterable
 - orderBy
```
public > IterableBuilder<T> orderBy(@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:
 
 U - the key type for the ordering, must be self comparable
 
 Parameters:
 
 keySelector - the key selector for comparison
 
 Returns:
 
 the new iterable
 - orderBy
```
public  IterableBuilder<T> orderBy(@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:
 
 U - the key type for the ordering
 
 Parameters:
 
 keySelector - the key selector for comparison
 
 keyComparator - the key comparator function
 
 Returns:
 
 the new iterable
 - prune
```
public  IterableBuilder prune(@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:
 
 U - the return types
 
 Parameters:
 
 func - invoke the function on the buffering iterable and return an iterator over it.
 
 Returns:
 
 the new iterable
 - publish
```
public  IterableBuilder publish(@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:
 
 U - the return types
 
 Parameters:
 
 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
```
public  IterableBuilder publish(@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:
 
 U - the return types
 
 Parameters:
 
 func - invoke the function on the buffering iterable and return an iterator over it.
 
 Returns:
 
 the new iterable
 - replay
```
public  IterableBuilder replay(@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:
 
 U - the return types
 
 Parameters:
 
 func - invoke the function on the buffering iterable and return an iterator over it.
 
 Returns:
 
 the new iterable
 - replay
```
public  IterableBuilder replay(@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:
 
 U - the return types
 
 Parameters:
 
 func - invoke the function on the buffering iterable and return an iterator over it.
 
 bufferSize - the buffer size
 
 Returns:
 
 the new iterable
 - run
```
public void run()
```
 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.
 - run
```
public void run(@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.
 
 Parameters:
 
 action - the action to invoke on with element
 - scan
```
public  IterableBuilder scan(@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:
 
 U - the destination element type
 
 Parameters:
 
 aggregator - the function which takes the current running aggregation value, the current element and produces a new aggregation value.
 
 Returns:
 
 the new iterable
 - scan
```
public  IterableBuilder scan(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:
 
 U - the destination element type
 
 Parameters:
 
 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
```
public  IterableBuilder select(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 element.
 
 Type Parameters:
 
 U - the output element type
 
 Parameters:
 
 selector - the selector function
 
 Returns:
 
 the new iterable
 - select
```
public  IterableBuilder select(@Nonnull
 Func2<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:
 
 U - the output element type
 
 Parameters:
 
 selector - the selector function
 
 Returns:
 
 the new iterable
 - selectMany
```
public  IterableBuilder selectMany(@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:
 
 U - the output element type
 
 Parameters:
 
 selector - the selector for multiple Us for each T
 
 Returns:
 
 the new iterable
 - share
```
public IterableBuilder<T> share()
```
 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.
 
 Returns:
 
 the new iterable
 - skipLast
```
public IterableBuilder<T> skipLast(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.
 
 Parameters:
 
 num - the number of elements to skip at the end
 
 Returns:
 
 the new iterable
 - startWith
```
public IterableBuilder<T> startWith(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.
 
 Parameters:
 
 value - the value to prefix
 
 Returns:
 
 the new iterable.
 - sumBigDecimal
```
@Nonnull
public IterableBuilder<java.math.BigDecimal> sumBigDecimal()
```
 Computes and signals the sum of the values of the BigDecimal source. The source may not send nulls.
 
 Returns:
 
 the observable for the sum value
 - sumBigInteger
```
@Nonnull
public IterableBuilder<java.math.BigInteger> sumBigInteger()
```
 Computes and signals the sum of the values of the BigInteger source. The source may not send nulls.
 
 Returns:
 
 the observable for the sum value
 - sumDouble
```
@Nonnull
public IterableBuilder<java.lang.Double> sumDouble()
```
 Computes and signals the sum of the values of the Double source. The source may not send nulls.
 
 Returns:
 
 the observable for the sum value
 - sumFloat
```
@Nonnull
public IterableBuilder<java.lang.Float> sumFloat()
```
 Computes and signals the sum of the values of the Float source. The source may not send nulls.
 
 Returns:
 
 the observable for the sum value
 - sumInt
```
@Nonnull
public IterableBuilder<java.lang.Integer> sumInt()
```
 Computes and signals the sum of the values of the Integer source. The source may not send nulls. An empty source produces an empty sum
 
 Returns:
 
 the observable for the sum value
 - sumIntAsDouble
```
@Nonnull
public IterableBuilder<java.lang.Double> sumIntAsDouble()
```
 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
 
 Returns:
 
 the observable for the sum value
 - sumLong
```
@Nonnull
public IterableBuilder<java.lang.Long> sumLong()
```
 Computes and signals the sum of the values of the Long source. The source may not send nulls.
 
 Returns:
 
 the observable for the sum value
 - sumLongAsDouble
```
@Nonnull
public IterableBuilder<java.lang.Double> sumLongAsDouble()
```
 Computes and signals the sum of the values of the Long sourceby using a double intermediate representation. The source may not send nulls.
 
 Returns:
 
 the observable for the sum value
 - take
```
public IterableBuilder<T> take(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.
 
 Parameters:
 
 num - the number of items to take
 
 Returns:
 
 the new iterable
 - takeLast
```
public IterableBuilder<T> takeLast(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.
 
 Parameters:
 
 num - the number of elements to skip at the end
 
 Returns:
 
 the new iterable
 - toArray
```
@Nonnull
public java.lang.Object[] toArray()
```
 Returns an object array of all elements in this iterable.
 
 Returns:
 
 the object array
 - toArray
```
@Nonnull
public T[] toArray(T[] a)
```
 Returns all elements from this iterable into either the given array or a new array if the size requires.
 
 Parameters:
 
 a - the output array
 
 Returns:
 
 the output array
 - toList
```
@Nonnull
public java.util.List<T> toList()
```
 Iterates over and returns all elements in a list.
 
 Returns:
 
 the list of the values from this iterable
 - toObservable
```
public ObservableBuilder<T> toObservable()
```
 Converts this iterable into an observable builder which uses the default scheduler of Reactive to emit values.
 
 Returns:
 
 the observable builder
 - toObservable
```
public ObservableBuilder<T> toObservable(@Nonnull
 Scheduler scheduler)
```
 Converts this iterable into an observable builder which uses the supplied Scheduler to emit values.
 
 Parameters:
 
 scheduler - the scheduler
 
 Returns:
 
 the observable builder
 - where
```
public IterableBuilder<T> where(Func1<? super T,java.lang.Boolean> filter)
```
 Creates an iterable which filters this 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 predicat 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.
 
 Parameters:
 
 filter - the predicate function
 
 Returns:
 
 the new iterable
 - where
```
public IterableBuilder<T> where(@Nonnull
 Func2<java.lang.Integer,? super T,java.lang.Boolean> predicate)
```
 Creates an iterable which filters this iterable with the given predicate factory function. The predicate returned by the factory receives an index telling how many elements were processed thus far.
 
 Parameters:
 
 predicate - the predicate
 
 Returns:
 
 the new iterable
 - zip
```
public <U,V> IterableBuilder<V> zip(@Nonnull
 java.lang.Iterable<? extends U> right,
 @Nonnull
 Func2<? super T,? super U,? extends V> combiner)
```
 Pairs each element from this and the oher iterable source 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:
 
 U - the right source type
 
 V - the result type
 
 Parameters:
 
 right - the right source
 
 combiner - the combiner function
 
 Returns:
 
 the new iterable
 - print
```
public void print()
```
 Runs this iterable and prints the values.
 Is the same as using this.run(Interactive.print()).
 - println
```
public void println()
```
 Runs this iterable and prints the values.
 Is the same as using this.run(Interactive.println()).
 - toMap
```
public <K,V> java.util.Map<K,V> toMap(Func1<? super T,? extends K> keySelector,
 Func1<? super T,? extends V> valueSelector,
 Func0<? extends java.util.Map<K,V>> mapProvider)
```
 Convert the iterable values into a map representation.
 If an element maps to the same key, the existing value will be overwritten.
 
 Type Parameters:
 
 K - the key type
 
 V - the value type
 
 Parameters:
 
 keySelector - the function to extract a key from an element
 
 valueSelector - the function to extract a value from an element
 
 mapProvider - the map provider
 
 Returns:
 
 the filled-in map.
 
 Since:
 
 0.96.1
 - toMap
```
public <K> java.util.Map<K,T> toMap(Func1<? super T,? extends K> keySelector,
 Func0<? extends java.util.Map<K,T>> mapProvider)
```
 Convert the iterable values into a map representation.
 If an element maps to the same key, the existing value will be overwritten.
 
 See Functions.hashMapProvider() and others for some standard map implementations.
 
 Type Parameters:
 
 K - the key type
 
 Parameters:
 
 keySelector - the function to extract a key from an element
 
 mapProvider - the map provider
 
 Returns:
 
 the filled-in map.
 
 Since:
 
 0.96.1
 - toMultimap
```
public <K,V,C extends java.util.Collection<V>> java.util.Map<K,C> toMultimap(Func1<? super T,? extends K> keySelector,
 Func1<? super T,? extends V> valueSelector,
 Func0<? extends java.util.Map<K,C>> mapProvider,
 Func0<? extends C> collectionProvider)
```
 Convert the values into a multimap representation where each key can have multiple values.
 See Functions.hashMapProvider(), Functions.arrayListProvider() and others for some standard map implementations.
 
 Type Parameters:
 
 K - the key type
 
 V - the value type
 
 C - the collection type
 
 Parameters:
 
 keySelector - the key selector
 
 valueSelector - the value selector
 
 mapProvider - the provider for the base map
 
 collectionProvider - the provider for the value collection
 
 Returns:
 
 the multimap
 
 Since:
 
 0.96.1
 - toHashMap
```
public <K> java.util.Map<K,T> toHashMap(Func1<? super T,? extends K> keySelector)
```
 Convinience method to create a hashmap from the elements.
 
 Type Parameters:
 
 K - the key type
 
 Parameters:
 
 keySelector - the key selector
 
 Returns:
 
 the map
 
 Since:
 
 0.96.1
 - toHashMultimap
```
public <K> java.util.Map<K,java.util.List<T>> toHashMultimap(Func1<? super T,? extends K> keySelector)
```
 Convinience method to create a hash-multimap with list from the elements.
 
 Type Parameters:
 
 K - the key type
 
 Parameters:
 
 keySelector - the key selector
 
 Returns:
 
 the multimap
 
 Since:
 
 0.96.1
 - subsequent
```
public IterableBuilder<Pair<T,T>> subsequent()
```
 Returns each pair of subsequent elements as pairs.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Returns:
 
 the iterable builder
 
 Since:
 
 0.96.1
 - subsequent
```
public IterableBuilder<IterableBuilder<T>> subsequent(int count)
```
 Returns each pair of subsequent elements as pairs.
 The returned iterator will throw an UnsupportedOperationException for its remove() method.
 
 Parameters:
 
 count - the number of subsequent elements
 
 Returns:
 
 the iterable builder
 
 Since:
 
 0.96.1
 - toBuilder
```
public static <T> Func1<java.lang.Iterable<T>,IterableBuilder<T>> toBuilder()
```
 Type Parameters:
 
 T - the element type
 
 Returns:
 
 a function which wraps its iterable parameter into an iterablebuilder instance
 
 Since:
 
 0.96.1
 - into
```
public > U into(@Nonnull
 U out)
```
 Add the elements of the sequence into the supplied collection.
 
 Type Parameters:
 
 U - a collection type
 
 Parameters:
 
 out - the output collection
 
 Returns:
 
 the same out value
 
 Since:
 
 0.97
 - removeAll
```
public void removeAll()
```
 Consumes the sequence and removes all items via the Iterator.remove().
 
 Since:
 
 0.97
 - concat
```
@Nonnull
public  ObservableBuilder concat(@Nonnull
 Func1<? super T,? extends Observable<? extends U>> resultSelector)
```
 Perform the concatenation of observable sequences based on this iterable and the given result selector function.
 
 Type Parameters:
 
 U - the result sequence type
 
 Parameters:
 
 resultSelector - the observable selector function
 
 Returns:
 
 the concatenating observable sequence

Class IterableBuilder<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

it

Constructor Detail

IterableBuilder

Method Detail

defer

fromPart

from

newBuilder

from

from

generate

range

range

repeat

repeat

aggregate

all

any

any

argAndMax

argAndMax

argAndMin

argAndMin

averageBigDecimal

averageBigInteger

averageDouble

averageFloat

averageInt

averageLong

buffer

cast

concat

concat

concatAll

contains

count

countLong

dematerialize

distinctNext

distinctNext

distinct

distinct

doWhile

endWith

finish

first

groupBy0

groupBy0

groupBy

groupBy

invoke

isEmpty

iterator

join

last

materialize

max

max

maxBy

maxBy

mayBy

mayBy

memoize

memoizeAll

min

min

minBy

minBy

minBy

minxBy

orderBy

orderBy

orderBy