Added in API level 1

ZipEntry

open class ZipEntry : Cloneable

kotlin.Any
↳	java.util.zip.ZipEntry

Known Direct Subclasses

JarEntry

This class is used to represent a JAR file entry.

This class is used to represent a ZIP file entry.

Summary

Constants
static Int	`CENATT` Central directory (CEN) header internal file attributes field offset.
static Int	`CENATX` Central directory (CEN) header external file attributes field offset.
static Int	`CENCOM` Central directory (CEN) header comment length field offset.
static Int	`CENCRC` Central directory (CEN) header uncompressed file crc-32 value field offset.
static Int	`CENDSK` Central directory (CEN) header disk number start field offset.
static Int	`CENEXT` Central directory (CEN) header extra field length field offset.
static Int	`CENFLG` Central directory (CEN) header encrypt, decrypt flags field offset.
static Int	`CENHDR` Central directory (CEN) header size in bytes (including signature).
static Int	`CENHOW` Central directory (CEN) header compression method field offset.
static Int	`CENLEN` Central directory (CEN) header uncompressed size field offset.
static Int	`CENNAM` Central directory (CEN) header filename length field offset.
static Int	`CENOFF` Central directory (CEN) header LOC header offset field offset.
static Long	`CENSIG` Central directory (CEN) header signature.
static Int	`CENSIZ` Central directory (CEN) header compressed size field offset.
static Int	`CENTIM` Central directory (CEN) header modification time field offset.
static Int	`CENVEM` Central directory (CEN) header version made by field offset.
static Int	`CENVER` Central directory (CEN) header version needed to extract field offset.
static Int	`DEFLATED` Compression method for compressed (deflated) entries.
static Int	`ENDCOM` End of central directory (END) header zip file comment length field offset.
static Int	`ENDHDR` End of central directory (END) header size in bytes (including signature).
static Int	`ENDOFF` End of central directory (END) header offset for the first CEN header field offset.
static Long	`ENDSIG` End of central directory (END) header signature.
static Int	`ENDSIZ` End of central directory (END) header central directory size in bytes field offset.
static Int	`ENDSUB` End of central directory (END) header number of entries on this disk field offset.
static Int	`ENDTOT` End of central directory (END) header total number of entries field offset.
static Int	`EXTCRC` Extra local (EXT) header uncompressed file crc-32 value field offset.
static Int	`EXTHDR` Extra local (EXT) header size in bytes (including signature).
static Int	`EXTLEN` Extra local (EXT) header uncompressed size field offset.
static Long	`EXTSIG` Extra local (EXT) header signature.
static Int	`EXTSIZ` Extra local (EXT) header compressed size field offset.
static Int	`LOCCRC` Local file (LOC) header uncompressed file crc-32 value field offset.
static Int	`LOCEXT` Local file (LOC) header extra field length field offset.
static Int	`LOCFLG` Local file (LOC) header general purpose bit flag field offset.
static Int	`LOCHDR` Local file (LOC) header size in bytes (including signature).
static Int	`LOCHOW` Local file (LOC) header compression method field offset.
static Int	`LOCLEN` Local file (LOC) header uncompressed size field offset.
static Int	`LOCNAM` Local file (LOC) header filename length field offset.
static Long	`LOCSIG` Local file (LOC) header signature.
static Int	`LOCSIZ` Local file (LOC) header compressed size field offset.
static Int	`LOCTIM` Local file (LOC) header modification time field offset.
static Int	`LOCVER` Local file (LOC) header version needed to extract field offset.
static Int	`STORED` Compression method for uncompressed entries.

Public constructors
`ZipEntry(name: String!)` Creates a new zip entry with the specified name.
`ZipEntry(e: ZipEntry!)` Creates a new zip entry with fields taken from the specified zip entry.

