loci.common

Class BZip2Handle

java.lang.Object

loci.common.StreamHandle

loci.common.BZip2Handle

All Implemented Interfaces:

DataInput, DataOutput, IRandomAccess

public class BZip2Handle
extends StreamHandle

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

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
BZip2Handle(String file) Construct a new BZip2Handle corresponding to the given file.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	isBZip2File(String file) Returns true if the given filename is a BZip2 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

BZip2Handle

public BZip2Handle(String file)
            throws IOException

Construct a new BZip2Handle corresponding to the given file.

Throws:

HandleException - if the given file is not a BZip2 file.

IOException

Method Detail

isBZip2File

public static boolean isBZip2File(String file)
                           throws IOException

Returns true if the given filename is a BZip2 file.

Throws:

IOException

resetStream

protected void resetStream()
                    throws 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:

IOException