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

ArchiveOutputStream

abstract class ArchiveOutputStream : OutputStream

Archive output stream implementations are expected to override the write method to improve performance. They should also override close to ensure that any necessary trailers are added.

The normal sequence of calls when working with ArchiveOutputStreams is:

Create ArchiveOutputStream object,
optionally write SFX header (Zip only),
repeat as needed:
- putArchiveEntry (writes entry header),
- write (writes entry data, as often as needed),
- closeArchiveEntry (closes entry),
finish (ends the addition of entries),
optionally write additional data, provided format supports it,
close.

Inheritors

ZipArchiveOutputStream

Constructors

ArchiveOutputStream

constructor()

Properties

open val bytesWritten: Long

holds the number of bytes written to this stream

Functions

canWriteEntryData

open fun canWriteEntryData(archiveEntry: ArchiveEntry): Boolean

Whether this stream is able to write the given entry.

open fun close()

closeArchiveEntry

abstract fun closeArchiveEntry()

Closes the archive entry, writing any trailer information that may be required.

createArchiveEntry

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

Create an archive entry using the inputFile and entryName provided.

abstract fun finish()

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

open fun flush()

nullOutputStream

open fun nullOutputStream(): OutputStream

putArchiveEntry

abstract fun putArchiveEntry(entry: ArchiveEntry)

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

open fun write(b: Array<Byte>)

open fun write(b: Int)

Writes a byte to the current archive entry.