StringLineReader (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.StringLineReader

All Implemented Interfaces:

LineReader, Closeable, AutoCloseable
```
public class StringLineReader
extends Object
implements LineReader
```
Implementation of LineReader that gets its input from a String. No charset conversion is necessary because the String is in unicode. Handles CR, LF or CRLF line termination, but if asked to return the line terminator, it always comes back as LF.

Constructor Summary

Constructors
Constructor and Description

StringLineReader(String s)

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
  - StringLineReader
```
public StringLineReader(String s)
```
- 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