|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.plexus.archiver.zip.ZipFile
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:
org.apache.tools.zip.ZipEntry
instances.
Nested Class Summary | |
private class |
ZipFile.BoundedInputStream
InputStream that delegates requests to the underlying RandomAccessFile, making sure that only bytes from a certain range can be read. |
Field Summary | |
private java.io.RandomAccessFile |
archive
The actual data source. |
private static int |
CFD_LOCATOR_OFFSET
|
private static int |
CFH_LEN
|
private java.util.Hashtable |
dataOffsets
Maps ZipEntrys to Longs, recording the offsets of the actual file data. |
private java.lang.String |
encoding
The encoding to use for filenames and the file comment. |
private java.util.Hashtable |
entries
Maps ZipEntrys to Longs, recording the offsets of the local file headers. |
private static long |
LFH_OFFSET_FOR_FILENAME_LENGTH
Number of bytes in local file header up to the "length of filename" entry. |
private static int |
MIN_EOCD_SIZE
|
private java.util.Hashtable |
nameMap
Maps String to ZipEntrys, name -> actual entry. |
Constructor Summary | |
ZipFile(java.io.File f)
Opens the given file for reading, assuming the platform's native encoding for file names. |
|
ZipFile(java.io.File f,
java.lang.String encoding)
Opens the given file for reading, assuming the specified encoding for file names. |
|
ZipFile(java.lang.String name)
Opens the given file for reading, assuming the platform's native encoding for file names. |
|
ZipFile(java.lang.String name,
java.lang.String encoding)
Opens the given file for reading, assuming the specified encoding for file names. |
Method Summary | |
void |
close()
Closes the archive. |
protected static java.util.Date |
fromDosTime(ZipLong l)
Convert a DOS date/time field to a Date object. |
java.lang.String |
getEncoding()
The encoding to use for filenames and the file comment. |
java.util.Enumeration |
getEntries()
Returns all entries. |
ZipEntry |
getEntry(java.lang.String name)
Returns a named entry - or null if no entry by
that name exists. |
java.io.InputStream |
getInputStream(ZipEntry ze)
Returns an InputStream for reading the contents of the given entry. |
protected java.lang.String |
getString(byte[] bytes)
Retrieve a String from the given bytes using the encoding set for this ZipFile. |
private void |
populateFromCentralDirectory()
Reads the central directory of the given archive and populates the internal tables with ZipEntry instances. |
private void |
positionAtCentralDirectory()
Searches for the "End of central dir record", parses it and positions the stream at the first central directory record. |
private void |
resolveLocalFileHeaderData()
Walks through all recorded entries and adds the data available from the local file header. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
private java.util.Hashtable entries
private java.util.Hashtable nameMap
private java.util.Hashtable dataOffsets
private java.lang.String encoding
For a list of possible values see http://java.sun.com/products/jdk/1.2/docs/guide/internat/encoding.doc.html. Defaults to the platform's default character encoding.
private java.io.RandomAccessFile archive
private static final int CFH_LEN
private static final int MIN_EOCD_SIZE
private static final int CFD_LOCATOR_OFFSET
private static final long LFH_OFFSET_FOR_FILENAME_LENGTH
Constructor Detail |
public ZipFile(java.io.File f) throws java.io.IOException
f
- the archive.
java.io.IOException
- if an error occurs while reading the file.public ZipFile(java.lang.String name) throws java.io.IOException
name
- name of the archive.
java.io.IOException
- if an error occurs while reading the file.public ZipFile(java.lang.String name, java.lang.String encoding) throws java.io.IOException
name
- name of the archive.encoding
- the encoding to use for file names
java.io.IOException
- if an error occurs while reading the file.public ZipFile(java.io.File f, java.lang.String encoding) throws java.io.IOException
f
- the archive.encoding
- the encoding to use for file names
java.io.IOException
- if an error occurs while reading the file.Method Detail |
public java.lang.String getEncoding()
public void close() throws java.io.IOException
java.io.IOException
- if an error occurs closing the archive.public java.util.Enumeration getEntries()
ZipEntry
instancespublic ZipEntry getEntry(java.lang.String name)
null
if no entry by
that name exists.
name
- name of the entry.
null
if not present.public java.io.InputStream getInputStream(ZipEntry ze) throws java.io.IOException, java.util.zip.ZipException
ze
- the entry to get the stream for.
java.io.IOException
java.util.zip.ZipException
private void populateFromCentralDirectory() throws java.io.IOException
The ZipEntrys will know all data that can be obtained from the central directory alone, but not the data that requires the local file header or additional data to be read.
java.io.IOException
private void positionAtCentralDirectory() throws java.io.IOException
java.io.IOException
private void resolveLocalFileHeaderData() throws java.io.IOException
Also records the offsets for the data to read from the entries.
java.io.IOException
protected static java.util.Date fromDosTime(ZipLong l)
l
- contains the stored DOS time.
protected java.lang.String getString(byte[] bytes) throws java.util.zip.ZipException
bytes
- the byte array to transform
java.util.zip.ZipException
- if the encoding cannot be recognized.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |