java.util.zip
Class ZipEntry

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.util.zip.ZipEntry
All Implemented Interfaces:
Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable
Direct Known Subclasses:
JarEntry sample code for java.util.jar.JarEntry definition code for java.util.jar.JarEntry

public class ZipEntry
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements Cloneable sample code for java.lang.Cloneable definition code for java.lang.Cloneable

This class is used to represent a ZIP file entry.


Field Summary
static int CENATT sample code for java.util.zip.ZipEntry.CENATT definition code for java.util.zip.ZipEntry.CENATT
           
static int CENATX sample code for java.util.zip.ZipEntry.CENATX definition code for java.util.zip.ZipEntry.CENATX
           
static int CENCOM sample code for java.util.zip.ZipEntry.CENCOM definition code for java.util.zip.ZipEntry.CENCOM
           
static int CENCRC sample code for java.util.zip.ZipEntry.CENCRC definition code for java.util.zip.ZipEntry.CENCRC
           
static int CENDSK sample code for java.util.zip.ZipEntry.CENDSK definition code for java.util.zip.ZipEntry.CENDSK
           
static int CENEXT sample code for java.util.zip.ZipEntry.CENEXT definition code for java.util.zip.ZipEntry.CENEXT
           
static int CENFLG sample code for java.util.zip.ZipEntry.CENFLG definition code for java.util.zip.ZipEntry.CENFLG
           
static int CENHDR sample code for java.util.zip.ZipEntry.CENHDR definition code for java.util.zip.ZipEntry.CENHDR
           
static int CENHOW sample code for java.util.zip.ZipEntry.CENHOW definition code for java.util.zip.ZipEntry.CENHOW
           
static int CENLEN sample code for java.util.zip.ZipEntry.CENLEN definition code for java.util.zip.ZipEntry.CENLEN
           
static int CENNAM sample code for java.util.zip.ZipEntry.CENNAM definition code for java.util.zip.ZipEntry.CENNAM
           
static int CENOFF sample code for java.util.zip.ZipEntry.CENOFF definition code for java.util.zip.ZipEntry.CENOFF
           
static long CENSIG sample code for java.util.zip.ZipEntry.CENSIG definition code for java.util.zip.ZipEntry.CENSIG
           
static int CENSIZ sample code for java.util.zip.ZipEntry.CENSIZ definition code for java.util.zip.ZipEntry.CENSIZ
           
static int CENTIM sample code for java.util.zip.ZipEntry.CENTIM definition code for java.util.zip.ZipEntry.CENTIM
           
static int CENVEM sample code for java.util.zip.ZipEntry.CENVEM definition code for java.util.zip.ZipEntry.CENVEM
           
static int CENVER sample code for java.util.zip.ZipEntry.CENVER definition code for java.util.zip.ZipEntry.CENVER
           
static int DEFLATED sample code for java.util.zip.ZipEntry.DEFLATED definition code for java.util.zip.ZipEntry.DEFLATED
          Compression method for compressed (deflated) entries.
static int ENDCOM sample code for java.util.zip.ZipEntry.ENDCOM definition code for java.util.zip.ZipEntry.ENDCOM
           
static int ENDHDR sample code for java.util.zip.ZipEntry.ENDHDR definition code for java.util.zip.ZipEntry.ENDHDR
           
static int ENDOFF sample code for java.util.zip.ZipEntry.ENDOFF definition code for java.util.zip.ZipEntry.ENDOFF
           
static long ENDSIG sample code for java.util.zip.ZipEntry.ENDSIG definition code for java.util.zip.ZipEntry.ENDSIG
           
static int ENDSIZ sample code for java.util.zip.ZipEntry.ENDSIZ definition code for java.util.zip.ZipEntry.ENDSIZ
           
static int ENDSUB sample code for java.util.zip.ZipEntry.ENDSUB definition code for java.util.zip.ZipEntry.ENDSUB
           
static int ENDTOT sample code for java.util.zip.ZipEntry.ENDTOT definition code for java.util.zip.ZipEntry.ENDTOT
           
static int EXTCRC sample code for java.util.zip.ZipEntry.EXTCRC definition code for java.util.zip.ZipEntry.EXTCRC
           
static int EXTHDR sample code for java.util.zip.ZipEntry.EXTHDR definition code for java.util.zip.ZipEntry.EXTHDR
           
static int EXTLEN sample code for java.util.zip.ZipEntry.EXTLEN definition code for java.util.zip.ZipEntry.EXTLEN
           
static long EXTSIG sample code for java.util.zip.ZipEntry.EXTSIG definition code for java.util.zip.ZipEntry.EXTSIG
           
static int EXTSIZ sample code for java.util.zip.ZipEntry.EXTSIZ definition code for java.util.zip.ZipEntry.EXTSIZ
           
static int LOCCRC sample code for java.util.zip.ZipEntry.LOCCRC definition code for java.util.zip.ZipEntry.LOCCRC
           
static int LOCEXT sample code for java.util.zip.ZipEntry.LOCEXT definition code for java.util.zip.ZipEntry.LOCEXT
           
static int LOCFLG sample code for java.util.zip.ZipEntry.LOCFLG definition code for java.util.zip.ZipEntry.LOCFLG
           
static int LOCHDR sample code for java.util.zip.ZipEntry.LOCHDR definition code for java.util.zip.ZipEntry.LOCHDR
           
static int LOCHOW sample code for java.util.zip.ZipEntry.LOCHOW definition code for java.util.zip.ZipEntry.LOCHOW
           
static int LOCLEN sample code for java.util.zip.ZipEntry.LOCLEN definition code for java.util.zip.ZipEntry.LOCLEN
           
static int LOCNAM sample code for java.util.zip.ZipEntry.LOCNAM definition code for java.util.zip.ZipEntry.LOCNAM
           
static long LOCSIG sample code for java.util.zip.ZipEntry.LOCSIG definition code for java.util.zip.ZipEntry.LOCSIG
           
static int LOCSIZ sample code for java.util.zip.ZipEntry.LOCSIZ definition code for java.util.zip.ZipEntry.LOCSIZ
           
static int LOCTIM sample code for java.util.zip.ZipEntry.LOCTIM definition code for java.util.zip.ZipEntry.LOCTIM
           
static int LOCVER sample code for java.util.zip.ZipEntry.LOCVER definition code for java.util.zip.ZipEntry.LOCVER
           
static int STORED sample code for java.util.zip.ZipEntry.STORED definition code for java.util.zip.ZipEntry.STORED
          Compression method for uncompressed entries.
 
Constructor Summary
ZipEntry sample code for java.util.zip.ZipEntry.ZipEntry(java.lang.String) definition code for java.util.zip.ZipEntry.ZipEntry(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  name)
          Creates a new zip entry with the specified name.
ZipEntry sample code for java.util.zip.ZipEntry.ZipEntry(java.util.zip.ZipEntry) definition code for java.util.zip.ZipEntry.ZipEntry(java.util.zip.ZipEntry) (ZipEntry sample code for java.util.zip.ZipEntry definition code for java.util.zip.ZipEntry  e)
          Creates a new zip entry with fields taken from the specified zip entry.
 
Method Summary
 Object sample code for java.lang.Object definition code for java.lang.Object clone sample code for java.util.zip.ZipEntry.clone() definition code for java.util.zip.ZipEntry.clone() ()
          Returns a copy of this entry.
 String sample code for java.lang.String definition code for java.lang.String getComment sample code for java.util.zip.ZipEntry.getComment() definition code for java.util.zip.ZipEntry.getComment() ()
          Returns the comment string for the entry, or null if none.
 long getCompressedSize sample code for java.util.zip.ZipEntry.getCompressedSize() definition code for java.util.zip.ZipEntry.getCompressedSize() ()
          Returns the size of the compressed entry data, or -1 if not known.
 long getCrc sample code for java.util.zip.ZipEntry.getCrc() definition code for java.util.zip.ZipEntry.getCrc() ()
          Returns the CRC-32 checksum of the uncompressed entry data, or -1 if not known.
 byte[] getExtra sample code for java.util.zip.ZipEntry.getExtra() definition code for java.util.zip.ZipEntry.getExtra() ()
          Returns the extra field data for the entry, or null if none.
 int getMethod sample code for java.util.zip.ZipEntry.getMethod() definition code for java.util.zip.ZipEntry.getMethod() ()
          Returns the compression method of the entry, or -1 if not specified.
 String sample code for java.lang.String definition code for java.lang.String getName sample code for java.util.zip.ZipEntry.getName() definition code for java.util.zip.ZipEntry.getName() ()
          Returns the name of the entry.
 long getSize sample code for java.util.zip.ZipEntry.getSize() definition code for java.util.zip.ZipEntry.getSize() ()
          Returns the uncompressed size of the entry data, or -1 if not known.
 long getTime sample code for java.util.zip.ZipEntry.getTime() definition code for java.util.zip.ZipEntry.getTime() ()
          Returns the modification time of the entry, or -1 if not specified.
 int hashCode sample code for java.util.zip.ZipEntry.hashCode() definition code for java.util.zip.ZipEntry.hashCode() ()
          Returns the hash code value for this entry.
 boolean isDirectory sample code for java.util.zip.ZipEntry.isDirectory() definition code for java.util.zip.ZipEntry.isDirectory() ()
          Returns true if this is a directory entry.
 void setComment sample code for java.util.zip.ZipEntry.setComment(java.lang.String) definition code for java.util.zip.ZipEntry.setComment(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  comment)
          Sets the optional comment string for the entry.
 void setCompressedSize sample code for java.util.zip.ZipEntry.setCompressedSize(long) definition code for java.util.zip.ZipEntry.setCompressedSize(long) (long csize)
          Sets the size of the compressed entry data.
 void setCrc sample code for java.util.zip.ZipEntry.setCrc(long) definition code for java.util.zip.ZipEntry.setCrc(long) (long crc)
          Sets the CRC-32 checksum of the uncompressed entry data.
 void setExtra sample code for java.util.zip.ZipEntry.setExtra(byte[]) definition code for java.util.zip.ZipEntry.setExtra(byte[]) (byte[] extra)
          Sets the optional extra field data for the entry.
 void setMethod sample code for java.util.zip.ZipEntry.setMethod(int) definition code for java.util.zip.ZipEntry.setMethod(int) (int method)
          Sets the compression method for the entry.
 void setSize sample code for java.util.zip.ZipEntry.setSize(long) definition code for java.util.zip.ZipEntry.setSize(long) (long size)
          Sets the uncompressed size of the entry data.
 void setTime sample code for java.util.zip.ZipEntry.setTime(long) definition code for java.util.zip.ZipEntry.setTime(long) (long time)
          Sets the modification time of the entry.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for java.util.zip.ZipEntry.toString() definition code for java.util.zip.ZipEntry.toString() ()
          Returns a string representation of the ZIP entry.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

STORED sample code for java.util.zip.ZipEntry.STORED

public static final int STORED
Compression method for uncompressed entries.

See Also:
Constant Field Values

DEFLATED sample code for java.util.zip.ZipEntry.DEFLATED

public static final int DEFLATED
Compression method for compressed (deflated) entries.

See Also:
Constant Field Values

LOCSIG sample code for java.util.zip.ZipConstants.LOCSIG

public static final long LOCSIG
See Also:
Constant Field Values

EXTSIG sample code for java.util.zip.ZipConstants.EXTSIG

public static final long EXTSIG
See Also:
Constant Field Values

CENSIG sample code for java.util.zip.ZipConstants.CENSIG

public static final long CENSIG
See Also:
Constant Field Values

ENDSIG sample code for java.util.zip.ZipConstants.ENDSIG

public static final long ENDSIG
See Also:
Constant Field Values

LOCHDR sample code for java.util.zip.ZipConstants.LOCHDR

public static final int LOCHDR
See Also:
Constant Field Values

EXTHDR sample code for java.util.zip.ZipConstants.EXTHDR

public static final int EXTHDR
See Also:
Constant Field Values

CENHDR sample code for java.util.zip.ZipConstants.CENHDR

public static final int CENHDR
See Also:
Constant Field Values

ENDHDR sample code for java.util.zip.ZipConstants.ENDHDR

public static final int ENDHDR
See Also:
Constant Field Values

LOCVER sample code for java.util.zip.ZipConstants.LOCVER

public static final int LOCVER
See Also:
Constant Field Values

LOCFLG sample code for java.util.zip.ZipConstants.LOCFLG

public static final int LOCFLG
See Also:
Constant Field Values

LOCHOW sample code for java.util.zip.ZipConstants.LOCHOW

public static final int LOCHOW
See Also:
Constant Field Values

LOCTIM sample code for java.util.zip.ZipConstants.LOCTIM

public static final int LOCTIM
See Also:
Constant Field Values

LOCCRC sample code for java.util.zip.ZipConstants.LOCCRC

public static final int LOCCRC
See Also:
Constant Field Values

LOCSIZ sample code for java.util.zip.ZipConstants.LOCSIZ

public static final int LOCSIZ
See Also:
Constant Field Values

LOCLEN sample code for java.util.zip.ZipConstants.LOCLEN

public static final int LOCLEN
See Also:
Constant Field Values

LOCNAM sample code for java.util.zip.ZipConstants.LOCNAM

public static final int LOCNAM
See Also:
Constant Field Values

