Overview  Package   Class  Use  Tree  Deprecated  Index 
TrueZIP Driver ZIP 7.1
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

de.schlichtherle.truezip.zip
Class ZipFile

java.lang.Object
  extended by de.schlichtherle.truezip.zip.RawZipFile<ZipEntry>
      extended by de.schlichtherle.truezip.zip.ZipFile
All Implemented Interfaces:
Closeable, Iterable<ZipEntry>
public class ZipFile
extends RawZipFile<ZipEntry>

Drop-in replacement for java.util.zip.ZipFile.

Where the constructors of this class accept a charset parameter, this is used to decode comments and entry names in the ZIP file. However, if an entry has bit 11 set in its General Purpose Bit Flag, then this parameter is ignored and "UTF-8" is used for this entry. This is in accordance to Appendix D of PKWARE's ZIP File Format Specification, version 6.3.0 and later.

This class is able to skip a preamble like the one found in self extracting archives.

Note that the entries returned by this class are instances of de.schlichtherle.truezip.io.zip.ZipEntry instead of java.util.zip.ZipEntry.

This class is thread-safe.

Author:
Christian Schlichtherle
See Also:
ZipOutputStream

Nested Class Summary
private static class ZipFile.DefaultReadOnlyFilePool
          A pool which allocates DefaultReadOnlyFile objects for the provided to its constructor.
 
Nested classes/interfaces inherited from class de.schlichtherle.truezip.zip.RawZipFile
RawZipFile.OffsetMapper
 
Field Summary
private  String name
           
 
Fields inherited from class de.schlichtherle.truezip.zip.RawZipFile
DEFAULT_CHARSET
 
Constructor Summary
ZipFile(File file)
          Equivalent to ZipFile(file, DEFAULT_CHARSET, true, false)
ZipFile(File file, Charset charset)
          Equivalent to ZipFile(file, charset, true, false)
ZipFile(File file, Charset charset, boolean preambled, boolean postambled)
          Opens the given File for reading its entries.
ZipFile(ReadOnlyFile rof)
          Equivalent to ZipFile(rof, DEFAULT_CHARSET, true, false)
ZipFile(ReadOnlyFile rof, Charset charset)
          Equivalent to ZipFile(rof, charset, true, false)
ZipFile(ReadOnlyFile rof, Charset charset, boolean preambled, boolean postambled)
          Opens the given ReadOnlyFile for reading its entries.
ZipFile(String path)
          Equivalent to ZipFile(name, DEFAULT_CHARSET, true, false)
ZipFile(String path, Charset charset)
          Equivalent to ZipFile(name, charset, true, false)
ZipFile(String path, Charset charset, boolean preambled, boolean postambled)
          Opens the ZIP file identified by the given path name for reading its entries.
 
Method Summary
 boolean busy()
          Returns true if and only if some input streams are busy with reading from this ZIP file.
 void close()
          Closes the file.
 Enumeration<? extends ZipEntry> entries()
          Enumerates clones of all entries in this ZIP file.
 ZipEntry getEntry(String name)
          Returns a clone of the entry for the given name or null if no entry with this name exists.
protected  InputStream getInputStream(String name, boolean check, boolean inflate)
          Returns an InputStream for reading the inflated or deflated data of the given entry.
 String getName()
          Returns the string representation of whatever input source object was used to construct this ZIP file.
 InputStream getPostambleInputStream()
          Returns an InputStream to read the postamble of this ZIP file.
 InputStream getPreambleInputStream()
          Returns an InputStream to read the preamble of this ZIP file.
 Iterator<ZipEntry> iterator()
          Iterates through clones for all entries in this ZIP file.
 
Methods inherited from class de.schlichtherle.truezip.zip.RawZipFile
assertOpen, getCharset, getCheckedInputStream, getCheckedInputStream, getComment, getInputStream, getInputStream, getOffsetMapper, getPostambleLength, getPreambleLength, length, offsetsConsiderPreamble, size
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

private final String name
Constructor Detail

ZipFile

public ZipFile(String path)
        throws IOException
Equivalent to ZipFile(name, DEFAULT_CHARSET, true, false)

Throws:
IOException

ZipFile

public ZipFile(String path,
               Charset charset)
        throws IOException
Equivalent to ZipFile(name, charset, true, false)

Throws:
IOException

ZipFile

public ZipFile(String path,
               Charset charset,
               boolean preambled,
               boolean postambled)
        throws IOException
Opens the ZIP file identified by the given path name for reading its entries.

Parameters:
path - the path name of the file.
charset - the charset to use for decoding entry names and ZIP file comment.
preambled - if this is true, then the ZIP file may have a preamble. Otherwise, the ZIP file must start with either a Local File Header (LFH) signature or an End Of Central Directory (EOCD) Header, causing this constructor to fail if the file is actually a false positive ZIP file, i.e. not compatible to the ZIP File Format Specification. This may be useful to read Self Extracting ZIP files (SFX), which usually contain the application code required for extraction in the preamble.
postambled - if this is true, then the ZIP file may have a postamble of arbitrary length. Otherwise, the ZIP file must not have a postamble which exceeds 64KB size, including the End Of Central Directory record (i.e. including the ZIP file comment), causing this constructor to fail if the file is actually a false positive ZIP file, i.e. not compatible to the ZIP File Format Specification. This may be useful to read Self Extracting ZIP files (SFX) with large postambles.
Throws:
NullPointerException - if any reference parameter is null.
FileNotFoundException - if name cannot get opened for reading.
ZipException - if name is not compatible with the ZIP File Format Specification.
IOException - on any other I/O related issue.

ZipFile

public ZipFile(File file)
        throws IOException
Equivalent to ZipFile(file, DEFAULT_CHARSET, true, false)

Throws:
IOException

ZipFile

public ZipFile(File file,
               Charset charset)
        throws IOException
Equivalent to ZipFile(file, charset, true, false)

Throws:
IOException

ZipFile

public ZipFile(File file,
               Charset charset,
               boolean preambled,
               boolean postambled)
        throws IOException
Opens the given File for reading its entries.

Parameters:
file - the file.
charset - the charset to use for decoding entry names and ZIP file comment.
preambled - if this is true, then the ZIP file may have a preamble. Otherwise, the ZIP file must start with either a Local File Header (LFH) signature or an End Of Central Directory (EOCD) Header, causing this constructor to fail if the file is actually a false positive ZIP file, i.e. not compatible to the ZIP File Format Specification. This may be useful to read Self Extracting ZIP files (SFX), which usually contain the application code required for extraction in the preamble.
postambled - if this is true, then the ZIP file may have a postamble of arbitrary length. Otherwise, the ZIP file must not have a postamble which exceeds 64KB size, including the End Of Central Directory record (i.e. including the ZIP file comment), causing this constructor to fail if the file is actually a false positive ZIP file, i.e. not compatible to the ZIP File Format Specification. This may be useful to read Self Extracting ZIP files (SFX) with large postambles.
Throws:
NullPointerException - if any reference parameter is null.
FileNotFoundException - if file cannot get opened for reading.
ZipException - if file is not compatible with the ZIP File Format Specification.
IOException - on any other I/O related issue.

ZipFile

public ZipFile(ReadOnlyFile rof)
        throws IOException
Equivalent to ZipFile(rof, DEFAULT_CHARSET, true, false)

Throws:
IOException

ZipFile

public ZipFile(ReadOnlyFile rof,
               Charset charset)
        throws IOException
Equivalent to ZipFile(rof, charset, true, false)

Throws:
IOException

ZipFile

public ZipFile(ReadOnlyFile rof,
               Charset charset,
               boolean preambled,
               boolean postambled)
        throws IOException
Opens the given ReadOnlyFile for reading its entries.

Parameters:
rof - the random access read only file.
charset - the charset to use for decoding entry names and ZIP file comment.
preambled - if this is true, then the ZIP file may have a preamble. Otherwise, the ZIP file must start with either a Local File Header (LFH) signature or an End Of Central Directory (EOCD) Header, causing this constructor to fail if the file is actually a false positive ZIP file, i.e. not compatible to the ZIP File Format Specification. This may be useful to read Self Extracting ZIP files (SFX), which usually contain the application code required for extraction in the preamble.
postambled - if this is true, then the ZIP file may have a postamble of arbitrary length. Otherwise, the ZIP file must not have a postamble which exceeds 64KB size, including the End Of Central Directory record (i.e. including the ZIP file comment), causing this constructor to fail if the file is actually a false positive ZIP file, i.e. not compatible to the ZIP File Format Specification. This may be useful to read Self Extracting ZIP files (SFX) with large postambles.
Throws:
NullPointerException - if any reference parameter is null.
FileNotFoundException - if rof cannot get opened for reading.
ZipException - if rof is not compatible with the ZIP File Format Specification.
IOException - on any other I/O related issue.
Method Detail

getName

public String getName()
Returns the string representation of whatever input source object was used to construct this ZIP file. For String and File objects, this is a path name.

entries

public Enumeration<? extends ZipEntry> entries()
Enumerates clones of all entries in this ZIP file.

See Also:
iterator()

iterator

public Iterator<ZipEntry> iterator()
Iterates through clones for all entries in this ZIP file. The iteration does not support element removal.

Specified by:
iterator in interface Iterable<ZipEntry>
Overrides:
iterator in class RawZipFile<ZipEntry>

getEntry

public ZipEntry getEntry(String name)
Returns a clone of the entry for the given name or null if no entry with this name exists.

Overrides:
getEntry in class RawZipFile<ZipEntry>
Parameters:
name - the name of the ZIP entry.

getPreambleInputStream

public InputStream getPreambleInputStream()
                                   throws IOException
Description copied from class: RawZipFile
Returns an InputStream to read the preamble of this ZIP file.

Note that the returned stream is a lightweight stream, i.e. there is no external resource such as a ReadOnlyFile allocated for it. Instead, all streams returned by this method share the underlying ReadOnlyFile of this ZipFile. This allows to close this object (and hence the underlying ReadOnlyFile) without cooperation of the returned streams, which is important if the client application wants to work on the underlying file again (e.g. update or delete it).

Overrides:
getPreambleInputStream in class RawZipFile<ZipEntry>
Throws:
ZipException - If this ZIP file has been closed.
IOException

getPostambleInputStream

public InputStream getPostambleInputStream()
                                    throws IOException
Description copied from class: RawZipFile
Returns an InputStream to read the postamble of this ZIP file.

Note that the returned stream is a lightweight stream, i.e. there is no external resource such as a ReadOnlyFile allocated for it. Instead, all streams returned by this method share the underlying ReadOnlyFile of this ZipFile. This allows to close this object (and hence the underlying ReadOnlyFile) without cooperation of the returned streams, which is important if the client application wants to work on the underlying file again (e.g. update or delete it).

Overrides:
getPostambleInputStream in class RawZipFile<ZipEntry>
Throws:
ZipException - If this ZIP file has been closed.
IOException

busy

public boolean busy()
Description copied from class: RawZipFile
Returns true if and only if some input streams are busy with reading from this ZIP file.

Overrides:
busy in class RawZipFile<ZipEntry>

getInputStream

protected InputStream getInputStream(String name,
                                     boolean check,
                                     boolean inflate)
                              throws IOException
Description copied from class: RawZipFile
Returns an InputStream for reading the inflated or deflated data of the given entry.

If the RawZipFile.close() method is called on this instance, all input streams returned by this method are closed, too.

Overrides:
getInputStream in class RawZipFile<ZipEntry>
Parameters:
name - The name of the entry to get the stream for - may not be null!
check - Whether or not the entry's CRC-32 value is checked. If and only if this parameter is true, two additional checks are performed for the ZIP entry:
  1. All entry headers are checked to have consistent declarations of the CRC-32 value for the inflated entry data.
  2. When calling InputStream.close() on the returned entry stream, the CRC-32 value computed from the inflated entry data is checked against the declared CRC-32 values. This is independent from the inflate parameter.
If any of these checks fail, a CRC32Exception is thrown.

This parameter should be false for most applications, and is the default for the sibling of this class in java.util.zip.ZipFile.

inflate - Whether or not the entry data should be inflated. If false, the entry data is not inflated, even if the entry data is deflated. This parameter should be true for most applications.
Returns:
A stream to read the entry data from or null if the entry does not exist.
Throws:
CRC32Exception - If the declared CRC-32 values of the inflated entry data are inconsistent across the entry headers.
ZipException - If this file is not compatible to the ZIP File Format Specification.
IOException - If the entry cannot get read from this ZipFile.

close

public void close()
           throws IOException
Description copied from class: RawZipFile
Closes the file. This closes any fetch input streams reading from this ZIP file.

Specified by:
close in interface Closeable
Overrides:
close in class RawZipFile<ZipEntry>
Throws:
IOException - if an error occurs closing the file.
Overview  Package   Class  Use  Tree  Deprecated  Index 
TrueZIP Driver ZIP 7.1
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2005-2011 Schlichtherle IT Services. All Rights Reserved.