BufferedLineReader (htsjdk 2.8.1 API)

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- htsjdk.samtools.util.BufferedLineReader

All Implemented Interfaces:

LineReader, Closeable, AutoCloseable
```
public class BufferedLineReader
extends 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(InputStream is)

BufferedLineReader(InputStream is, int bufferSize)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`int`	`getLineNumber()`
`int`	`peek()` Non-destructive one-character look-ahead.
`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(InputStream is)
```
  - BufferedLineReader
```
public BufferedLineReader(InputStream is,
                          int bufferSize)
```
- Method Detail
  - readLine
```
public 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 Closeable
    
    Specified by:
    
    close in interface AutoCloseable

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method