cz.auderis.tools.collection.iterator

Class Iterators

java.lang.Object

cz.auderis.tools.collection.iterator.Iterators

public final class Iterators
extends Object

The type Iterators.

Version:

1.0

Author:

Boleslav Bobcik <bbobcik@gmail.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Iterators.EmptyIterator<T> The type Empty iterator.

Method Summary

Modifier and Type	Method and Description
static <T> Iterable<T>	asIterable(Iterator<? extends T> baseIter) As iterable.
static <T> Iterator<T>	emptyIterator() Empty iterator.
static <T> IndexedIteratorDecorator<T>	indexedIterable(Iterable<? extends T> baseSource) Indexed iterable.
static <T> IndexedIteratorDecorator<T>	indexedIterator(Iterator<? extends T> baseIter) Indexed iterator.
static <T> InterleavedIteratorDecorator<T>	interleavedIterable(Iterable<? extends T> baseSrc, Iterable<? extends T> interSrc) Interleaved iterable.
static <T> InterleavedIteratorDecorator<T>	interleavedIterable(Iterable<? extends T> baseSrc, T interValue) Interleaved iterable.
static <T> InterleavedIteratorDecorator<T>	interleavedIterator(Iterator<? extends T> baseIter, Iterator<? extends T> interIter) Interleaved iterator.
static <T> InterleavedIteratorDecorator<T>	interleavedIterator(Iterator<? extends T> base, T interValue) Interleaved iterator.
static <K,V> ParallelIteratorDecorator<K,V>	parallelIterable(Iterable<? extends K> keySource, Iterable<? extends V> valSource) Parallel iterable.
static <K,V> ParallelIteratorDecorator<K,V>	parallelIterator(Iterator<? extends K> keyIter, Iterator<? extends V> valIter) Parallel iterator.
static <T> PushbackIteratorDecorator<T>	pushbackIterable(Iterable<? extends T> baseSource) Pushback iterable.
static <T> PushbackIteratorDecorator<T>	pushbackIterator(Iterator<? extends T> baseIter) Pushback iterator.
static <T> SingleItemIterator<T>	singleItemIterator(T item) Single item iterator.

Methods inherited from class java.lang.Object

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

Method Detail

asIterable

public static <T> Iterable<T> asIterable(Iterator<? extends T> baseIter)

As iterable.

Type Parameters:

T - the type parameter

Parameters:

baseIter - the base iter

Returns:

the iterable

emptyIterator

public static <T> Iterator<T> emptyIterator()

Empty iterator.

Type Parameters:

T - the type parameter

Returns:

the iterator

singleItemIterator

public static <T> SingleItemIterator<T> singleItemIterator(T item)

Single item iterator.

Type Parameters:

T - the type parameter

Parameters:

item - the item

Returns:

the single item iterator

parallelIterator

public static <K,V> ParallelIteratorDecorator<K,V> parallelIterator(Iterator<? extends K> keyIter,
                                                                    Iterator<? extends V> valIter)

Parallel iterator.

Type Parameters:

K - the type parameter

V - the type parameter

Parameters:

keyIter - the key iter

valIter - the val iter

Returns:

the parallel iterator decorator

parallelIterable

public static <K,V> ParallelIteratorDecorator<K,V> parallelIterable(Iterable<? extends K> keySource,
                                                                    Iterable<? extends V> valSource)

Parallel iterable.

Type Parameters:

K - the type parameter

V - the type parameter

Parameters:

keySource - the key source

valSource - the val source

Returns:

the parallel iterator decorator

indexedIterator

public static <T> IndexedIteratorDecorator<T> indexedIterator(Iterator<? extends T> baseIter)

Indexed iterator.

Type Parameters:

T - the type parameter

Parameters:

baseIter - the base iter

Returns:

the indexed iterator decorator

indexedIterable

public static <T> IndexedIteratorDecorator<T> indexedIterable(Iterable<? extends T> baseSource)

Indexed iterable.

Type Parameters:

T - the type parameter

Parameters:

baseSource - the base source

Returns:

the indexed iterator decorator

pushbackIterator

public static <T> PushbackIteratorDecorator<T> pushbackIterator(Iterator<? extends T> baseIter)

Pushback iterator.

Type Parameters:

T - the type parameter

Parameters:

baseIter - the base iter

Returns:

the pushback iterator decorator

pushbackIterable

public static <T> PushbackIteratorDecorator<T> pushbackIterable(Iterable<? extends T> baseSource)

Pushback iterable.

Type Parameters:

T - the type parameter

Parameters:

baseSource - the base source

Returns:

the pushback iterator decorator

interleavedIterator

public static <T> InterleavedIteratorDecorator<T> interleavedIterator(Iterator<? extends T> baseIter,
                                                                      Iterator<? extends T> interIter)

Interleaved iterator.

Type Parameters:

T - the type parameter

Parameters:

baseIter - the base iter

interIter - the inter iter

Returns:

the interleaved iterator decorator

interleavedIterator

public static <T> InterleavedIteratorDecorator<T> interleavedIterator(Iterator<? extends T> base,
                                                                      T interValue)

Interleaved iterator.

Type Parameters:

T - the type parameter

Parameters:

base - the base

interValue - the inter value

Returns:

the interleaved iterator decorator

interleavedIterable

public static <T> InterleavedIteratorDecorator<T> interleavedIterable(Iterable<? extends T> baseSrc,
                                                                      Iterable<? extends T> interSrc)

Interleaved iterable.

Type Parameters:

T - the type parameter

Parameters:

baseSrc - the base src

interSrc - the inter src

Returns:

the interleaved iterator decorator

interleavedIterable

public static <T> InterleavedIteratorDecorator<T> interleavedIterable(Iterable<? extends T> baseSrc,
                                                                      T interValue)

Interleaved iterable.

Type Parameters:

T - the type parameter

Parameters:

baseSrc - the base src

interValue - the inter value

Returns:

the interleaved iterator decorator