GzipCompressorOutputStream (Apache Commons Compress 1.13 API)

java.lang.Object
- java.io.OutputStream
- - org.apache.commons.compress.compressors.CompressorOutputStream
  - - org.apache.commons.compress.compressors.gzip.GzipCompressorOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable
```
public class GzipCompressorOutputStream
extends CompressorOutputStream
```
Compressed output stream using the gzip format. This implementation improves over the standard GZIPOutputStream class by allowing the configuration of the compression level and the header metadata (filename, comment, modification time, operating system and extra flags).

See Also:
GZIP File Format Specification

Constructor Summary

Constructors
Constructor and Description
`GzipCompressorOutputStream(OutputStream out)` Creates a gzip compressed output stream with the default parameters.
`GzipCompressorOutputStream(OutputStream out, GzipParameters parameters)` Creates a gzip compressed output stream with the specified parameters.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()`
`void`	`finish()` Finishes writing compressed data to the underlying stream without closing it.
`void`	`flush()`
`void`	`write(byte[] buffer)`
`void`	`write(byte[] buffer, int offset, int length)`
`void`	`write(int b)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GzipCompressorOutputStream
```
public GzipCompressorOutputStream(OutputStream out)
                           throws IOException
```
    Creates a gzip compressed output stream with the default parameters.
    
    Parameters:
    out - the stream to compress to
    
    Throws:
    
    IOException - if writing fails
  - GzipCompressorOutputStream
```
public GzipCompressorOutputStream(OutputStream out,
                          GzipParameters parameters)
                           throws IOException
```
    Creates a gzip compressed output stream with the specified parameters.
    
    Parameters:
    out - the stream to compress to
    parameters - the parameters to use
    
    Throws:
    
    IOException - if writing fails
    Since:
    
    1.7
- Method Detail
  - write
```
public void write(int b)
           throws IOException
```
    Specified by:
    
    write in class OutputStream
    
    Throws:
    
    IOException
  - write
```
public void write(byte[] buffer)
           throws IOException
```
    Overrides:
    
    write in class OutputStream
    
    Throws:
    
    IOException
    Since:
    
    1.1
  - write
```
public void write(byte[] buffer,
         int offset,
         int length)
           throws IOException
```
    Overrides:
    
    write in class OutputStream
    
    Throws:
    
    IOException
    Since:
    
    1.1
  - finish
```
public void finish()
            throws IOException
```
    Finishes writing compressed data to the underlying stream without closing it.
    
    Throws:
    
    IOException - on error
    Since:
    
    1.7
  - flush
```
public void flush()
           throws IOException
```
    Specified by:
    
    flush in interface Flushable
    
    Overrides:
    
    flush in class OutputStream
    
    Throws:
    
    IOException
    Since:
    
    1.7
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Overrides:
    
    close in class OutputStream
    
    Throws:
    
    IOException

Class GzipCompressorOutputStream

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GzipCompressorOutputStream

GzipCompressorOutputStream

Method Detail

write

write

write

finish

flush

close