DeflaterOutputStream (Java Platform SE 7 ) (original) (raw)

java.lang.Object
- java.io.OutputStream
- - java.io.FilterOutputStream
    - - java.util.zip.DeflaterOutputStream
All Implemented Interfaces:
Closeable, Flushable, AutoCloseable
Direct Known Subclasses:
GZIPOutputStream, ZipOutputStream

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.
See Also:
Deflater

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	buf Output buffer for writing compressed data.
protected Deflater	def Compressor for this stream.

   * ### Fields inherited from class java.io.[FilterOutputStream](../../../java/io/FilterOutputStream.html "class in java.io")  
   `[out](../../../java/io/FilterOutputStream.html#out)`

Constructor Summary

Constructors

Constructor and Description
DeflaterOutputStream(OutputStream out) Creates 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

Methods

Modifier and Type	Method and Description
void	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 inherited from class java.io.[FilterOutputStream](../../../java/io/FilterOutputStream.html "class in java.io")  
   `[write](../../../java/io/FilterOutputStream.html#write%28byte[]%29)`  
   * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
   `[clone](../../../java/lang/Object.html#clone%28%29), [equals](../../../java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../java/lang/Object.html#finalize%28%29), [getClass](../../../java/lang/Object.html#getClass%28%29), [hashCode](../../../java/lang/Object.html#hashCode%28%29), [notify](../../../java/lang/Object.html#notify%28%29), [notifyAll](../../../java/lang/Object.html#notifyAll%28%29), [toString](../../../java/lang/Object.html#toString%28%29), [wait](../../../java/lang/Object.html#wait%28%29), [wait](../../../java/lang/Object.html#wait%28long%29), [wait](../../../java/lang/Object.html#wait%28long,%20int%29)`

Field Detail

 * #### def  
 protected [Deflater](../../../java/util/zip/Deflater.html "class in java.util.zip") def  
 Compressor for this stream.  
 * #### buf  
 protected byte[] buf  
 Output buffer for writing compressed data.

Constructor Detail

* #### DeflaterOutputStream  
public DeflaterOutputStream([OutputStream](../../../java/io/OutputStream.html "class in java.io") out,  
                    [Deflater](../../../java/util/zip/Deflater.html "class in java.util.zip") def,  
                    int size,  
                    boolean syncFlush)  
