to top
Android APIs
public class

GZIPOutputStream

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

Class Overview

The GZIPOutputStream class is used to write data to a stream in the GZIP storage format.

Example

Using GZIPOutputStream is a little easier than ZipOutputStream because GZIP is only for compression, and is not a container for multiple files. This code creates a GZIP stream, similar to the gzip(1) utility. 

 OutputStream os = ...
 byte[] bytes = ...
 GZIPOutputStream zos = new GZIPOutputStream(new BufferedOutputStream(os));
 try {
     zos.write(bytes);
 } finally {
     zos.close();
 }

Summary

Fields
protected CRC32 crc The checksum algorithm used when treating uncompressed data.
[Expand]
Inherited Fields
From class java.util.zip.DeflaterOutputStream
From class java.io.FilterOutputStream
Public Constructors
GZIPOutputStream( OutputStream os)
Construct a new GZIPOutputStream to write data in GZIP format to the underlying stream.
GZIPOutputStream( OutputStream os, int size)
Construct a new GZIPOutputStream to write data in GZIP format to the underlying stream.
Public Methods
void finish()
Indicates to the stream that all data has been written out, and any GZIP terminal data can now be written.
void write(byte[] buffer, int off, int nbytes)
Write up to nbytes of data from the given buffer, starting at offset off, to the underlying stream in GZIP format.
[Expand]
Inherited Methods
From class java.util.zip.DeflaterOutputStream
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 CRC32 crc

Added in API level 1

The checksum algorithm used when treating uncompressed data.

Public Constructors

public GZIPOutputStream (OutputStream os)

Added in API level 1

Construct a new GZIPOutputStream to write data in GZIP format to the underlying stream.

Parameters
os the OutputStream to write data to.
Throws
IOException if an IOException occurs.

public GZIPOutputStream (OutputStream os, int size)

Added in API level 1

Construct a new GZIPOutputStream to write data in GZIP format to the underlying stream. Set the internal compression buffer to size size.

Parameters
os the OutputStream to write to.
size the internal buffer size.
Throws
IOException if an IOException occurs.

Public Methods

public void finish ()

Added in API level 1

Indicates to the stream that all data has been written out, and any GZIP terminal data can now be written.

Throws
IOException if an IOException occurs.

public void write (byte[] buffer, int off, int nbytes)

Added in API level 1

Write up to nbytes of data from the given buffer, starting at offset off, to the underlying stream in GZIP format.

Parameters
buffer the buffer to write.
off the index of the first byte in buffer to write.
nbytes the number of bytes in buffer to write.
Throws
IOException
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.