Package org.apache.hadoop.io.compress

Class CompressionCodecFactory

java.lang.Object

org.apache.hadoop.io.compress.CompressionCodecFactory

@Public
@Evolving
public class CompressionCodecFactory
extends java.lang.Object

A factory that will find the correct codec for a given filename.

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
CompressionCodecFactory(Configuration conf)	Find the codecs specified in the config value io.compression.codecs and register them.

Method Summary

Modifier and Type	Method	Description
CompressionCodec	getCodec(Path file)	Find the relevant compression codec for the given file based on its filename suffix.
CompressionCodec	getCodecByClassName(java.lang.String classname)	Find the relevant compression codec for the codec's canonical class name.
CompressionCodec	getCodecByName(java.lang.String codecName)	Find the relevant compression codec for the codec's canonical class name or by codec alias.
java.lang.Class<? extends CompressionCodec>	getCodecClassByName(java.lang.String codecName)	Find the relevant compression codec for the codec's canonical class name or by codec alias and returns its implemetation class.
static java.util.List<java.lang.Class<? extends CompressionCodec>>	getCodecClasses(Configuration conf)	Get the list of codecs discovered via a Java ServiceLoader, or listed in the configuration.
static void	main(java.lang.String[] args)	A little test program.
static java.lang.String	removeSuffix(java.lang.String filename, java.lang.String suffix)	Removes a suffix from a filename, if it has it.
static void	setCodecClasses(Configuration conf, java.util.List<java.lang.Class> classes)	Sets a list of codec classes in the configuration.
java.lang.String	toString()	Print the extension map out as a string.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

Constructor Detail

CompressionCodecFactory

public CompressionCodecFactory(Configuration conf)

Find the codecs specified in the config value io.compression.codecs and register them. Defaults to gzip and deflate.

Parameters:

conf - configuration.

Method Detail

toString

public java.lang.String toString()

Print the extension map out as a string.

Overrides:

toString in class java.lang.Object

getCodecClasses

public static java.util.List<java.lang.Class<? extends CompressionCodec>> getCodecClasses(Configuration conf)

Get the list of codecs discovered via a Java ServiceLoader, or listed in the configuration. Codecs specified in configuration come later in the returned list, and are considered to override those from the ServiceLoader.

Parameters:

conf - the configuration to look in

Returns:

a list of the CompressionCodec classes

setCodecClasses

public static void setCodecClasses(Configuration conf,
                                   java.util.List<java.lang.Class> classes)

Sets a list of codec classes in the configuration. In addition to any classes specified using this method, CompressionCodec classes on the classpath are discovered using a Java ServiceLoader.

Parameters:

conf - the configuration to modify

classes - the list of classes to set

getCodec

public CompressionCodec getCodec(Path file)

Find the relevant compression codec for the given file based on its filename suffix.

Parameters:

file - the filename to check

Returns:

the codec object

getCodecByClassName

public CompressionCodec getCodecByClassName(java.lang.String classname)

Find the relevant compression codec for the codec's canonical class name.

Parameters:

classname - the canonical class name of the codec

Returns:

the codec object

getCodecByName

public CompressionCodec getCodecByName(java.lang.String codecName)

Find the relevant compression codec for the codec's canonical class name or by codec alias.

Codec aliases are case insensitive.

The code alias is the short class name (without the package name). If the short class name ends with 'Codec', then there are two aliases for the codec, the complete short class name and the short class name without the 'Codec' ending. For example for the 'GzipCodec' codec class name the alias are 'gzip' and 'gzipcodec'.

Parameters:

codecName - the canonical class name of the codec

Returns:

the codec object

getCodecClassByName

public java.lang.Class<? extends CompressionCodec> getCodecClassByName(java.lang.String codecName)

Find the relevant compression codec for the codec's canonical class name or by codec alias and returns its implemetation class.

Codec aliases are case insensitive.

The code alias is the short class name (without the package name). If the short class name ends with 'Codec', then there are two aliases for the codec, the complete short class name and the short class name without the 'Codec' ending. For example for the 'GzipCodec' codec class name the alias are 'gzip' and 'gzipcodec'.

Parameters:

codecName - the canonical class name of the codec

Returns:

the codec class

removeSuffix

public static java.lang.String removeSuffix(java.lang.String filename,
                                            java.lang.String suffix)

Removes a suffix from a filename, if it has it.

Parameters:

filename - the filename to strip

suffix - the suffix to remove

Returns:

the shortened filename

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

A little test program.

Parameters:

args - arguments.

Throws:

java.lang.Exception - exception.