Java Platform 1.2

java.util.zip
Class GZIPOutputStream

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

public class GZIPOutputStream
extends DeflaterOutputStream

This class implements a stream filter for writing compressed data in the GZIP file format.


Field Summary
protected  CRC32 crc
          CRC-32 of uncompressed data.
 
Fields inherited from class java.util.zip.DeflaterOutputStream
buf, def
 
Fields inherited from class java.io.FilterOutputStream
out
 
Constructor Summary
GZIPOutputStream(OutputStream out)
          Creates a new output stream with a default buffer size.
GZIPOutputStream(OutputStream out, int size)
          Creates a new output stream with the specified buffer size.
 
Method Summary
 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[] buf, int off, int len)
          Writes array of bytes to the compressed output stream.
 
Methods inherited from class java.util.zip.DeflaterOutputStream
deflate, write
 
Methods inherited from class java.io.FilterOutputStream
flush, write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

crc

protected CRC32 crc
CRC-32 of uncompressed data.
Constructor Detail

GZIPOutputStream

public GZIPOutputStream(OutputStream out,
                        int size)
                 throws IOException
Creates a new output stream with the specified buffer size.
Parameters:
out - the output stream
size - the output buffer size
Throws:
IOException - If an I/O error has occurred.
IllegalArgumentException - if size is <= 0

GZIPOutputStream

public GZIPOutputStream(OutputStream out)
                 throws IOException
Creates a new output stream with a default buffer size.
Parameters:
out - the output stream
Throws:
IOException - If an I/O error has occurred.
Method Detail

write

public void write(byte[] buf,
                  int off,
                  int len)
           throws IOException
Writes 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 DeflaterOutputStream

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
Overrides:
finish in class DeflaterOutputStream

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 DeflaterOutputStream

Java Platform 1.2

Submit a bug or feature Version 1.2 of Java Platform API Specification
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.