Client and backend. This class is shared: the same code is compiled into your app and into your server, so everything on this page works in both.

public class ZipArchiveOutputStream

  1. Object
  2. OutputStream
  3. FilterOutputStream
  4. DeflaterOutputStream
  5. ZipArchiveOutputStream

ImplementsAutoCloseable

Streaming ZIP writer with optional Unix permissions. Works on the JVM and ParparVM. Payloads are never buffered in full. Central-directory metadata is limited to 16 MiB and 65534 entries; ZIP64 is explicitly refused. finish() leaves the destination open; close() closes it even after a failure. Input streams are owned by the caller. This stream is not thread safe.

Fields

public static final int STORED = 0
public static final int DEFLATED = 8

Constructors

public ZipArchiveOutputStream(OutputStream out)
public ZipArchiveOutputStream(OutputStream out, Charset charset)

Methods

public void setMethod(int method)
public void setLevel(int level)
public void setComment(String comment)
public void putNextEntry(ZipEntry entry) throws IOExceptionWrites an entry without Unix attributes, like java.util.zip.ZipOutputStream.
public void putNextEntry(ZipEntry entry, int permissions) throws IOExceptionWrites an entry with Unix permission bits (for example 0755 or 0644).
public void write(int value) throws IOExceptionWrites the specified byte to this output stream.
public void write(byte[] data, int off, int len) throws IOExceptionWrites len bytes from the specified byte array starting at offset off to this output stream.
protected void deflate() throws IOException
public void closeEntry() throws IOException
public void finish() throws IOException
public void flush() throws IOExceptionFlushes this output stream and forces any buffered output bytes to be written out.
public void close() throws IOExceptionCloses this output stream and releases any system resources associated with this stream.

Inherited fields

From DeflaterOutputStream

def, buf

From FilterOutputStream

out

Inherited methods

From OutputStream

write

From Object

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

Field details

STORED

public static final int STORED = 0

DEFLATED

public static final int DEFLATED = 8

Constructor details

ZipArchiveOutputStream

public ZipArchiveOutputStream(OutputStream out)

ZipArchiveOutputStream

public ZipArchiveOutputStream(OutputStream out, Charset charset)

Method details

setMethod

public void setMethod(int method)

setLevel

public void setLevel(int level)

setComment

public void setComment(String comment)

putNextEntry

public void putNextEntry(ZipEntry entry) throws IOException
Writes an entry without Unix attributes, like java.util.zip.ZipOutputStream.

Throws

IOException

putNextEntry

public void putNextEntry(ZipEntry entry, int permissions) throws IOException
Writes an entry with Unix permission bits (for example 0755 or 0644). File/directory type bits are inferred from the trailing slash. Symlinks and special files are not created. Values outside 0000..0777 are refused.

Throws

IOException

write

public void write(int value) throws IOException
Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored. Subclasses of OutputStream must provide an implementation for this method.

Throws

IOException

write

public void write(byte[] data, int off, int len) throws IOException
Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation. The write method of OutputStream calls the write method of one argument on each of the bytes to be written out. Subclasses are encouraged to override this method and provide a more efficient implementation. If b is null, a NullPointerException is thrown. If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Throws

IOException

deflate

protected void deflate() throws IOException

Throws

IOException

closeEntry

public void closeEntry() throws IOException

Throws

IOException

finish

public void finish() throws IOException

Throws

IOException

flush

public void flush() throws IOException
Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination. The flush method of OutputStream does nothing.

Throws

IOException

close

public void close() throws IOException
Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened. The close method of OutputStream does nothing.

Throws

IOException