Google is committed to advancing racial equity for Black communities. See how.
Added in API level 1

ZipEntry

open class ZipEntry : Cloneable
kotlin.Any
   ↳ java.util.zip.ZipEntry

This class is used to represent a ZIP file entry.

Summary

Constants
static Int

static Int

static Int

static Int

static Int

static Int

static Int

static Int

static Int

static Int

static Int

static Int

static Long

static Int

static Int

static Int

static Int

static Int

Compression method for compressed (deflated) entries.
static Int

static Int

static Int

static Long

static Int

static Int

static Int

static Int

static Int

static Int

static Long

static Int

static Int

static Int

static Int

static Int

static Int

static Int

static Int

static Long

static Int

static Int

static Int

static Int

Compression method for uncompressed entries.
Public constructors
<init>(name: String!)

Creates a new zip entry with the specified name.

Creates a new zip entry with fields taken from the specified zip entry.
Public methods
open Any

Returns a copy of this entry.
open String!

Returns the comment string for the entry.
open Long

Returns the size of the compressed entry data.
open Long

Returns the CRC-32 checksum of the uncompressed entry data.
open FileTime!

Returns the creation time of the entry.
open ByteArray!

Returns the extra field data for the entry.
open FileTime!

Returns the last access time of the entry.
open FileTime!

Returns the last modification time of the entry.
open Int

Returns the compression method of the entry.
open String!

Returns the name of the entry.
open Long

Returns the uncompressed size of the entry data.
open Long

Returns the last modification time of the entry.
open Int

Returns the hash code value for this entry.
open Boolean

Returns true if this is a directory entry.
open Unit
setComment(comment: String!)

Sets the optional comment string for the entry.
open Unit

Sets the size of the compressed entry data.
open Unit
setCrc(crc: Long)

Sets the CRC-32 checksum of the uncompressed entry data.
open ZipEntry!

Sets the creation time of the entry.
open Unit

Sets the optional extra field data for the entry.
open ZipEntry!

Sets the last access time of the entry.
open ZipEntry!

Sets the last modification time of the entry.
open Unit
setMethod(method: Int)

Sets the compression method for the entry.
open Unit
setSize(size: Long)

Sets the uncompressed size of the entry data.
open Unit
setTime(time: Long)

Sets the last modification time of the entry.
open String

Returns a string representation of the ZIP entry.

Constants

CENATT

Added in API level 21
static val CENATT: Int
Value: 36

CENATX

Added in API level 21
static val CENATX: Int
Value: 38

CENCOM

Added in API level 21
static val CENCOM: Int
Value: 32

CENCRC

Added in API level 21
static val CENCRC: Int
Value: 16

CENDSK

Added in API level 21
static val CENDSK: Int
Value: 34

CENEXT

Added in API level 21
static val CENEXT: Int
Value: 30

CENFLG

Added in API level 21
static val CENFLG: Int
Value: 8

CENHDR

Added in API level 21
static val CENHDR: Int
Value: 46

CENHOW

Added in API level 21
static val CENHOW: Int
Value: 10

CENLEN

Added in API level 21
static val CENLEN: Int
Value: 24

CENNAM

Added in API level 21
static val CENNAM: Int
Value: 28

CENOFF

Added in API level 21
static val CENOFF: Int
Value: 42

CENSIG

Added in API level 21
static val CENSIG: Long
Value: 33639248L

CENSIZ

Added in API level 21
static val CENSIZ: Int
Value: 20

CENTIM

Added in API level 21
static val CENTIM: Int
Value: 12

CENVEM

Added in API level 21
static val CENVEM: Int
Value: 4

CENVER

Added in API level 21
static val CENVER: Int
Value: 6

DEFLATED

Added in API level 1
static val DEFLATED: Int

Compression method for compressed (deflated) entries.

Value: 8

ENDCOM

Added in API level 21
static val ENDCOM: Int
Value: 20

ENDHDR

Added in API level 21
static val ENDHDR: Int
Value: 22

ENDOFF

Added in API level 21
static val ENDOFF: Int
Value: 16

ENDSIG

Added in API level 21
static val ENDSIG: Long
Value: 101010256L

ENDSIZ

Added in API level 21
static val ENDSIZ: Int
Value: 12

ENDSUB

