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

java.util.zip

Class InflaterOutputStream

java.lang.Object java.io.OutputStream java.io.FilterOutputStream java.util.zip.InflaterOutputStream

All Implemented Interfaces:

Closeable, Flushable

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

inf

protected final Inflater inf

Decompressor for this stream.

buf

protected final byte[] buf

Output buffer for writing uncompressed data.

InflaterOutputStream

public InflaterOutputStream(OutputStream 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 out, Inflater 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 out, Inflater 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

close

public void close() throws IOException

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")

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(), FilterOutputStream.out

flush

public void flush() throws IOException

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

finish

public void finish() throws IOException

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

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

Writes an array of bytes to the uncompressed output stream.

Overrides:

[write](../../../java/io/FilterOutputStream.html#write%28byte[], int, int%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 iflen < 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)

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Scripting on this page tracks web page traffic, but does not change the content in any way.