java.util.zip
Class GZIPOutputStream

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

public class GZIPOutputStream
extends DeflaterOutputStream

This filter stream is used to compress a stream into a "GZIP" stream. The "GZIP" format is described in RFC 1952.

Since:
JDK 1.1

Field Summary
protected  CRC32 crc
          CRC-32 value for 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 GZIPOutputStream with the default buffer size
GZIPOutputStream(OutputStream out, int size)
          Creates a GZIPOutputStream with the specified buffer size
 
Method Summary
 void close()
          Writes remaining compressed output data to the output stream and closes it.
 void finish()
          Finishes the stream by calling finish() on the deflater.
 void write(byte[] buf, int off, int len)
          Writes a len bytes from an array to the compressed stream.
 
Methods inherited from class java.util.zip.DeflaterOutputStream
deflate, flush, write
 
Methods inherited from class java.io.FilterOutputStream
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 value for uncompressed data

Constructor Detail

GZIPOutputStream

public GZIPOutputStream(OutputStream out)
                 throws IOException
Creates a GZIPOutputStream with the default buffer size

Parameters:
out - The stream to read data (to be compressed) from
Throws:
IOException

GZIPOutputStream

public GZIPOutputStream(OutputStream out,
                        int size)
                 throws IOException
Creates a GZIPOutputStream with the specified buffer size

Parameters:
out - The stream to read compressed data from
size - Size of the buffer to use
Throws:
IOException
Method Detail

write

public void write(byte[] buf,
                  int off,
                  int len)
           throws IOException
Description copied from class: DeflaterOutputStream
Writes a len bytes from an array to the compressed stream.

Overrides:
write in class DeflaterOutputStream
Parameters:
buf - the byte array.
off - the offset into the byte array where to start.
len - the number of bytes to write.
Throws:
IOException - If an error occurs

close

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

Specified by:
close in interface Closeable
Overrides:
close in class DeflaterOutputStream
Throws:
IOException - If an error occurs

finish

public void finish()
            throws IOException
Description copied from class: DeflaterOutputStream
Finishes the stream by calling finish() on the deflater. This was the only way to ensure that all bytes are flushed in Sun's JDK.

Overrides:
finish in class DeflaterOutputStream
Throws:
IOException