htsjdk.samtools.util

Class MergingIterator<T>

java.lang.Object

htsjdk.samtools.util.MergingIterator<T>

All Implemented Interfaces:

CloseableIterator<T>, java.io.Closeable, java.lang.AutoCloseable, java.util.Iterator<T>

public class MergingIterator<T>
extends java.lang.Object
implements CloseableIterator<T>

An iterator over Iterators that return Ts. Calling next() returns the next T ordered according to Comparator provided at construction time. Importantly, the elements in the input Iterators must already be sorted according to the provided Comparator.

Constructor Summary

Constructors

Constructor and Description
MergingIterator(java.util.Comparator<T> comparator, java.util.Collection<CloseableIterator<T>> iterators) Creates a MergingIterator over the given Collection of iterators whose elements will be returned in the order defined by the given Comparator.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes every CloseableIterator in this MergingIterator.
boolean	hasNext()
T	next()
void	remove() Unsupported.

Methods inherited from class java.lang.Object

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

Constructor Detail

MergingIterator

public MergingIterator(java.util.Comparator<T> comparator,
               java.util.Collection<CloseableIterator<T>> iterators)

Creates a MergingIterator over the given Collection of iterators whose elements will be returned in the order defined by the given Comparator.

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<T>

See Also:

java.util.Iterator.hasNext

next

public T next()

Specified by:

next in interface java.util.Iterator<T>

See Also:

java.util.Iterator.next

remove

public void remove()

Unsupported.

Specified by:

remove in interface java.util.Iterator<T>

close

public void close()

Closes every CloseableIterator in this MergingIterator. After calling, calls to hasNext() will always return false.

Specified by:

close in interface CloseableIterator<T>

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable