ZipEntry

public class ZipEntry extends Object
implements Cloneable
Known Direct Subclasses

This class is used to represent a ZIP file entry.

Constant Summary

int CENATT
int CENATX
int CENCOM
int CENCRC
int CENDSK
int CENEXT
int CENFLG
int CENHDR
int CENHOW
int CENLEN
int CENNAM
int CENOFF
long CENSIG
int CENSIZ
int CENTIM
int CENVEM
int CENVER
int DEFLATED Compression method for compressed (deflated) entries.
int ENDCOM
int ENDHDR
int ENDOFF
long ENDSIG
int ENDSIZ
int ENDSUB
int ENDTOT
int EXTCRC
int EXTHDR
int EXTLEN
long EXTSIG
int EXTSIZ
int LOCCRC
int LOCEXT
int LOCFLG
int LOCHDR
int LOCHOW
int LOCLEN
int LOCNAM
long LOCSIG
int LOCSIZ
int LOCTIM
int LOCVER
int STORED Compression method for uncompressed entries.

Public Constructor Summary

ZipEntry(String name)
Creates a new zip entry with the specified name.
ZipEntry(ZipEntry e)
Creates a new zip entry with fields taken from the specified zip entry.

Public Method Summary

Object
clone()
Returns a copy of this entry.
String
getComment()
Returns the comment string for the entry, or null if none.
long
getCompressedSize()
Returns the size of the compressed entry data, or -1 if not known.
long
getCrc()
Returns the CRC-32 checksum of the uncompressed entry data, or -1 if not known.
byte[]
getExtra()
Returns the extra field data for the entry, or null if none.
int
getMethod()
Returns the compression method of the entry, or -1 if not specified.
String
getName()
Returns the name of the entry.
long
getSize()
Returns the uncompressed size of the entry data, or -1 if not known.
long
getTime()
Returns the modification time of the entry, or -1 if not specified.
int
hashCode()
Returns the hash code value for this entry.
boolean
isDirectory()
Returns true if this is a directory entry.
void
setComment(String comment)
Sets the optional comment string for the entry.
void
setCompressedSize(long csize)
Sets the size of the compressed entry data.
void
setCrc(long crc)
Sets the CRC-32 checksum of the uncompressed entry data.
void
setExtra(byte[] extra)
Sets the optional extra field data for the entry.
void
setMethod(int method)
Sets the compression method for the entry.
void
setSize(long size)
Sets the uncompressed size of the entry data.
void
setTime(long time)
Sets the modification time of the entry.
String
toString()
Returns a string representation of the ZIP entry.

Inherited Method Summary

Constants

public static final int CENATT

Constant Value: 36

public static final int CENATX

Constant Value: 38

public static final int CENCOM

Constant Value: 32

public static final int CENCRC

Constant Value: 16

public static final int CENDSK

Constant Value: 34

public static final int CENEXT

Constant Value: 30

public static final int CENFLG

Constant Value: 8

public static final int CENHDR

Constant Value: 46

public static final int CENHOW

Constant Value: 10

public static final int CENLEN

Constant Value: 24

public static final int CENNAM

Constant Value: 28

public static final int CENOFF

Constant Value: 42

public static final long CENSIG

Constant Value: 33639248

public static final int CENSIZ

Constant Value: 20

public static final int CENTIM

Constant Value: 12

public static final int CENVEM

Constant Value: 4

public static final int CENVER

Constant Value: 6

public static final int DEFLATED

Compression method for compressed (deflated) entries.

Constant Value: 8

public static final int ENDCOM

Constant Value: 20

public static final int ENDHDR

Constant Value: 22

public static final int ENDOFF

Constant Value: 16

public static final long ENDSIG

Constant Value: 101010256

public static final int ENDSIZ

Constant Value: 12

public static final int ENDSUB

Constant Value: 8

public static final int ENDTOT

Constant Value: 10

public static final int EXTCRC

Constant Value: 4

public static final int EXTHDR

Constant Value: 16

public static final int EXTLEN

Constant Value: 12

public static final long EXTSIG

Constant Value: 134695760

public static final int EXTSIZ

Constant Value: 8

public static final int LOCCRC

Constant Value: 14

public static final int LOCEXT

Constant Value: 28

public static final int LOCFLG

Constant Value: 6

public static final int LOCHDR

Constant Value: 30

public static final int LOCHOW

Constant Value: 8

public static final int LOCLEN

Constant Value: 22

public static final int LOCNAM

Constant Value: 26

public static final long LOCSIG

Constant Value: 67324752

public static final int LOCSIZ

Constant Value: 18

public static final int LOCTIM

Constant Value: 10

public static final int LOCVER

Constant Value: 4

public static final int STORED

Compression method for uncompressed entries.

Constant Value: 0

Public Constructors

public ZipEntry (String name)

Creates a new zip entry with the specified name.

Parameters
name the entry name
Throws
NullPointerException if the entry name is null
IllegalArgumentException if the entry name is longer than 0xFFFF bytes

public ZipEntry (ZipEntry e)

Creates a new zip entry with fields taken from the specified zip entry.

Parameters
e a zip Entry object

Public Methods

public Object clone ()

Returns a copy of this entry.

Returns
  • a copy of this object.

public String getComment ()

Returns the comment string for the entry, or null if none.

Returns
  • the comment string for the entry, or null if none

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

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

public byte[] getExtra ()

Returns the extra field data for the entry, or null if none.

Returns
  • the extra field data for the entry, or null if none
See Also

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

public String getName ()

Returns the name of the entry.

Returns
  • the name of the entry

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

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

public int hashCode ()

Returns the hash code value for this entry.

Returns
  • this object's hash code.

public boolean isDirectory ()

Returns true if this is a directory entry. A directory entry is defined to be one whose name ends with a '/'.

Returns
  • true if this is a directory entry

public void setComment (String comment)

Sets the optional comment string for the entry.

ZIP entry comments have maximum length of 0xffff. If the length of the specified comment string is greater than 0xFFFF bytes after encoding, only the first 0xFFFF bytes are output to the ZIP file entry.

Parameters
comment the comment string
See Also

public void setCompressedSize (long csize)

Sets the size of the compressed entry data.

Parameters
csize the compressed size to set to

public void setCrc (long crc)

Sets the CRC-32 checksum of the uncompressed entry data.

Parameters
crc the CRC-32 value
Throws
IllegalArgumentException if the specified CRC-32 value is less than 0 or greater than 0xFFFFFFFF
See Also

public void setExtra (byte[] extra)

Sets the optional extra field data for the entry.

Parameters
extra the extra field data bytes
Throws
IllegalArgumentException if the length of the specified extra field data is greater than 0xFFFF bytes
See Also

public void setMethod (int method)

Sets the compression method for the entry.

Parameters
method the compression method, either STORED or DEFLATED
Throws
IllegalArgumentException if the specified compression method is invalid
See Also

public void setSize (long size)

Sets the uncompressed size of the entry data.

Parameters
size the uncompressed size in bytes
Throws
IllegalArgumentException if the specified size is less than 0, is greater than 0xFFFFFFFF when ZIP64 format is not supported, or is less than 0 when ZIP64 is supported
See Also

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

public String toString ()

Returns a string representation of the ZIP entry.

Returns
  • a printable representation of this object.