htsjdk.samtools.util

Interface LineReader

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

BufferedLineReader, StringLineReader

public interface LineReader
extends java.io.Closeable

Interface allows for implementations that read lines from a String, an ASCII file, or somewhere else.

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

Method Detail

readLine

java.lang.String readLine()

Read a line and remove the line terminator

Returns:

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

getLineNumber

int getLineNumber()

Returns:

1-based number of line most recently read

peek

int peek()

Non-destructive one-character look-ahead.

Returns:

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

close

void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable