to top
Android APIs
public class

DeflaterOutputStream

extends FilterOutputStream
java.lang.Object
   ↳ java.io.OutputStream
     ↳ java.io.FilterOutputStream
       ↳ java.util.zip.DeflaterOutputStream
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

This class provides an implementation of FilterOutputStream that compresses data using the DEFLATE algorithm. Basically it wraps the Deflater class and takes care of the buffering.

See Also

Summary

Fields
protected byte[] buf The buffer for the data to be written to.
protected Deflater def The deflater used.
[Expand]
Inherited Fields
From class java.io.FilterOutputStream
Public Constructors
DeflaterOutputStream( OutputStream os, Deflater def)
This constructor lets you pass the Deflater specifying the compression algorithm.
DeflaterOutputStream( OutputStream os)
This is the most basic constructor.
DeflaterOutputStream( OutputStream os, Deflater def, int bsize)
This constructor lets you specify both the compression algorithm as well as the internal buffer size to be used.
Public Methods
void close()
Writes any unwritten compressed data to the underlying stream, the closes all underlying streams.
void finish()
Writes any unwritten data to the underlying stream.
void flush()
Flushes the underlying stream.
void write(byte[] buffer, int offset, int byteCount)
Compresses byteCount bytes of data from buf starting at offset and writes it to the underlying stream.
void write(int i)
Writes one byte to the target stream.
Protected Methods
void deflate()
Compress the data in the input buffer and write it to the underlying stream.
[Expand]
Inherited Methods
From class java.io.FilterOutputStream
From class java.io.OutputStream
From class java.lang.Object
From interface java.io.Closeable
From interface java.io.Flushable

Fields

protected byte[] buf

Added in API level 1

The buffer for the data to be written to.

protected Deflater def

Added in API level 1

The deflater used.

Public Constructors

public DeflaterOutputStream (OutputStream os, Deflater def)

Added in API level 1

This constructor lets you pass the Deflater specifying the compression algorithm.

Parameters
os is the OutputStream where to write the compressed data to.
def is the specific Deflater that is used to compress data.

public DeflaterOutputStream (OutputStream os)

Added in API level 1

This is the most basic constructor. You only need to pass the OutputStream to which the compressed data shall be written to. The default settings for the Deflater and internal buffer are used. In particular the Deflater produces a ZLIB header in the output stream.

Parameters
os is the OutputStream where to write the compressed data to.

public DeflaterOutputStream (OutputStream os, Deflater def, int bsize)

Added in API level 1

This constructor lets you specify both the compression algorithm as well as the internal buffer size to be used.

Parameters
os is the OutputStream where to write the compressed data to.
def is the specific Deflater that will be used to compress data.
bsize is the size to be used for the internal buffer.

Public Methods

public void close ()

Added in API level 1

Writes any unwritten compressed data to the underlying stream, the closes all underlying streams. This stream can no longer be used after close() has been called.

Throws
IOException If an error occurs while closing the data compression process.

public void finish ()

Added in API level 1

Writes any unwritten data to the underlying stream. Does not close the stream.

Throws
IOException If an error occurs.

public void flush ()

Added in API level 1

Flushes the underlying stream. This flushes only the bytes that can be compressed at the highest level.

For deflater output streams constructed with Java 7's syncFlush parameter set to true (not yet available on Android), this first flushes all outstanding data so that it may be immediately read by its recipient. Doing so may degrade compression.

Throws
IOException

public void write (byte[] buffer, int offset, int byteCount)

Added in API level 1

Compresses byteCount bytes of data from buf starting at offset and writes it to the underlying stream.

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 during writing.

public void write (int i)

Added in API level 1

Writes one byte to the target stream. Only the low order byte of the integer oneByte is written.

Parameters
i the byte to be written.
Throws
IOException

Protected Methods

protected void deflate ()

Added in API level 1

Compress the data in the input buffer and write it to the underlying stream.

Throws
IOException If an error occurs during deflation.
No examples for this method.
Frequently called with: [Clear]
Portions of this page are reproduced from work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License. The original page is available here.