ZipFile

java.lang.Object
- eve.zipfile.ZipFile

All Implemented Interfaces:

FileStore
```
public class ZipFile
extends Object
implements FileStore
```
This class represents a Zip archive. You can ask for the contained entries, or get an input stream for a file entry. The entry is automatically decompressed. This class is thread safe: You can open input streams for arbitrary entries in different threads.

Author:

Jochen Hoenicke, Artur Biesiadowski

Nested Class Summary
- Nested classes/interfaces inherited from interface eve.io.filestore.FileStore
  FileStore.Util

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CENATT`
`static int`	`CENATX`
`static int`	`CENCOM`
`static int`	`CENCRC`
`static int`	`CENDSK`
`static int`	`CENEXT`
`static int`	`CENFLG`
`static int`	`CENHDR`
`static int`	`CENHOW`
`static int`	`CENLEN`
`static int`	`CENNAM`
`static int`	`CENOFF`
`static int`	`CENSIG`
`static int`	`CENSIZ`
`static int`	`CENTIM`
`static int`	`CENVEM`
`static int`	`CENVER`
`static int`	`ENDCOM`
`static int`	`ENDDCD`
`static int`	`ENDHDR`
`static int`	`ENDNRD`
`static int`	`ENDOFF`
`static int`	`ENDSIG`
`static int`	`ENDSIZ`
`static int`	`ENDSUB`
`static int`	`ENDTOT`
`static int`	`EXTCRC`
`static int`	`EXTHDR`
`static int`	`EXTLEN`
`static int`	`EXTSIG`
`static int`	`EXTSIZ`
`static int`	`LOCCRC`
`static int`	`LOCEXT`
`static int`	`LOCFLG`
`static int`	`LOCHDR`
`static int`	`LOCHOW`
`static int`	`LOCLEN`
`static int`	`LOCNAM`
`static int`	`LOCSIG`
`static int`	`LOCSIZ`
`static int`	`LOCTIM`
`static int`	`LOCVER`
`static int`	`OPEN_DELETE` Mode flag to delete a zip file after reading.
`static int`	`OPEN_READ` Mode flag to open a zip file for reading.

Constructor Summary

Constructors
Constructor and Description
`ZipFile(File file)` Opens a Zip file reading the given File.
`ZipFile(File file)` Opens a Zip file reading the given File.
`ZipFile(RandomStream rs)` Opens a Zip file reading the given File in the given mode.
`ZipFile(RandomStream rs, String name)`
`ZipFile(RandomStream stream, String name, Handle h)` This should only be called from a Coroutine if the handle is not null.
`ZipFile(String name)` Opens a Zip file with the given name for reading.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addToZippedMemoryFile(Object zipFile, String name, Object data)`
`void`	`close()` Closes the ZipFile.
`static ZipFile`	`completeZippedMemoryFile(Object zipFile)`
`static Object`	`createZippedMemoryFile()` This is useful for creating a zipped file in memory without needing to know how to use the ZipFile API.
`Enumeration`	`entries()` Returns an enumeration of all Zip entries in this Zip file.
`protected void`	`finalize()` Calls the `close()` method when this ZipFile has not yet been explicitly closed.
`FileStoreEntry`	`findEntry(String name)`
`ZipEntry`	`getEntry(String name)` Searches for a zip entry in this archive with the given name.
`int`	`getEntryCount()` If the count is known then return the number of entries, otherwise return -1.
`FileStoreEntryFile`	`getFileSystem(Handle h)`
`InputStream`	`getInputStream(ZipEntry entry)` Creates an input stream reading the given zip entry as uncompressed data.
`String`	`getName()` Returns the name of this zip file.
`FileStoreEntry`	`getNewEntry(String forName)`
`Enumeration`	`getStoreEntries()` Get an enumeration to go through the entries in the file.
`Hashtable`	`getStoreHashtable()` Expose the hashtable of entries if available.
`String`	`getStoreName()`
`String`	`getZipName()`
`InputStream`	`openInputStream(FileStoreEntry entry)`
`int`	`size()` Returns the number of entries in this zip file.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - OPEN_READ
```
public static final int OPEN_READ
```
    Mode flag to open a zip file for reading.
    
    See Also:
    
    Constant Field Values
  - OPEN_DELETE
```
public static final int OPEN_DELETE
```
    Mode flag to delete a zip file after reading.
    
    See Also:
    
    Constant Field Values
  - LOCHDR
```
public static final int LOCHDR
```
    See Also:
    
    Constant Field Values
  - LOCSIG
```
public static final int LOCSIG
```
    See Also:
    
    Constant Field Values
  - LOCVER
```
public static final int LOCVER
```
    See Also:
    
    Constant Field Values
  - LOCFLG
```
public static final int LOCFLG
```
    See Also:
    
    Constant Field Values
  - LOCHOW
```
public static final int LOCHOW
```
    See Also:
    
    Constant Field Values
  - LOCTIM
```
public static final int LOCTIM
```
    See Also:
    
    Constant Field Values
  - LOCCRC
```
public static final int LOCCRC
```
    See Also:
    
    Constant Field Values
  - LOCSIZ
```
public static final int LOCSIZ
```
    See Also:
    
    Constant Field Values
  - LOCLEN
```
public static final int LOCLEN
```
    See Also:
    
    Constant Field Values
  - LOCNAM
```
public static final int LOCNAM
```
    See Also:
    
    Constant Field Values
  - LOCEXT
```
public static final int LOCEXT
```
    See Also:
    
    Constant Field Values
  - EXTSIG
```
public static final int EXTSIG
```
    See Also:
    
    Constant Field Values
  - EXTHDR
```
public static final int EXTHDR
```
    See Also:
    
    Constant Field Values
  - EXTCRC
```
public static final int EXTCRC
```
    See Also:
    
    Constant Field Values
  - EXTSIZ
```
public static final int EXTSIZ
```
    See Also:
    
    Constant Field Values
  - EXTLEN
```
public static final int EXTLEN
```
    See Also:
    
    Constant Field Values
  - CENSIG
```
public static final int CENSIG
```
    See Also:
    
    Constant Field Values
  - CENHDR
```
public static final int CENHDR
```
    See Also:
    
    Constant Field Values
  - CENVEM
```
public static final int CENVEM
```
    See Also:
    
    Constant Field Values
  - CENVER
```
public static final int CENVER
```
    See Also:
    
    Constant Field Values
  - CENFLG
```
public static final int CENFLG
```
    See Also:
    
    Constant Field Values
  - CENHOW
```
public static final int CENHOW
```
    See Also:
    
    Constant Field Values
  - CENTIM
```
public static final int CENTIM
```
    See Also:
    
    Constant Field Values
  - CENCRC
```
public static final int CENCRC
```
    See Also:
    
    Constant Field Values
  - CENSIZ
```
public static final int CENSIZ
```
    See Also:
    
    Constant Field Values
  - CENLEN
```
public static final int CENLEN
```
    See Also:
    
    Constant Field Values
  - CENNAM
```
public static final int CENNAM
```
    See Also:
    
    Constant Field Values
  - CENEXT
```
public static final int CENEXT
```
    See Also:
    
    Constant Field Values
  - CENCOM
```
public static final int CENCOM
```
    See Also:
    
    Constant Field Values
  - CENDSK
```
public static final int CENDSK
```
    See Also:
    
    Constant Field Values
  - CENATT
```
public static final int CENATT
```
    See Also:
    
    Constant Field Values
  - CENATX
```
public static final int CENATX
```
    See Also:
    
    Constant Field Values
  - CENOFF
```
public static final int CENOFF
```
    See Also:
    
    Constant Field Values
  - ENDSIG
```
public static final int ENDSIG
```
    See Also:
    
    Constant Field Values
  - ENDHDR
```
public static final int ENDHDR
```
    See Also:
    
    Constant Field Values
  - ENDNRD
```
public static final int ENDNRD
```
    See Also:
    
    Constant Field Values
  - ENDDCD
```
public static final int ENDDCD
```
    See Also:
    
    Constant Field Values
  - ENDSUB
```
public static final int ENDSUB
```
    See Also:
    
    Constant Field Values
  - ENDTOT
```
public static final int ENDTOT
```
    See Also:
    
    Constant Field Values
  - ENDSIZ
```
public static final int ENDSIZ
```
    See Also:
    
    Constant Field Values
  - ENDOFF
```
public static final int ENDOFF
```
    See Also:
    
    Constant Field Values
  - ENDCOM
```
public static final int ENDCOM
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ZipFile
```
public ZipFile(String name)
        throws ZipException,
               IOException
```
    Opens a Zip file with the given name for reading.
    
    Throws:
    
    IOException - if a i/o error occured.
    
    ZipException - if the file doesn't contain a valid zip archive.
  - ZipFile
```
public ZipFile(File file)
        throws ZipException,
               IOException
```
    Opens a Zip file reading the given File.
    
    Throws:
    
    IOException - if a i/o error occured.
    
    ZipException - if the file doesn't contain a valid zip archive.
  - ZipFile
```
public ZipFile(File file)
        throws ZipException,
               IOException
```
    Opens a Zip file reading the given File.
    
    Throws:
    
    IOException - if a i/o error occured.
    
    ZipException - if the file doesn't contain a valid zip archive.
  - ZipFile
```
public ZipFile(RandomStream rs)
        throws ZipException,
               IOException
```
    Opens a Zip file reading the given File in the given mode. If the OPEN_DELETE mode is specified, the zip file will be deleted at some time moment after it is opened. It will be deleted before the zip file is closed or the Virtual Machine exits. The contents of the zip file will be accessible until it is closed. The OPEN_DELETE mode is currently unimplemented in this library
    
    Parameters:
    
    mode - Must be one of OPEN_READ or OPEN_READ | OPEN_DELETE
    
    Throws:
    
    IOException - if a i/o error occured.
    
    ZipException - if the file doesn't contain a valid zip archive.
    
    Since:
    
    JDK1.3
  - ZipFile
```
public ZipFile(RandomStream rs,
               String name)
        throws ZipException,
               IOException
```
    Throws:
    
    ZipException
    
    IOException
  - ZipFile
```
public ZipFile(RandomStream stream,
               String name,
               Handle h)
        throws ZipException,
               IOException
```
    This should only be called from a Coroutine if the handle is not null. It does not return until the zip file is fully opened unless the stop() method is called on the handle.
    
    Throws:
    
    ZipException
    
    IOException
- Method Detail
  - getEntryCount
```
public int getEntryCount()
```
    Description copied from interface: FileStore
    
    If the count is known then return the number of entries, otherwise return -1.
    
    Specified by:
    
    getEntryCount in interface FileStore
    
    Returns:
    
    the number of entries or -1 if not known.
  - getZipName
```
public String getZipName()
```
  - close
```
public void close()
           throws IOException
```
    Closes the ZipFile. This also closes all input streams given by this class. After this is called, no further method should be called.
    
    Specified by:
    
    close in interface FileStore
    
    Throws:
    
    IOException - if a i/o error occured.
  - finalize
```
protected void finalize()
                 throws IOException
```
    Calls the close() method when this ZipFile has not yet been explicitly closed.
    
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    IOException
  - entries
```
public Enumeration entries()
```
    Returns an enumeration of all Zip entries in this Zip file.
  - getEntry
```
public ZipEntry getEntry(String name)
```
    Searches for a zip entry in this archive with the given name.
    
    Parameters:
    
    the - name. May contain directory components separated by slashes ('/').
    
    Returns:
    
    the zip entry, or null if no entry with that name exists.
  - findEntry
```
public FileStoreEntry findEntry(String name)
```
    Specified by:
    
    findEntry in interface FileStore
  - openInputStream
```
public InputStream openInputStream(FileStoreEntry entry)
                            throws IOException
