Class GZIPOutputStream

  • All Implemented Interfaces:
    java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

    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

      Fields 
      Modifier and Type Field Description
      protected CRC32 crc
      CRC-32 value for uncompressed data
      • Fields inherited from class java.io.FilterOutputStream

        out
    • Constructor Summary

      Constructors 
      Constructor Description
      GZIPOutputStream​(java.io.OutputStream out)  
      GZIPOutputStream​(java.io.OutputStream out, int size)
      Creates a GZIPOutputStream with the specified buffer size
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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.io.FilterOutputStream

        write
      • Methods inherited from class java.io.OutputStream

        nullOutputStream
      • 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​(java.io.OutputStream out)
                         throws java.io.IOException
        Throws:
        java.io.IOException
      • GZIPOutputStream

        public GZIPOutputStream​(java.io.OutputStream out,
                                int size)
                         throws java.io.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:
        java.io.IOException
    • Method Detail

      • write

        public void write​(byte[] buf,
                          int off,
                          int len)
                   throws java.io.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:
        java.io.IOException
      • close

        public void close()
                   throws java.io.IOException
        Writes remaining compressed output data to the output stream and closes it.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Overrides:
        close in class DeflaterOutputStream
        Throws:
        java.io.IOException
      • finish

        public void finish()
                    throws java.io.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:
        java.io.IOException