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

Modifier and Type	Field and Description
private int	entryCount
private String	entryName
private RandomAccessInputStream	in
private ZipInputStream	zip

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

Methods

Modifier and Type	Method and Description
void	close() Closes this random access stream and releases any system resources associated with the stream.
int	getEntryCount() Returns the number of entries.
String	getEntryName() Get the name of the backing Zip entry.
private static IRandomAccess	getHandle(String file)
DataInputStream	getInputStream() Returns the DataInputStream corresponding to the backing Zip entry.
static boolean	isZipFile(String file) Returns true if the given filename is a Zip file.
private static RandomAccessInputStream	openStream(String file)
private void	populateLength()
protected void	resetStream() Close and reopen the stream; the stream pointer and mark should be reset to 0.
private void	seekToEntry()

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

Field Detail

in

private RandomAccessInputStream in

zip

private ZipInputStream zip

entryName

private String entryName

entryCount

private int entryCount

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.

Throws:

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

IOException

Method Detail

isZipFile

public static boolean isZipFile(String file)
                         throws IOException

Returns true if the given filename is a Zip file.

Throws:

IOException

getEntryName

public String getEntryName()

Get 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

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

seekToEntry

private void seekToEntry()
                  throws IOException

Throws:

IOException

populateLength

private void populateLength()
                     throws IOException

Throws:

IOException

getHandle

private static IRandomAccess getHandle(String file)
                                throws IOException

Throws:

IOException

openStream

private static RandomAccessInputStream openStream(String file)
                                           throws IOException

Throws:

IOException