This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.util.zip
class DeflaterOutputStream

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

Most common way to construct:

ByteArrayOutputStream baos = …;
Deflater def = …;

DeflaterOutputStream deflaterOS = new DeflaterOutputStream(baos, def);

Based on 9 examples


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.


Field Summary
protected byte[] buf
          Output buffer for writing compressed data.
protected Deflater def
          Compressor for this stream.
 
Fields inherited from class java.io.FilterOutputStream
out
 
Constructor Summary

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

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

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

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

          Writes next block of compressed data to the output stream.
 void

          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.
 
Methods inherited from class java.io.FilterOutputStream
close, flush, write, write, write
 
Methods inherited from class java.io.OutputStream
close, flush, write, write, write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

buf

protected byte[] buf
Output buffer for writing compressed data.

def

protected Deflater def
Compressor for this stream.
Constructor Detail

DeflaterOutputStream

public DeflaterOutputStream(OutputStream out)
Creates a new output stream with a default compressor and buffer size.

Parameters:
out - the output stream

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,
                            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
Method Detail

close

public void close()
           throws IOException
Writes remaining compressed data to the output stream and closes the underlying stream.

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

deflate

protected void deflate()
                throws IOException
Writes next block of compressed data to the output stream.

Throws:
IOException - if an I/O error has occurred

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

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.

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

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.

Overrides:
write in class FilterOutputStream
Parameters:
b - the byte to be written
Throws:
IOException - if an I/O error has occurred


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.