public
class
ZipEntry
extends Object
implements
Cloneable
java.lang.Object | |
↳ | java.util.zip.ZipEntry |
Known Direct Subclasses |
This class is used to represent a ZIP file entry.
Constants | |
---|---|
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 constructors | |
---|---|
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 methods | |
---|---|
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 methods | |
---|---|
From
class
java.lang.Object
|
int DEFLATED
Compression method for compressed (deflated) entries.
Constant Value: 8 (0x00000008)
int STORED
Compression method for uncompressed entries.
Constant Value: 0 (0x00000000)
ZipEntry (String name)
Creates a new zip entry with the specified name.
Parameters | |
---|---|
name |
String :
the entry name |
Throws | |
---|---|
NullPointerException |
if the entry name is null |
IllegalArgumentException |
if the entry name is longer than 0xFFFF bytes |
ZipEntry (ZipEntry e)
Creates a new zip entry with fields taken from the specified zip entry.
Parameters | |
---|---|
e |
ZipEntry :
a zip Entry object
|
Object clone ()
Returns a copy of this entry.
Returns | |
---|---|
Object |
a clone of this instance. |
String getComment ()
Returns the comment string for the entry, or null if none.
Returns | |
---|---|
String |
the comment string for the entry, or null if none |
See also:
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 | |
---|---|
long |
the size of the compressed entry data, or -1 if not known |
See also:
long getCrc ()
Returns the CRC-32 checksum of the uncompressed entry data, or -1 if not known.
Returns | |
---|---|
long |
the CRC-32 checksum of the uncompressed entry data, or -1 if not known |
See also:
byte[] getExtra ()
Returns the extra field data for the entry, or null if none.
Returns | |
---|---|
byte[] |
the extra field data for the entry, or null if none |
See also:
int getMethod ()
Returns the compression method of the entry, or -1 if not specified.
Returns | |
---|---|
int |
the compression method of the entry, or -1 if not specified |
See also:
String getName ()
Returns the name of the entry.
Returns | |
---|---|
String |
the name of the entry |
long getSize ()
Returns the uncompressed size of the entry data, or -1 if not known.
Returns | |
---|---|
long |
the uncompressed size of the entry data, or -1 if not known |
See also:
long getTime ()
Returns the modification time of the entry, or -1 if not specified.
Returns | |
---|---|
long |
the modification time of the entry, or -1 if not specified |
See also:
int hashCode ()
Returns the hash code value for this entry.
Returns | |
---|---|
int |
a hash code value for this object. |
boolean isDirectory ()
Returns true if this is a directory entry. A directory entry is defined to be one whose name ends with a '/'.
Returns | |
---|---|
boolean |
true if this is a directory entry |
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 |
String :
the comment string |
See also:
void setCompressedSize (long csize)
Sets the size of the compressed entry data.
Parameters | |
---|---|
csize |
long :
the compressed size to set to |
See also:
void setCrc (long crc)
Sets the CRC-32 checksum of the uncompressed entry data.
Parameters | |
---|---|
crc |
long :
the CRC-32 value |
Throws | |
---|---|
IllegalArgumentException |
if the specified CRC-32 value is less than 0 or greater than 0xFFFFFFFF |
See also:
void setExtra (byte[] extra)
Sets the optional extra field data for the entry.
Parameters | |
---|---|
extra |
byte :
the extra field data bytes |
Throws | |
---|---|
IllegalArgumentException |
if the length of the specified extra field data is greater than 0xFFFF bytes |
See also:
void setMethod (int method)
Sets the compression method for the entry.
Parameters | |
---|---|
method |
int :
the compression method, either STORED or DEFLATED |
Throws | |
---|---|
IllegalArgumentException |
if the specified compression method is invalid |
See also:
void setSize (long size)
Sets the uncompressed size of the entry data.
Parameters | |
---|---|
size |
long :
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:
void setTime (long time)
Sets the modification time of the entry.
Parameters | |
---|---|
time |
long :
the entry modification time in number of milliseconds
since the epoch |
See also:
String toString ()
Returns a string representation of the ZIP entry.
Returns | |
---|---|
String |
a string representation of the object. |