Android
java.util.zip
public class

java.util.zip.ZipFile

java.lang.Object
java.util.zip.ZipFile

This class provides read-only random access to a Zip archive. The easy way to do this would be to use ZipInputStream to scan out the entries. This is less efficient than reading the central directory, because it requires performing small reads at points across the entire file, rather than reading one concentrated blob. Use ZipOutputStream if you want to create an archive.

Known Direct Subclasses

Summary

Constants

      Value  
int  CENATT    36  0x00000024 
int  CENATX    38  0x00000026 
int  CENCOM    32  0x00000020 
int  CENCRC    16  0x00000010 
int  CENDSK    34  0x00000022 
int  CENEXT    30  0x0000001e 
int  CENFLG    0x00000008 
int  CENHDR    46  0x0000002e 
int  CENHOW    10  0x0000000a 
int  CENLEN    24  0x00000018 
int  CENNAM    28  0x0000001c 
int  CENOFF    42  0x0000002a 
long  CENSIG    33639248  0x0000000002014b50 
int  CENSIZ    20  0x00000014 
int  CENTIM    12  0x0000000c 
int  CENVEM    0x00000004 
int  CENVER    0x00000006 
int  ENDCOM    20  0x00000014 
int  ENDHDR    22  0x00000016 
int  ENDOFF    16  0x00000010 
long  ENDSIG    101010256  0x0000000006054b50 
int  ENDSIZ    12  0x0000000c 
int  ENDSUB    0x00000008 
int  ENDTOT    10  0x0000000a 
int  EXTCRC    0x00000004 
int  EXTHDR    16  0x00000010 
int  EXTLEN    12  0x0000000c 
long  EXTSIG    134695760  0x0000000008074b50 
int  EXTSIZ    0x00000008 
int  LOCCRC    14  0x0000000e 
int  LOCEXT    28  0x0000001c 
int  LOCFLG    0x00000006 
int  LOCHDR    30  0x0000001e 
int  LOCHOW    0x00000008 
int  LOCLEN    22  0x00000016 
int  LOCNAM    26  0x0000001a 
long  LOCSIG    67324752  0x0000000004034b50 
int  LOCSIZ    18  0x00000012 
int  LOCTIM    10  0x0000000a 
int  LOCVER    0x00000004 
int  OPEN_DELETE  Delete zip file when closed.  0x00000004 
int  OPEN_READ  Open zip file for read.  0x00000001 

Public Constructors

            ZipFile(File file)
Constructs a new ZipFile opened on the specified File.
            ZipFile(File file, int mode)
Open a Zip file.
            ZipFile(String name)
Open a Zip file.

Public Methods

          void  close()
Close the Zip file.
          Enumeration<? extends ZipEntry entries()
Return an enumeration of the entries.
          ZipEntry  getEntry(String entryName)
Gets the zip entry with the specified name from this ZipFile.
          InputStream  getInputStream(ZipEntry entry)
Returns an input stream on the data of the specified ZipEntry.
          String  getName()
Gets the file name of this ZipFile.
          int  size()
Returns the number of ZipEntries in this ZipFile.

Protected Methods

          void  finalize()
Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
Methods inherited from class java.lang.Object

Details

Constants

public static final int CENATT

Constant Value: 36 (0x00000024)

public static final int CENATX

Constant Value: 38 (0x00000026)

public static final int CENCOM

Constant Value: 32 (0x00000020)

public static final int CENCRC

Constant Value: 16 (0x00000010)

public static final int CENDSK

Constant Value: 34 (0x00000022)

public static final int CENEXT

Constant Value: 30 (0x0000001e)

public static final int CENFLG

Constant Value: 8 (0x00000008)

public static final int CENHDR

Constant Value: 46 (0x0000002e)

public static final int CENHOW

Constant Value: 10 (0x0000000a)

public static final int CENLEN

Constant Value: 24 (0x00000018)

public static final int CENNAM

Constant Value: 28 (0x0000001c)

public static final int CENOFF

Constant Value: 42 (0x0000002a)

public static final long CENSIG

Constant Value: 33639248 (0x0000000002014b50)

