|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.compress.archivers.zip.ZipFile
public class 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.commons.compress.archivers.zip.ZipArchiveEntry
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.commons.compress.archivers.zip.ZipArchiveEntry
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. |
private static class |
ZipFile.NameAndComment
|
private static class |
ZipFile.OffsetEntry
|
Field Summary | |
---|---|
private java.io.RandomAccessFile |
archive
The actual data source. |
(package private) static int |
BYTE_SHIFT
|
private static int |
CFD_LOCATOR_OFFSET
|
private static int |
CFH_LEN
|
private java.lang.String |
encoding
The encoding to use for filenames and the file comment. |
private java.util.Map |
entries
Maps ZipArchiveEntrys to Longs, recording the offsets of the local file headers. |
private static int |
HASH_SIZE
|
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 |
MAX_EOCD_SIZE
|
private static int |
MIN_EOCD_SIZE
|
private java.util.Map |
nameMap
Maps String to ZipArchiveEntrys, name -> actual entry. |
(package private) static int |
NIBLET_MASK
|
private java.util.Comparator |
OFFSET_COMPARATOR
Compares two ZipArchiveEntries based on their offset within the archive. |
private static int |
POS_0
|
private static int |
POS_1
|
private static int |
POS_2
|
private static int |
POS_3
|
private static int |
SHORT
|
private boolean |
useUnicodeExtraFields
Whether to look for and use Unicode extra fields. |
private static int |
WORD
|
private ZipEncoding |
zipEncoding
The zip encoding to use for filenames and the file comment. |
Constructor Summary | |
---|---|
ZipFile(java.io.File f)
Opens the given file for reading, assuming "UTF8" 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 and scanning for unicode extra fields. |
|
ZipFile(java.io.File f,
java.lang.String encoding,
boolean useUnicodeExtraFields)
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 "UTF8". |
|
ZipFile(java.lang.String name,
java.lang.String encoding)
Opens the given file for reading, assuming the specified encoding for file names, scanning unicode extra fields. |
Method Summary | |
---|---|
boolean |
canReadEntryData(ZipArchiveEntry ze)
Whether this class is able to read the given entry. |
void |
close()
Closes the archive. |
static void |
closeQuietly(ZipFile zipfile)
close a zipfile quietly; throw no io fault, do nothing on a null parameter |
java.lang.String |
getEncoding()
The encoding to use for filenames and the file comment. |
java.util.Enumeration |
getEntries()
Returns all entries. |
java.util.Enumeration |
getEntriesInPhysicalOrder()
Returns all entries in physical order. |
ZipArchiveEntry |
getEntry(java.lang.String name)
Returns a named entry - or null if no entry by
that name exists. |
java.io.InputStream |
getInputStream(ZipArchiveEntry ze)
Returns an InputStream for reading the contents of the given entry. |
private java.util.Map |
populateFromCentralDirectory()
Reads the central directory of the given archive and populates the internal tables with ZipArchiveEntry 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(java.util.Map entriesWithoutUTF8Flag)
Walks through all recorded entries and adds the data available from the local file header. |
private boolean |
startsWithLocalFileHeader()
Checks whether the archive starts with a LFH. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final int HASH_SIZE
private static final int SHORT
private static final int WORD
static final int NIBLET_MASK
static final int BYTE_SHIFT
private static final int POS_0
private static final int POS_1
private static final int POS_2
private static final int POS_3
private final java.util.Map entries
private final java.util.Map nameMap
private final java.lang.String encoding
For a list of possible values see http://java.sun.com/j2se/1.5.0/docs/guide/intl/encoding.doc.html. Defaults to UTF-8.
private final ZipEncoding zipEncoding
private final java.io.RandomAccessFile archive
private final boolean useUnicodeExtraFields
private static final int CFH_LEN
private static final int MIN_EOCD_SIZE
private static final int MAX_EOCD_SIZE
private static final int CFD_LOCATOR_OFFSET
private static final long LFH_OFFSET_FOR_FILENAME_LENGTH
private final java.util.Comparator OFFSET_COMPARATOR
Won't return any meaningful results if one of the entries isn't part of the archive at all.
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, use null
for the platform's default encoding
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, use null
for the platform's default encoding
java.io.IOException
- if an error occurs while reading the file.public ZipFile(java.io.File f, java.lang.String encoding, boolean useUnicodeExtraFields) throws java.io.IOException
f
- the archive.encoding
- the encoding to use for file names, use null
for the platform's default encodinguseUnicodeExtraFields
- whether to use InfoZIP Unicode
Extra Fields (if present) to set the 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 static void closeQuietly(ZipFile zipfile)
zipfile
- file to close, can be nullpublic java.util.Enumeration getEntries()
Entries will be returned in the same order they appear within the archive's central directory.
ZipArchiveEntry
instancespublic java.util.Enumeration getEntriesInPhysicalOrder()
Entries will be returned in the same order their contents appear within the archive.
ZipArchiveEntry
instancespublic ZipArchiveEntry getEntry(java.lang.String name)
null
if no entry by
that name exists.
name
- name of the entry.
null
if not present.public boolean canReadEntryData(ZipArchiveEntry ze)
May return false if it is set up to use encryption or a compression method that hasn't been implemented yet.
public java.io.InputStream getInputStream(ZipArchiveEntry ze) throws java.io.IOException, java.util.zip.ZipException
ze
- the entry to get the stream for.
java.io.IOException
- if unable to create an input stream from the zipenty
java.util.zip.ZipException
- if the zipentry uses an unsupported featureprivate java.util.Map populateFromCentralDirectory() throws java.io.IOException
The ZipArchiveEntrys 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(java.util.Map entriesWithoutUTF8Flag) throws java.io.IOException
Also records the offsets for the data to read from the entries.
java.io.IOException
private boolean startsWithLocalFileHeader() throws java.io.IOException
java.io.IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |