loci.common

Class ZipHandle

java.lang.Object

loci.common.StreamHandle

loci.common.ZipHandle

All Implemented Interfaces:

DataInput, DataOutput, IRandomAccess

public class ZipHandle
extends StreamHandle

StreamHandle implementation for reading from Zip-compressed files or byte arrays. Instances of ZipHandle 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
ZipHandle(String file)
ZipHandle(String file, ZipEntry entry) Constructs a new ZipHandle corresponding to the given entry of the specified Zip file.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this random access stream and releases any system resources associated with the stream.
int	getEntryCount()
String	getEntryName()
DataInputStream	getInputStream()
static boolean	isZipFile(String 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

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

ZipHandle

public ZipHandle(String file)
          throws IOException

Throws:

IOException

ZipHandle

public ZipHandle(String file,
                 ZipEntry entry)
          throws IOException

Constructs a new ZipHandle corresponding to the given entry of the specified Zip file.

Parameters:

file - a name that can be passed to Location.getHandle(String, boolean, boolean)

entry - the specific entry in the Zip file to be opened

Throws:

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

IOException

See Also:

ZipEntry

Method Detail

isZipFile

public static boolean isZipFile(String file)
                         throws IOException

Parameters:

file - a name that can be passed to Location.getHandle(String, boolean, boolean)

Returns:

true if the given filename is a Zip file.

Throws:

IOException - if the file cannot be read

getEntryName

public String getEntryName()

Returns:

the name of the backing Zip entry.

getInputStream

public DataInputStream getInputStream()

Returns:

the DataInputStream corresponding to the backing Zip entry.

getEntryCount

public int getEntryCount()

Returns:

the number of entries.

close

public void close()
           throws IOException

Description copied from interface: IRandomAccess

Closes this random access stream and releases any system resources associated with the stream.

Specified by:

close in interface IRandomAccess

Overrides:

close in class StreamHandle

Throws:

IOException - if the underlying stream(s) could not be closed

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 - if the stream cannot be reset