htsjdk.samtools.util

Class GZIIndex.GZIIndexer

java.lang.Object

htsjdk.samtools.util.GZIIndex.GZIIndexer

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Enclosing class:

GZIIndex

public static final class GZIIndex.GZIIndexer
extends java.lang.Object
implements java.io.Closeable

Helper class for constructing the GZIindex. In order to construct a GZI index addGzipBlock() should be called every time a new Gzip Block is written out and the entire index will be written out when close() is called.

Constructor Summary

Constructors

Constructor and Description
GZIIndexer(java.io.OutputStream outputStream)
GZIIndexer(java.nio.file.Path outputFile)

Method Summary

Modifier and Type	Method and Description
void	addGzipBlock(long compressedFileOffset, long uncompressedBlockSize)
void	close()

Methods inherited from class java.lang.Object

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

Constructor Detail

GZIIndexer

public GZIIndexer(java.io.OutputStream outputStream)

GZIIndexer

public GZIIndexer(java.nio.file.Path outputFile)
           throws java.io.IOException

Throws:

java.io.IOException

Method Detail

addGzipBlock

public void addGzipBlock(long compressedFileOffset,
                         long uncompressedBlockSize)

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException