htsjdk.samtools.util

Class BufferedLineReader

java.lang.Object

htsjdk.samtools.util.BufferedLineReader

All Implemented Interfaces:

LineReader, java.io.Closeable, java.lang.AutoCloseable

public class BufferedLineReader
extends java.lang.Object
implements LineReader

Implementation of LineReader that is a thin wrapper around BufferedReader. On Linux, this is faster than AsciiLineReaderImpl. If you use AsciiLineReader rather than this class, it will detect the OS and delegate to the preferred implementation. TODO: Replace this with LineNumberReader?

Constructor Summary

Constructors

Constructor and Description
BufferedLineReader(java.io.InputStream is)
BufferedLineReader(java.io.InputStream is, int bufferSize)

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
int	getLineNumber()
int	peek() Non-destructive one-character look-ahead.
java.lang.String	readLine() Read a line and remove the line terminator

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferedLineReader

public BufferedLineReader(java.io.InputStream is)

BufferedLineReader

public BufferedLineReader(java.io.InputStream is,
                  int bufferSize)

Method Detail

readLine

public java.lang.String readLine()

Read a line and remove the line terminator

Specified by:

readLine in interface LineReader

Returns:

the line read, or null if EOF has been reached.

getLineNumber

public int getLineNumber()

Specified by:

getLineNumber in interface LineReader

Returns:

1-based number of line most recently read

peek

public int peek()

Non-destructive one-character look-ahead.

Specified by:

peek in interface LineReader

Returns:

If not eof, the next character that would be read. If eof, -1.

close

public void close()

Specified by:

close in interface LineReader

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable