net.java.truevfs.comp.zip

Class ZipOutputStream

java.lang.Object

java.io.OutputStream

net.java.truecommons.io.DecoratingOutputStream

net.java.truevfs.comp.zip.AbstractZipOutputStream<ZipEntry>

net.java.truevfs.comp.zip.ZipOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable, java.lang.Iterable<ZipEntry>

@NotThreadSafe
public class ZipOutputStream
extends AbstractZipOutputStream<ZipEntry>

Replacement for java.util.zip.ZipOutputStream.

This class starts writing ordinary ZIP32 File Format. It automatically adds ZIP64 extensions if required, i.e. if the file size exceeds 4GB or more than 65535 entries are written. This implies that the class may produce ZIP archive files which cannot be read by older ZIP implementations.

If the system property net.truevfs.kernel.io.zip.zip64ext is set to true (case is ignored), then ZIP64 extensions are always added when writing a ZIP archive file, regardless of its size. This system property is primarily intended for unit testing purposes. During normal operations, it should not be set as many third party tools would not treat the redundant ZIP64 extensions correctly. Note that it's impossible to inhibit ZIP64 extensions.

See Also:

ZipFile

Field Summary

Fields

Modifier and Type	Field and Description
static java.nio.charset.Charset	DEFAULT_CHARSET The default character set used for entry names and comments in ZIP files.

Fields inherited from class net.java.truecommons.io.DecoratingOutputStream

out

Constructor Summary

Constructors

Constructor and Description
ZipOutputStream(java.io.OutputStream out) Constructs a ZIP output stream which decorates the given output stream using the "UTF-8" charset.
ZipOutputStream(java.io.OutputStream out, java.nio.charset.Charset charset) Constructs a ZIP output stream which decorates the given output stream using the given charset.
ZipOutputStream(java.io.OutputStream out, ZipFile appendee) Constructs a ZIP output stream which decorates the given output stream and appends to the given ZIP file.

Method Summary

Modifier and Type	Method and Description
ZipEntry	entry(java.lang.String name) Returns a clone of the entry for the given name or null if no entry with this name exists in this ZIP file.
ZipCryptoParameters	getCryptoParameters() Returns the parameters for encryption or authentication of entries.
java.util.Iterator<ZipEntry>	iterator() Returns a safe iteration of clones for all entries written to this ZIP file so far.
void	setCryptoParameters(ZipCryptoParameters cryptoParameters) Sets the parameters for encryption or authentication of entries.

Methods inherited from class net.java.truevfs.comp.zip.AbstractZipOutputStream

close, closeEntry, finish, getCharset, getComment, getLevel, getMethod, getRawCharset, isBusy, length, putNextEntry, putNextEntry, setComment, setLevel, setMethod, size

Methods inherited from class net.java.truecommons.io.DecoratingOutputStream

flush, toString, write, write, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

DEFAULT_CHARSET

public static final java.nio.charset.Charset DEFAULT_CHARSET

The default character set used for entry names and comments in ZIP files. This is "UTF-8" for compatibility with Sun's JDK implementation.

Constructor Detail

ZipOutputStream

@CreatesObligation
public ZipOutputStream(@WillCloseWhenClosed
                                          java.io.OutputStream out)
                                   throws java.io.IOException

Constructs a ZIP output stream which decorates the given output stream using the "UTF-8" charset.

Parameters:

out - The output stream to write the ZIP file to.

Throws:

java.io.IOException - on any I/O error.

ZipOutputStream

@CreatesObligation
public ZipOutputStream(@WillCloseWhenClosed
                                          java.io.OutputStream out,
                                          java.nio.charset.Charset charset)
                                   throws java.io.IOException

Constructs a ZIP output stream which decorates the given output stream using the given charset.

Parameters:

out - The output stream to write the ZIP file to.

charset - the character set to use.

Throws:

java.io.IOException - on any I/O error.

ZipOutputStream

@CreatesObligation
public ZipOutputStream(@WillCloseWhenClosed
                                          java.io.OutputStream out,
                                          ZipFile appendee)
                                   throws java.io.IOException

Constructs a ZIP output stream which decorates the given output stream and appends to the given ZIP file.

Parameters:

out - The output stream to write the ZIP file to. If appendee is not null, then this must be set up so that it appends to the same ZIP file from which appendee is reading.

appendee - the ZIP file to append to. This may already be closed.

Throws:

java.io.IOException - on any I/O error.

Method Detail

iterator

public java.util.Iterator<ZipEntry> iterator()

Returns a safe iteration of clones for all entries written to this ZIP file so far. This method takes a snapshot of the collection of all entries and clones them while iterating, so concurrent modifications or state changes do not affect this instance, the returned enumeration or the enumerated ZIP entries. The iteration does not support element removal.

Specified by:

iterator in interface java.lang.Iterable<ZipEntry>

Overrides:

iterator in class AbstractZipOutputStream<ZipEntry>

entry

public ZipEntry entry(java.lang.String name)

Returns a clone of the entry for the given name or null if no entry with this name exists in this ZIP file.

Overrides:

entry in class AbstractZipOutputStream<ZipEntry>

Parameters:

name - the name of the ZIP entry.

Returns:

A clone of the entry for the given name or null if no entry with this name exists in this ZIP file.

getCryptoParameters

@Nullable
public ZipCryptoParameters getCryptoParameters()

Description copied from class: AbstractZipOutputStream

Returns the parameters for encryption or authentication of entries.

Returns The parameters for encryption or authentication of entries.

Specified by:

getCryptoParameters in class AbstractZipOutputStream<ZipEntry>

setCryptoParameters

public void setCryptoParameters(@CheckForNull
                                ZipCryptoParameters cryptoParameters)

Sets the parameters for encryption or authentication of entries.

Note that only WinZip AES encryption is currently supported.

Parameters:

cryptoParameters - the parameters for encryption or authentication of entries.