public static final int CENSIZ

Constant Value: 20 (0x00000014)

public static final int CENTIM

Constant Value: 12 (0x0000000c)

public static final int CENVEM

Constant Value: 4 (0x00000004)

public static final int CENVER

Constant Value: 6 (0x00000006)

public static final int ENDCOM

Constant Value: 20 (0x00000014)

public static final int ENDHDR

Constant Value: 22 (0x00000016)

public static final int ENDOFF

Constant Value: 16 (0x00000010)

public static final long ENDSIG

Constant Value: 101010256 (0x0000000006054b50)

public static final int ENDSIZ

Constant Value: 12 (0x0000000c)

public static final int ENDSUB

Constant Value: 8 (0x00000008)

public static final int ENDTOT

Constant Value: 10 (0x0000000a)

public static final int EXTCRC

Constant Value: 4 (0x00000004)

public static final int EXTHDR

Constant Value: 16 (0x00000010)

public static final int EXTLEN

Constant Value: 12 (0x0000000c)

public static final long EXTSIG

Constant Value: 134695760 (0x0000000008074b50)

public static final int EXTSIZ

Constant Value: 8 (0x00000008)

public static final int LOCCRC

Constant Value: 14 (0x0000000e)

public static final int LOCEXT

Constant Value: 28 (0x0000001c)

public static final int LOCFLG

Constant Value: 6 (0x00000006)

public static final int LOCHDR

Constant Value: 30 (0x0000001e)

public static final int LOCHOW

Constant Value: 8 (0x00000008)

public static final int LOCLEN

Constant Value: 22 (0x00000016)

public static final int LOCNAM

Constant Value: 26 (0x0000001a)

public static final long LOCSIG

Constant Value: 67324752 (0x0000000004034b50)

public static final int LOCSIZ

Constant Value: 18 (0x00000012)

public static final int LOCTIM

Constant Value: 10 (0x0000000a)

public static final int LOCVER

Constant Value: 4 (0x00000004)

public static final int OPEN_DELETE

Delete zip file when closed.
Constant Value: 4 (0x00000004)

public static final int OPEN_READ

Open zip file for read.
Constant Value: 1 (0x00000001)

Public Constructors

public ZipFile(File file)

Constructs a new ZipFile opened on the specified File.

Parameters

file the File

public ZipFile(File file, int mode)

Open a Zip file. "mode" must be OPEN_READ or OPEN_READ|OPEN_DELETE. The latter sets the "delete on exit" flag through a File object.

Throws

IOException

public ZipFile(String name)

Open a Zip file.

Throws

IOException

Public Methods

public void close()

Close the Zip file. This could be called multiple times, e.g. once explicitly and again by the finalizer. The Java doc doesn't say anything about what operations like entries() or getName() are supposed to do after the file is closed.

Throws

IOException

public Enumeration<? extends ZipEntry> entries()

Return an enumeration of the entries. The entries are listed in the order in which they appear in the Zip archive.

public ZipEntry getEntry(String entryName)

Gets the zip entry with the specified name from this ZipFile.

Parameters

entryName the name of the entry in the zip file

Returns

  • a ZipEntry or null if the entry name does not exist in the zip file

public InputStream getInputStream(ZipEntry entry)

Returns an input stream on the data of the specified ZipEntry.

Parameters

entry the ZipEntry

Returns

  • an input stream on the ZipEntry data

Throws

IOException

public String getName()

Gets the file name of this ZipFile.

Returns

  • the file name of this ZipFile

public int size()

Returns the number of ZipEntries in this ZipFile.

Returns

  • Number of entries in this file

Protected Methods

protected void finalize()

Called by the virtual machine when there are no longer any (non-weak) references to the receiver. Subclasses can use this facility to guarantee that any associated resources are cleaned up before the receiver is garbage collected. Uncaught exceptions which are thrown during the running of the method cause it to terminate immediately, but are otherwise ignored.

Note: The virtual machine assumes that the implementation in class Object is empty.

Throws

IOException
Copyright 2007 Google Inc. Build 0.9_r1-98467 - 14 Aug 2008 18:48