java.util.zip: public class: GZIPOutputStream

java.util.zip
public class: GZIPOutputStream [javadoc | source]

java.lang.Object
   java.io.OutputStream
      java.io.FilterOutputStream
         java.util.zip.DeflaterOutputStream
            java.util.zip.GZIPOutputStream

All Implemented Interfaces:
Flushable, Closeable

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

author: David - Connelly

Field Summary
protected CRC32	crc	CRC-32 of uncompressed data.

Fields inherited from java.util.zip.DeflaterOutputStream:
def, buf, usesDefaultDeflater

Fields inherited from java.io.FilterOutputStream:
out

Constructor:

Constructor:
public GZIPOutputStream(OutputStream out) throws IOException { this(out, 512); } Creates a new output stream with a default buffer size. Parameters: `out` - the output stream Throws: `IOException` - If an I/O error has occurred. exception: `IOException` - If an I/O error has occurred.
public GZIPOutputStream(OutputStream out, int size) throws IOException { super(out, new Deflater(Deflater.DEFAULT_COMPRESSION, true), size); usesDefaultDeflater = true; writeHeader(); crc.reset(); } 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 exception: `IOException` - If an I/O error has occurred. exception: `IllegalArgumentException` - if size is <= 0

 public GZIPOutputStream(OutputStream out) throws IOException {
        this(out, 512);
}

Creates a new output stream with a default buffer size.

Parameters:

out - the output stream

Throws:

IOException - If an I/O error has occurred.

exception: IOException - If an I/O error has occurred.

 public GZIPOutputStream(OutputStream out,
    int size) throws IOException {
                                             
        super(out, new Deflater(Deflater.DEFAULT_COMPRESSION, true), size);
        usesDefaultDeflater = true;
        writeHeader();
        crc.reset();
}

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

exception: IOException - If an I/O error has occurred.

exception: IllegalArgumentException - if size is <= 0

Method from java.util.zip.GZIPOutputStream Summary:
finish, write

Methods from java.util.zip.DeflaterOutputStream:
close, deflate, finish, 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.GZIPOutputStream Detail:
public void finish() throws IOException { if (!def.finished()) { def.finish(); while (!def.finished()) { int len = def.deflate(buf, 0, buf.length); if (def.finished() && len < = buf.length - TRAILER_SIZE) { // last deflater buffer. Fit trailer at the end writeTrailer(buf, len); len = len + TRAILER_SIZE; out.write(buf, 0, len); return; } if (len > 0) out.write(buf, 0, len); } // if we can't fit the trailer at the end of the last // deflater buffer, we write it separately byte[] trailer = new byte[TRAILER_SIZE]; writeTrailer(trailer, 0); out.write(trailer); } } 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 synchronized void write(byte[] buf, int off, int len) throws IOException { super.write(buf, off, len); crc.update(buf, off, len); } Writes array of bytes to the compressed output stream. This method will block until all the bytes are written.

Method from java.util.zip.GZIPOutputStream Detail:

 public  void finish() throws IOException {
        if (!def.finished()) {
            def.finish();
            while (!def.finished()) {
                int len = def.deflate(buf, 0, buf.length);
                if (def.finished() && len < = buf.length - TRAILER_SIZE) {
                    // last deflater buffer. Fit trailer at the end
                    writeTrailer(buf, len);
                    len = len + TRAILER_SIZE;
                    out.write(buf, 0, len);
                    return;
                }
                if (len  > 0)
                    out.write(buf, 0, len);
            }
            // if we can't fit the trailer at the end of the last
            // deflater buffer, we write it separately
            byte[] trailer = new byte[TRAILER_SIZE];
            writeTrailer(trailer, 0);
            out.write(trailer);
        }
}

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 synchronized  void write(byte[] buf,
    int off,
    int len) throws IOException {
        super.write(buf, off, len);
        crc.update(buf, off, len);
}

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