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

ZipArchiveOutputStream

open class ZipArchiveOutputStream : ArchiveOutputStream

Reimplementation of java.util.zip.ZipOutputStream that does handle the extended functionality of this package, especially internal/external file attributes and extra fields with different layouts for local file data and central directory entries.

This class will try to use java.nio.channels.SeekableByteChannel when it knows that the output is going to go to a file and no split archive shall be created.

If SeekableByteChannel cannot be used, this implementation will use a Data Descriptor to store size and CRC information for DEFLATED entries, this means, you don't need to calculate them yourself. Unfortunately this is not possible for the STORED method, here setting the CRC and uncompressed size information is required before putArchiveEntry can be called.

As of Apache Commons Compress 1.3 it transparently supports Zip64 extensions and thus individual entries and archives larger than 4 GB or with more than 65536 entries in most cases but explicit control is provided via setUseZip64. If the stream can not use SeekableByteChannel and you try to write a ZipArchiveEntry of unknown size then Zip64 extensions will be disabled by default.

Constructors

ZipArchiveOutputStream

constructor(out: OutputStream)

Creates a new ZIP OutputStream filtering the underlying stream.

constructor(file: File, zipSplitSize: Long)

Creates a split ZIP Archive.

constructor(channel: SeekableByteChannel)

Creates a new ZIP OutputStream writing to a SeekableByteChannel.

Types

UnicodeExtraFieldPolicy

class UnicodeExtraFieldPolicy

enum that represents the possible policies for creating Unicode extra fields.

Properties

DEFAULT_COMPRESSION

val DEFAULT_COMPRESSION: Int = -1

Default compression level for deflated entries.

val DEFLATED: Int = 8

Compression method for deflated entries.

open var encoding: String

The encoding to use for file names and the file comment.

val STORED: Int = 0

Compression method for stored entries.

Functions

addRawArchiveEntry

open fun addRawArchiveEntry(entry: ZipArchiveEntry, rawStream: InputStream)

Adds an archive entry with a raw input stream.

canWriteEntryData

open fun canWriteEntryData(ae: ArchiveEntry): Boolean

Whether this stream is able to write the given entry.

open fun close()

Closes this output stream and releases any system resources associated with the stream.

closeArchiveEntry

open fun closeArchiveEntry()

Writes all necessary data for this entry.

createArchiveEntry

open fun createArchiveEntry(inputFile: File, entryName: String): ArchiveEntry

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

open fun finish()

Finishes the addition of entries to this stream, without closing it.

open fun flush()

Flushes this output stream and forces any buffered output bytes to be written out to the stream.

getBytesWritten

open fun getBytesWritten(): Long

Returns the total number of bytes written to this stream.

open fun isSeekable(): Boolean

This method indicates whether this archive is writing to a seekable stream (i.e., to a random access file).

nullOutputStream

open fun nullOutputStream(): OutputStream

putArchiveEntry

open fun putArchiveEntry(archiveEntry: ArchiveEntry)

Writes the headers for an archive entry to the output stream.

open fun setComment(comment: String)

Set the file comment.

setCreateUnicodeExtraFields

open fun setCreateUnicodeExtraFields(b: ZipArchiveOutputStream.UnicodeExtraFieldPolicy)

Whether to create Unicode Extra Fields.

setFallbackToUTF8

open fun setFallbackToUTF8(b: Boolean)

Whether to fall back to UTF and the language encoding flag if the file name cannot be encoded using the specified encoding.

open fun setLevel(level: Int)

Sets the compression level for subsequent entries.

open fun setMethod(method: Int)

Sets the default compression method for subsequent entries.

setUseLanguageEncodingFlag

open fun setUseLanguageEncodingFlag(b: Boolean)

Whether to set the language encoding flag if the file name encoding is UTF-8.

open fun setUseZip64(mode: Zip64Mode)

Whether Zip64 extensions will be used.

open fun write(b: Array<Byte>)

open fun write(b: Int)

Writes a byte to the current archive entry.

open fun write(b: Array<Byte>, offset: Int, length: Int)

Writes bytes to ZIP entry.

open fun writePreamble(preamble: Array<Byte>)

open fun writePreamble(preamble: Array<Byte>, offset: Int, length: Int)

Write preamble data.