类 ZipFile

java.lang.Object
com.sh.common.zip.ZipFile

public class ZipFile extends Object
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.
  • 构造器概要

    构造器
    构造器
    说明
    Opens the given file for reading, assuming the platform's native encoding for file names.
    ZipFile(File f, String encoding)
    Opens the given file for reading, assuming the specified encoding for file names and scanning for unicode extra fields.
    ZipFile(File f, String encoding, boolean useUnicodeExtraFields)
    Opens the given file for reading, assuming the specified encoding for file names.
    Opens the given file for reading, assuming the platform's native encoding for file names.
    ZipFile(String name, String encoding)
    Opens the given file for reading, assuming the specified encoding for file names, scanning unicode extra fields.
  • 方法概要

    修饰符和类型
    方法
    说明
    void
    Closes the archive.
    static void
    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.
    The encoding to use for filenames and the file comment.
    Returns all entries.
    Returns a named entry - or null if no entry by that name exists.
    Returns an InputStream for reading the contents of the given entry.
    protected String
    getString(byte[] bytes)
    Retrieve a String from the given bytes using the encoding set for this ZipFile.

    从类继承的方法 java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • 构造器详细资料

    • ZipFile

      public ZipFile(File f) throws IOException
      Opens the given file for reading, assuming the platform's native encoding for file names.
      参数:
      f - the archive.
      抛出:
      IOException - if an error occurs while reading the file.
    • ZipFile

      public ZipFile(String name) throws IOException
      Opens the given file for reading, assuming the platform's native encoding for file names.
      参数:
      name - name of the archive.
      抛出:
      IOException - if an error occurs while reading the file.
    • ZipFile

      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.
      参数:
      name - name of the archive.
      encoding - the encoding to use for file names
      抛出:
      IOException - if an error occurs while reading the file.
    • ZipFile

      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.
      参数:
      f - the archive.
      encoding - the encoding to use for file names, use null for the platform's default encoding
      抛出:
      IOException - if an error occurs while reading the file.
    • ZipFile

      public ZipFile(File f, String encoding, boolean useUnicodeExtraFields) throws IOException
      Opens the given file for reading, assuming the specified encoding for file names.
      参数:
      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.
      抛出:
      IOException - if an error occurs while reading the file.
  • 方法详细资料

    • getEncoding

      public String getEncoding()
      The encoding to use for filenames and the file comment.
      返回:
      null if using the platform's default character encoding.
    • close

      public void close() throws IOException
      Closes the archive.
      抛出:
      IOException - if an error occurs closing the archive.
    • closeQuietly

      public static void closeQuietly(ZipFile zipfile)
      close a zipfile quietly; throw no io fault, do nothing on a null parameter
      参数:
      zipfile - file to close, can be null
    • getEntries

      public Enumeration getEntries()
      Returns all entries.
      返回:
      all entries as ZipEntry instances
    • getEntry

      public ZipEntry getEntry(String name)
      Returns a named entry - or null if no entry by that name exists.
      参数:
      name - name of the entry.
      返回:
      the ZipEntry corresponding to the given name - or null if not present.
    • getInputStream

      public InputStream getInputStream(ZipEntry ze) throws IOException, ZipException
      Returns an InputStream for reading the contents of the given entry.
      参数:
      ze - the entry to get the stream for.
      返回:
      a stream to read the entry from.
      抛出:
      IOException - if unable to create an input stream from the zipenty
      ZipException - if the zipentry has an unsupported compression method
    • fromDosTime

      protected static Date fromDosTime(ZipLong zipDosTime)
      Convert a DOS date/time field to a Date object.
      参数:
      zipDosTime - contains the stored DOS time.
      返回:
      a Date instance corresponding to the given time.
    • getString

      protected String getString(byte[] bytes) throws ZipException
      Retrieve a String from the given bytes using the encoding set for this ZipFile.
      参数:
      bytes - the byte array to transform
      返回:
      String obtained by using the given encoding
      抛出:
      ZipException - if the encoding cannot be recognized.