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

java.lang.Object
- java.io.OutputStream
- - java.io.FilterOutputStream
    - - java.util.zip.InflaterOutputStream
All Implemented Interfaces:
Closeable, Flushable, AutoCloseable

public class InflaterOutputStream
extends FilterOutputStream
Implements an output stream filter for uncompressing data stored in the "deflate" compression format.
Since:
1.6
See Also:
InflaterInputStream, DeflaterInputStream, DeflaterOutputStream

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	buf Output buffer for writing uncompressed data.
protected Inflater	inf Decompressor 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
InflaterOutputStream(OutputStream out) Creates a new output stream with a default decompressor and buffer size.
InflaterOutputStream(OutputStream out,Inflater infl) Creates a new output stream with the specified decompressor and a default buffer size.
InflaterOutputStream(OutputStream out,Inflater infl, int bufLen) Creates a new output stream with the specified decompressor and buffer size.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Writes any remaining uncompressed data to the output stream and closes the underlying output stream.
void	finish() Finishes writing uncompressed data to the output stream without closing the underlying stream.
void	flush() Flushes this output stream, forcing any pending buffered output bytes to be written.
void	write(byte[] b, int off, int len) Writes an array of bytes to the uncompressed output stream.
void	write(int b) Writes a byte to the uncompressed 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

 * #### inf  
 protected final [Inflater](../../../java/util/zip/Inflater.html "class in java.util.zip") inf  
 Decompressor for this stream.  
 * #### buf  
 protected final byte[] buf  
 Output buffer for writing uncompressed data.

Constructor Detail

* #### InflaterOutputStream  
public InflaterOutputStream([OutputStream](../../../java/io/OutputStream.html "class in java.io") out)  
Creates a new output stream with a default decompressor and buffer size.  
Parameters:  
`out` \- output stream to write the uncompressed data to  
Throws:  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if `out` is null  
* #### InflaterOutputStream  
public InflaterOutputStream([OutputStream](../../../java/io/OutputStream.html "class in java.io") out,  
                    [Inflater](../../../java/util/zip/Inflater.html "class in java.util.zip") infl)  
Creates a new output stream with the specified decompressor and a default buffer size.  
Parameters:  
`out` \- output stream to write the uncompressed data to  
`infl` \- decompressor ("inflater") for this stream  
Throws:  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if `out` or `infl` is null  
* #### InflaterOutputStream  
public InflaterOutputStream([OutputStream](../../../java/io/OutputStream.html "class in java.io") out,  
                    [Inflater](../../../java/util/zip/Inflater.html "class in java.util.zip") infl,  
                    int bufLen)  
Creates a new output stream with the specified decompressor and buffer size.  
Parameters:  
`out` \- output stream to write the uncompressed data to  
`infl` \- decompressor ("inflater") for this stream  
`bufLen` \- decompression buffer size  
Throws:  
`[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `bufLen` is <= 0  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if `out` or `infl` is null

Method Detail

* #### close  
public void close()  
           throws [IOException](../../../java/io/IOException.html "class in java.io")  
Writes any remaining uncompressed data to the output stream and closes the underlying output 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 occurs  
See Also:  
[FilterOutputStream.flush()](../../../java/io/FilterOutputStream.html#flush%28%29), [FilterOutputStream.out](../../../java/io/FilterOutputStream.html#out)  
* #### flush  
public void flush()  
           throws [IOException](../../../java/io/IOException.html "class in java.io")  
Flushes this output stream, forcing any pending buffered output bytes to be written.  
**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 occurs or this stream is already closed  
See Also:  
[FilterOutputStream.out](../../../java/io/FilterOutputStream.html#out)  
* #### finish  
public void finish()  
            throws [IOException](../../../java/io/IOException.html "class in java.io")  
Finishes writing uncompressed 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 occurs or this stream is already closed  
* #### write  
public void write(int b)  
           throws [IOException](../../../java/io/IOException.html "class in java.io")  
Writes a byte to the uncompressed output stream.  
**Overrides:**  
`[write](../../../java/io/FilterOutputStream.html#write%28int%29)` in class `[FilterOutputStream](../../../java/io/FilterOutputStream.html "class in java.io")`  
Parameters:  
`b` \- a single byte of compressed data to decompress and write to the output stream  
Throws:  
`[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs or this stream is already closed  
`[ZipException](../../../java/util/zip/ZipException.html "class in java.util.zip")` \- if a compression (ZIP) format error occurs  
* #### 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 uncompressed output stream.  
**Overrides:**  
`[write](../../../java/io/FilterOutputStream.html#write%28byte[],%20int,%20int%29)` in class `[FilterOutputStream](../../../java/io/FilterOutputStream.html "class in java.io")`  
Parameters:  
`b` \- buffer containing compressed data to decompress and write to the output stream  
`off` \- starting offset of the compressed data within `b`  
`len` \- number of bytes to decompress from `b`  
Throws:  
`[IndexOutOfBoundsException](../../../java/lang/IndexOutOfBoundsException.html "class in java.lang")` \- if `off` < 0, or if`len` < 0, or if `len` \> `b.length - off`  
`[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs or this stream is already closed  
`[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang")` \- if `b` is null  
`[ZipException](../../../java/util/zip/ZipException.html "class in java.util.zip")` \- if a compression (ZIP) format error occurs  
See Also:  
[FilterOutputStream.write(int)](../../../java/io/FilterOutputStream.html#write%28int%29)

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.

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

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail