Package org.apache.commons.compress.archivers.zip

Class ScatterZipOutputStream

java.lang.Object

org.apache.commons.compress.archivers.zip.ScatterZipOutputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class ScatterZipOutputStream
extends Object
implements 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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ScatterZipOutputStream.CompressedEntry
static class	ScatterZipOutputStream.ZipEntryWriter

Field Summary

Fields

Modifier and Type	Field	Description
private final ScatterGatherBackingStore	backingStore
private final AtomicBoolean	isClosed
private final Queue<ScatterZipOutputStream.CompressedEntry>	items
private final StreamCompressor	streamCompressor
private ScatterZipOutputStream.ZipEntryWriter	zipEntryWriter

Constructor Summary

Constructors

Constructor	Description
ScatterZipOutputStream(ScatterGatherBackingStore backingStore, StreamCompressor streamCompressor)

Method Summary

Modifier and Type	Method	Description
void	addArchiveEntry(ZipArchiveEntryRequest zipArchiveEntryRequest)	Add 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)	Create a ScatterZipOutputStream with default compression level that is backed by a file
static ScatterZipOutputStream	fileBased(File file, int compressionLevel)	Create a ScatterZipOutputStream that is backed by a file
void	writeTo(ZipArchiveOutputStream target)	Write the contents of this scatter stream to a target archive.
ScatterZipOutputStream.ZipEntryWriter	zipEntryWriter()	Get a zip entry writer for this scatter stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

items

private final Queue<ScatterZipOutputStream.CompressedEntry> items

backingStore

private final ScatterGatherBackingStore backingStore

streamCompressor

private final StreamCompressor streamCompressor

isClosed

private final AtomicBoolean isClosed

zipEntryWriter

private ScatterZipOutputStream.ZipEntryWriter zipEntryWriter

Constructor Details

ScatterZipOutputStream

public ScatterZipOutputStream(ScatterGatherBackingStore backingStore,
 StreamCompressor streamCompressor)

Method Details

addArchiveEntry

public void addArchiveEntry(ZipArchiveEntryRequest zipArchiveEntryRequest)
                     throws IOException

Add an archive entry to this scatter stream.

Parameters:

zipArchiveEntryRequest - The entry to write.

Throws:

IOException - If writing fails

writeTo

public void writeTo(ZipArchiveOutputStream target)
             throws IOException

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

Parameters:

target - The archive to receive the contents of this ScatterZipOutputStream.

Throws:

IOException - If writing fails

See Also:

• zipEntryWriter()

zipEntryWriter

public ScatterZipOutputStream.ZipEntryWriter zipEntryWriter()
                                                     throws IOException

Get 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

close

public void close()
           throws IOException

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

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - If closing fails

fileBased

public static ScatterZipOutputStream fileBased(File file)
                                        throws FileNotFoundException

Create a ScatterZipOutputStream with 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

Create a ScatterZipOutputStream that 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