public class

DeflaterOutputStream

extends FilterOutputStream
java.lang.Object
   ↳ java.io.OutputStream
     ↳ java.io.FilterOutputStream
       ↳ java.util.zip.DeflaterOutputStream
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

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

Summary

Fields
protected byte[] buf Output buffer for writing compressed data.
protected Deflater def Compressor for this stream.
[Expand]
Inherited Fields
From class java.io.FilterOutputStream
Public Constructors
DeflaterOutputStream(OutputStream out, Deflater def, int size)
Creates a new output stream with the specified compressor and buffer size.
DeflaterOutputStream(OutputStream out, Deflater def)
Creates a new output stream with the specified compressor and a default buffer size.
DeflaterOutputStream(OutputStream out)
Creates a new output stream with a default compressor and buffer size.
Public Methods
void close()
Writes remaining compressed data to the output stream and closes the underlying stream.
void finish()
Finishes writing compressed data to the output stream without closing the underlying 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.
Protected Methods
void deflate()
Writes next block of compressed data to the output stream.
[Expand]
Inherited Methods
From class java.io.FilterOutputStream
From class java.io.OutputStream
From class java.lang.Object
From interface java.io.Closeable
From interface java.io.Flushable

Fields

protected byte[] buf

Output buffer for writing compressed data.

protected Deflater def

Compressor for this stream.

Public Constructors

public DeflaterOutputStream (OutputStream out, Deflater def, int size)

Creates a new output stream with the specified compressor and buffer size.

Parameters
out the output stream
def the compressor ("deflater")
size the output buffer size
Throws
IllegalArgumentException if size is <= 0

public DeflaterOutputStream (OutputStream out, Deflater def)

Creates a new output stream with the specified compressor and a default buffer size.

Parameters
out the output stream
def the compressor ("deflater")

public DeflaterOutputStream (OutputStream out)

Creates a new output stream with a default compressor and buffer size.

Parameters
out the output stream

Public Methods

public void close ()

Writes remaining compressed data to the output stream and closes the underlying stream.

Throws
IOException if an I/O error has occurred

public void 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

public void write (byte[] b, int off, int len)

Writes an array of bytes to the compressed output stream. This method will block until all the bytes are written.

Parameters
b the data to be written
off the start offset of the data
len the length of the data
Throws
IOException if an I/O error has occurred

public void write (int b)

Writes a byte to the compressed output stream. This method will block until the byte can be written.

Parameters
b the byte to be written
Throws
IOException if an I/O error has occurred

Protected Methods

protected void deflate ()

Writes next block of compressed data to the output stream.

Throws
IOException if an I/O error has occurred