Added in API level 1

DeflaterOutputStream

public class DeflaterOutputStream
extends FilterOutputStream

java.lang.Object
↳	java.io.OutputStream
	↳	java.io.FilterOutputStream
		↳	java.util.zip.DeflaterOutputStream

Known direct subclasses

GZIPOutputStream, ZipOutputStream

GZIPOutputStream	This class implements a stream filter for writing compressed data in the GZIP file format.
ZipOutputStream	This class implements an output stream filter for writing files in the ZIP file format.

Known indirect subclasses

JarOutputStream

JarOutputStream The JarOutputStream class is used to write the contents of a JAR file to any output stream.

This class implements an output stream filter for compressing data in the "deflate" compression format. It is also used as the basis for other types of compression filters, such as GZIPOutputStream.

See also:

Deflater

Summary

Fields
`protected byte[]`	`buf` Output buffer for writing compressed data.
`protected Deflater`	`def` Compressor for this stream.

Inherited fields

From class java.io.FilterOutputStream


    protected
    
    
    OutputStream

out

The underlying output stream to be filtered.

Public constructors
`DeflaterOutputStream(OutputStream out)` Creates a new output stream with a default compressor and buffer size.
`DeflaterOutputStream(OutputStream out, boolean syncFlush)` Creates a new output stream with a default compressor, a default buffer size and the specified flush mode.
`DeflaterOutputStream(OutputStream out, Deflater def)` Creates a new output stream with the specified compressor and a default buffer size.
`DeflaterOutputStream(OutputStream out, Deflater def, boolean syncFlush)` Creates a new output stream with the specified compressor, flush mode and a default buffer size.
`DeflaterOutputStream(OutputStream out, Deflater def, int size)` Creates a new output stream with the specified compressor and buffer size.
`DeflaterOutputStream(OutputStream out, Deflater def, int size, boolean syncFlush)` Creates a new output stream with the specified compressor, buffer size and flush mode.

Public methods
`void`	`close()` Writes remaining compressed data to the output stream and closes the underlying stream.
`void`	`finish()` Finishes writing compressed data to the output stream without closing the underlying stream.
`void`	`flush()` Flushes the compressed output stream.
`void`	`write(byte[] b, int off, int len)` Writes an array of bytes to the compressed output stream.
`void`	`write(int b)` Writes a byte to the compressed output stream.

Protected methods
`void`	`deflate()` Writes next block of compressed data to the output stream.

Inherited methods

From class


        
          java.io.FilterOutputStream

`void`	`close()` Closes this output stream and releases any system resources associated with the stream.
`void`	`flush()` Flushes this output stream and forces any buffered output bytes to be written out to the stream.
`void`	`write(byte[] b)` Writes `b.length` bytes to this output stream.
`void`	`write(byte[] b, int off, int len)` Writes `len` bytes from the specified `byte` array starting at offset `off` to this output stream.
`void`	`write(int b)` Writes the specified `byte` to this output stream.

From class


        
          java.io.OutputStream

`void`	`close()` Closes this output stream and releases any system resources associated with this stream.
`void`	`flush()` Flushes this output stream and forces any buffered output bytes to be written out.
`static OutputStream`	`nullOutputStream()` Returns a new `OutputStream` which discards all bytes.
`void`	`write(byte[] b)` Writes `b.length` bytes from the specified byte array to this output stream.
`void`	`write(byte[] b, int off, int len)` Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.
`abstract void`	`write(int b)` Writes the specified byte to this output stream.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          java.io.Closeable


      close()

Closes this stream and releases any system resources associated with it.

From interface


        
          java.io.Flushable


      flush()

Flushes this stream by writing any buffered output to the underlying stream.

From interface


        
          java.lang.AutoCloseable


      close()

Closes this resource, relinquishing any underlying resources.

Fields

buf

Added in API level 1

protected byte[] buf

Output buffer for writing compressed data.

def

Added in API level 1

protected Deflater def

Compressor for this stream.

Public constructors

DeflaterOutputStream

Added in API level 1

public DeflaterOutputStream (OutputStream out)

Creates a new output stream with a default compressor and buffer size.

The new output stream instance is created as if by invoking the 2-argument constructor DeflaterOutputStream(out, false).

Parameters
`out`	`OutputStream`: the output stream

DeflaterOutputStream

Added in API level 19

public DeflaterOutputStream (OutputStream out, 
                boolean syncFlush)

Creates a new output stream with a default compressor, a default buffer size and the specified flush mode.

Parameters
`out`	`OutputStream`: the output stream
`syncFlush`	`boolean`: if `true` the `flush()` method of this instance flushes the compressor with flush mode `Deflater.SYNC_FLUSH` before flushing the output stream, otherwise only flushes the output stream

DeflaterOutputStream

Added in API level 1

public DeflaterOutputStream (OutputStream out, 
                Deflater def)

Creates a new output stream with the specified compressor and a default buffer size.

The new output stream instance is created as if by invoking the 3-argument constructor DeflaterOutputStream(out, def, false).

Parameters
`out`	`OutputStream`: the output stream
`def`	`Deflater`: the compressor ("deflater")

DeflaterOutputStream

Added in API level 19

public DeflaterOutputStream (OutputStream out, 
                Deflater def, 
                boolean syncFlush)

Creates a new output stream with the specified compressor, flush mode and a default buffer size.

Parameters
`out`	`OutputStream`: the output stream
`def`	`Deflater`: the compressor ("deflater")
`syncFlush`	`boolean`: if `true` the `flush()` method of this instance flushes the compressor with flush mode `Deflater.SYNC_FLUSH` before flushing the output stream, otherwise only flushes the output stream

DeflaterOutputStream

Added in API level 1

public DeflaterOutputStream (OutputStream out, 
                Deflater def, 
                int size)

Creates a new output stream with the specified compressor and buffer size.

The new output stream instance is created as if by invoking the 4-argument constructor DeflaterOutputStream(out, def, size, false).

Parameters
`out`	`OutputStream`: the output stream
`def`	`Deflater`: the compressor ("deflater")
`size`	`int`: the output buffer size

Throws
`IllegalArgumentException`	if `size <= 0`

DeflaterOutputStream

Added in API level 19

public DeflaterOutputStream (OutputStream out, 
                Deflater def, 
                int size, 
                boolean syncFlush)

Creates a new output stream with the specified compressor, buffer size and flush mode.

Parameters
`out`	`OutputStream`: the output stream
`def`	`Deflater`: the compressor ("deflater")
`size`	`int`: the output buffer size
`syncFlush`	`boolean`: if `true` the `flush()` method of this instance flushes the compressor with flush mode `Deflater.SYNC_FLUSH` before flushing the output stream, otherwise only flushes the output stream

Throws
`IllegalArgumentException`	if `size <= 0`

Public methods

close

Added in API level 1

public void close ()

Writes remaining compressed data to the output stream and closes the underlying stream.

Throws
`IOException`	if an I/O error has occurred

finish

Added in API level 1

public void finish ()

Finishes writing compressed data to the output stream without closing the underlying stream. Use this method when applying multiple filters in succession to the same output stream.

Throws
`IOException`	if an I/O error has occurred

flush

Added in API level 1

public void flush ()

Flushes the compressed output stream. If syncFlush is true when this compressed output stream is constructed, this method first flushes the underlying compressor with the flush mode Deflater.SYNC_FLUSH to force all pending data to be flushed out to the output stream and then flushes the output stream. Otherwise this method only flushes the output stream without flushing the compressor.

Throws
`IOException`	if an I/O error has occurred

write

Added in API level 1

public void write (byte[] b, 
                int off, 
                int len)

Writes an array of bytes to the compressed output stream. This method will block until all the bytes are written.

Parameters
`b`	`byte`: the data to be written
`off`	`int`: the start offset of the data
`len`	`int`: the length of the data

Throws
`IOException`	if an I/O error has occurred

write

Added in API level 1

public void write (int b)

Writes a byte to the compressed output stream. This method will block until the byte can be written.

Parameters
`b`	`int`: the byte to be written

Throws
`IOException`	if an I/O error has occurred

Protected methods

deflate

Added in API level 1

protected void deflate ()

Writes next block of compressed data to the output stream.

Throws
`IOException`	if an I/O error has occurred