Added in API level 21
static val ENDSUB: Int
Value: 8

ENDTOT

Added in API level 21
static val ENDTOT: Int
Value: 10

EXTCRC

Added in API level 21
static val EXTCRC: Int
Value: 4

EXTHDR

Added in API level 21
static val EXTHDR: Int
Value: 16

EXTLEN

Added in API level 21
static val EXTLEN: Int
Value: 12

EXTSIG

Added in API level 21
static val EXTSIG: Long
Value: 134695760L

EXTSIZ

Added in API level 21
static val EXTSIZ: Int
Value: 8

LOCCRC

Added in API level 21
static val LOCCRC: Int
Value: 14

LOCEXT

Added in API level 21
static val LOCEXT: Int
Value: 28

LOCFLG

Added in API level 21
static val LOCFLG: Int
Value: 6

LOCHDR

Added in API level 21
static val LOCHDR: Int
Value: 30

LOCHOW

Added in API level 21
static val LOCHOW: Int
Value: 8

LOCLEN

Added in API level 21
static val LOCLEN: Int
Value: 22

LOCNAM

Added in API level 21
static val LOCNAM: Int
Value: 26

LOCSIG

Added in API level 21
static val LOCSIG: Long
Value: 67324752L

LOCSIZ

Added in API level 21
static val LOCSIZ: Int
Value: 18

LOCTIM

Added in API level 21
static val LOCTIM: Int
Value: 10

LOCVER

Added in API level 21
static val LOCVER: Int
Value: 4

STORED

Added in API level 1
static val STORED: Int

Compression method for uncompressed entries.

Value: 0

Public constructors

<init>

Added in API level 1
ZipEntry(name: String!)

Creates a new zip entry with the specified name.

Parameters
name String!: The entry name
Exceptions
java.lang.NullPointerException if the entry name is null
java.lang.IllegalArgumentException if the entry name is longer than 0xFFFF bytes

<init>

Added in API level 1
ZipEntry(e: ZipEntry!)

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

Parameters
e ZipEntry!: A zip Entry object
Exceptions
java.lang.NullPointerException if the entry object is null

Public methods

clone

Added in API level 1
open fun clone(): Any

Returns a copy of this entry.

Return
Any a clone of this instance.
Exceptions
java.lang.CloneNotSupportedException if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

getComment

Added in API level 1
open fun getComment(): String!

Returns the comment string for the entry.

Return
String! the comment string for the entry, or null if none

getCompressedSize

Added in API level 1
open fun getCompressedSize(): Long

Returns the size of the compressed entry data.

In the case of a stored entry, the compressed size will be the same as the uncompressed size of the entry.

Return
Long the size of the compressed entry data, or -1 if not known

getCrc

Added in API level 1
open fun getCrc(): Long

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

Return
Long the CRC-32 checksum of the uncompressed entry data, or -1 if not known

See Also

getCreationTime

Added in API level 26
open fun getCreationTime(): FileTime!

Returns the creation time of the entry.

The creation time is from the extended timestamp fields of entry's optional extra data when read from a ZIP file or ZIP file formatted stream.

Return
FileTime! the creation time of the entry, null if not specified

getExtra

Added in API level 1
open fun getExtra(): ByteArray!

Returns the extra field data for the entry.

Return
ByteArray! the extra field data for the entry, or null if none

getLastAccessTime

Added in API level 26
open fun getLastAccessTime(): FileTime!

Returns the last access time of the entry.

The last access time is from the extended timestamp fields of entry's optional extra data when read from a ZIP file or ZIP file formatted stream.

Return
FileTime! The last access time of the entry, null if not specified

getLastModifiedTime

Added in API level 26
open fun getLastModifiedTime(): FileTime!

Returns the last modification time of the entry.

If the entry is read from a ZIP file or ZIP file formatted input stream, this is the last modification time from the zip file entry's optional extra data if the extended timestamp fields are present. Otherwise the last modification time is read from the entry's date and time fields, the is used to convert the standard MS-DOS formatted date and time to the epoch time.

Return
FileTime! The last modification time of the entry, null if not specified

getMethod

Added in API level 1
open fun getMethod(): Int

Returns the compression method of the entry.

Return
Int the compression method of the entry, or -1 if not specified

See Also

getName

Added in API level 1
open fun getName(): String!

Returns the name of the entry.

Return
String! the name of the entry

getSize

Added in API level 1
open fun getSize(): Long

Returns the uncompressed size of the entry data.

Return
Long the uncompressed size of the entry data, or -1 if not known

See Also

getTime

Added in API level 1
open fun getTime(): Long

Returns the last modification time of the entry.

If the entry is read from a ZIP file or ZIP file formatted input stream, this is the last modification time from the date and time fields of the zip file entry. The default TimeZone is used to convert the standard MS-DOS formatted date and time to the epoch time.

Return
Long The last modification time of the entry in milliseconds since the epoch, or -1 if not specified

hashCode

Added in API level 1
open fun hashCode(): Int

Returns the hash code value for this entry.

Return
Int a hash code value for this object.

isDirectory

Added in API level 1
open fun isDirectory(): Boolean

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

Return
Boolean true if this is a directory entry

setComment

Added in API level 1
open fun setComment(comment: String!): Unit

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
open fun setCompressedSize(csize: Long): Unit

Sets the size of the compressed entry data.

Parameters
csize Long: the compressed size to set to

setCrc

Added in API level 1
open fun setCrc(crc: Long): Unit

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

Parameters
crc Long: the CRC-32 value
Exceptions
java.lang.IllegalArgumentException if the specified CRC-32 value is less than 0 or greater than 0xFFFFFFFF

See Also

setCreationTime

Added in API level 26
open fun setCreationTime(time: FileTime!): ZipEntry!

Sets the creation time of the entry.

If set, the creation time will be stored into the extended timestamp fields of entry's optional extra data, when output to a ZIP file or ZIP file formatted stream.

Parameters
time FileTime!: The creation time of the entry
Return
ZipEntry! This zip entry
Exceptions
java.lang.NullPointerException if the time is null

setExtra

Added in API level 1
open fun setExtra(extra: ByteArray!): Unit

Sets the optional extra field data for the entry.

Invoking this method may change this entry's last modification time, last access time and creation time, if the extra field data includes the extensible timestamp fields, such as NTFS tag 0x0001 or Info-ZIP Extended Timestamp, as specified in Info-ZIP Application Note 970311.

Parameters
extra ByteArray!: The extra field data bytes
Exceptions
java.lang.IllegalArgumentException if the length of the specified extra field data is greater than 0xFFFF bytes

See Also

setLastAccessTime

Added in API level 26
open fun setLastAccessTime(time: FileTime!): ZipEntry!

Sets the last access time of the entry.

If set, the last access time will be stored into the extended timestamp fields of entry's optional extra data, when output to a ZIP file or ZIP file formatted stream.

Parameters
time FileTime!: The last access time of the entry
Return
ZipEntry! This zip entry
Exceptions
java.lang.NullPointerException if the time is null

setLastModifiedTime

Added in API level 26
open fun setLastModifiedTime(time: FileTime!): ZipEntry!

Sets the last modification time of the entry.

When output to a ZIP file or ZIP file formatted output stream the last modification time set by this method will be stored into zip file entry's date and time fields in standard MS-DOS date and time format), and the extended timestamp fields in optional extra data in UTC time.

Parameters
time FileTime!: The last modification time of the entry
Return
ZipEntry! This zip entry
Exceptions
java.lang.NullPointerException if the time is null

setMethod

Added in API level 1
open fun setMethod(method: Int): Unit

Sets the compression method for the entry.

Parameters
method Int: the compression method, either STORED or DEFLATED
Exceptions
java.lang.IllegalArgumentException if the specified compression method is invalid

See Also

setSize

Added in API level 1
open fun setSize(size: Long): Unit

Sets the uncompressed size of the entry data.

Parameters
size Long: the uncompressed size in bytes
Exceptions
java.lang.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
open fun setTime(time: Long): Unit

Sets the last modification time of the entry.

If the entry is output to a ZIP file or ZIP file formatted output stream the last modification time set by this method will be stored into the date and time fields of the zip file entry and encoded in standard MS-DOS date and time format. The default TimeZone is used to convert the epoch time to the MS-DOS data and time.

Parameters
time Long: The last modification time of the entry in milliseconds since the epoch

toString

Added in API level 1
open fun toString(): String

Returns a string representation of the ZIP entry.

Return
String a string representation of the object.