All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class java.util.zip.DeflaterOutputStream

java.lang.Object
   |
   +----java.io.OutputStream
           |
           +----java.io.FilterOutputStream
                   |
                   +----java.util.zip.DeflaterOutputStream

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

buf: Output buffer for writing compressed data.
def: Compressor for this stream.

DeflaterOutputStream(OutputStream): Creates a new output stream with a defaul compressor and buffer size.
DeflaterOutputStream(OutputStream, Deflater): Creates a new output stream with the specified compressor and a default buffer size.
DeflaterOutputStream(OutputStream, Deflater, int): Creates a new output stream with the specified compressor and buffer size.

close(): Writes remaining compressed data to the output stream and closes the underlying stream.
deflate(): Writes next block of compressed data to the output stream.
finish(): Finishes writing compressed data to the output stream without closing the underlying stream.
write(byte[], int, int): Writes an array of bytes to the compressed output stream.
write(int): Writes a byte to the compressed output stream.

def

 protected Deflater def

Compressor for this stream.

buf

 protected byte buf[]

Output buffer for writing compressed data.

DeflaterOutputStream

 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"); len - the output buffer size

DeflaterOutputStream

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

DeflaterOutputStream

 public DeflaterOutputStream(OutputStream out)

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

write

 public void write(int b) throws IOException

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
Overrides:: write in class FilterOutputStream

write

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

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

Parameters:: buf - 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
Overrides:: write in class FilterOutputStream

finish

 public void finish() throws IOException

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

 public void close() throws IOException

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

Throws: IOException: if an I/O error has occurred
Overrides:: close in class FilterOutputStream

deflate

 protected void deflate() throws IOException

Writes next block of compressed data to the output stream.

All Packages  Class Hierarchy  This Package  Previous  Next  Index

Submit a bug or feature