LOCEXT sample code for java.util.zip.ZipConstants.LOCEXT

public static final int LOCEXT
See Also:
Constant Field Values

EXTCRC sample code for java.util.zip.ZipConstants.EXTCRC

public static final int EXTCRC
See Also:
Constant Field Values

EXTSIZ sample code for java.util.zip.ZipConstants.EXTSIZ

public static final int EXTSIZ
See Also:
Constant Field Values

EXTLEN sample code for java.util.zip.ZipConstants.EXTLEN

public static final int EXTLEN
See Also:
Constant Field Values

CENVEM sample code for java.util.zip.ZipConstants.CENVEM

public static final int CENVEM
See Also:
Constant Field Values

CENVER sample code for java.util.zip.ZipConstants.CENVER

public static final int CENVER
See Also:
Constant Field Values

CENFLG sample code for java.util.zip.ZipConstants.CENFLG

public static final int CENFLG
See Also:
Constant Field Values

CENHOW sample code for java.util.zip.ZipConstants.CENHOW

public static final int CENHOW
See Also:
Constant Field Values

CENTIM sample code for java.util.zip.ZipConstants.CENTIM

public static final int CENTIM
See Also:
Constant Field Values

CENCRC sample code for java.util.zip.ZipConstants.CENCRC

public static final int CENCRC
See Also:
Constant Field Values

CENSIZ sample code for java.util.zip.ZipConstants.CENSIZ

public static final int CENSIZ
See Also:
Constant Field Values

CENLEN sample code for java.util.zip.ZipConstants.CENLEN

public static final int CENLEN
See Also:
Constant Field Values

CENNAM sample code for java.util.zip.ZipConstants.CENNAM

public static final int CENNAM
See Also:
Constant Field Values

CENEXT sample code for java.util.zip.ZipConstants.CENEXT

public static final int CENEXT
See Also:
Constant Field Values

CENCOM sample code for java.util.zip.ZipConstants.CENCOM

public static final int CENCOM
See Also:
Constant Field Values

CENDSK sample code for java.util.zip.ZipConstants.CENDSK

public static final int CENDSK
See Also:
Constant Field Values

CENATT sample code for java.util.zip.ZipConstants.CENATT

public static final int CENATT
See Also:
Constant Field Values

CENATX sample code for java.util.zip.ZipConstants.CENATX

public static final int CENATX
See Also:
Constant Field Values

CENOFF sample code for java.util.zip.ZipConstants.CENOFF

public static final int CENOFF
See Also:
Constant Field Values

ENDSUB sample code for java.util.zip.ZipConstants.ENDSUB

public static final int ENDSUB
See Also:
Constant Field Values

ENDTOT sample code for java.util.zip.ZipConstants.ENDTOT

public static final int ENDTOT
See Also:
Constant Field Values

ENDSIZ sample code for java.util.zip.ZipConstants.ENDSIZ

public static final int ENDSIZ
See Also:
Constant Field Values

ENDOFF sample code for java.util.zip.ZipConstants.ENDOFF

public static final int ENDOFF
See Also:
Constant Field Values

ENDCOM sample code for java.util.zip.ZipConstants.ENDCOM

public static final int ENDCOM
See Also:
Constant Field Values
Constructor Detail

ZipEntry sample code for java.util.zip.ZipEntry(java.lang.String) definition code for java.util.zip.ZipEntry(java.lang.String)

public ZipEntry(String sample code for java.lang.String definition code for java.lang.String  name)
Creates a new zip entry with the specified name.

Parameters:
name - the entry name
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if the entry name is null
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if the entry name is longer than 0xFFFF bytes

ZipEntry sample code for java.util.zip.ZipEntry(java.util.zip.ZipEntry) definition code for java.util.zip.ZipEntry(java.util.zip.ZipEntry)

public ZipEntry(ZipEntry sample code for java.util.zip.ZipEntry definition code for java.util.zip.ZipEntry  e)
Creates a new zip entry with fields taken from the specified zip entry.

Parameters:
e - a zip Entry object
Method Detail

getName sample code for java.util.zip.ZipEntry.getName() definition code for java.util.zip.ZipEntry.getName()

public String sample code for java.lang.String definition code for java.lang.String  getName()
Returns the name of the entry.

Returns:
the name of the entry

setTime sample code for java.util.zip.ZipEntry.setTime(long) definition code for java.util.zip.ZipEntry.setTime(long)

public void setTime(long time)
Sets the modification time of the entry.

