| java.lang.Object
 org.apache.tools.zip.ZipFile
| ZipFile | | public class ZipFile (Code) | | Replacement for java.util.ZipFile.
This class adds support for file name encodings other than UTF-8
(which is required to work on ZIP files created by native zip tools
and is able to skip a preamble like the one found in self
extracting archives. Furthermore it returns instances of
org.apache.tools.zip.ZipEntry instead of
java.util.zip.ZipEntry.
It doesn't extend java.util.zip.ZipFile as it would
have to reimplement all methods anyway. Like
java.util.ZipFile, it uses RandomAccessFile under the
covers and supports compressed and uncompressed entries.
The method signatures mimic the ones of
java.util.zip.ZipFile, with a couple of exceptions:
- There is no getName method.
- entries has been renamed to getEntries.
- getEntries and getEntry return
org.apache.tools.zip.ZipEntry instances.
- close is allowed to throw IOException.
|
| Constructor Summary | |
| public | ZipFile(File f)
Opens the given file for reading, assuming the platform's
native encoding for file names. | | public | ZipFile(String name)
Opens the given file for reading, assuming the platform's
native encoding for file names. | | public | ZipFile(String name, String encoding)
Opens the given file for reading, assuming the specified
encoding for file names. | | public | ZipFile(File f, String encoding)
Opens the given file for reading, assuming the specified
encoding for file names. |
| Method Summary | |
| public void | close()
Closes the archive. | | public static void | closeQuietly(ZipFile zipfile)
| | protected static Date | fromDosTime(ZipLong zipDosTime)
Convert a DOS date/time field to a Date object.
Parameters:
zipDosTime - contains the stored DOS time. | | public String | getEncoding()
The encoding to use for filenames and the file comment. | | public Enumeration | getEntries()
Returns all entries. | | public ZipEntry | getEntry(String name)
Returns a named entry - or null if no entry by
that name exists.
Parameters:
name - name of the entry. | | public InputStream | getInputStream(ZipEntry ze)
Returns an InputStream for reading the contents of the given entry.
Parameters:
ze - the entry to get the stream for. | | protected String | getString(byte[] bytes)
Retrieve a String from the given bytes using the encoding set
for this ZipFile. |
| ZipFile | | public ZipFile(File f) throws IOException(Code) | | Opens the given file for reading, assuming the platform's
native encoding for file names.
Parameters:
f - the archive.
throws:
IOException - if an error occurs while reading the file. |
| ZipFile | | public ZipFile(String name) throws IOException(Code) | | Opens the given file for reading, assuming the platform's
native encoding for file names.
Parameters:
name - name of the archive.
throws:
IOException - if an error occurs while reading the file. |
| ZipFile | | public ZipFile(String name, String encoding) throws IOException(Code) | | Opens the given file for reading, assuming the specified
encoding for file names.
Parameters:
name - name of the archive.
Parameters:
encoding - the encoding to use for file names
throws:
IOException - if an error occurs while reading the file. |
| ZipFile | | public ZipFile(File f, String encoding) throws IOException(Code) | | Opens the given file for reading, assuming the specified
encoding for file names.
Parameters:
f - the archive.
Parameters:
encoding - the encoding to use for file names
throws:
IOException - if an error occurs while reading the file. |
| closeQuietly | | public static void closeQuietly(ZipFile zipfile)(Code) | | close a zipfile quietly; throw no io fault, do nothing
on a null parameter
Parameters:
zipfile - file to close, can be null |
| fromDosTime | | protected static Date fromDosTime(ZipLong zipDosTime)(Code) | | Convert a DOS date/time field to a Date object.
Parameters:
zipDosTime - contains the stored DOS time. a Date instance corresponding to the given time. |
| getEncoding | | public String getEncoding()(Code) | | The encoding to use for filenames and the file comment.
null if using the platform's default character encoding. |
| getEntry | | public ZipEntry getEntry(String name)(Code) | | Returns a named entry - or null if no entry by
that name exists.
Parameters:
name - name of the entry. the ZipEntry corresponding to the given name - ornull if not present. |
| getInputStream | | public InputStream getInputStream(ZipEntry ze) throws IOException, ZipException(Code) | | Returns an InputStream for reading the contents of the given entry.
Parameters:
ze - the entry to get the stream for. a stream to read the entry from.
throws:
IOException - if unable to create an input stream from the zipenty
throws:
ZipException - if the zipentry has an unsupported compression method |
| getString | | protected String getString(byte[] bytes) throws ZipException(Code) | | Retrieve a String from the given bytes using the encoding set
for this ZipFile.
Parameters:
bytes - the byte array to transform String obtained by using the given encoding
throws:
ZipException - if the encoding cannot be recognized. |
|
|