ZipOutputStream (moe.ios.core API)

java.lang.Object
- java.io.OutputStream
- - java.io.FilterOutputStream
  - - java.util.zip.DeflaterOutputStream
    - - java.util.zip.ZipOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

JarOutputStream
```
public class ZipOutputStream
extends DeflaterOutputStream
```
Used to write (compress) data into zip files.
ZipOutputStream is used to write ZipEntrys to the underlying stream. Output from ZipOutputStream can be read using ZipFile or ZipInputStream.
While DeflaterOutputStream can write compressed zip file entries, this extension can write uncompressed entries as well. Use ZipEntry.setMethod(int) or setMethod(int) with the ZipEntry.STORED flag.
Example

Using ZipOutputStream is a little more complicated than GZIPOutputStream because zip files are containers that can contain multiple files. This code creates a zip file containing several files, similar to the zip(1) utility.
```
 OutputStream os = ...
 ZipOutputStream zos = new ZipOutputStream(new BufferedOutputStream(os));
 try {
     for (int i = 0; i < fileCount; ++i) {
         String filename = ...
         byte[] bytes = ...
         ZipEntry entry = new ZipEntry(filename);
         zos.putNextEntry(entry);
         zos.write(bytes);
         zos.closeEntry();
     }
 } finally {
     zos.close();
 }
 
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CENATT`
`static int`	`CENATX`
`static int`	`CENCOM`
`static int`	`CENCRC`
`static int`	`CENDSK`
`static int`	`CENEXT`
`static int`	`CENFLG`
`static int`	`CENHDR`
`static int`	`CENHOW`
`static int`	`CENLEN`
`static int`	`CENNAM`
`static int`	`CENOFF`
`static long`	`CENSIG`
`static int`	`CENSIZ`
`static int`	`CENTIM`
`static int`	`CENVEM`
`static int`	`CENVER`
`static int`	`DEFLATED` Indicates deflated entries.
`static int`	`ENDCOM`
`static int`	`ENDHDR`
`static int`	`ENDOFF`
`static long`	`ENDSIG`
`static int`	`ENDSIZ`
`static int`	`ENDSUB`
`static int`	`ENDTOT`
`static int`	`EXTCRC`
`static int`	`EXTHDR`
`static int`	`EXTLEN`
`static long`	`EXTSIG`
`static int`	`EXTSIZ`
`static int`	`LOCCRC`
`static int`	`LOCEXT`
`static int`	`LOCFLG`
`static int`	`LOCHDR`
`static int`	`LOCHOW`
`static int`	`LOCLEN`
`static int`	`LOCNAM`
`static long`	`LOCSIG`
`static int`	`LOCSIZ`
`static int`	`LOCTIM`
`static int`	`LOCVER`
`static int`	`STORED` Indicates uncompressed entries.

Fields inherited from class java.util.zip.DeflaterOutputStream
buf, def

Fields inherited from class java.io.FilterOutputStream
out

Constructor Summary

