net.java.truevfs.comp.zip.ZipOutputStream Maven / Gradle / Ivy
Show all versions of truevfs-comp-zip Show documentation
/*
* Copyright (C) 2005-2015 Schlichtherle IT Services.
* All rights reserved. Use is subject to license terms.
*/
package net.java.truevfs.comp.zip;
import edu.umd.cs.findbugs.annotations.CreatesObligation;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Objects;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import javax.annotation.WillCloseWhenClosed;
import javax.annotation.concurrent.NotThreadSafe;
import net.java.truecommons.io.OneTimeSink;
/**
* Replacement for
* {@link java.util.zip.ZipOutputStream 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 {@code net.truevfs.kernel.io.zip.zip64ext}
* is set to {@code 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 ZipFile
* @author Christian Schlichtherle
*/
@NotThreadSafe
public class ZipOutputStream extends AbstractZipOutputStream {
/**
* The default character set used for entry names and comments in ZIP files.
* This is {@code "UTF-8"} for compatibility with Sun's JDK implementation.
*/
public static final Charset DEFAULT_CHARSET = Constants.DEFAULT_CHARSET;
private static final ZipOutputStreamParameters DEFAULT_PARAM
= new DefaultZipOutputStreamParameters(DEFAULT_CHARSET);
private @CheckForNull ZipCryptoParameters cryptoParameters;
/**
* Constructs a ZIP output stream which decorates the given output stream
* using the {@code "UTF-8"} charset.
*
* @param out The output stream to write the ZIP file to.
* @throws IOException on any I/O error.
*/
@CreatesObligation
public ZipOutputStream(@WillCloseWhenClosed OutputStream out)
throws IOException {
super(new OneTimeSink(out), null, DEFAULT_PARAM);
}
/**
* Constructs a ZIP output stream which decorates the given output stream
* using the given charset.
*
* @param out The output stream to write the ZIP file to.
* @param charset the character set to use.
* @throws IOException on any I/O error.
*/
@CreatesObligation
public ZipOutputStream(@WillCloseWhenClosed OutputStream out, Charset charset)
throws IOException {
super( new OneTimeSink(out), null,
new DefaultZipOutputStreamParameters(charset));
}
/**
* Constructs a ZIP output stream which decorates the given output stream
* and appends to the given ZIP file.
*
* @param out The output stream to write the ZIP file to.
* If {@code appendee} is not {@code null}, then this must be set
* up so that it appends to the same ZIP file from which
* {@code appendee} is reading.
* @param appendee the ZIP file to append to.
* This may already be closed.
* @throws IOException on any I/O error.
*/
@CreatesObligation
public ZipOutputStream(
@WillCloseWhenClosed OutputStream out,
ZipFile appendee)
throws IOException {
super(new OneTimeSink(out), Objects.requireNonNull(appendee), DEFAULT_PARAM);
}
/**
* 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.
*/
@Override
public Iterator iterator() {
final class EntryIterator implements Iterator {
final Iterator i;
EntryIterator() {
List l = new ArrayList<>(ZipOutputStream.super.size());
Iterator si = ZipOutputStream.super.iterator();
while (si.hasNext())
l.add(si.next());
i = l.iterator();
}
@Override
public boolean hasNext() {
return i.hasNext();
}
@Override
public ZipEntry next() {
return i.next().clone();
}
@Override
public void remove() {
throw new UnsupportedOperationException();
}
} // class EntryIterator
return new EntryIterator();
}
/**
* Returns a clone of the entry for the given {@code name} or {@code null}
* if no entry with this name exists in this ZIP file.
*
* @param name the name of the ZIP entry.
* @return A clone of the entry for the given {@code name} or {@code null}
* if no entry with this name exists in this ZIP file.
*/
@Override
public ZipEntry entry(String name) {
final ZipEntry entry = super.entry(name);
return entry != null ? entry.clone() : null;
}
@Override
public @Nullable ZipCryptoParameters getCryptoParameters() {
return cryptoParameters;
}
/**
* Sets the parameters for encryption or authentication of entries.
*
* Note that only {@link WinZipAesParameters WinZip AES encryption} is
* currently supported.
*
* @param cryptoParameters the parameters for encryption or authentication
* of entries.
*/
public void setCryptoParameters(
final @CheckForNull ZipCryptoParameters cryptoParameters) {
this.cryptoParameters = cryptoParameters;
}
}