Skip to content

Most visited

Recently visited

navigation

ZipEntry

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.

Summary

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

Constants

CENATT

Added in API level 21
int CENATT

Constant Value: 36 (0x00000024)

CENATX

Added in API level 21
int CENATX

Constant Value: 38 (0x00000026)

CENCOM

Added in API level 21
int CENCOM

Constant Value: 32 (0x00000020)

CENCRC

Added in API level 21
int CENCRC

Constant Value: 16 (0x00000010)

CENDSK

Added in API level 21
int CENDSK

Constant Value: 34 (0x00000022)

CENEXT

Added in API level 21
int CENEXT

Constant Value: 30 (0x0000001e)

CENFLG

Added in API level 21
int CENFLG

Constant Value: 8 (0x00000008)

CENHDR

Added in API level 21
int CENHDR

Constant Value: 46 (0x0000002e)

CENHOW

Added in API level 21
int CENHOW

Constant Value: 10 (0x0000000a)

CENLEN

Added in API level 21
int CENLEN

Constant Value: 24 (0x00000018)

CENNAM

Added in API level 21
int CENNAM

Constant Value: 28 (0x0000001c)

CENOFF

Added in API level 21
int CENOFF

Constant Value: 42 (0x0000002a)

CENSIG

Added in API level 21
long CENSIG

Constant Value: 33639248 (0x0000000002014b50)

CENSIZ

Added in API level 21
int CENSIZ

Constant Value: 20 (0x00000014)

CENTIM

Added in API level 21
int CENTIM

Constant Value: 12 (0x0000000c)

CENVEM

Added in API level 21
int CENVEM

Constant Value: 4 (0x00000004)

CENVER

Added in API level 21
int CENVER

Constant Value: 6 (0x00000006)

DEFLATED

Added in API level 1
int DEFLATED

Compression method for compressed (deflated) entries.

Constant Value: 8 (0x00000008)

ENDCOM

Added in API level 21
int ENDCOM

Constant Value: 20 (0x00000014)

ENDHDR

Added in API level 21
int ENDHDR

Constant Value: 22 (0x00000016)

ENDOFF

Added in API level 21
int ENDOFF

Constant Value: 16 (0x00000010)

ENDSIG

Added in API level 21
long ENDSIG

Constant Value: 101010256 (0x0000000006054b50)

ENDSIZ

Added in API level 21
int ENDSIZ

Constant Value: 12 (0x0000000c)

ENDSUB

Added in API level 21
int ENDSUB

Constant Value: 8 (0x00000008)

ENDTOT

Added in API level 21
int ENDTOT

Constant Value: 10 (0x0000000a)

EXTCRC

Added in API level 21
int EXTCRC

Constant Value: 4 (0x00000004)

EXTHDR

Added in API level 21
int EXTHDR

Constant Value: 16 (0x00000010)

EXTLEN

Added in API level 21
int EXTLEN

Constant Value: 12 (0x0000000c)

EXTSIG

Added in API level 21
long EXTSIG

Constant Value: 134695760 (0x0000000008074b50)

EXTSIZ

Added in API level 21
int EXTSIZ

Constant Value: 8 (0x00000008)

LOCCRC

Added in API level 21
int LOCCRC

Constant Value: 14 (0x0000000e)

LOCEXT

Added in API level 21
int LOCEXT

Constant Value: 28 (0x0000001c)

LOCFLG

Added in API level 21
int LOCFLG

Constant Value: 6 (0x00000006)

LOCHDR

Added in API level 21
int LOCHDR

Constant Value: 30 (0x0000001e)

LOCHOW

Added in API level 21
int LOCHOW

Constant Value: 8 (0x00000008)

LOCLEN

Added in API level 21
int LOCLEN

Constant Value: 22 (0x00000016)

LOCNAM

Added in API level 21
int LOCNAM

Constant Value: 26 (0x0000001a)

LOCSIG

Added in API level 21
long LOCSIG

Constant Value: 67324752 (0x0000000004034b50)

LOCSIZ

Added in API level 21
int LOCSIZ

Constant Value: 18 (0x00000012)

LOCTIM

Added in API level 21
int LOCTIM

Constant Value: 10 (0x0000000a)

LOCVER

Added in API level 21
int LOCVER

Constant Value: 4 (0x00000004)

STORED

Added in API level 1
int STORED

Compression method for uncompressed entries.

Constant Value: 0 (0x00000000)

Public constructors

ZipEntry

Added in API level 1
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

Added in API level 1
ZipEntry (ZipEntry e)

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

Parameters
e ZipEntry: a zip Entry object

Public methods

clone

Added in API level 1
Object clone ()

Returns a copy of this entry.

Returns
Object a clone of this instance.

getComment

Added in API level 1
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:

getCompressedSize

Added in API level 1
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:

getCrc

Added in API level 1
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:

getExtra

Added in API level 1
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:

getMethod

Added in API level 1
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:

getName

Added in API level 1
String getName ()

Returns the name of the entry.

Returns
String the name of the entry

getSize

Added in API level 1
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:

getTime

Added in API level 1
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:

hashCode

Added in API level 1
int hashCode ()

Returns the hash code value for this entry.

Returns
int a hash code value for this object.

isDirectory

Added in API level 1
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

setComment

Added in API level 1
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:

setCompressedSize

Added in API level 1
void setCompressedSize (long csize)

Sets the size of the compressed entry data.

Parameters
csize long: the compressed size to set to

See also:

setCrc

Added in API level 1
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:

setExtra

Added in API level 1
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:

setMethod

Added in API level 1
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:

setSize

Added in API level 1
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:

setTime

Added in API level 1
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:

toString

Added in API level 1
String toString ()

Returns a string representation of the ZIP entry.

Returns
String a string representation of the object.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.