com.mattunderscore.iterators

Class JoinIterator.Builder<E>

java.lang.Object

com.mattunderscore.iterators.JoinIterator.Builder<E>

Type Parameters:

E - the type of elements returned by the iterator

Enclosing class:

JoinIterator<E>

@NotThreadSafe
public static final class JoinIterator.Builder<E>
extends Object

Builder for the iterator.

Method Summary

Modifier and Type	Method and Description
Iterator<E>	build()
JoinIterator.Builder<E>	estimatedSize(int estimatedSize) Set an estimated size for the number of iterators to join
JoinIterator.Builder<E>	join(Iterator<? extends E> iterator) Add another iterator.

Methods inherited from class java.lang.Object

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

Method Detail

estimatedSize

public JoinIterator.Builder<E> estimatedSize(int estimatedSize)

Set an estimated size for the number of iterators to join

Parameters:

estimatedSize - the number of iterators

Returns:

the builder

join

public JoinIterator.Builder<E> join(Iterator<? extends E> iterator)

Add another iterator.

Parameters:

iterator - the new iterator

Returns:

The builder

build

public Iterator<E> build()

Returns:

The joined iterator