Class DeflaterOutputStream
java.lang.Object
java.io.OutputStream
java.io.FilterOutputStream
java.util.zip.DeflaterOutputStream
- All Implemented Interfaces:
Closeable
,Flushable
,AutoCloseable
- Direct Known Subclasses:
GZIPOutputStream
,ZipOutputStream
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.
Unless otherwise noted, passing a null
argument to a constructor
or method in this class will cause a NullPointerException
to be
thrown.
- Since:
- 1.1
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionprotected byte[]
Output buffer for writing compressed data.protected Deflater
Compressor for this stream.Fields declared in class java.io.FilterOutputStream
out
-
Constructor Summary
ConstructorDescriptionCreates a new output stream with a default compressor and buffer size.DeflaterOutputStream
(OutputStream out, boolean syncFlush) Creates a new output stream with a default compressor, a default buffer size and the specified flush mode.DeflaterOutputStream
(OutputStream out, Deflater def) Creates a new output stream with the specified compressor and a default buffer size.DeflaterOutputStream
(OutputStream out, Deflater def, boolean syncFlush) Creates a new output stream with the specified compressor, flush mode and a default buffer size.DeflaterOutputStream
(OutputStream out, Deflater def, int size) Creates a new output stream with the specified compressor and buffer size.DeflaterOutputStream
(OutputStream out, Deflater def, int size, boolean syncFlush) Creates a new output stream with the specified compressor, buffer size and flush mode. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Writes remaining compressed data to the output stream and closes the underlying stream.protected 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.Methods declared in class java.io.FilterOutputStream
write
Methods declared in class java.io.OutputStream
nullOutputStream
-
Field Details
-
def
Compressor for this stream. -
buf
protected byte[] bufOutput buffer for writing compressed data.
-
-
Constructor Details
-
DeflaterOutputStream
Creates a new output stream with the specified compressor, buffer size and flush mode.- Parameters:
out
- the output streamdef
- the compressor ("deflater")size
- the output buffer sizesyncFlush
- iftrue
theflush()
method of this instance flushes the compressor with flush modeDeflater.SYNC_FLUSH
before flushing the output stream, otherwise only flushes the output stream- Throws:
IllegalArgumentException
- ifsize <= 0
- Since:
- 1.7
-
DeflaterOutputStream
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).
- Parameters:
out
- the output streamdef
- the compressor ("deflater")size
- the output buffer size- Throws:
IllegalArgumentException
- ifsize <= 0
-
DeflaterOutputStream
Creates a new output stream with the specified compressor, flush mode and a default buffer size.- Parameters:
out
- the output streamdef
- the compressor ("deflater")syncFlush
- iftrue
theflush()
method of this instance flushes the compressor with flush modeDeflater.SYNC_FLUSH
before flushing the output stream, otherwise only flushes the output stream- Since:
- 1.7
-
DeflaterOutputStream
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).
- Parameters:
out
- the output streamdef
- the compressor ("deflater")
-
DeflaterOutputStream
Creates a new output stream with a default compressor, a default buffer size and the specified flush mode.- Parameters:
out
- the output streamsyncFlush
- iftrue
theflush()
method of this instance flushes the compressor with flush modeDeflater.SYNC_FLUSH
before flushing the output stream, otherwise only flushes the output stream- Since:
- 1.7
-
DeflaterOutputStream
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).
- Parameters:
out
- the output stream
-
-
Method Details
-
write
Writes a byte to the compressed output stream. This method will block until the byte can be written.- Overrides:
write
in classFilterOutputStream
- Parameters:
b
- the byte to be written- Throws:
IOException
- if an I/O error has occurred
-
write
Writes an array of bytes to the compressed output stream. This method will block until all the bytes are written.- Overrides:
write
in classFilterOutputStream
- Parameters:
b
- 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.- Throws:
IOException
- if an I/O error has occurred
-
close
Writes remaining compressed data to the output stream and closes the underlying stream.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classFilterOutputStream
- Throws:
IOException
- if an I/O error has occurred- See Also:
-
deflate
Writes next block of compressed data to the output stream.- Throws:
IOException
- if an I/O error has occurred
-
flush
Flushes the compressed output stream. IfsyncFlush
istrue
when this compressed output stream is constructed, this method first flushes the underlyingcompressor
with the flush modeDeflater.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 thecompressor
.- Specified by:
flush
in interfaceFlushable
- Overrides:
flush
in classFilterOutputStream
- Throws:
IOException
- if an I/O error has occurred- Since:
- 1.7
- See Also:
-