readium-shared/org.readium.r2.shared.util.zip.compress.archivers.zip/ZipArchiveEntry

ZipArchiveEntry

open class ZipArchiveEntry : ZipEntry, ArchiveEntry, EntryStreamOffsets

Extension that adds better handling of extra fields and provides access to the internal and external file attributes.

The extra data is expected to follow the recommendation of APPNOTE.TXT:

the extra byte array consists of a sequence of extra fields
each extra fields starts by a two byte header id followed by a two byte sequence holding the length of the remainder of data.

Any extra data that cannot be parsed by the rules above will be consumed as "unparseable" extra data and treated differently by the methods of this class. Versions prior to Apache Commons Compress 1.1 would have thrown an exception if any attempt was made to read or write extra data not conforming to the recommendation.

Constructors

ZipArchiveEntry

constructor(inputFile: File, entryName: String)

Creates a new ZIP entry taking some information from the given file and using the provided name.

constructor(entry: ZipEntry)

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

constructor(name: String)

Creates a new ZIP entry with the specified name.

constructor(entry: ZipArchiveEntry)

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

Types

CommentSource

enum CommentSource

Indicates how the comment of this entry has been determined.

ExtraFieldParsingMode

enum ExtraFieldParsingMode : ExtraFieldParsingBehavior

How to try to parse the extra fields.

NameSource

enum NameSource

Indicates how the name of this entry has been determined.

Properties

alignment

protected open var alignment: Int

val CENATT: Int = 36

val CENATX: Int = 38

val CENCOM: Int = 32

val CENCRC: Int = 16

val CENDSK: Int = 34

val CENEXT: Int = 30

val CENFLG: Int = 8

val CENHDR: Int = 46

val CENHOW: Int = 10

val CENLEN: Int = 24

val CENNAM: Int = 28

val CENOFF: Int = 42

val CENSIG: Long = 33639248

val CENSIZ: Int = 20

val CENTIM: Int = 12

val CENVEM: Int = 4

val CENVER: Int = 6

open var commentSource: ZipArchiveEntry.CommentSource

CRC_UNKNOWN

val CRC_UNKNOWN: Int = -1

dataOffset

open var dataOffset: Long

DEFLATED

val DEFLATED: Int = 8

diskNumberStart

open var diskNumberStart: Long

val ENDCOM: Int = 20

val ENDHDR: Int = 22

val ENDOFF: Int = 16

val ENDSIG: Long = 101010256

val ENDSIZ: Int = 12

val ENDSUB: Int = 8

val ENDTOT: Int = 10

val EXTCRC: Int = 4

open var externalAttributes: Long

EXTHDR

val EXTHDR: Int = 16

EXTLEN

val EXTLEN: Int = 12

extraFields

open var extraFields: Array<ZipExtraField>

EXTSIG

val EXTSIG: Long = 134695760

EXTSIZ

val EXTSIZ: Int = 8

internalAttributes

open var internalAttributes: Int

isStreamContiguous

open var isStreamContiguous: Boolean

val LOCCRC: Int = 14

val LOCEXT: Int = 28

val LOCFLG: Int = 6

val LOCHDR: Int = 30

val LOCHOW: Int = 8

val LOCLEN: Int = 22

val LOCNAM: Int = 26

val LOCSIG: Long = 67324752

val LOCSIZ: Int = 18

val LOCTIM: Int = 10

val LOCVER: Int = 4

open var method: Int

The java.util.zip.ZipEntry base class only supports the compression methods STORED and DEFLATED.

name

open var name: String

nameSource

open var nameSource: ZipArchiveEntry.NameSource

OFFSET_UNKNOWN

val OFFSET_UNKNOWN: Long = -1

Special value indicating that the offset is unknown.

platform

open var platform: Int

PLATFORM_FAT

val PLATFORM_FAT: Int = 0

PLATFORM_UNIX

val PLATFORM_UNIX: Int = 3

rawFlag

open var rawFlag: Int

rawName

open val rawName: Array<Byte>

size

open var size: Long

The setSize method in the base class throws an IllegalArgumentException if the size is bigger than 2GB for Java versions <7 and even in Java 7+ if the implementation in java.util.zip doesn't support Zip64 itself (it is an optional feature).

SIZE_UNKNOWN

val SIZE_UNKNOWN: Long = -1

Special value indicating that the size is unknown

STORED

val STORED: Int = 0

time

open var time: Long

versionMadeBy

open var versionMadeBy: Int

versionRequired

open var versionRequired: Int