Constructors
Constructor and Description
`ZipOutputStream(OutputStream os)` Constructs a new `ZipOutputStream` that writes a zip file to the given `OutputStream`.
`ZipOutputStream(OutputStream os, boolean forceZip64)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the current `ZipEntry`, if any, and the underlying output stream.
`void`	`closeEntry()` Closes the current `ZipEntry`.
`void`	`finish()` Indicates that all entries have been written to the stream.
`void`	`putNextEntry(ZipEntry ze)` Writes entry information to the underlying stream.
`void`	`setComment(String comment)` Sets the comment associated with the file being written.
`void`	`setLevel(int level)` Sets the compression level to be used for writing entry data.
`void`	`setMethod(int method)` Sets the default compression method to be used when a `ZipEntry` doesn't explicitly specify a method.
`void`	`write(byte[] buffer, int offset, int byteCount)` Writes data for the current entry to the underlying stream.

Methods inherited from class java.util.zip.DeflaterOutputStream
deflate, flush, write

Methods inherited from class java.io.OutputStream
nullOutputStream, write

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

- Field Detail
  - DEFLATED
```
public static final int DEFLATED
```
    Indicates deflated entries.
    
    See Also:
    
    Constant Field Values
  - STORED
```
public static final int STORED
```
    Indicates uncompressed entries.
    
    See Also:
    
    Constant Field Values
  - LOCSIG
```
public static final long LOCSIG
```
    See Also:
    
    Constant Field Values
  - EXTSIG
```
public static final long EXTSIG
```
    See Also:
    
    Constant Field Values
  - CENSIG
```
public static final long CENSIG
```
    See Also:
    
    Constant Field Values
  - ENDSIG
```
public static final long ENDSIG
```
    See Also:
    
    Constant Field Values
  - LOCHDR
```
public static final int LOCHDR
```
    See Also:
    
    Constant Field Values
  - EXTHDR
```
public static final int EXTHDR
```
    See Also:
    
    Constant Field Values
  - CENHDR
```
public static final int CENHDR
```
    See Also:
    
    Constant Field Values
  - ENDHDR
```
public static final int ENDHDR
```
    See Also:
    
    Constant Field Values
  - LOCVER
```
public static final int LOCVER
```
    See Also:
    
    Constant Field Values
  - LOCFLG
```
public static final int LOCFLG
```
    See Also:
    
    Constant Field Values
  - LOCHOW
```
public static final int LOCHOW
```
    See Also:
    
    Constant Field Values
  - LOCTIM
```
public static final int LOCTIM
```
    See Also:
    
    Constant Field Values
  - LOCCRC
```
public static final int LOCCRC
```
    See Also:
    
    Constant Field Values
  - LOCSIZ
```
public static final int LOCSIZ
```
    See Also:
    
    Constant Field Values
  - LOCLEN
```
public static final int LOCLEN
```
    See Also:
    
    Constant Field Values
  - LOCNAM
```
public static final int LOCNAM
```
    See Also:
    
    Constant Field Values
  - LOCEXT
```
public static final int LOCEXT
```
    See Also:
    
    Constant Field Values
  - EXTCRC
```
public static final int EXTCRC
```
    See Also:
    
    Constant Field Values
  - EXTSIZ
```
public static final int EXTSIZ
```
    See Also:
    
    Constant Field Values
  - EXTLEN
```
public static final int EXTLEN
```
    See Also:
    
    Constant Field Values
  - CENVEM
```
public static final int CENVEM
```
    See Also:
    
    Constant Field Values
  - CENVER
```
public static final int CENVER
```
    See Also:
    
    Constant Field Values
  - CENFLG
```
public static final int CENFLG
```
    See Also:
    
    Constant Field Values
  - CENHOW
```
public static final int CENHOW
```
    See Also:
    
    Constant Field Values
  - CENTIM
```
public static final int CENTIM
```
    See Also:
    
    Constant Field Values
  - CENCRC
```
public static final int CENCRC
```
    See Also:
    
    Constant Field Values
  - CENSIZ
```
public static final int CENSIZ
```
    See Also:
    
    Constant Field Values
  - CENLEN
```
public static final int CENLEN
```
    See Also:
    
    Constant Field Values
  - CENNAM
```
public static final int CENNAM
```
    See Also:
    
    Constant Field Values
  - CENEXT
```
public static final int CENEXT
```
    See Also:
    
    Constant Field Values
  - CENCOM
```
public static final int CENCOM
```
    See Also:
    
    Constant Field Values
  - CENDSK
```
public static final int CENDSK
```
    See Also:
    
    Constant Field Values
  - CENATT
```
public static final int CENATT
```
    See Also:
    
    Constant Field Values
  - CENATX
```
public static final int CENATX
```
    See Also:
    
    Constant Field Values
  - CENOFF
```
public static final int CENOFF
```
    See Also:
    
    Constant Field Values
  - ENDSUB
```
public static final int ENDSUB
```
    See Also:
    
    Constant Field Values
  - ENDTOT
```
public static final int ENDTOT
```
    See Also:
    
    Constant Field Values
  - ENDSIZ
```
public static final int ENDSIZ
```
    See Also:
    
    Constant Field Values
  - ENDOFF
```
public static final int ENDOFF
```
    See Also:
    
    Constant Field Values
  - ENDCOM
```
public static final int ENDCOM
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ZipOutputStream
```
public ZipOutputStream(OutputStream os)
```
    Constructs a new ZipOutputStream that writes a zip file to the given OutputStream.
    UTF-8 will be used to encode the file comment, entry names and comments.
  - ZipOutputStream
```
public ZipOutputStream(OutputStream os,
                       boolean forceZip64)
```
- Method Detail
  - close
```
public void close()
           throws IOException
```
    Closes the current ZipEntry, if any, and the underlying output stream. If the stream is already closed this method does nothing.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class DeflaterOutputStream
    
    Throws:
    
    IOException - If an error occurs closing the stream.
  - closeEntry
```
public void closeEntry()
                throws IOException
```
    Closes the current ZipEntry. Any entry terminal data is written to the underlying stream.
    
    Throws:
    
    IOException - If an error occurs closing the entry.
  - finish
```
public void finish()
            throws IOException
```
    Indicates that all entries have been written to the stream. Any terminal information is written to the underlying stream.
    
    Overrides:
    
    finish in class DeflaterOutputStream
    
    Throws:
    
    IOException - if an error occurs while terminating the stream.
  - putNextEntry
```
public void putNextEntry(ZipEntry ze)
                  throws IOException
```
    Writes entry information to the underlying stream. Data associated with the entry can then be written using write(). After data is written closeEntry() must be called to complete the writing of the entry to the underlying stream.
    
    Parameters:
    
    ze - the ZipEntry to store.
    
    Throws:
    
    IOException - If an error occurs storing the entry.
    
    See Also:
    
    write(byte[], int, int)
  - setComment
```
public void setComment(String comment)
```
    Sets the comment associated with the file being written. See ZipFile.getComment().
    
    Throws:
    
    IllegalArgumentException - if the comment is >= 64 Ki encoded bytes.
  - setLevel
```
public void setLevel(int level)
```
    Sets the compression level to be used for writing entry data.
  - setMethod
```
public void setMethod(int method)
```
    Sets the default compression method to be used when a ZipEntry doesn't explicitly specify a method. See ZipEntry.setMethod(int) for more details.
  - write
```
public void write(byte[] buffer,
                  int offset,
                  int byteCount)
           throws IOException
```
    Writes data for the current entry to the underlying stream.
    
    Overrides:
    
    write in class DeflaterOutputStream
    
    Parameters:
    
    buffer - the buffer to write.
    
    offset - the index of the first byte in buffer to write.
    
    byteCount - the number of bytes in buffer to write.
    
    Throws:
    
    IOException - If an error occurs writing to the stream

Class ZipOutputStream

Example

Field Summary

Fields inherited from class java.util.zip.DeflaterOutputStream

Fields inherited from class java.io.FilterOutputStream

Constructor Summary

Method Summary

Methods inherited from class java.util.zip.DeflaterOutputStream

Methods inherited from class java.io.OutputStream

Methods inherited from class java.lang.Object

Field Detail

DEFLATED

STORED

LOCSIG

EXTSIG

CENSIG

ENDSIG

LOCHDR

EXTHDR

CENHDR

ENDHDR

LOCVER

LOCFLG

LOCHOW

LOCTIM

LOCCRC

LOCSIZ

LOCLEN

LOCNAM

LOCEXT

EXTCRC

EXTSIZ

EXTLEN

CENVEM

CENVER

CENFLG

CENHOW

CENTIM

CENCRC

CENSIZ

CENLEN

CENNAM

CENEXT

CENCOM

CENDSK

CENATT

CENATX

CENOFF

ENDSUB

ENDTOT

ENDSIZ

ENDOFF

ENDCOM

Constructor Detail

ZipOutputStream

ZipOutputStream

Method Detail

close

closeEntry

finish

putNextEntry

setComment

setLevel

setMethod

write