Parameters:
time - the entry modification time in number of milliseconds since the epoch
See Also:
getTime() sample code for java.util.zip.ZipEntry.getTime() definition code for java.util.zip.ZipEntry.getTime()

getTime sample code for java.util.zip.ZipEntry.getTime() definition code for java.util.zip.ZipEntry.getTime()

public long getTime()
Returns the modification time of the entry, or -1 if not specified.

Returns:
the modification time of the entry, or -1 if not specified
See Also:
setTime(long) sample code for java.util.zip.ZipEntry.setTime(long) definition code for java.util.zip.ZipEntry.setTime(long)

setSize sample code for java.util.zip.ZipEntry.setSize(long) definition code for java.util.zip.ZipEntry.setSize(long)

public void setSize(long size)
Sets the uncompressed size of the entry data.

Parameters:
size - the uncompressed size in bytes
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if the specified size is less than 0 or greater than 0xFFFFFFFF bytes
See Also:
getSize() sample code for java.util.zip.ZipEntry.getSize() definition code for java.util.zip.ZipEntry.getSize()

getSize sample code for java.util.zip.ZipEntry.getSize() definition code for java.util.zip.ZipEntry.getSize()

public long getSize()
Returns the uncompressed size of the entry data, or -1 if not known.

Returns:
the uncompressed size of the entry data, or -1 if not known
See Also:
setSize(long) sample code for java.util.zip.ZipEntry.setSize(long) definition code for java.util.zip.ZipEntry.setSize(long)

getCompressedSize sample code for java.util.zip.ZipEntry.getCompressedSize() definition code for java.util.zip.ZipEntry.getCompressedSize()

public long getCompressedSize()
Returns the size of the compressed entry data, or -1 if not known. In the case of a stored entry, the compressed size will be the same as the uncompressed size of the entry.

Returns:
the size of the compressed entry data, or -1 if not known
See Also:
setCompressedSize(long) sample code for java.util.zip.ZipEntry.setCompressedSize(long) definition code for java.util.zip.ZipEntry.setCompressedSize(long)

setCompressedSize sample code for java.util.zip.ZipEntry.setCompressedSize(long) definition code for java.util.zip.ZipEntry.setCompressedSize(long)

public void setCompressedSize(long csize)
Sets the size of the compressed entry data.

Parameters:
csize - the compressed size to set to
See Also:
getCompressedSize() sample code for java.util.zip.ZipEntry.getCompressedSize() definition code for java.util.zip.ZipEntry.getCompressedSize()

setCrc sample code for java.util.zip.ZipEntry.setCrc(long) definition code for java.util.zip.ZipEntry.setCrc(long)

public void setCrc(long crc)
Sets the CRC-32 checksum of the uncompressed entry data.

Parameters:
crc - the CRC-32 value
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if the specified CRC-32 value is less than 0 or greater than 0xFFFFFFFF
See Also:
setCrc(long) sample code for java.util.zip.ZipEntry.setCrc(long) definition code for java.util.zip.ZipEntry.setCrc(long)

getCrc sample code for java.util.zip.ZipEntry.getCrc() definition code for java.util.zip.ZipEntry.getCrc()

public long getCrc()
Returns the CRC-32 checksum of the uncompressed entry data, or -1 if not known.

Returns:
the CRC-32 checksum of the uncompressed entry data, or -1 if not known
See Also:
getCrc() sample code for java.util.zip.ZipEntry.getCrc() definition code for java.util.zip.ZipEntry.getCrc()

setMethod sample code for java.util.zip.ZipEntry.setMethod(int) definition code for java.util.zip.ZipEntry.setMethod(int)

public void setMethod(int method)
Sets the compression method for the entry.

Parameters:
method - the compression method, either STORED or DEFLATED
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if the specified compression method is invalid
See Also:
getMethod() sample code for java.util.zip.ZipEntry.getMethod() definition code for java.util.zip.ZipEntry.getMethod()

getMethod sample code for java.util.zip.ZipEntry.getMethod() definition code for java.util.zip.ZipEntry.getMethod()

public int getMethod()
Returns the compression method of the entry, or -1 if not specified.

Returns:
the compression method of the entry, or -1 if not specified
See Also:
setMethod(int) sample code for java.util.zip.ZipEntry.setMethod(int) definition code for java.util.zip.ZipEntry.setMethod(int)

setExtra sample code for java.util.zip.ZipEntry.setExtra(byte[]) definition code for java.util.zip.ZipEntry.setExtra(byte[])

public void setExtra(byte[] extra)
Sets the optional extra field data for the entry.

Parameters:
extra - the extra field data bytes
Throws: