to top
Android APIs
public class

InflaterOutputStream

extends FilterOutputStream
java.lang.Object
   ↳ java.io.OutputStream
     ↳ java.io.FilterOutputStream
       ↳ java.util.zip.InflaterOutputStream

Class Overview

An OutputStream filter to decompress data. Callers write compressed data in the "deflate" format, and uncompressed data is written to the underlying stream.

Summary

Fields
protected final byte[] buf
protected final Inflater inf
[Expand]
Inherited Fields
From class java.io.FilterOutputStream
Public Constructors
InflaterOutputStream( OutputStream out)
Constructs an InflaterOutputStream with a new Inflater and an implementation-defined default internal buffer size.
InflaterOutputStream( OutputStream out, Inflater inf)
Constructs an InflaterOutputStream with the given Inflater and an implementation-defined default internal buffer size.
InflaterOutputStream( OutputStream out, Inflater inf, int bufferSize)
Constructs an InflaterOutputStream with the given Inflater and given internal buffer size.
Public Methods
void close()
Writes remaining data into the output stream and closes the underlying output stream.
void finish()
Finishes writing current uncompressed data into the InflaterOutputStream without closing it.
void flush()
Ensures that all pending data is sent out to the target stream.
void write(byte[] bytes, int offset, int byteCount)
Writes to the decompressing output stream.
void write(int b)
Writes a byte to the decompressing output 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 final byte[] buf

Added in API level 9

protected final Inflater inf

Added in API level 9

Public Constructors

public InflaterOutputStream (OutputStream out)

Added in API level 9

Constructs an InflaterOutputStream with a new Inflater and an implementation-defined default internal buffer size. out is a destination for uncompressed data, and compressed data will be written to this stream.

Parameters
out the destination OutputStream

public InflaterOutputStream (OutputStream out, Inflater inf)

Added in API level 9

Constructs an InflaterOutputStream with the given Inflater and an implementation-defined default internal buffer size. out is a destination for uncompressed data, and compressed data will be written to this stream.

Parameters
out the destination OutputStream
inf the Inflater to be used for decompression

public InflaterOutputStream (OutputStream out, Inflater inf, int bufferSize)

Added in API level 9

Constructs an InflaterOutputStream with the given Inflater and given internal buffer size. out is a destination for uncompressed data, and compressed data will be written to this stream.

Parameters
out the destination OutputStream
inf the Inflater to be used for decompression
bufferSize the length in bytes of the internal buffer

Public Methods

public void close ()

Added in API level 9

Writes remaining data into the output stream and closes the underlying output stream.

Throws
IOException

public void finish ()

Added in API level 9

Finishes writing current uncompressed data into the InflaterOutputStream without closing it.

Throws
IOException if an I/O error occurs, or the stream has been closed

public void flush ()

Added in API level 9

Ensures that all pending data is sent out to the target stream. This implementation flushes the target stream.

Throws
IOException

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

Added in API level 9

Writes to the decompressing output stream. The bytes array should contain compressed input. The corresponding uncompressed data will be written to the underlying stream.

Parameters
bytes 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 I/O error occurs, or the stream has been closed
ZipException if a zip exception occurs.
NullPointerException if b == null.
IndexOutOfBoundsException if off < 0 || len < 0 || off + len > b.length

public void write (int b)

Added in API level 9

Writes a byte to the decompressing output stream. b should be a byte of compressed input. The corresponding uncompressed data will be written to the underlying stream.

Parameters
b the byte
Throws
IOException if an I/O error occurs, or the stream has been closed
ZipException if a zip exception occurs.
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.