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

ScatterZipOutputStream

open class ScatterZipOutputStream : Closeable

A zip output stream that is optimized for multi-threaded scatter/gather construction of zip files.

The internal data format of the entries used by this class are entirely private to this class and are not part of any public api whatsoever.

It is possible to extend this class to support different kinds of backing storage, the default implementation only supports file-based backing.

Thread safety: This class supports multiple threads. But the "writeTo" method must be called by the thread that originally created the ZipArchiveEntry.

Since

1.10

Constructors

ScatterZipOutputStream

constructor(backingStore: ScatterGatherBackingStore, streamCompressor: StreamCompressor)

Types

ZipEntryWriter

open class ZipEntryWriter : Closeable

Functions

addArchiveEntry

open fun addArchiveEntry(zipArchiveEntryRequest: ZipArchiveEntryRequest)

Add an archive entry to this scatter stream.

open fun close()

Closes this stream, freeing all resources involved in the creation of this stream.

writeTo

open fun writeTo(target: ZipArchiveOutputStream)

Write the contents of this scatter stream to a target archive.

zipEntryWriter

open fun zipEntryWriter(): ScatterZipOutputStream.ZipEntryWriter

Get a zip entry writer for this scatter stream.