public class DeflaterOutputStream extends FilterOutputStream
This class implements an output stream filter for compressing data in the "deflate" compression format. It is also used as the basis for other types of compression filters, such as GZIPOutputStream.
Deflater
protected Deflater def
Compressor for this stream.
protected byte[] buf
Output buffer for writing compressed data.
public DeflaterOutputStream(OutputStream out, Deflater def, int size, boolean syncFlush)
Creates a new output stream with the specified compressor, buffer size and flush mode.
out
- the output streamdef
- the compressor ("deflater")size
- the output buffer sizesyncFlush
- if true
the flush()
method of this instance flushes the compressor with flush mode Deflater.SYNC_FLUSH
before flushing the output stream, otherwise only flushes the output streamIllegalArgumentException
- if size <= 0
public DeflaterOutputStream(OutputStream out, Deflater def, int size)
Creates a new output stream with the specified compressor and buffer size.
The new output stream instance is created as if by invoking the 4-argument constructor DeflaterOutputStream(out, def, size, false).
out
- the output streamdef
- the compressor ("deflater")size
- the output buffer sizeIllegalArgumentException
- if size <= 0
public DeflaterOutputStream(OutputStream out, Deflater def, boolean syncFlush)
Creates a new output stream with the specified compressor, flush mode and a default buffer size.
out
- the output streamdef
- the compressor ("deflater")syncFlush
- if true
the flush()
method of this instance flushes the compressor with flush mode Deflater.SYNC_FLUSH
before flushing the output stream, otherwise only flushes the output streampublic DeflaterOutputStream(OutputStream out, Deflater def)
Creates a new output stream with the specified compressor and a default buffer size.
The new output stream instance is created as if by invoking the 3-argument constructor DeflaterOutputStream(out, def, false).
out
- the output streamdef
- the compressor ("deflater")public DeflaterOutputStream(OutputStream out, boolean syncFlush)
Creates a new output stream with a default compressor, a default buffer size and the specified flush mode.
out
- the output streamsyncFlush
- if true
the flush()
method of this instance flushes the compressor with flush mode Deflater.SYNC_FLUSH
before flushing the output stream, otherwise only flushes the output streampublic DeflaterOutputStream(OutputStream out)
Creates a new output stream with a default compressor and buffer size.
The new output stream instance is created as if by invoking the 2-argument constructor DeflaterOutputStream(out, false).
out
- the output streampublic void write(int b) throws IOException
Writes a byte to the compressed output stream. This method will block until the byte can be written.
write
in class FilterOutputStream
b
- the byte to be writtenIOException
- if an I/O error has occurredpublic void write(byte[] b, int off, int len) throws IOException
Writes an array of bytes to the compressed output stream. This method will block until all the bytes are written.
write
in class FilterOutputStream
b
- the data to be writtenoff
- the start offset of the datalen
- the length of the dataIOException
- if an I/O error has occurredFilterOutputStream.write(int)
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.
IOException
- if an I/O error has occurredpublic void close() throws IOException
Writes remaining compressed data to the output stream and closes the underlying stream.
close
in interface Closeable
close
in interface AutoCloseable
close
in class FilterOutputStream
IOException
- if an I/O error has occurredFilterOutputStream.flush()
, FilterOutputStream.out
protected void deflate() throws IOException
Writes next block of compressed data to the output stream.
IOException
- if an I/O error has occurredpublic void flush() throws IOException
Flushes the compressed output stream. If syncFlush
is true
when this compressed output stream is constructed, this method first flushes the underlying compressor
with the flush mode Deflater.SYNC_FLUSH
to force all pending data to be flushed out to the output stream and then flushes the output stream. Otherwise this method only flushes the output stream without flushing the compressor
.
flush
in interface Flushable
flush
in class FilterOutputStream
IOException
- if an I/O error has occurredFilterOutputStream.out
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.