public class ScatterZipOutputStream extends Object implements Closeable
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
.
Modifier and Type | Class and Description |
---|---|
static class |
ScatterZipOutputStream.ZipEntryWriter |
Constructor and Description |
---|
ScatterZipOutputStream(ScatterGatherBackingStore backingStore,
StreamCompressor streamCompressor) |
Modifier and Type | Method and Description |
---|---|
void |
addArchiveEntry(ZipArchiveEntryRequest zipArchiveEntryRequest)
Adds an archive entry to this scatter stream.
|
void |
close()
Closes this stream, freeing all resources involved in the creation of this stream.
|
static ScatterZipOutputStream |
fileBased(File file)
Creates a
ScatterZipOutputStream with default compression level that is backed by a file |
static ScatterZipOutputStream |
fileBased(File file,
int compressionLevel)
Creates a
ScatterZipOutputStream that is backed by a file |
static ScatterZipOutputStream |
pathBased(Path path)
Creates a
ScatterZipOutputStream with default compression level that is backed by a file |
static ScatterZipOutputStream |
pathBased(Path path,
int compressionLevel)
Creates a
ScatterZipOutputStream that is backed by a file |
void |
writeTo(ZipArchiveOutputStream target)
Writes the contents of this scatter stream to a target archive.
|
ScatterZipOutputStream.ZipEntryWriter |
zipEntryWriter()
Gets a ZIP entry writer for this scatter stream.
|
public ScatterZipOutputStream(ScatterGatherBackingStore backingStore, StreamCompressor streamCompressor)
public static ScatterZipOutputStream fileBased(File file) throws FileNotFoundException
ScatterZipOutputStream
with default compression level that is backed by a filefile
- The file to offload compressed data into.FileNotFoundException
- if the file cannot be foundpublic static ScatterZipOutputStream fileBased(File file, int compressionLevel) throws FileNotFoundException
ScatterZipOutputStream
that is backed by a filefile
- The file to offload compressed data into.compressionLevel
- The compression level to use, @see #DeflaterFileNotFoundException
- if the file cannot be foundpublic static ScatterZipOutputStream pathBased(Path path) throws FileNotFoundException
ScatterZipOutputStream
with default compression level that is backed by a filepath
- The path to offload compressed data into.FileNotFoundException
- if the path cannot be foundpublic static ScatterZipOutputStream pathBased(Path path, int compressionLevel) throws FileNotFoundException
ScatterZipOutputStream
that is backed by a filepath
- The path to offload compressed data into.compressionLevel
- The compression level to use, @see #DeflaterFileNotFoundException
- if the path cannot be foundpublic void addArchiveEntry(ZipArchiveEntryRequest zipArchiveEntryRequest) throws IOException
zipArchiveEntryRequest
- The entry to write.IOException
- If writing failspublic void close() throws IOException
close
in interface Closeable
close
in interface AutoCloseable
IOException
- If closing failspublic void writeTo(ZipArchiveOutputStream target) throws IOException
target
- The archive to receive the contents of this ScatterZipOutputStream
.IOException
- If writing failszipEntryWriter()
public ScatterZipOutputStream.ZipEntryWriter zipEntryWriter() throws IOException
IOException
- If getting scatter stream input streamCopyright © 2002–2022 The Apache Software Foundation. All rights reserved.