AsciiLineReader (htsjdk 2.8.1 API)

java.lang.Object
- htsjdk.tribble.readers.AsciiLineReader

All Implemented Interfaces:

LocationAware, LineReader, Closeable, AutoCloseable
```
public class AsciiLineReader
extends Object
implements LineReader, LocationAware
```
A simple class that provides readLine() functionality around a PositionalBufferedStream BufferedReader and its BufferedReader.readLine() method should be used in preference to this class (when the LocationAware functionality is not required) because it offers greater performance.

Constructor Summary

Constructors
Constructor and Description

AsciiLineReader(InputStream is)

AsciiLineReader(PositionalBufferedStream is)

Constructors
Constructor and Description
`AsciiLineReader(InputStream is)`
`AsciiLineReader(PositionalBufferedStream is)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`long`	`getPosition()` The current offset, in bytes, of this stream/writer/file.
`static void`	`main(String[] args)`
`String`	`readLine()` Same as `readLine(PositionalBufferedStream)` but uses the stream provided in the constructor
`String`	`readLine(PositionalBufferedStream stream)` Read a line of text.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AsciiLineReader
```
public AsciiLineReader(InputStream is)
```
  - AsciiLineReader
```
public AsciiLineReader(PositionalBufferedStream is)
```
- Method Detail
  - getPosition
```
public long getPosition()
```
    Description copied from interface: LocationAware
    
    The current offset, in bytes, of this stream/writer/file. Or, if this is an iterator/producer, the offset (in bytes) of the END of the most recently returned record (since a produced record corresponds to something that has been read already). See class javadoc for more. Note that for BGZF files, this does not represent an actually file position, but a virtual file pointer.
    
    Specified by:
    
    getPosition in interface LocationAware
    
    Returns:
    
    The position of the InputStream
  - readLine
```
public final String readLine(PositionalBufferedStream stream)
                      throws IOException
```
    Read a line of text. A line is considered to be terminated by any one of a line feed ('\n'), a carriage return ('\r'), or a carriage return followed immediately by a linefeed.
    
    Parameters:
    
    stream - the stream to read the next line from
    
    Returns:
    
    A String containing the contents of the line or null if the end of the stream has been reached
    
    Throws:
    
    IOException
  - readLine
```
public final String readLine()
                      throws IOException
```
    Same as readLine(PositionalBufferedStream) but uses the stream provided in the constructor
    
    Specified by:
    
    readLine in interface LineReader
    
    Returns:
    
    Throws:
    
    IOException
  - close
```
public void close()
```
    Specified by:
    
    close in interface LineReader
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
  - main
```
public static void main(String[] args)
                 throws Exception
```
    Throws:
    
    Exception

Class AsciiLineReader

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AsciiLineReader

AsciiLineReader

Method Detail

getPosition

readLine

readLine

close

main