```
    Specified by:
    
    openInputStream in interface FileStore
    
    Throws:
    
    IOException
  - getInputStream
```
public InputStream getInputStream(ZipEntry entry)
                           throws IOException
```
    Creates an input stream reading the given zip entry as uncompressed data. Normally zip entry should be an entry returned by getEntry() or entries().
    
    Parameters:
    
    entry - the entry to create an InputStream for.
    
    Returns:
    
    the input stream.
    
    Throws:
    
    IOException - if a i/o error occured.
    
    ZipException - if the Zip archive is malformed.
  - getName
```
public String getName()
```
    Returns the name of this zip file.
  - size
```
public int size()
```
    Returns the number of entries in this zip file.
  - getStoreEntries
```
public Enumeration getStoreEntries()
                            throws IOException
```
    Description copied from interface: FileStore
    
    Get an enumeration to go through the entries in the file. Each entry provided is a FileStoreEntry.
    
    Specified by:
    
    getStoreEntries in interface FileStore
    
    Throws:
    
    IOException
  - getStoreHashtable
```
public Hashtable getStoreHashtable()
                            throws IOException
```
    Description copied from interface: FileStore
    
    Expose the hashtable of entries if available. The hashtable should consist of a set of FileStoreEntry objects each one stored with a key that is equal to the name of the entry.
    
    Specified by:
    
    getStoreHashtable in interface FileStore
    
    Returns:
    
    the hashtable of entries if available, or null if not available.
    
    Throws:
    
    IOException
  - getNewEntry
```
public FileStoreEntry getNewEntry(String forName)
```
    Specified by:
    
    getNewEntry in interface FileStore
  - getStoreName
```
public String getStoreName()
```
    Specified by:
    
    getStoreName in interface FileStore
  - getFileSystem
```
public FileStoreEntryFile getFileSystem(Handle h)
```
    Specified by:
    
    getFileSystem in interface FileStore
  - createZippedMemoryFile
```
public static Object createZippedMemoryFile()
```
    This is useful for creating a zipped file in memory without needing to know how to use the ZipFile API. Call this method first and then call addToZippedMemoryFile() for each item to add. Then, when complete, call one of the completeZippedMemoryFile() methods to save or open the ZipFile.
    
    Returns:
    
    an Object that you should use with addToZippedMemoryFile() and completeZippedMemoryFile().
  - addToZippedMemoryFile
```
public static void addToZippedMemoryFile(Object zipFile,
                                         String name,
                                         Object data)
                                  throws IOException
```
    Throws:
    
    IOException
  - completeZippedMemoryFile
```
public static ZipFile completeZippedMemoryFile(Object zipFile)
                                        throws IOException
```
    Throws:
    
    IOException

Class ZipFile

Nested Class Summary

Nested classes/interfaces inherited from interface eve.io.filestore.FileStore

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OPEN_READ

OPEN_DELETE

LOCHDR

LOCSIG

LOCVER

LOCFLG

LOCHOW

LOCTIM

LOCCRC

LOCSIZ

LOCLEN

LOCNAM

LOCEXT

EXTSIG

EXTHDR

EXTCRC

EXTSIZ

EXTLEN

CENSIG

CENHDR

CENVEM

CENVER

CENFLG

CENHOW

CENTIM

CENCRC

CENSIZ

CENLEN

CENNAM

CENEXT

CENCOM

CENDSK

CENATT

CENATX

CENOFF

ENDSIG

ENDHDR

ENDNRD

ENDDCD

ENDSUB

ENDTOT

ENDSIZ

ENDOFF

ENDCOM

Constructor Detail

ZipFile

ZipFile

ZipFile

ZipFile

ZipFile

ZipFile

Method Detail

getEntryCount

getZipName

close

finalize

entries

getEntry

findEntry

openInputStream

getInputStream

getName

size

getStoreEntries

getStoreHashtable

getNewEntry

getStoreName

getFileSystem

createZippedMemoryFile

addToZippedMemoryFile

completeZippedMemoryFile