Class ScatterZipOutputStream
java.lang.Object
org.apache.commons.compress.archivers.zip.ScatterZipOutputStream
- All Implemented Interfaces:
Closeable,AutoCloseable
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
-
Nested Class Summary
Nested Classes -
Constructor Summary
ConstructorsConstructorDescriptionScatterZipOutputStream(ScatterGatherBackingStore backingStore, StreamCompressor streamCompressor) -
Method Summary
Modifier and TypeMethodDescriptionvoidaddArchiveEntry(ZipArchiveEntryRequest zipArchiveEntryRequest) Adds an archive entry to this scatter stream.voidclose()Closes this stream, freeing all resources involved in the creation of this stream.static ScatterZipOutputStreamCreates aScatterZipOutputStreamwith default compression level that is backed by a filestatic ScatterZipOutputStreamCreates aScatterZipOutputStreamthat is backed by a filestatic ScatterZipOutputStreamCreates aScatterZipOutputStreamwith default compression level that is backed by a filestatic ScatterZipOutputStreamCreates aScatterZipOutputStreamthat is backed by a filevoidwriteTo(ZipArchiveOutputStream target) Writes the contents of this scatter stream to a target archive.Gets a ZIP entry writer for this scatter stream.
-
Constructor Details
-
ScatterZipOutputStream
public ScatterZipOutputStream(ScatterGatherBackingStore backingStore, StreamCompressor streamCompressor)
-
-
Method Details
-
fileBased
Creates aScatterZipOutputStreamwith default compression level that is backed by a file- Parameters:
file- The file to offload compressed data into.- Returns:
- A ScatterZipOutputStream that is ready for use.
- Throws:
FileNotFoundException- if the file cannot be found
-
fileBased
public static ScatterZipOutputStream fileBased(File file, int compressionLevel) throws FileNotFoundException Creates aScatterZipOutputStreamthat is backed by a file- Parameters:
file- The file to offload compressed data into.compressionLevel- The compression level to use, @see #Deflater- Returns:
- A ScatterZipOutputStream that is ready for use.
- Throws:
FileNotFoundException- if the file cannot be found
-
pathBased
Creates aScatterZipOutputStreamwith default compression level that is backed by a file- Parameters:
path- The path to offload compressed data into.- Returns:
- A ScatterZipOutputStream that is ready for use.
- Throws:
FileNotFoundException- if the path cannot be found- Since:
- 1.22
-
pathBased
public static ScatterZipOutputStream pathBased(Path path, int compressionLevel) throws FileNotFoundException Creates aScatterZipOutputStreamthat is backed by a file- Parameters:
path- The path to offload compressed data into.compressionLevel- The compression level to use, @see #Deflater- Returns:
- A ScatterZipOutputStream that is ready for use.
- Throws:
FileNotFoundException- if the path cannot be found- Since:
- 1.22
-
addArchiveEntry
Adds an archive entry to this scatter stream.- Parameters:
zipArchiveEntryRequest- The entry to write.- Throws:
IOException- If writing fails
-
close
Closes this stream, freeing all resources involved in the creation of this stream.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Throws:
IOException- If closing fails
-
writeTo
Writes the contents of this scatter stream to a target archive.- Parameters:
target- The archive to receive the contents of thisScatterZipOutputStream.- Throws:
IOException- If writing fails- See Also:
-
zipEntryWriter
Gets a ZIP entry writer for this scatter stream.- Returns:
- the ZipEntryWriter created on first call of the method
- Throws:
IOException- If getting scatter stream input stream
-