picard.util

Class AsyncIterator<T>

java.lang.Object

picard.util.AsyncIterator<T>

All Implemented Interfaces:

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

public class AsyncIterator<T>
extends java.lang.Object
implements htsjdk.samtools.util.CloseableIterator<T>

Wrapper around a CloseableIterator that reads in a separate thread, for cases in which that might be efficient.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_QUEUE_SIZE

Constructor Summary

Constructors

Constructor and Description
AsyncIterator(htsjdk.samtools.util.CloseableIterator<T> underlyingIterator, int queueSize, java.lang.String threadNamePrefix)

Method Summary

Modifier and Type	Method and Description
void	close() Stops the thread and then calls synchronouslyClose() to allow implementation to do any one time clean up.
boolean	hasNext()
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 htsjdk.samtools.util.CloseableIterator

stream, toList

Methods inherited from interface java.util.Iterator

forEachRemaining

Field Detail

DEFAULT_QUEUE_SIZE

public static final int DEFAULT_QUEUE_SIZE

See Also:

Constant Field Values

Constructor Detail

AsyncIterator

public AsyncIterator(htsjdk.samtools.util.CloseableIterator<T> underlyingIterator,
                     int queueSize,
                     java.lang.String threadNamePrefix)

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<T>

next

public T next()

Specified by:

next in interface java.util.Iterator<T>

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<T>

close

public void close()

Stops the thread and then calls synchronouslyClose() to allow implementation to do any one time clean up.

Specified by:

close in interface htsjdk.samtools.util.CloseableIterator<T>

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable