loci.common

Class GZipHandle

java.lang.Object

loci.common.StreamHandle

loci.common.GZipHandle

All Implemented Interfaces:

java.io.DataInput, java.io.DataOutput, IRandomAccess

public class GZipHandle
extends StreamHandle

StreamHandle implementation for reading from gzip-compressed files or byte arrays. Instances of GZipHandle are read-only.

Source code:

Trac, Gitweb

Author:

Melissa Linkert melissa at glencoesoftware.com

See Also:

StreamHandle

Field Summary

Fields inherited from class loci.common.StreamHandle

file, fp, length, mark, order, outStream, stream

Constructor Summary

Constructors

Constructor and Description
GZipHandle(java.lang.String file) Construct a new GZipHandle for the given file.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	isGZipFile(java.lang.String file) Returns true if the given filename is a gzip file.
protected void	resetStream() Close and reopen the stream; the stream pointer and mark should be reset to 0.

Methods inherited from class loci.common.StreamHandle

close, getFilePointer, getOrder, length, read, read, read, read, readBoolean, readByte, readChar, readDouble, readFloat, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedShort, readUTF, seek, setOrder, skipBytes, write, write, write, write, write, writeBoolean, writeByte, writeBytes, writeChar, writeChars, writeDouble, writeFloat, writeInt, writeLong, writeShort, writeUTF

Methods inherited from class java.lang.Object

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

Constructor Detail

GZipHandle

public GZipHandle(java.lang.String file)
           throws java.io.IOException

Construct a new GZipHandle for the given file.

Throws:

HandleException - if the given file name is not a GZip file.

java.io.IOException

Method Detail

isGZipFile

public static boolean isGZipFile(java.lang.String file)
                          throws java.io.IOException

Returns true if the given filename is a gzip file.

Throws:

java.io.IOException

resetStream

protected void resetStream()
                    throws java.io.IOException

Description copied from class: StreamHandle

Close and reopen the stream; the stream pointer and mark should be reset to 0. This method is called if we need to seek backwards within the stream.

Specified by:

resetStream in class StreamHandle

Throws:

java.io.IOException