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

protected byte[] buf

Output buffer for writing compressed data.

protected Deflater def

Compressor for this stream.

protected OutputStream out

The underlying output stream to be filtered.

Public constructors

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.

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.

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

void close()

Writes remaining compressed data to the output stream and closes the underlying stream.

void deflate()

Writes next block of compressed data to the output stream.

void finish()

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

void flush()

Flushes the compressed output stream.

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

Writes an array of bytes to the compressed output stream.

void write(int b)

Writes a byte to the compressed output stream.

void close()

Closes this output stream and releases any system resources associated with the stream.

void flush()

Flushes this output stream and forces any buffered output bytes to be written out to the stream.

void write(byte[] b)

Writes b.length bytes to this output stream.

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

Writes len bytes from the specified byte array starting at offset off to this output stream.

void write(int b)

Writes the specified byte to this output stream.

void close()

Closes this output stream and releases any system resources associated with this stream.

void flush()

Flushes this output stream and forces any buffered output bytes to be written out.

static OutputStream nullOutputStream()

Returns a new OutputStream which discards all bytes.

void write(byte[] b)

Writes b.length bytes from the specified byte array to this output stream.

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

Writes len bytes from the specified byte array starting at offset off to this output stream.

abstract void write(int b)

Writes the specified byte to this output stream.

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

abstract void close()

Closes this stream and releases any system resources associated with it.

abstract void flush()

Flushes this stream by writing any buffered output to the underlying stream.

abstract void close()

Closes this resource, relinquishing any underlying resources.

Fields

crc

Added in API level 1
protected CRC32 crc

CRC-32 of uncompressed data.

Public constructors

GZIPOutputStream

Added in API level 1
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 OutputStream: the output stream

Throws
IOException If an I/O error has occurred.

GZIPOutputStream

Added in API level 19
public 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 Deflater.SYNC_FLUSH before flushing the output stream, otherwise only flushes the output stream

Throws
IOException If an I/O error has occurred.

GZIPOutputStream

Added in API level 1
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). Android-note: Android limits the number of UnbufferedIO operations that can be performed, so consider using buffered inputs with this class. More information can be found in the UnbufferedIO and StrictMode documentation.

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
public 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 Deflater.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

Public methods

finish

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

write

Added in API level 1
public 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.