- java.lang.Object
-
- java.io.OutputStream
-
- java.io.FilterOutputStream
-
- java.util.zip.DeflaterOutputStream
-
- java.util.zip.GZIPOutputStream
-
- All Implemented Interfaces:
- Closeable, Flushable, AutoCloseable
public class GZIPOutputStream extends DeflaterOutputStream
This class implements a stream filter for writing compressed data in the GZIP file format.
-
-
Field Summary
Fields Modifier and Type Field and Description protected CRC32
crc
CRC-32 of uncompressed data.-
Fields inherited from class java.io.FilterOutputStream
out
-
-
Constructor Summary
Constructors Constructor and Description 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.
-
Method Summary
Methods Modifier and Type Method and Description 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.-
Methods inherited from class java.io.FilterOutputStream
write
-
-
-
-
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.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
- if size is <= 0
-
GZIPOutputStream
public GZIPOutputStream(OutputStream out, int size, boolean syncFlush) throws IOException
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
- if size is <= 0- Since:
- 1.7
-
GZIPOutputStream
public GZIPOutputStream(OutputStream out) throws IOException
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
public GZIPOutputStream(OutputStream out, boolean syncFlush) throws IOException
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 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
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:
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
in classDeflaterOutputStream
- Throws:
IOException
- if an I/O error has occurred
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-java/util/zip/gzipoutputstream.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.