Creates a new output stream with the specified compressor, buffer size and flush mode.  
Parameters:  
`out` \- the output stream  
`def` \- the compressor ("deflater")  
`size` \- the output buffer size  
`syncFlush` \- if `true` the [flush()](../../../java/util/zip/DeflaterOutputStream.html#flush%28%29) method of this instance flushes the compressor with flush mode[Deflater.SYNC\_FLUSH](../../../java/util/zip/Deflater.html#SYNC%5FFLUSH) before flushing the output stream, otherwise only flushes the output stream  
Throws:  
`[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if size is <= 0  
Since:  
1.7  
* #### DeflaterOutputStream  
public DeflaterOutputStream([OutputStream](../../../java/io/OutputStream.html "class in java.io") out,  
                    [Deflater](../../../java/util/zip/Deflater.html "class in java.util.zip") 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).  
Parameters:  
`out` \- the output stream  
`def` \- the compressor ("deflater")  
`size` \- the output buffer size  
Throws:  
`[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if size is <= 0  
* #### DeflaterOutputStream  
public DeflaterOutputStream([OutputStream](../../../java/io/OutputStream.html "class in java.io") out,  
                    [Deflater](../../../java/util/zip/Deflater.html "class in java.util.zip") def,  
                    boolean syncFlush)  
Creates a new output stream with the specified compressor, flush mode and a default buffer size.  
Parameters:  
`out` \- the output stream  
`def` \- the compressor ("deflater")  
`syncFlush` \- if `true` the [flush()](../../../java/util/zip/DeflaterOutputStream.html#flush%28%29) method of this instance flushes the compressor with flush mode[Deflater.SYNC\_FLUSH](../../../java/util/zip/Deflater.html#SYNC%5FFLUSH) before flushing the output stream, otherwise only flushes the output stream  
Since:  
1.7  
* #### DeflaterOutputStream  
public DeflaterOutputStream([OutputStream](../../../java/io/OutputStream.html "class in java.io") out,  
                    [Deflater](../../../java/util/zip/Deflater.html "class in java.util.zip") 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).  
Parameters:  
`out` \- the output stream  
`def` \- the compressor ("deflater")  
* #### DeflaterOutputStream  
public DeflaterOutputStream([OutputStream](../../../java/io/OutputStream.html "class in java.io") out,  
                    boolean syncFlush)  
Creates a new output stream with a default compressor, a default buffer size and the specified flush mode.  
Parameters:  
`out` \- the output stream  
`syncFlush` \- if `true` the [flush()](../../../java/util/zip/DeflaterOutputStream.html#flush%28%29) method of this instance flushes the compressor with flush mode[Deflater.SYNC\_FLUSH](../../../java/util/zip/Deflater.html#SYNC%5FFLUSH) before flushing the output stream, otherwise only flushes the output stream  
Since:  
1.7  
* #### DeflaterOutputStream  
public DeflaterOutputStream([OutputStream](../../../java/io/OutputStream.html "class in java.io") 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).  
Parameters:  
`out` \- the output stream

Method Detail

* #### write  
public void write(int b)  
           throws [IOException](../../../java/io/IOException.html "class in java.io")  
Writes a byte to the compressed output stream. This method will block until the byte can be written.  
**Overrides:**  
`[write](../../../java/io/FilterOutputStream.html#write%28int%29)` in class `[FilterOutputStream](../../../java/io/FilterOutputStream.html "class in java.io")`  
Parameters:  
`b` \- the byte to be written  
Throws:  
`[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error has occurred  
* #### write  
public void write(byte[] b,  
         int off,  
         int len)  
           throws [IOException](../../../java/io/IOException.html "class in java.io")  
Writes an array of bytes to the compressed output stream. This method will block until all the bytes are written.  
**Overrides:**  
`[write](../../../java/io/FilterOutputStream.html#write%28byte[],%20int,%20int%29)` in class `[FilterOutputStream](../../../java/io/FilterOutputStream.html "class in java.io")`  
Parameters:  
`b` \- 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)](../../../java/io/FilterOutputStream.html#write%28int%29)  
* #### finish  
public void finish()  
            throws [IOException](../../../java/io/IOException.html "class in java.io")  
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](../../../java/io/IOException.html "class in java.io")` \- if an I/O error has occurred  
* #### close  
public void close()  
           throws [IOException](../../../java/io/IOException.html "class in java.io")  
Writes remaining compressed data to the output stream and closes the underlying stream.  
**Specified by:**  
`[close](../../../java/io/Closeable.html#close%28%29)` in interface `[Closeable](../../../java/io/Closeable.html "interface in java.io")`  
**Specified by:**  
`[close](../../../java/lang/AutoCloseable.html#close%28%29)` in interface `[AutoCloseable](../../../java/lang/AutoCloseable.html "interface in java.lang")`  
**Overrides:**  
`[close](../../../java/io/FilterOutputStream.html#close%28%29)` in class `[FilterOutputStream](../../../java/io/FilterOutputStream.html "class in java.io")`  
Throws:  
`[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error has occurred  
See Also:  
[FilterOutputStream.flush()](../../../java/io/FilterOutputStream.html#flush%28%29), [FilterOutputStream.out](../../../java/io/FilterOutputStream.html#out)  
* #### deflate  
protected void deflate()  
                throws [IOException](../../../java/io/IOException.html "class in java.io")  
Writes next block of compressed data to the output stream.  
Throws:  
`[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error has occurred  
* #### flush  
public void flush()  
           throws [IOException](../../../java/io/IOException.html "class in java.io")  
Flushes the compressed output stream. If [syncFlush](../../../java/util/zip/DeflaterOutputStream.html#DeflaterOutputStream%28java.io.OutputStream,%20java.util.zip.Deflater,%20int,%20boolean%29) is `true` when this compressed output stream is constructed, this method first flushes the underlying `compressor` with the flush mode [Deflater.SYNC\_FLUSH](../../../java/util/zip/Deflater.html#SYNC%5FFLUSH) 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`.  
**Specified by:**  
`[flush](../../../java/io/Flushable.html#flush%28%29)` in interface `[Flushable](../../../java/io/Flushable.html "interface in java.io")`  
**Overrides:**  
`[flush](../../../java/io/FilterOutputStream.html#flush%28%29)` in class `[FilterOutputStream](../../../java/io/FilterOutputStream.html "class in java.io")`  
Throws:  
`[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error has occurred  
Since:  
1.7  
See Also:  
[FilterOutputStream.out](../../../java/io/FilterOutputStream.html#out)

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

DeflaterOutputStream (Java Platform SE 7 ) (original) (raw)

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail