Save This Page
Home » apache-ant-1.8.1 » org.apache.tools » zip » [javadoc | source]
org.apache.tools.zip
public class: ZipFile [javadoc | source]
java.lang.Object
   org.apache.tools.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:

Constructor:
 public ZipFile(File f) throws IOException 
    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.
 public ZipFile(String name) throws IOException 
    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.
 public ZipFile(String name,
    String encoding) throws IOException 
    Opens the given file for reading, assuming the specified encoding for file names, scanning unicode extra fields.
    Parameters:
    name - name of the archive.
    encoding - the encoding to use for file names
    Throws:
    IOException - if an error occurs while reading the file.
 public ZipFile(File f,
    String encoding) throws IOException 
    Opens the given file for reading, assuming the specified encoding for file names and scanning for unicode extra fields.
    Parameters:
    f - the archive.
    encoding - the encoding to use for file names, use null for the platform's default encoding
    Throws:
    IOException - if an error occurs while reading the file.
 public ZipFile(File f,
    String encoding,
    boolean useUnicodeExtraFields) throws IOException 
    Opens the given file for reading, assuming the specified encoding for file names.
    Parameters:
    f - the archive.
    encoding - the encoding to use for file names, use null for the platform's default encoding
    useUnicodeExtraFields - whether to use InfoZIP Unicode Extra Fields (if present) to set the file names.
    Throws:
    IOException - if an error occurs while reading the file.
Method from org.apache.tools.zip.ZipFile Summary:
close,   closeQuietly,   fromDosTime,   getEncoding,   getEntries,   getEntry,   getInputStream,   getString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.tools.zip.ZipFile Detail:
 public  void close() throws IOException 
    Closes the archive.
 public static  void closeQuietly(ZipFile zipfile) 
    close a zipfile quietly; throw no io fault, do nothing on a null parameter
 protected static Date fromDosTime(ZipLong zipDosTime) 
    Convert a DOS date/time field to a Date object.
 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.
 public InputStream getInputStream(ZipEntry ze) throws IOException, ZipException 
    Returns an InputStream for reading the contents of the given entry.
 protected String getString(byte[] bytes) throws ZipException 
    Retrieve a String from the given bytes using the encoding set for this ZipFile.