GZIPOutputStream (Java Platform SE 7 ) (original) (raw)

• java.lang.Object

• • java.io.OutputStream
  • • java.io.FilterOutputStream
      • • java.util.zip.DeflaterOutputStream
          * * java.util.zip.GZIPOutputStream

• All Implemented Interfaces:
  Closeable, Flushable, AutoCloseable

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

• • Field Summary

  Fields

  Modifier and Type	Field and Description
  protected CRC32	crc CRC-32 of uncompressed data.

     * ### Fields inherited from class java.util.zip.[DeflaterOutputStream](../../../java/util/zip/DeflaterOutputStream.html "class in java.util.zip")  
     `[buf](../../../java/util/zip/DeflaterOutputStream.html#buf), [def](../../../java/util/zip/DeflaterOutputStream.html#def)`  
     * ### Fields inherited from class java.io.[FilterOutputStream](../../../java/io/FilterOutputStream.html "class in java.io")  
     `[out](../../../java/io/FilterOutputStream.html#out)`  

  • Constructor Summary

  Constructors

  Constructor and Description
  GZIPOutputStream(OutputStream out) Creates a new output stream with a default buffer size.
  GZIPOutputStream(OutputStream out, boolean syncFlush) Creates a new output stream with a default buffer size and the specified flush mode.
  GZIPOutputStream(OutputStream out, int size) Creates a new output stream with the specified buffer size.
  GZIPOutputStream(OutputStream out, int size, boolean syncFlush) Creates a new output stream with the specified buffer size and flush mode.

  • Method Summary

  Methods

  Modifier and Type	Method and Description
  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](../../../java/util/zip/DeflaterOutputStream.html "class in java.util.zip")  
     `[close](../../../java/util/zip/DeflaterOutputStream.html#close%28%29), [deflate](../../../java/util/zip/DeflaterOutputStream.html#deflate%28%29), [flush](../../../java/util/zip/DeflaterOutputStream.html#flush%28%29), [write](../../../java/util/zip/DeflaterOutputStream.html#write%28int%29)`  
     * ### Methods inherited from class java.io.[FilterOutputStream](../../../java/io/FilterOutputStream.html "class in java.io")  
     `[write](../../../java/io/FilterOutputStream.html#write%28byte[]%29)`  
     * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../java/lang/Object.html#clone%28%29), [equals](../../../java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../java/lang/Object.html#finalize%28%29), [getClass](../../../java/lang/Object.html#getClass%28%29), [hashCode](../../../java/lang/Object.html#hashCode%28%29), [notify](../../../java/lang/Object.html#notify%28%29), [notifyAll](../../../java/lang/Object.html#notifyAll%28%29), [toString](../../../java/lang/Object.html#toString%28%29), [wait](../../../java/lang/Object.html#wait%28%29), [wait](../../../java/lang/Object.html#wait%28long%29), [wait](../../../java/lang/Object.html#wait%28long,%20int%29)`

• • Field Detail

     * #### crc  
     protected [CRC32](../../../java/util/zip/CRC32.html "class in java.util.zip") crc  
     CRC-32 of uncompressed data.  

  • Constructor Detail

    * #### GZIPOutputStream  
    public GZIPOutputStream([OutputStream](../../../java/io/OutputStream.html "class in java.io") out,  
                    int size)  
                     throws [IOException](../../../java/io/IOException.html "class in java.io")  
    Creates a new output stream with the specified buffer size.  
    The new output stream instance is created as if by invoking the 3-argument constructor GZIPOutputStream(out, size, false).  
    Parameters:  
    `out` \- the output stream  
    `size` \- the output buffer size  
    Throws:  
    `[IOException](../../../java/io/IOException.html "class in java.io")` \- If an I/O error has occurred.  
    `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if size is <= 0  
    * #### GZIPOutputStream  
    public GZIPOutputStream([OutputStream](../../../java/io/OutputStream.html "class in java.io") out,  
                    int size,  
                    boolean syncFlush)  
                     throws [IOException](../../../java/io/IOException.html "class in java.io")  
    Creates a new output stream with the specified buffer size and flush mode.  
    Parameters:  
    `out` \- the output stream  
    `size` \- the output buffer size  
    `syncFlush` \- if `true` invocation of the inherited[flush()](../../../java/util/zip/DeflaterOutputStream.html#flush%28%29) method of this instance flushes the compressor with flush mode[Deflater.SYNC\_FLUSH](../../../java/util/zip/Deflater.html#SYNC%5FFLUSH) before flushing the output stream, otherwise only flushes the output stream  
    Throws:  
    `[IOException](../../../java/io/IOException.html "class in java.io")` \- If an I/O error has occurred.  
    `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if size is <= 0  
    Since:  
    1.7  
    * #### GZIPOutputStream  
    public GZIPOutputStream([OutputStream](../../../java/io/OutputStream.html "class in java.io") out)  
                     throws [IOException](../../../java/io/IOException.html "class in java.io")  
    Creates a new output stream with a default buffer size.  
    The new output stream instance is created as if by invoking the 2-argument constructor GZIPOutputStream(out, false).  
    Parameters:  
    `out` \- the output stream  
    Throws:  
    `[IOException](../../../java/io/IOException.html "class in java.io")` \- If an I/O error has occurred.  
    * #### GZIPOutputStream  
    public GZIPOutputStream([OutputStream](../../../java/io/OutputStream.html "class in java.io") out,  
                    boolean syncFlush)  
                     throws [IOException](../../../java/io/IOException.html "class in java.io")  
    Creates a new output stream with a default buffer size and the specified flush mode.  
    Parameters:  
    `out` \- the output stream  
    `syncFlush` \- if `true` invocation of the inherited[flush()](../../../java/util/zip/DeflaterOutputStream.html#flush%28%29) method of this instance flushes the compressor with flush mode[Deflater.SYNC\_FLUSH](../../../java/util/zip/Deflater.html#SYNC%5FFLUSH) before flushing the output stream, otherwise only flushes the output stream  
    Throws:  
    `[IOException](../../../java/io/IOException.html "class in java.io")` \- If an I/O error has occurred.  
    Since:  
    1.7  

  • Method Detail

    * #### write  
    public void write(byte[] buf,  
             int off,  
             int len)  
               throws [IOException](../../../java/io/IOException.html "class in java.io")  
    Writes array of bytes to the compressed output stream. This method will block until all the bytes are written.  
    **Overrides:**  
    `[write](../../../java/util/zip/DeflaterOutputStream.html#write%28byte[],%20int,%20int%29)` in class `[DeflaterOutputStream](../../../java/util/zip/DeflaterOutputStream.html "class in java.util.zip")`  
    Parameters:  
    `buf` \- the data to be written  
    `off` \- the start offset of the data  
    `len` \- the length of the data  
    Throws:  
    `[IOException](../../../java/io/IOException.html "class in java.io")` \- If an I/O error has occurred.  
    See Also:  
    [FilterOutputStream.write(int)](../../../java/io/FilterOutputStream.html#write%28int%29)  
    * #### finish  
    public void finish()  
                throws [IOException](../../../java/io/IOException.html "class in java.io")  
    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.  
    **Overrides:**  
    `[finish](../../../java/util/zip/DeflaterOutputStream.html#finish%28%29)` in class `[DeflaterOutputStream](../../../java/util/zip/DeflaterOutputStream.html "class in java.util.zip")`  
    Throws:  
    `[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error has occurred

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.