GZIPOutputStream (Java 2 Platform SE 5.0) (original) (raw)

java.util.zip

Class GZIPOutputStream

java.lang.Object extended by java.io.OutputStream java.io.FilterOutputStream java.util.zip.DeflaterOutputStream java.util.zip.GZIPOutputStream

All Implemented Interfaces:

Closeable, Flushable

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.

Fields inherited from class java.util.zip.DeflaterOutputStream
buf, def

Fields inherited from class java.io.FilterOutputStream
out

Constructor Summary
GZIPOutputStream(OutputStream out) Creates a new output stream with a default buffer size.
[GZIPOutputStream](../../../java/util/zip/GZIPOutputStream.html#GZIPOutputStream%28java.io.OutputStream, int%29)(OutputStream out, int size) Creates a new output stream with the specified buffer size.

Method Summary
void	finish() Finishes writing compressed data to the output stream without closing the underlying stream.
void	[write](../../../java/util/zip/GZIPOutputStream.html#write%28byte[], int, int%29)(byte[] buf, int off, int len) Writes array of bytes to the compressed output stream.

Methods inherited from class java.util.zip.DeflaterOutputStream
close, deflate, write

Methods inherited from class java.io.FilterOutputStream
flush, write

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../../java/lang/Object.html#wait%28long, int%29)

Field Detail

crc

protected CRC32 crc

CRC-32 of uncompressed data.

Constructor Detail

GZIPOutputStream

public GZIPOutputStream(OutputStream out, int size) throws IOException

Creates a new output stream with the specified buffer size.

Parameters:

out - the output stream

size - the output buffer size

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - If an I/O error has occurred.

[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang") - if size is <= 0

GZIPOutputStream

public GZIPOutputStream(OutputStream out) throws IOException

Creates a new output stream with a default buffer size.

Parameters:

out - the output stream

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - If an I/O error has occurred.

Method Detail

write

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

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

Overrides:

[write](../../../java/util/zip/DeflaterOutputStream.html#write%28byte[], int, int%29) in class [DeflaterOutputStream](../../../java/util/zip/DeflaterOutputStream.html "class in java.util.zip")

Parameters:

buf - the data to be written

off - the start offset of the data

len - the length of the data

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - If an I/O error has occurred.

See Also:

FilterOutputStream.write(int)

finish

public void finish() throws IOException

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.

Overrides:

[finish](../../../java/util/zip/DeflaterOutputStream.html#finish%28%29) in class [DeflaterOutputStream](../../../java/util/zip/DeflaterOutputStream.html "class in java.util.zip")

Throws:

[IOException](../../../java/io/IOException.html "class in java.io") - if an I/O error has occurred

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.