edu.ucla.sspace.util

Class CombinedIterator<T>

java.lang.Object

edu.ucla.sspace.util.CombinedIterator<T>

All Implemented Interfaces:

Iterator<T>

public class CombinedIterator<T>
extends Object
implements Iterator<T>

An Iterator implemntation that combines multiple iterators into a single instance.

This class is thread-safe.

Author:

David Jurgens

Constructor Summary

Constructors

Constructor and Description
CombinedIterator(Collection<Iterator<T>> iterators) Constructs a CombinedIterator from all of the iterators in the provided collection.
CombinedIterator(Iterator<T>... iterators) Constructs a CombinedIterator from all of the provided iterators.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasNext() Returns true if there are still elements in at least one of the backing iterators.
static <T> Iterator<T>	join(Collection<Iterable<T>> iterables) Joins the iterators of all the provided iterables as one unified iterator.
T	next() Returns the next element from some iterator.
void	remove() Removes the previously returned element using the backing iterator's remove method.

Methods inherited from class java.lang.Object

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

Constructor Detail

CombinedIterator

public CombinedIterator(Iterator<T>... iterators)

Constructs a CombinedIterator from all of the provided iterators.

CombinedIterator

public CombinedIterator(Collection<Iterator<T>> iterators)

Constructs a CombinedIterator from all of the iterators in the provided collection.

Method Detail

join

public static <T> Iterator<T> join(Collection<Iterable<T>> iterables)

Joins the iterators of all the provided iterables as one unified iterator.

hasNext

public boolean hasNext()

Returns true if there are still elements in at least one of the backing iterators.

Specified by:

hasNext in interface Iterator<T>

next

public T next()

Returns the next element from some iterator.

Specified by:

next in interface Iterator<T>

remove

public void remove()

Removes the previously returned element using the backing iterator's remove method.

Specified by:

remove in interface Iterator<T>