SAMFileWriter (htsjdk 2.14.3 API)

Skip navigation links

All Classes

SEARCH:

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

CRAMFileWriter, SAMFileWriterImpl, SAMTextWriter
```
public interface SAMFileWriter
extends Closeable
```
Interface for SAMText and BAM file writers. Clients need not care which they write to, once the object is constructed.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addAlignment(SAMRecord alignment)`
`void`	`close()`	Must be called to flush or file will likely be defective.
`SAMFileHeader`	`getFileHeader()`
`void`	`setProgressLogger(ProgressLoggerInterface progress)`	Sets a ProgressLogger on this writer.

- Method Detail
  - addAlignment
```
void addAlignment(SAMRecord alignment)
```
  - getFileHeader
```
SAMFileHeader getFileHeader()
```
  - setProgressLogger
```
void setProgressLogger(ProgressLoggerInterface progress)
```
    Sets a ProgressLogger on this writer. This is useful when pulling, for instance, from a SortingCollection.
  - close
```
void close()
```
    Must be called to flush or file will likely be defective.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method