Public methods
open Any	`clone()` Returns a copy of this entry.
open String!	`getComment()` Returns the comment string for the entry.
open Long	`getCompressedSize()` Returns the size of the compressed entry data.
open Long	`getCrc()` Returns the CRC-32 checksum of the uncompressed entry data.
open FileTime!	`getCreationTime()` Returns the creation time of the entry.
open ByteArray!	`getExtra()` Returns the extra field data for the entry.
open FileTime!	`getLastAccessTime()` Returns the last access time of the entry.
open FileTime!	`getLastModifiedTime()` Returns the last modification time of the entry.
open Int	`getMethod()` Returns the compression method of the entry.
open String!	`getName()` Returns the name of the entry.
open Long	`getSize()` Returns the uncompressed size of the entry data.
open Long	`getTime()` Returns the last modification time of the entry.
open LocalDateTime!	`getTimeLocal()` Returns the last modification time of the entry in local date-time.
open Int	`hashCode()` Returns the hash code value for this entry.
open Boolean	`isDirectory()` Returns true if this is a directory entry.
open Unit	`setComment(comment: String!)` Sets the optional comment string for the entry.
open Unit	`setCompressedSize(csize: Long)` 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!	`setCreationTime(time: FileTime!)` Sets the creation time of the entry.
open Unit	`setExtra(extra: ByteArray!)` Sets the optional extra field data for the entry.
open ZipEntry!	`setLastAccessTime(time: FileTime!)` Sets the last access time of the entry.
open ZipEntry!	`setLastModifiedTime(time: FileTime!)` 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 Unit	`setTimeLocal(time: LocalDateTime!)` Sets the last modification time of the entry in local date-time.
open String	`toString()` Returns a string representation of the ZIP entry.

Constants

CENATT

Added in API level 21

static val CENATT: Int

Central directory (CEN) header internal file attributes field offset.

Value: 36

CENATX

Added in API level 21

static val CENATX: Int

Central directory (CEN) header external file attributes field offset.

Value: 38

CENCOM

Added in API level 21

static val CENCOM: Int

Central directory (CEN) header comment length field offset.

Value: 32

CENCRC

Added in API level 21

static val CENCRC: Int

Central directory (CEN) header uncompressed file crc-32 value field offset.

Value: 16

CENDSK

Added in API level 21

static val CENDSK: Int

Central directory (CEN) header disk number start field offset.

Value: 34

CENEXT

Added in API level 21

static val CENEXT: Int

Central directory (CEN) header extra field length field offset.

Value: 30

CENFLG

Added in API level 21

static val CENFLG: Int

Central directory (CEN) header encrypt, decrypt flags field offset.

Value: 8

CENHDR

Added in API level 21

static val CENHDR: Int

Central directory (CEN) header size in bytes (including signature).

Value: 46

CENHOW

Added in API level 21

static val CENHOW: Int

Central directory (CEN) header compression method field offset.

Value: 10

CENLEN

Added in API level 21

static val CENLEN: Int

Central directory (CEN) header uncompressed size field offset.

Value: 24

CENNAM

Added in API level 21

static val CENNAM: Int

Central directory (CEN) header filename length field offset.

Value: 28

CENOFF

Added in API level 21

static val CENOFF: Int

Central directory (CEN) header LOC header offset field offset.

Value: 42

CENSIG

Added in API level 21

static val CENSIG: Long

Central directory (CEN) header signature.

Value: 33639248L

CENSIZ

Added in API level 21

static val CENSIZ: Int

Central directory (CEN) header compressed size field offset.

Value: 20

CENTIM

Added in API level 21

static val CENTIM: Int

Central directory (CEN) header modification time field offset.

Value: 12

CENVEM

Added in API level 21

static val CENVEM: Int

Central directory (CEN) header version made by field offset.

Value: 4

CENVER

Added in API level 21

static val CENVER: Int

Central directory (CEN) header version needed to extract field offset.

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

End of central directory (END) header zip file comment length field offset.

Value: 20

ENDHDR

Added in API level 21

static val ENDHDR: Int

End of central directory (END) header size in bytes (including signature).

Value: 22

ENDOFF

Added in API level 21

static val ENDOFF: Int

End of central directory (END) header offset for the first CEN header field offset.

Value: 16

ENDSIG

Added in API level 21

static val ENDSIG: Long

End of central directory (END) header signature.

Value: 101010256L

ENDSIZ

Added in API level 21

static val ENDSIZ: Int

End of central directory (END) header central directory size in bytes field offset.

Value: 12

ENDSUB

Added in API level 21

static val ENDSUB: Int

End of central directory (END) header number of entries on this disk field offset.

Value: 8

ENDTOT

Added in API level 21

static val ENDTOT: Int

End of central directory (END) header total number of entries field offset.

Value: 10

EXTCRC

Added in API level 21

static val EXTCRC: Int

Extra local (EXT) header uncompressed file crc-32 value field offset.

Value: 4

EXTHDR

Added in API level 21

static val EXTHDR: Int

Extra local (EXT) header size in bytes (including signature).

Value: 16

EXTLEN

Added in API level 21

static val EXTLEN: Int

Extra local (EXT) header uncompressed size field offset.

Value: 12

EXTSIG

Added in API level 21

static val EXTSIG: Long

Extra local (EXT) header signature.

Value: 134695760L

EXTSIZ

Added in API level 21

static val EXTSIZ: Int

Extra local (EXT) header compressed size field offset.

Value: 8

LOCCRC

Added in API level 21

static val LOCCRC: Int

Local file (LOC) header uncompressed file crc-32 value field offset.

Value: 14

LOCEXT

Added in API level 21

static val LOCEXT: Int

Local file (LOC) header extra field length field offset.

Value: 28

LOCFLG

Added in API level 21

static val LOCFLG: Int

Local file (LOC) header general purpose bit flag field offset.

Value: 6

LOCHDR

Added in API level 21

static val LOCHDR: Int

Local file (LOC) header size in bytes (including signature).

Value: 30

LOCHOW

Added in API level 21

static val LOCHOW: Int

Local file (LOC) header compression method field offset.

Value: 8

LOCLEN

Added in API level 21

static val LOCLEN: Int

Local file (LOC) header uncompressed size field offset.

Value: 22

LOCNAM

Added in API level 21

static val LOCNAM: Int

Local file (LOC) header filename length field offset.

Value: 26

LOCSIG

Added in API level 21

static val LOCSIG: Long

Local file (LOC) header signature.

Value: 67324752L

LOCSIZ

Added in API level 21

static val LOCSIZ: Int

Local file (LOC) header compressed size field offset.

Value: 18

LOCTIM

Added in API level 21

static val LOCTIM: Int

Local file (LOC) header modification time field offset.

Value: 10

LOCVER

Added in API level 21

static val LOCVER: Int

Local file (LOC) header version needed to extract field offset.

Value: 4

STORED

Added in API level 1

static val STORED: Int

Compression method for uncompressed entries.

Value: 0

Public constructors

ZipEntry

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

ZipEntry

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

See Also

#setComment(String)

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

See Also

#setCompressedSize(long)

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

#setCrc(long)

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

See Also

#setCreationTime(FileTime)

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

See Also

#setExtra(byte[])

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

See Also

#setLastAccessTime(FileTime)

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 default TimeZone 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

See Also

#setLastModifiedTime(FileTime)

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

#setMethod(int)

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

#setSize(long)

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

See Also

#setTime(long)
#setLastModifiedTime(FileTime)

getTimeLocal

Added in API level 35

open fun getTimeLocal(): LocalDateTime!

Returns the last modification time of the entry in local date-time.

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 entry's standard MS-DOS formatted date and time fields.

The system default TimeZone is used to convert the UTC time to local date-time.

Return
`LocalDateTime!`	The last modification time of the entry in local date-time

See Also

#setTimeLocal(LocalDateTime)

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

#getComment()

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

See Also

#getCompressedSize()

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

#getCrc()

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

See Also

#getCreationTime()

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

#getExtra()

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

See Also

#getLastAccessTime()

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

See Also

#getLastModifiedTime()

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

#getMethod()

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

#getSize()

setTime

Added in API level 1

open fun setTime(time: Long): Unit

Sets the last modification time of the entry.

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

See Also

#getTime()
#getLastModifiedTime()

setTimeLocal

Added in API level 35

open fun setTimeLocal(time: LocalDateTime!): Unit

Sets the last modification time of the entry in local date-time.

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. If the date-time set is out of the range of the standard MS-DOS date and time format, the time will also be stored into zip file entry's extended timestamp fields in optional extra data in UTC time. The system default TimeZone is used to convert the local date-time to UTC time.

LocalDateTime uses a precision of nanoseconds, whereas this class uses a precision of milliseconds. The conversion will truncate any excess precision information as though the amount in nanoseconds was subject to integer division by one million.

Parameters
`time`	LocalDateTime!: The last modification time of the entry in local date-time

See Also

#getTimeLocal()

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.