Added in API level 1

JarEntry

open class JarEntry : ZipEntry

kotlin.Any
↳	java.util.zip.ZipEntry
	↳	java.util.jar.JarEntry

This class is used to represent a JAR file entry.

Summary

Constants
static Int	`CENATT`
static Int	`CENATX`
static Int	`CENCOM`
static Int	`CENCRC`
static Int	`CENDSK`
static Int	`CENEXT`
static Int	`CENFLG`
static Int	`CENHDR`
static Int	`CENHOW`
static Int	`CENLEN`
static Int	`CENNAM`
static Int	`CENOFF`
static Long	`CENSIG`
static Int	`CENSIZ`
static Int	`CENTIM`
static Int	`CENVEM`
static Int	`CENVER`
static Int	`ENDCOM`
static Int	`ENDHDR`
static Int	`ENDOFF`
static Long	`ENDSIG`
static Int	`ENDSIZ`
static Int	`ENDSUB`
static Int	`ENDTOT`
static Int	`EXTCRC`
static Int	`EXTHDR`
static Int	`EXTLEN`
static Long	`EXTSIG`
static Int	`EXTSIZ`
static Int	`LOCCRC`
static Int	`LOCEXT`
static Int	`LOCFLG`
static Int	`LOCHDR`
static Int	`LOCHOW`
static Int	`LOCLEN`
static Int	`LOCNAM`
static Long	`LOCSIG`
static Int	`LOCSIZ`
static Int	`LOCTIM`
static Int	`LOCVER`

Inherited constants

From class ZipEntry

Int

DEFLATED

Compression method for compressed (deflated) entries.

Int

STORED

Compression method for uncompressed entries.

Public constructors
`<init>(name: String!)` Creates a new `JarEntry` for the specified JAR file entry name.
`<init>(ze: ZipEntry!)` Creates a new `JarEntry` with fields taken from the specified `ZipEntry` object.
`<init>(je: JarEntry!)` Creates a new `JarEntry` with fields taken from the specified `JarEntry` object.

Public methods
open Attributes!	`getAttributes()` Returns the `Manifest` `Attributes` for this entry, or `null` if none.
open Array<Certificate!>!	`getCertificates()` Returns the `Certificate` objects for this entry, or `null` if none.
open Array<CodeSigner!>!	`getCodeSigners()` Returns the `CodeSigner` objects for this entry, or `null` if none.

Inherited functions

From class ZipEntry

`Any`	`clone()` Returns a copy of this entry.
`String!`	`getComment()` Returns the comment string for the entry.
`Long`	`getCompressedSize()` 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.
`Long`	`getCrc()` Returns the CRC-32 checksum of the uncompressed entry data.
`FileTime!`	`getCreationTime()` 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.
`ByteArray!`	`getExtra()` Returns the extra field data for the entry.
`FileTime!`	`getLastAccessTime()` 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.
`FileTime!`	`getLastModifiedTime()` 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.
`Int`	`getMethod()` Returns the compression method of the entry.
`String!`	`getName()` Returns the name of the entry.
`Long`	`getSize()` Returns the uncompressed size of the entry data.
`Long`	`getTime()` 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.
`Int`	`hashCode()` Returns the hash code value for this entry.
`Boolean`	`isDirectory()` Returns true if this is a directory entry. A directory entry is defined to be one whose name ends with a '/'.
`Unit`	`setComment(comment: String!)` 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.
`Unit`	`setCompressedSize(csize: Long)` Sets the size of the compressed entry data.
`Unit`	`setCrc(crc: Long)` Sets the CRC-32 checksum of the uncompressed entry data.
`ZipEntry!`	`setCreationTime(time: FileTime!)` 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.
`Unit`	`setExtra(extra: ByteArray!)` 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.
`ZipEntry!`	`setLastAccessTime(time: FileTime!)` 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.
`ZipEntry!`	`setLastModifiedTime(time: FileTime!)` 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.
`Unit`	`setMethod(method: Int)` Sets the compression method for the entry.
`Unit`	`setSize(size: Long)` Sets the uncompressed size of the entry data.
`Unit`	`setTime(time: Long)` 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.
`String`	`toString()` 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

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

Public constructors

<init>

Added in API level 1

JarEntry(name: String!)

Creates a new JarEntry for the specified JAR file entry name.

Parameters
`name`	String!: the JAR file 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

JarEntry(ze: ZipEntry!)

Creates a new JarEntry with fields taken from the specified ZipEntry object.

Parameters
`ze`	ZipEntry!: the `ZipEntry` object to create the `JarEntry` from

<init>

Added in API level 1

JarEntry(je: JarEntry!)

Creates a new JarEntry with fields taken from the specified JarEntry object.

Parameters
`je`	JarEntry!: the `JarEntry` to copy

Public methods

getAttributes

Added in API level 1

open fun getAttributes(): Attributes!

Returns the Manifest Attributes for this entry, or null if none.

Return
`Attributes!`	the `Manifest` `Attributes` for this entry, or `null` if none

Exceptions
`java.io.IOException`	if an I/O error has occurred

getCertificates

Added in API level 1

open fun getCertificates(): Array<Certificate!>!

Returns the Certificate objects for this entry, or null if none. This method can only be called once the JarEntry has been completely verified by reading from the entry input stream until the end of the stream has been reached. Otherwise, this method will return null.

The returned certificate array comprises all the signer certificates that were used to verify this entry. Each signer certificate is followed by its supporting certificate chain (which may be empty). Each signer certificate and its supporting certificate chain are ordered bottom-to-top (i.e., with the signer certificate first and the (root) certificate authority last).

Return
`Array<Certificate!>!`	the `Certificate` objects for this entry, or `null` if none.

getCodeSigners

Added in API level 1

open fun getCodeSigners(): Array<CodeSigner!>!

Returns the CodeSigner objects for this entry, or null if none. This method can only be called once the JarEntry has been completely verified by reading from the entry input stream until the end of the stream has been reached. Otherwise, this method will return null.

The returned array comprises all the code signers that have signed this entry.

Return
`Array<CodeSigner!>!`	the `CodeSigner` objects for this entry, or `null` if none.