Save This Page
Home » openjdk-7 » java » util » zip » [javadoc | source]
java.util.zip
public class: DeflaterOutputStream [javadoc | source]
java.lang.Object
   java.io.OutputStream
      java.io.FilterOutputStream
         java.util.zip.DeflaterOutputStream

All Implemented Interfaces:
    Flushable, Closeable

Direct Known Subclasses:
    JarOutputStream, GZIPOutputStream, ZipOutputStream

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  Deflater def    Compressor for this stream. 
protected  byte[] buf    Output buffer for writing compressed data. 
 boolean usesDefaultDeflater     
Fields inherited from java.io.FilterOutputStream:
out
Constructor:
 public DeflaterOutputStream(OutputStream out) 
    Creates a new output stream with a default compressor and buffer size.

    The new output stream instance is created as if by invoking the 2-argument constructor DeflaterOutputStream(out, false).

    Parameters:
    out - the output stream
 public DeflaterOutputStream(OutputStream out,
    Deflater def) 
    Creates a new output stream with the specified compressor and a default buffer size.

    The new output stream instance is created as if by invoking the 3-argument constructor DeflaterOutputStream(out, def, false).

    Parameters:
    out - the output stream
    def - the compressor ("deflater")
 public DeflaterOutputStream(OutputStream out,
    boolean syncFlush) 
    Creates a new output stream with a default compressor, a default buffer size and the specified flush mode.
    Parameters:
    out - the output stream
    syncFlush - if {@code true} the #flush() method of this instance flushes the compressor with flush mode Deflater#SYNC_FLUSH before flushing the output stream, otherwise only flushes the output stream
    since: 1.7 -
 public DeflaterOutputStream(OutputStream out,
    Deflater def,
    int size) 
    Creates a new output stream with the specified compressor and buffer size.

    The new output stream instance is created as if by invoking the 4-argument constructor DeflaterOutputStream(out, def, size, false).

    Parameters:
    out - the output stream
    def - the compressor ("deflater")
    size - the output buffer size
    Throws:
    IllegalArgumentException - if size is <= 0
    exception: IllegalArgumentException - if size is <= 0
 public DeflaterOutputStream(OutputStream out,
    Deflater def,
    boolean syncFlush) 
    Creates a new output stream with the specified compressor, flush mode and a default buffer size.
    Parameters:
    out - the output stream
    def - the compressor ("deflater")
    syncFlush - if {@code true} the #flush() method of this instance flushes the compressor with flush mode Deflater#SYNC_FLUSH before flushing the output stream, otherwise only flushes the output stream
    since: 1.7 -
 public DeflaterOutputStream(OutputStream out,
    Deflater def,
    int size,
    boolean syncFlush) 
    Creates a new output stream with the specified compressor, buffer size and flush mode.
    Parameters:
    out - the output stream
    def - the compressor ("deflater")
    size - the output buffer size
    syncFlush - if {@code true} the #flush() method of this instance flushes the compressor with flush mode Deflater#SYNC_FLUSH before flushing the output stream, otherwise only flushes the output stream
    Throws:
    IllegalArgumentException - if size is <= 0
    since: 1.7 -
Method from java.util.zip.DeflaterOutputStream Summary:
close,   deflate,   finish,   flush,   write,   write
Methods from java.io.FilterOutputStream:
close,   flush,   write,   write,   write
Methods from java.io.OutputStream:
close,   flush,   write,   write,   write
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.util.zip.DeflaterOutputStream Detail:
 public  void close() throws IOException 
    Writes remaining compressed data to the output stream and closes the underlying stream.
 protected  void deflate() throws IOException 
    Writes next block of compressed data to the output stream.
 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.
 public  void flush() throws IOException 
    Flushes the compressed output stream. If Deflater, int, boolean) syncFlush is {@code true} when this compressed output stream is constructed, this method first flushes the underlying {@code compressor} with the flush mode Deflater#SYNC_FLUSH to force all pending data to be flushed out to the output stream and then flushes the output stream. Otherwise this method only flushes the output stream without flushing the {@code compressor}.
 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.
 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.