GZIPOutputStream

public class GZIPOutputStream extends DeflaterOutputStream

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

Field Summary

protected CRC32 crc CRC-32 of uncompressed data.

Inherited Field Summary

Public Constructor Summary

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 Method Summary

void
finish()
Finishes writing compressed data to the output stream without closing the underlying stream.
synchronized void
write(byte[] buf, int off, int len)
Writes array of bytes to the compressed output stream.

Inherited Method Summary

Fields

protected CRC32 crc

CRC-32 of uncompressed data.

Public Constructors

public 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 the output stream
size the output buffer size
Throws
IOException If an I/O error has occurred.
IllegalArgumentException if size is <= 0

public GZIPOutputStream (OutputStream out, int size, boolean syncFlush)

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

Parameters
out the output stream
size the output buffer size
syncFlush 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 is <= 0

public 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 the output stream
Throws
IOException If an I/O error has occurred.

public GZIPOutputStream (OutputStream out, boolean syncFlush)

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

Parameters
out the output stream
syncFlush 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

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

public synchronized 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 the data to be written
off the start offset of the data
len the length of the data
Throws
IOException If an I/O error has occurred.