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

Inherited constants

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

Public constructors
JarEntry(name: String!) Creates a new JarEntry for the specified JAR file entry name.
JarEntry(je: JarEntry!) Creates a new JarEntry with fields taken from the specified JarEntry object.
JarEntry(ze: ZipEntry!) Creates a new JarEntry with fields taken from the specified ZipEntry 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.
open String!	getRealName() This method returns the same name that getName() returns.

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 default TimeZone 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. LocalDateTime! getTimeLocal() 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. 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. Unit setTimeLocal(time: LocalDateTime!) 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. String toString() Returns a string representation of the ZIP entry.

Public constructors

JarEntry

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.IllegalArgumentException	if the entry name is longer than 0xFFFF bytes.
java.lang.NullPointerException	if the entry name is null

JarEntry

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

JarEntry

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

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.

getRealName

Added in API level 33

open fun getRealName(): String!

This method returns the same name that getName() returns.

Return
String!	the real name of the JarEntry