Class GZIPOutputStream
java.lang.Object
java.io.OutputStream
java.io.FilterOutputStream
java.util.zip.DeflaterOutputStream
java.util.zip.GZIPOutputStream
- All Implemented Interfaces:
Closeable
,Flushable
,AutoCloseable
This class implements a stream filter for writing compressed data in the GZIP file format.
Unless otherwise noted, passing anull
argument to a constructor or method in this class will cause aNullPointerException
to be thrown.
- Since:
- 1.1
Field Summary
FieldsFields declared in class java.util.zip.DeflaterOutputStream
buf,def
Fields declared in class java.io.FilterOutputStream
out
Constructor Summary
ConstructorsConstructorDescriptionCreates 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.Method Summary
Methods declared in class java.util.zip.DeflaterOutputStream
close,deflate,flush,write
Methods declared in class java.io.FilterOutputStream
write
Methods declared in class java.io.OutputStream
nullOutputStream
Field Details
crc
CRC-32 of uncompressed data.
Constructor Details
GZIPOutputStream
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 streamsize
- the output buffer size- Throws:
IOException
- If an I/O error has occurred.IllegalArgumentException
- ifsize <= 0
GZIPOutputStream
Creates a new output stream with the specified buffer size and flush mode.- Parameters:
out
- the output streamsize
- the output buffer sizesyncFlush
- iftrue
invocation of the inheritedflush()
method of this instance flushes the compressor with flush modeDeflater.SYNC_FLUSH
before flushing the output stream, otherwise only flushes the output stream- Throws:
IOException
- If an I/O error has occurred.IllegalArgumentException
- ifsize <= 0
- Since:
- 1.7
GZIPOutputStream
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.
GZIPOutputStream
Creates a new output stream with a default buffer size and the specified flush mode.- Parameters:
out
- the output streamsyncFlush
- iftrue
invocation of the inheritedflush()
method of this instance flushes the compressor with flush modeDeflater.SYNC_FLUSH
before flushing the output stream, otherwise only flushes the output stream- Throws:
IOException
- If an I/O error has occurred.- Since:
- 1.7
Method Details
write
Writes array of bytes to the compressed output stream. This method will block until all the bytes are written.- Overrides:
write
in classDeflaterOutputStream
- Parameters:
buf
- the data to be writtenoff
- the start offset of the datalen
- the length of the data- Throws:
IOException
- If an I/O error has occurred.- See Also:
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.- Overrides:
finish
in classDeflaterOutputStream
- Throws:
IOException
- if an I/O error has occurred