htsjdk.samtools.util

Class IntervalListWriter

java.lang.Object

htsjdk.samtools.util.IntervalListWriter

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class IntervalListWriter
extends java.lang.Object
implements java.io.Closeable

Writes out the list of intervals to the supplied file. This class is particularly useful if we have many intervals to write, such that they all cannot be held in memory, for example in an IntervalList.

Constructor Summary

Constructors

Constructor and Description
IntervalListWriter(java.nio.file.Path path) Creates a new writer, writing a header to the file.
IntervalListWriter(java.nio.file.Path path, SAMFileHeader header) Creates a new writer, writing a header to the file.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the writer.
void	write(Interval interval) Writes a single interval list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IntervalListWriter

public IntervalListWriter(java.nio.file.Path path)

Creates a new writer, writing a header to the file.

Parameters:

path - a path to write to. If exists it will be overwritten.

IntervalListWriter

public IntervalListWriter(java.nio.file.Path path,
                          SAMFileHeader header)

Creates a new writer, writing a header to the file.

Parameters:

path - a file to write to. If exists it will be overwritten.

header - the header to write.

Method Detail

write

public void write(Interval interval)
           throws java.io.IOException

Writes a single interval list.

Parameters:

interval - the interval to write.

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Closes the writer.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException