GZIPOutputStream

public class GZIPOutputStream
extends DeflaterOutputStream

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


This class implements a stream filter for writing compressed data in the GZIP file format.

Summary

Fields

protected CRC32 crc

CRC-32 of uncompressed data.

Inherited fields

Public constructors

GZIPOutputStream(OutputStream out, int size)

Creates a new output stream with the specified buffer size.

GZIPOutputStream(OutputStream out, int size, boolean syncFlush)

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

GZIPOutputStream(OutputStream out)

Creates a new output stream with a default buffer size.

GZIPOutputStream(OutputStream out, boolean syncFlush)

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

Public methods

void finish()

Finishes writing compressed data to the output stream without closing the underlying stream.

void write(byte[] buf, int off, int len)

Writes array of bytes to the compressed output stream.

Inherited methods

Fields

crc

added in API level 1
CRC32 crc

CRC-32 of uncompressed data.

Public constructors

GZIPOutputStream

added in API level 1
GZIPOutputStream (OutputStream out, 
                int size)

Creates a new output stream with the specified buffer size.

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

Parameters
out OutputStream: the output stream

size int: the output buffer size

Throws
IOException If an I/O error has occurred.
IllegalArgumentException if size <= 0

GZIPOutputStream

added in API level 19
GZIPOutputStream (OutputStream out, 
                int size, 
                boolean syncFlush)

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

Parameters
out OutputStream: the output stream

size int: the output buffer size

syncFlush boolean: if true invocation of the inherited flush() method of this instance flushes the compressor with flush mode SYNC_FLUSH before flushing the output stream, otherwise only flushes the output stream

Throws
IOException If an I/O error has occurred.
IllegalArgumentException if size <= 0

GZIPOutputStream

added in API level 1
GZIPOutputStream (OutputStream out)

Creates a new output stream with a default buffer size.

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

Parameters
out OutputStream: the output stream

Throws
IOException If an I/O error has occurred.

GZIPOutputStream

added in API level 19
GZIPOutputStream (OutputStream out, 
                boolean syncFlush)

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

Parameters
out OutputStream: the output stream

syncFlush boolean: if true invocation of the inherited flush() method of this instance flushes the compressor with flush mode SYNC_FLUSH before flushing the output stream, otherwise only flushes the output stream

Throws
IOException If an I/O error has occurred.

Public methods

finish

added in API level 1
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

write

added in API level 1
void write (byte[] buf, 
                int off, 
                int len)

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

Parameters
buf 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.