htsjdk.tribble.readers

Class AsynchronousLineReader

java.lang.Object

htsjdk.tribble.readers.AsynchronousLineReader

All Implemented Interfaces:

LineReader, Closeable, AutoCloseable

public class AsynchronousLineReader
extends Object
implements LineReader

A LineReader implementation that delegates the work of reading and fetching lines to another thread. The thread terminates when it encounters EOF in the underlying reader, or when this LineReader is closed.

Author:

mccowan

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_NUMBER_LINES_BUFFER

Constructor Summary

Constructors

Constructor and Description
AsynchronousLineReader(Reader reader)
AsynchronousLineReader(Reader reader, int lineReadAheadSize)

Method Summary

Modifier and Type	Method and Description
void	close()
String	readLine()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NUMBER_LINES_BUFFER

public static final int DEFAULT_NUMBER_LINES_BUFFER

See Also:

Constant Field Values

Constructor Detail

AsynchronousLineReader

public AsynchronousLineReader(Reader reader,
                              int lineReadAheadSize)

AsynchronousLineReader

public AsynchronousLineReader(Reader reader)

Method Detail

readLine

public String readLine()

Specified by:

readLine in interface LineReader

Returns:

The next "line" from the source. Typically a line is a set of characters terminated by '\n', '\r', or '\r\n'. The line-terminator is not included

close

public void close()

Specified by:

close in interface LineReader

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable