ZipOutputStream (TrueZIP Driver ZIP 7.4.1 API)

java.lang.Object
- java.io.OutputStream
- - de.schlichtherle.truezip.io.DecoratingOutputStream
  - - de.schlichtherle.truezip.zip.RawZipOutputStream<ZipEntry>
    - - de.schlichtherle.truezip.zip.ZipOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable, Iterable<ZipEntry>
```
@ThreadSafe
@DefaultAnnotation(value=edu.umd.cs.findbugs.annotations.NonNull.class)
public class ZipOutputStream
extends RawZipOutputStream<ZipEntry>
```
Drop-in 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 de.schlichtherle.truezip.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.
This class is thread-safe.

Author:

Christian Schlichtherle

See Also:
ZipFile

Field Summary

Fields
Modifier and Type	Field and Description
`private ZipCryptoParameters`	`cryptoParameters`
`static Charset`	`DEFAULT_CHARSET` The default character set used for entry names and comments in ZIP files.
`private static ZipOutputStreamParameters`	`DEFAULT_PARAM`
`static int`	`OVERHEAD_SIZE` The number of entries which can be additionally accomodated by the internal hash map without resizing it, which is 64.

Fields inherited from class de.schlichtherle.truezip.io.DecoratingOutputStream
delegate

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Closes this output stream and releases any system resources associated with the stream.
`void`	`closeEntry()` Writes all necessary data for this entry to the underlying stream.
`void`	`finish()` Closes the current entry and writes the Central Directory to the underlying output stream.
`String`	`getComment()` Returns the file comment.
`ZipCryptoParameters`	`getCryptoParameters()` Returns the parameters for encryption or authentication of entries.
`ZipEntry`	`getEntry(String name)` Returns a clone of the entry for the given name or `null` if no entry with this name exists.
`int`	`getLevel()` Returns the compression level for entries.
`int`	`getMethod()` Returns the default compression method for subsequent entries.
`boolean`	`isBusy()` Returns `true` if and only if this `RawZipOutputStream` is currently writing a ZIP entry.
`Iterator<ZipEntry>`	`iterator()` Returns a safe iteration of clones for all entries written to this ZIP file so far.
`long`	`length()` Returns the total number of (compressed) bytes this stream has written to the underlying stream.
`void`	`putNextEntry(ZipEntry entry, boolean process)` Starts writing the next ZIP entry to the underlying stream.
`void`	`setComment(String comment)` Sets the file comment.
`void`	`setCryptoParameters(ZipCryptoParameters cryptoParameters)` Sets the parameters for encryption or authentication of entries.
`void`	`setLevel(int level)` Sets the compression level for entries.
`void`	`setMethod(int method)` Sets the default compression method for entries.
`int`	`size()` Returns the number of ZIP entries written so far.
`void`	`write(byte[] b, int off, int len)`
`void`	`write(int b)`

Methods inherited from class de.schlichtherle.truezip.zip.RawZipOutputStream
getCharset, getRawCharset, putNextEntry

Methods inherited from class de.schlichtherle.truezip.io.DecoratingOutputStream
flush, toString, write

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - cryptoParameters
```
@CheckForNull
private ZipCryptoParameters cryptoParameters
```
  - DEFAULT_CHARSET
```
public static final 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.
  - DEFAULT_PARAM
```
private static final ZipOutputStreamParameters DEFAULT_PARAM
```
  - OVERHEAD_SIZE
```
public static final int OVERHEAD_SIZE
```
    The number of entries which can be additionally accomodated by the internal hash map without resizing it, which is 64. When a new ZIP file is created, this constant is used in order to compute the initial capacity of the internal hash map. When an existing ZIP file is appended to, this constant is added to the number of entries in order to compute the initial capacity of the internal hash map.
    
    Since:
    
    TrueZIP 7.3
    
    See Also:
    Constant Field Values
- Constructor Detail
  - ZipOutputStream
```
public ZipOutputStream(OutputStream out)
```
    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.
  - ZipOutputStream
```
public ZipOutputStream(OutputStream out,
               Charset charset)
```
    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.
  - ZipOutputStream
```
public ZipOutputStream(OutputStream out,
               ZipFile appendee)
```
    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.
- Method Detail
  - close
```
public void close()
           throws IOException
```
    Description copied from class: RawZipOutputStream
    
    Closes this output stream and releases any system resources associated with the stream. This closes the open output stream writing to this ZIP file, if any.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class RawZipOutputStream<ZipEntry>
    
    Throws:
    
    IOException - On any I/O error.
  - closeEntry
```
public void closeEntry()
                throws IOException
```
    Description copied from class: RawZipOutputStream
    
    Writes all necessary data for this entry to the underlying stream.
    
    Overrides:
    
    closeEntry in class RawZipOutputStream<ZipEntry>
    
    Throws:
    
    ZipException - If and only if writing the entry is impossible because the resulting file would not comply to the ZIP file format specification.
    
    IOException - On any I/O error.
  - finish
```
public void finish()
            throws IOException
```
    Description copied from class: RawZipOutputStream
    Closes the current entry and writes the Central Directory to the underlying output stream.
    Notes:
    - The underlying stream is not closed.
    - Unlike Sun's implementation in J2SE 1.4.2, you may continue to use this ZIP output stream with putNextEntry(...) and the like. When you finally close the stream, the central directory will contain all entries written.
    Overrides:
    
    finish in class RawZipOutputStream<ZipEntry>
    
    Throws:
    
    ZipException - If and only if writing the entry is impossible because the resulting file would not comply to the ZIP file format specification.
    
    IOException - On any I/O error.
  - getComment
```
public String getComment()
```
    Description copied from class: RawZipOutputStream
    
    Returns the file comment.
    
    Overrides:
    
    getComment in class RawZipOutputStream<ZipEntry>
    
    Returns:
    The file comment.
  - getCryptoParameters
```
@Nullable
public ZipCryptoParameters getCryptoParameters()
```
    Description copied from class: RawZipOutputStream
    
    Returns the parameters for encryption or authentication of entries. Returns The parameters for encryption or authentication of entries.
    
    Specified by:
    
    getCryptoParameters in class RawZipOutputStream<ZipEntry>
  - getEntry
```
public ZipEntry getEntry(String name)
```
    Returns a clone of the entry for the given name or null if no entry with this name exists.
    
    Overrides:
    
    getEntry in class RawZipOutputStream<ZipEntry>
    
    Parameters:
    name - the name of the ZIP entry.
  - getLevel
```
public int getLevel()
```
    Returns the compression level for entries. This property is only used if the effective compression method is ZipEntry.DEFLATED or ZipEntry.BZIP2.
    The initial value is Deflater#DEFAULT_COMPRESSION.
    
    Overrides:
    
    getLevel in class RawZipOutputStream<ZipEntry>
    
    Returns:
    The compression level for entries.
    See Also:
    RawZipOutputStream.setLevel(int)
  - getMethod
```
public int getMethod()
```
    Returns the default compression method for subsequent entries. This property is only used if a ZipEntry does not specify a compression method. The initial value is ZipEntry.DEFLATED.
    The initial value is ZipEntry#DEFLATED.
    
    Overrides:
    
    getMethod in class RawZipOutputStream<ZipEntry>
    
    See Also:
    RawZipOutputStream.setMethod(int), ZipEntry.getMethod()
  - isBusy
```
public final boolean isBusy()
```
    Description copied from class: RawZipOutputStream
    
    Returns true if and only if this RawZipOutputStream is currently writing a ZIP entry.
    
    Overrides:
    
    isBusy in class RawZipOutputStream<ZipEntry>
  - iterator
```
public 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 Iterable<ZipEntry>
    
    Overrides:
    
    iterator in class RawZipOutputStream<ZipEntry>
  - length
```
public long length()
```
    Description copied from class: RawZipOutputStream
    
    Returns the total number of (compressed) bytes this stream has written to the underlying stream.
    
    Overrides:
    
    length in class RawZipOutputStream<ZipEntry>
  - putNextEntry
```
public void putNextEntry(ZipEntry entry,
                boolean process)
                  throws IOException
```
    Description copied from class: RawZipOutputStream
    
    Starts writing the next ZIP entry to the underlying stream. Note that if two or more entries with the same name are written consecutively to this stream, the last entry written will shadow all other entries, i.e. all of them are written to the ZIP file (and hence require space), but only the last will be listed in the central directory. This is unlike the genuine java.util.zip.ZipOutputStream which would throw a ZipException in this method when another entry with the same name is to be written.
    
    Overrides:
    
    putNextEntry in class RawZipOutputStream<ZipEntry>
    
    Parameters:
    entry - The entry to write.
    process - Whether or not the entry contents should get processed, e.g. deflated. This should be set to false if and only if the application is going to copy entries from an input ZIP file to an output ZIP file. The entries' CRC-32, compressed size and uncompressed size properties must be set in advance.
    
    Throws:
    
    ZipException - If and only if writing the entry is impossible because the resulting file would not comply to the ZIP file format specification.
    
    IOException - On any I/O error.
  - setComment
```
public void setComment(String comment)
```
    Description copied from class: RawZipOutputStream
    
    Sets the file comment.
    
    Overrides:
    
    setComment in class RawZipOutputStream<ZipEntry>
    
    Parameters:
    comment - the file comment.
  - 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.
    Since:
    
    TrueZIP 7.3
  - setLevel
```
public void setLevel(int level)
```
    Description copied from class: RawZipOutputStream
    
    Sets the compression level for entries. This property is only used if the effective compression method is ZipEntry.DEFLATED or ZipEntry.BZIP2. Legal values are Deflater.DEFAULT_COMPRESSION or range from Deflater#BEST_SPEED to Deflater#BEST_COMPRESSION.
    
    Overrides:
    
    setLevel in class RawZipOutputStream<ZipEntry>
    
    Parameters:
    level - the compression level for entries.
    See Also:
    RawZipOutputStream.getLevel()
  - setMethod
```
public void setMethod(int method)
```
    Description copied from class: RawZipOutputStream
    
    Sets the default compression method for entries. This property is only used if a ZipEntry does not specify a compression method. Legal values are ZipEntry.STORED, ZipEntry.DEFLATED and ZipEntry.BZIP2.
    
    Overrides:
    
    setMethod in class RawZipOutputStream<ZipEntry>
    
    Parameters:
    method - the default compression method for entries.
    See Also:
    RawZipOutputStream.getMethod(), ZipEntry.setMethod(int)
  - size
```
public int size()
```
    Description copied from class: RawZipOutputStream
    
    Returns the number of ZIP entries written so far.
    
    Overrides:
    
    size in class RawZipOutputStream<ZipEntry>
  - write
```
public void write(byte[] b,
         int off,
         int len)
           throws IOException
```
    Overrides:
    
    write in class DecoratingOutputStream
    
    Throws:
    
    IOException
  - write
```
public void write(int b)
           throws IOException
```
    Overrides:
    
    write in class DecoratingOutputStream
    
    Throws:
    
    IOException

Class ZipOutputStream

Field Summary

Fields inherited from class de.schlichtherle.truezip.io.DecoratingOutputStream

Constructor Summary

Method Summary

Methods inherited from class de.schlichtherle.truezip.zip.RawZipOutputStream

Methods inherited from class de.schlichtherle.truezip.io.DecoratingOutputStream

Methods inherited from class java.lang.Object

Field Detail

cryptoParameters

DEFAULT_CHARSET

DEFAULT_PARAM

OVERHEAD_SIZE

Constructor Detail

ZipOutputStream

ZipOutputStream

ZipOutputStream

Method Detail

close

closeEntry

finish

getComment

getCryptoParameters

getEntry

getLevel

getMethod

isBusy

iterator

length

putNextEntry

setComment

setCryptoParameters

setLevel

setMethod

size

write

write