Class GzipCompressorOutputStream
- 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 standardGZIPOutputStream
class by allowing the configuration of the compression level and the header metadata (file name, comment, modification time, operating system and extra flags).- See Also:
- GZIP File Format Specification
-
-
Constructor Summary
Constructors Constructor 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
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.io.OutputStream
nullOutputStream
-
-
-
-
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 toparameters
- 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 classOutputStream
- Throws:
IOException
-
write
public void write(byte[] buffer) throws IOException
- Overrides:
write
in classOutputStream
- Throws:
IOException
- Since:
- 1.1
-
write
public void write(byte[] buffer, int offset, int length) throws IOException
- Overrides:
write
in classOutputStream
- 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 interfaceFlushable
- Overrides:
flush
in classOutputStream
- Throws:
IOException
- Since:
- 1.7
-
close
public void close() throws IOException
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classOutputStream
- Throws:
IOException
-
-