ix

Class Ix<T>

java.lang.Object

ix.Ix<T>

Type Parameters:

T - the element type

All Implemented Interfaces:

java.lang.Iterable<T>

Direct Known Subclasses:

GroupedIterable

public class Ix<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 Observable class.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Ix(java.lang.Iterable<T> source) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
<U,V> Ix<V>	aggregate(rx.functions.Func2<? super U,? super T,? extends U> sum, rx.functions.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.
Ix<java.lang.Boolean>	all(rx.functions.Func1<? super T,java.lang.Boolean> predicate) Returns an iterable which contains true if all elements of the source iterable satisfy the predicate.
Ix<java.lang.Boolean>	any() Determines if the given source has any elements at all.
Ix<java.lang.Boolean>	any(rx.functions.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(rx.functions.Func1<? super T,? extends V> valueSelector) Returns a pair of the maximum argument and value from the given sequence.
<V> Pair<T,V>	argAndMax(rx.functions.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(rx.functions.Func1<? super T,? extends V> valueSelector) Returns a pair of the minimum argument and value from the given sequence.
<V> Pair<T,V>	argAndMin(rx.functions.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.
Ix<java.math.BigDecimal>	averageBigDecimal() Computes and signals the average value of the BigDecimal source.
Ix<java.math.BigDecimal>	averageBigInteger() Computes and signals the average value of the BigInteger source.
Ix<java.lang.Double>	averageDouble() Computes and signals the average value of the Double source.
Ix<java.lang.Float>	averageFloat() Computes and signals the average value of the Float source.
Ix<java.lang.Double>	averageInt() Computes and signals the average value of the integer source.
Ix<java.lang.Double>	averageLong() Computes and signals the average value of the Long source.
Ix<java.util.List<T>>	buffer(int bufferSize) Returns an iterable which buffers the source elements into bufferSize lists.
static <T> Ix<T>	concat(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources) Creates an iterable builder which contains the concatenation of all the iterables returned by the iterable.
Ix<T>	concatWith(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.
Ix<T>	concatWith(T... values) Concatenate this iterable with the sequence of array values.
Ix<T>	concatWithAll(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.
Ix<java.lang.Boolean>	contains(java.lang.Object 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().
Ix<java.lang.Integer>	count() Counts the elements of the iterable source by using a 32 bit int.
Ix<java.lang.Long>	countLong() Counts the elements of the iterable source by using a 64 bit long.
static <T> Ix<T>	defer(rx.functions.Func0<? extends java.lang.Iterable<T>> func) Defers the source iterable creation to registration time and calls the given func for the actual source.
Ix<T>	dematerialize() Convert the source materialized elements into normal iterator behavior.
Ix<T>	distinct() Returns an iterable which filters its elements based if they vere ever seen before in the current iteration.
<U> Ix<T>	distinct(rx.functions.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.
Ix<T>	distinctNext() Creates an iterable which ensures that subsequent values of T are not equal (reference and equals).
<U> Ix<T>	distinctNext(rx.functions.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).
Ix<T>	doOnCompleted(rx.functions.Action0 action) Returns an iterable which executes the given action after the stream completes.
Ix<T>	doOnNext(rx.functions.Action1<? super T> action) Construct a new iterable which will invoke the specified action before the source value gets relayed through it.
Ix<T>	doWhile(rx.functions.Func0<java.lang.Boolean> gate) Returns an iterable which reiterates over and over again on source as long as the gate is true.
static <T> java.lang.Iterable<T>	empty() Returns an empty iterable which will not produce elements.
Ix<T>	endWith(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>	error(java.lang.Throwable t) Returns an iterator which will throw the given Throwable exception when the client invokes next() the first time.
Ix<T>	filter(rx.functions.Func1<? super T,java.lang.Boolean> predicate) Creates an iterable which filters this iterable with the given predicate factory function.
Ix<T>	filterIndexed(rx.functions.Func2<java.lang.Integer,? super T,java.lang.Boolean> predicate) Creates an iterable which filters this iterable with the given predicate factory function.
T	first() Returns the first element from the iterable sequence or throws a NoSuchElementException.
<U> Ix<U>	flatMap(rx.functions.Func1<? super T,? extends java.lang.Iterable<? extends U>> selector) Creates an iterable which returns a stream of Us for each source Ts.
void	forEach(rx.functions.Action1<? super T> action) Iterate over the source and submit each value to the given action.
static <T> Ix<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> Ix<T>	from(rx.Observable<T> source) Creates a new iterable builder by wrapping the given observable.
static <T> Ix<T>	from(T... ts) Creates a new iterable builder instance by wrapping the given array.
static <T> Ix<T>	fromPart(int from, int to, T... ts) Creates a new iterable builder instance by wrapping the given array.
static <T> Ix<T>	generate(T seed, rx.functions.Func1<? super T,java.lang.Boolean> predicate, rx.functions.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> Ix<GroupedIterable<K,T>>	groupBy(rx.functions.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> Ix<GroupedIterable<K,V>>	groupBy(rx.functions.Func1<? super T,? extends K> keySelector, rx.functions.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.
Ix<java.lang.Boolean>	isEmpty() Returns a single true if the target iterable is empty.
java.util.Iterator<T>	iterator()
Ix<java.lang.String>	join(java.lang.String separator) Concatenates the source strings one after another and uses the given separator.
static <T> java.lang.Iterable<T>	just(T value) Creates an iterable which returns only a single element.
T	last() Returns the last element of the iterable or throws a NoSuchElementException if the iterable is empty.
<U> Ix<U>	map(rx.functions.Func1<? super T,? extends U> selector) Creates an iterable which is a transforms the source elements by using the selector function.
<U> Ix<U>	mapIndexed(rx.functions.Func2<java.lang.Integer,? super T,? extends U> selector) Creates an iterable which is a transforms the source elements by using the selector function.
Ix<rx.Notification<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>> Ix<U>	max() Returns the maximum value of the given iterable source.
Ix<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>> Ix<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.
Ix<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>> Ix<java.util.List<T>>	mayBy(rx.functions.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> Ix<java.util.List<T>>	mayBy(rx.functions.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.
Ix<T>	memoize(int bufferSize) Enumerates the source iterable once and caches its results.
Ix<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>> Ix<U>	min() Returns the maximum value of the given iterable source.
Ix<T>	min(java.util.Comparator<? super T> comparator) Returns the minimum value of the given iterable source in respect to the supplied comparator.
Ix<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>> Ix<java.util.List<T>>	minBy(rx.functions.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> Ix<java.util.List<T>>	minBy(rx.functions.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>> Ix<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> Ix<T>	newBuilder(java.lang.Iterable<T> source) Creates a new iterable builder instance by wrapping the given source sequence.
<U> Ix<U>	ofType(java.lang.Class<U> token) Casts the source iterable into a different typ by using a type token.
<U extends java.lang.Comparable<? super U>> Ix<U>	orderBy() Returns an iterable which traverses the entire source iterable and creates an ordered list of elements.
Ix<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>> Ix<T>	orderBy(rx.functions.Func1<? super T,? extends U> keySelector) Returns an iterable which traverses the entire source iterable and creates an ordered list of elements.
<U> Ix<T>	orderBy(rx.functions.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> Ix<U>	prune(rx.functions.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> Ix<U>	publish(rx.functions.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> Ix<U>	publish(rx.functions.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 Ix<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 Ix<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> Ix<T>	repeat(T t) Creates an iterable builder which repeats the given value indefinitely.
static <T> Ix<T>	repeat(T t, int count) Returns an iterable builder which repeats the given single value the specified number of times.
<U> Ix<U>	replay(rx.functions.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> Ix<U>	replay(rx.functions.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.
<U> Ix<U>	scan(rx.functions.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> Ix<U>	scan(U seed, rx.functions.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.
Ix<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.
Ix<T>	skipLast(int num) Returns an iterable which skips the last num elements from the source iterable.
Ix<T>	startWith(T value) Returns an iterable which prefixes the source iterable values by a constant.
Ix<Pair<T,T>>	subsequent() Returns each pair of subsequent elements as pairs.
Ix<Ix<T>>	subsequent(int count) Returns each pair of subsequent elements as pairs.
Ix<java.math.BigDecimal>	sumBigDecimal() Computes and signals the sum of the values of the BigDecimal source.
Ix<java.math.BigInteger>	sumBigInteger() Computes and signals the sum of the values of the BigInteger source.
Ix<java.lang.Double>	sumDouble() Computes and signals the sum of the values of the Double source.
Ix<java.lang.Float>	sumFloat() Computes and signals the sum of the values of the Float source.
Ix<java.lang.Integer>	sumInt() Computes and signals the sum of the values of the Integer source.
Ix<java.lang.Double>	sumIntAsDouble() Computes and signals the sum of the values of the Integer source by using a double intermediate representation.
Ix<java.lang.Long>	sumLong() Computes and signals the sum of the values of the Long source.
Ix<java.lang.Double>	sumLongAsDouble() Computes and signals the sum of the values of the Long sourceby using a double intermediate representation.
Ix<T>	take(int num) Returns the iterable which returns the first num element.
Ix<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> rx.functions.Func1<java.lang.Iterable<T>,Ix<T>>	toBuilder()
<K> java.util.Map<K,T>	toHashMap(rx.functions.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(rx.functions.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(rx.functions.Func1<? super T,? extends K> keySelector, rx.functions.Func0<? extends java.util.Map<K,T>> mapProvider) Convert the iterable values into a map representation.
<K,V> java.util.Map<K,V>	toMap(rx.functions.Func1<? super T,? extends K> keySelector, rx.functions.Func1<? super T,? extends V> valueSelector, rx.functions.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(rx.functions.Func1<? super T,? extends K> keySelector, rx.functions.Func1<? super T,? extends V> valueSelector, rx.functions.Func0<? extends java.util.Map<K,C>> mapProvider, rx.functions.Func0<? extends C> collectionProvider) Convert the values into a multimap representation where each key can have multiple values.
rx.Observable<T>	toObservable() Converts this iterable into an observable builder which uses the default scheduler of Observable to emit values.
rx.Observable<T>	toObservable(rx.Scheduler scheduler) Converts this iterable into an observable builder which uses the supplied Scheduler to emit values.
<U,V> Ix<V>	zip(java.lang.Iterable<? extends U> right, rx.functions.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

Field Detail

it

protected final java.lang.Iterable<T> it

The backing iterable.

Constructor Detail

Ix

protected Ix(java.lang.Iterable<T> source)

Constructor.

Parameters:

source - the backing iterable

Method Detail

concat

public static <T> Ix<T> concat(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> sources)

Creates an iterable builder which contains the concatenation of all the iterables returned by the iterable.

Type Parameters:

T - the value type

Parameters:

sources - the source iterables

Returns:

the created iterable

defer

public static <T> Ix<T> defer(rx.functions.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

from

public static <T> Ix<T> from(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

from

public static <T> Ix<T> from(rx.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> Ix<T> from(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

just

public static <T> java.lang.Iterable<T> just(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

error

public static <T> java.lang.Iterable<T> error(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.

Type Parameters:

T - the element type, irrelevant

Parameters:

t - the exception to throw

Returns:

the new iterable

empty

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

fromPart

public static <T> Ix<T> fromPart(int from,
                 int to,
                 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

generate

public static <T> Ix<T> generate(T seed,
                 rx.functions.Func1<? super T,java.lang.Boolean> predicate,
                 rx.functions.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

newBuilder

public static <T> Ix<T> newBuilder(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

range

public static Ix<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 Ix<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> Ix<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> Ix<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

toBuilder

public static <T> rx.functions.Func1<java.lang.Iterable<T>,Ix<T>> toBuilder()

Type Parameters:

T - the element type

Returns:

a function which wraps its iterable parameter into an iterablebuilder instance

aggregate

public <U,V> Ix<V> aggregate(rx.functions.Func2<? super U,? super T,? extends U> sum,
                    rx.functions.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 Ix<java.lang.Boolean> all(rx.functions.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 Ix<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 Ix<java.lang.Boolean> any(rx.functions.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(rx.functions.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

argAndMax

public <V> Pair<T,V> argAndMax(rx.functions.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.

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

argAndMin

public <V extends java.lang.Comparable<? super V>> Pair<T,V> argAndMin(rx.functions.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

argAndMin

public <V> Pair<T,V> argAndMin(rx.functions.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.

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

averageBigDecimal

public Ix<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

public Ix<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

public Ix<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

public Ix<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

public Ix<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

public Ix<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 Ix<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

concatWith

public Ix<T> concatWith(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

concatWith

public Ix<T> concatWith(T... values)

Concatenate this iterable with the sequence of array values.

Parameters:

values - the array values

Returns:

the created iterable builder

concatWithAll

public Ix<T> concatWithAll(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 Ix<java.lang.Boolean> contains(java.lang.Object 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 Ix<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 Ix<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 Ix<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

distinct

public Ix<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 <U> Ix<T> distinct(rx.functions.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

distinctNext

public Ix<T> distinctNext()

Creates an iterable which ensures that subsequent values of T are not equal (reference and equals).

Returns:

the new iterable

distinctNext

public <U> Ix<T> distinctNext(rx.functions.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

doOnCompleted

public Ix<T> doOnCompleted(rx.functions.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

doOnNext

public Ix<T> doOnNext(rx.functions.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

doWhile

public Ix<T> doWhile(rx.functions.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 Ix<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

filter

public Ix<T> filter(rx.functions.Func1<? 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. 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:

predicate - the predicate function

Returns:

the new iterable

filterIndexed

public Ix<T> filterIndexed(rx.functions.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

first

public T first()

Returns the first element from the iterable sequence or throws a NoSuchElementException.

Returns:

the first element

flatMap

public <U> Ix<U> flatMap(rx.functions.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

forEach

public void forEach(rx.functions.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

groupBy

public <K> Ix<GroupedIterable<K,T>> groupBy(rx.functions.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

groupBy

public <K,V> Ix<GroupedIterable<K,V>> groupBy(rx.functions.Func1<? super T,? extends K> keySelector,
                                     rx.functions.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

into

public <U extends java.util.Collection<? super T>> U into(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

isEmpty

public Ix<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 Ix<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

map

public <U> Ix<U> map(rx.functions.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

mapIndexed

public <U> Ix<U> mapIndexed(rx.functions.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

materialize

public Ix<rx.Notification<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 <U extends java.lang.Comparable<? super U>> Ix<U> max()

Returns the maximum value of the given iterable source.

Type Parameters:

U - the self comparable type

Returns:

the new iterable

max

public Ix<T> max(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 <U extends java.lang.Comparable<? super U>> Ix<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.

Type Parameters:

U - the source element type, which must be self comparable

Returns:

the new iterable

maxBy

public Ix<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.

Parameters:

comparator - the key comparator

Returns:

the new iterable

mayBy

public <U extends java.lang.Comparable<? super U>> Ix<java.util.List<T>> mayBy(rx.functions.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 <U> Ix<java.util.List<T>> mayBy(rx.functions.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.

Type Parameters:

U - the key type

Parameters:

keySelector - the selector for keys

keyComparator - the key comparator

Returns:

the new iterable

memoize

public Ix<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 Ix<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 <U extends java.lang.Comparable<? super U>> Ix<U> min()

Returns the maximum value of the given iterable source.

Type Parameters:

U - the self comparable type

Returns:

the new iterable

min

public Ix<T> min(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 Ix<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.

Parameters:

comparator - the key comparator

Returns:

the new iterable

minBy

public <U extends java.lang.Comparable<? super U>> Ix<java.util.List<T>> minBy(rx.functions.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 <U> Ix<java.util.List<T>> minBy(rx.functions.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.

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 <U extends java.lang.Comparable<? super U>> Ix<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.

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

ofType

public <U> Ix<U> ofType(java.lang.Class<U> 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

orderBy

public <U extends java.lang.Comparable<? super U>> Ix<U> 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 Ix<T> orderBy(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 <U extends java.lang.Comparable<? super U>> Ix<T> orderBy(rx.functions.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 <U> Ix<T> orderBy(rx.functions.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. 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

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

prune

public <U> Ix<U> prune(rx.functions.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)).

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 <U> Ix<U> publish(rx.functions.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 <U> Ix<U> publish(rx.functions.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.

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

removeAll

public void removeAll()

Consumes the sequence and removes all items via the Iterator.remove().

replay

public <U> Ix<U> replay(rx.functions.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.

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 <U> Ix<U> replay(rx.functions.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.

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.

scan

public <U> Ix<U> scan(rx.functions.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 <U> Ix<U> scan(U seed,
             rx.functions.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

share

public Ix<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 Ix<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 Ix<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.

subsequent

public Ix<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

subsequent

public Ix<Ix<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

sumBigDecimal

public Ix<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

public Ix<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

public Ix<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

public Ix<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

public Ix<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

public Ix<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

public Ix<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

public Ix<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 Ix<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 Ix<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

public java.lang.Object[] toArray()

Returns an object array of all elements in this iterable.

Returns:

the object array

toArray

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

toHashMap

public <K> java.util.Map<K,T> toHashMap(rx.functions.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

toHashMultimap

public <K> java.util.Map<K,java.util.List<T>> toHashMultimap(rx.functions.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

toList

public java.util.List<T> toList()

Iterates over and returns all elements in a list.

Returns:

the list of the values from this iterable

toMap

public <K> java.util.Map<K,T> toMap(rx.functions.Func1<? super T,? extends K> keySelector,
                           rx.functions.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.

toMap

public <K,V> java.util.Map<K,V> toMap(rx.functions.Func1<? super T,? extends K> keySelector,
                             rx.functions.Func1<? super T,? extends V> valueSelector,
                             rx.functions.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.

toMultimap

public <K,V,C extends java.util.Collection<V>> java.util.Map<K,C> toMultimap(rx.functions.Func1<? super T,? extends K> keySelector,
                                                                    rx.functions.Func1<? super T,? extends V> valueSelector,
                                                                    rx.functions.Func0<? extends java.util.Map<K,C>> mapProvider,
                                                                    rx.functions.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

toObservable

public rx.Observable<T> toObservable()

Converts this iterable into an observable builder which uses the default scheduler of Observable to emit values.

Returns:

the observable builder

toObservable

public rx.Observable<T> toObservable(rx.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

zip

public <U,V> Ix<V> zip(java.lang.Iterable<? extends U> right,
              rx.functions.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