Package org.apache.hadoop.io.compress

Class GzipCodec

java.lang.Object

org.apache.hadoop.io.compress.DefaultCodec

org.apache.hadoop.io.compress.GzipCodec

All Implemented Interfaces:

Configurable, CompressionCodec, DirectDecompressionCodec

@Public
@Evolving
public class GzipCodec
extends DefaultCodec

This class creates gzip compressors/decompressors.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.io.compress.CompressionCodec

CompressionCodec.Util

Constructor Summary

Constructors

Constructor	Description
GzipCodec()

Method Summary

Modifier and Type	Method	Description
Compressor	createCompressor()	Create a new Compressor for use by this CompressionCodec.
Decompressor	createDecompressor()	Create a new Decompressor for use by this CompressionCodec.
DirectDecompressor	createDirectDecompressor()	Create a new DirectDecompressor for use by this DirectDecompressionCodec.
CompressionInputStream	createInputStream(java.io.InputStream in)	Create a CompressionInputStream that will read from the given input stream.
CompressionInputStream	createInputStream(java.io.InputStream in, Decompressor decompressor)	Create a CompressionInputStream that will read from the given InputStream with the given Decompressor.
CompressionOutputStream	createOutputStream(java.io.OutputStream out)	Create a CompressionOutputStream that will write to the given OutputStream.
CompressionOutputStream	createOutputStream(java.io.OutputStream out, Compressor compressor)	Create a CompressionOutputStream that will write to the given OutputStream with the given Compressor.
java.lang.Class<? extends Compressor>	getCompressorType()	Get the type of Compressor needed by this CompressionCodec.
java.lang.Class<? extends Decompressor>	getDecompressorType()	Get the type of Decompressor needed by this CompressionCodec.
java.lang.String	getDefaultExtension()	Get the default filename extension for this kind of compression.

Methods inherited from class org.apache.hadoop.io.compress.DefaultCodec

getConf, setConf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GzipCodec

public GzipCodec()

Method Detail

createOutputStream

public CompressionOutputStream createOutputStream(java.io.OutputStream out)
                                           throws java.io.IOException

Description copied from interface: CompressionCodec

Create a CompressionOutputStream that will write to the given OutputStream.

Specified by:

createOutputStream in interface CompressionCodec

Overrides:

createOutputStream in class DefaultCodec

Parameters:

out - the location for the final output stream

Returns:

a stream the user can write uncompressed data to have it compressed

Throws:

java.io.IOException - raised on errors performing I/O.

createOutputStream

public CompressionOutputStream createOutputStream(java.io.OutputStream out,
                                                  Compressor compressor)
                                           throws java.io.IOException

Description copied from interface: CompressionCodec

Create a CompressionOutputStream that will write to the given OutputStream with the given Compressor.

Specified by:

createOutputStream in interface CompressionCodec

Overrides:

createOutputStream in class DefaultCodec

Parameters:

out - the location for the final output stream

compressor - compressor to use

Returns:

a stream the user can write uncompressed data to have it compressed

Throws:

java.io.IOException - raised on errors performing I/O.

createCompressor

public Compressor createCompressor()

Description copied from interface: CompressionCodec

Create a new Compressor for use by this CompressionCodec.

Specified by:

createCompressor in interface CompressionCodec

Overrides:

createCompressor in class DefaultCodec

Returns:

a new compressor for use by this codec

getCompressorType

public java.lang.Class<? extends Compressor> getCompressorType()

Description copied from interface: CompressionCodec

Get the type of Compressor needed by this CompressionCodec.

Specified by:

getCompressorType in interface CompressionCodec

Overrides:

getCompressorType in class DefaultCodec

Returns:

the type of compressor needed by this codec.

createInputStream

public CompressionInputStream createInputStream(java.io.InputStream in)
                                         throws java.io.IOException

Description copied from interface: CompressionCodec

Create a CompressionInputStream that will read from the given input stream.

Specified by:

createInputStream in interface CompressionCodec

Overrides:

createInputStream in class DefaultCodec

Parameters:

in - the stream to read compressed bytes from

Returns:

a stream to read uncompressed bytes from

Throws:

java.io.IOException - raised on errors performing I/O.

createInputStream

public CompressionInputStream createInputStream(java.io.InputStream in,
                                                Decompressor decompressor)
                                         throws java.io.IOException

Description copied from interface: CompressionCodec

Create a CompressionInputStream that will read from the given InputStream with the given Decompressor.

Specified by:

createInputStream in interface CompressionCodec

Overrides:

createInputStream in class DefaultCodec

Parameters:

in - the stream to read compressed bytes from

decompressor - decompressor to use

Returns:

a stream to read uncompressed bytes from

Throws:

java.io.IOException - raised on errors performing I/O.

createDecompressor

public Decompressor createDecompressor()

Description copied from interface: CompressionCodec

Create a new Decompressor for use by this CompressionCodec.

Specified by:

createDecompressor in interface CompressionCodec

Overrides:

createDecompressor in class DefaultCodec

Returns:

a new decompressor for use by this codec

getDecompressorType

public java.lang.Class<? extends Decompressor> getDecompressorType()

Description copied from interface: CompressionCodec

Get the type of Decompressor needed by this CompressionCodec.

Specified by:

getDecompressorType in interface CompressionCodec

Overrides:

getDecompressorType in class DefaultCodec

Returns:

the type of decompressor needed by this codec.

createDirectDecompressor

public DirectDecompressor createDirectDecompressor()

Description copied from class: DefaultCodec

Create a new DirectDecompressor for use by this DirectDecompressionCodec.

Specified by:

createDirectDecompressor in interface DirectDecompressionCodec

Overrides:

createDirectDecompressor in class DefaultCodec

Returns:

a new direct decompressor for use by this codec

getDefaultExtension

public java.lang.String getDefaultExtension()

Description copied from interface: CompressionCodec

Get the default filename extension for this kind of compression.

Specified by:

getDefaultExtension in interface CompressionCodec

Overrides:

getDefaultExtension in class DefaultCodec

Returns:

the extension including the '.'