cz.auderis.tools.collection.iterator

Class InterleavedIteratorDecorator<T>

java.lang.Object

cz.auderis.tools.collection.iterator.InterleavedIteratorDecorator<T>

Type Parameters:

T - common type of iterated elements

All Implemented Interfaces:

Iterable<T>, Iterator<T>

public class InterleavedIteratorDecorator<T>
extends Object
implements Iterator<T>, Iterable<T>

Decorator that mixes elements from a decorated iterator with another items. The mixed items may come either from another iterator or be a constant.

Example: Given that the base iterator I would yield items a,b,c,d and iterator J would yield items 1,2,3, the interleaved iterator of I,J will yield sequence a,1,b,2,c,3,d.

Version:

1.0

Author:

Boleslav Bobcik <bbobcik@gmail.com>

Constructor Summary

Constructors

Constructor and Description
InterleavedIteratorDecorator(Iterator<? extends T> baseIter, Iterator<? extends T> interIter) Instantiates a new Interleaved iterator decorator.
InterleavedIteratorDecorator(Iterator<? extends T> baseIter, Iterator<? extends T> interIter, T remainingValue) Instantiates a new Interleaved iterator decorator.
InterleavedIteratorDecorator(Iterator<? extends T> baseIter, T interVal) Instantiates a new Interleaved iterator decorator.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext()
boolean	isBetween() Is between.
Iterator<T>	iterator()
T	next()
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

InterleavedIteratorDecorator

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

Instantiates a new Interleaved iterator decorator.

Parameters:

baseIter - the base iter

interIter - the inter iter

remainingValue - the remaining value

InterleavedIteratorDecorator

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

Instantiates a new Interleaved iterator decorator.

Parameters:

baseIter - the base iter

interIter - the inter iter

InterleavedIteratorDecorator

public InterleavedIteratorDecorator(Iterator<? extends T> baseIter,
                                    T interVal)

Instantiates a new Interleaved iterator decorator.

Parameters:

baseIter - the base iter

interVal - the inter val

Method Detail

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<T>

next

public T next()

Specified by:

next in interface Iterator<T>

remove

public void remove()

Specified by:

remove in interface Iterator<T>

isBetween

public boolean isBetween()

Is between.

Returns:

the boolean