Uses of Interface org.apache.hadoop.io.compress.CompressionCodec (Apache Hadoop Common 3.5.0 API)
Description: use: package: org.apache.hadoop.io.compress, interface: CompressionCodec

# Uses of Interface
org.apache.hadoop.io.compress.CompressionCodec

Packages that use CompressionCodec
Package
Description
org.apache.hadoop.io
Generic i/o code for use when reading and writing data to the network, to databases, and to files.
org.apache.hadoop.io.compress

- ## Uses of CompressionCodec in org.apache.hadoop.io

  Methods in org.apache.hadoop.io that return CompressionCodec
  Modifier and Type
  Method
  Description
  `CompressionCodec`
  SequenceFile.Reader.`getCompressionCodec()`
  Returns the compression codec of data in this file.
  `CompressionCodec`
  SequenceFile.Writer.`getCompressionCodec()`
  Methods in org.apache.hadoop.io with parameters of type CompressionCodec
  Modifier and Type
  Method
  Description
  `static SequenceFile.Writer.Option`
  MapFile.Writer.`compression(SequenceFile.CompressionType type, CompressionCodec codec)`
  `static SequenceFile.Writer.Option`
  SequenceFile.Writer.`compression(SequenceFile.CompressionType value, CompressionCodec codec)`
  `static SequenceFile.Writer`
  SequenceFile.`createWriter(Configuration conf, FSDataOutputStream out, Class keyClass, Class valClass, SequenceFile.CompressionType compressionType, CompressionCodec codec)`
  Deprecated.
  Use `SequenceFile.createWriter(Configuration, Writer.Option...)` instead.
  `static SequenceFile.Writer`
  SequenceFile.`createWriter(Configuration conf, FSDataOutputStream out, Class keyClass, Class valClass, SequenceFile.CompressionType compressionType, CompressionCodec codec, SequenceFile.Metadata metadata)`
  Deprecated.
  Use `SequenceFile.createWriter(Configuration, Writer.Option...)` instead.
  `static SequenceFile.Writer`
  SequenceFile.`createWriter(FileContext fc, Configuration conf, Path name, Class keyClass, Class valClass, SequenceFile.CompressionType compressionType, CompressionCodec codec, SequenceFile.Metadata metadata, EnumSet<CreateFlag> createFlag, Options.CreateOpts... opts)`
  Construct the preferred type of SequenceFile Writer.
  `static SequenceFile.Writer`
  SequenceFile.`createWriter(FileSystem fs, Configuration conf, Path name, Class keyClass, Class valClass, int bufferSize, short replication, long blockSize, boolean createParent, SequenceFile.CompressionType compressionType, CompressionCodec codec, SequenceFile.Metadata metadata)`
  Deprecated.
  `static SequenceFile.Writer`
  SequenceFile.`createWriter(FileSystem fs, Configuration conf, Path name, Class keyClass, Class valClass, int bufferSize, short replication, long blockSize, SequenceFile.CompressionType compressionType, CompressionCodec codec, Progressable progress, SequenceFile.Metadata metadata)`
  Deprecated.
  Use `SequenceFile.createWriter(Configuration, Writer.Option...)` instead.
  `static SequenceFile.Writer`
  SequenceFile.`createWriter(FileSystem fs, Configuration conf, Path name, Class keyClass, Class valClass, SequenceFile.CompressionType compressionType, CompressionCodec codec)`
  Deprecated.
  Use `SequenceFile.createWriter(Configuration, Writer.Option...)` instead.
  `static SequenceFile.Writer`
  SequenceFile.`createWriter(FileSystem fs, Configuration conf, Path name, Class keyClass, Class valClass, SequenceFile.CompressionType compressionType, CompressionCodec codec, Progressable progress)`
  Deprecated.
  Use `SequenceFile.createWriter(Configuration, Writer.Option...)` instead.
  `static SequenceFile.Writer`
  SequenceFile.`createWriter(FileSystem fs, Configuration conf, Path name, Class keyClass, Class valClass, SequenceFile.CompressionType compressionType, CompressionCodec codec, Progressable progress, SequenceFile.Metadata metadata)`
  Deprecated.
  Use `SequenceFile.createWriter(Configuration, Writer.Option...)` instead.
  Constructors in org.apache.hadoop.io with parameters of type CompressionCodec
  Modifier
  Constructor
  Description
  ``
  `Writer(Configuration conf, FileSystem fs, String dirName, Class<? extends WritableComparable> keyClass, Class<? extends Writable> valClass, SequenceFile.CompressionType compress, CompressionCodec codec, Progressable progress)`
  Deprecated.
  ``
  `Writer(Configuration conf, FileSystem fs, String dirName, WritableComparator comparator, Class valClass, SequenceFile.CompressionType compress, CompressionCodec codec, Progressable progress)`
  Deprecated.
  ``
  `Writer(Configuration conf, FileSystem fs, String dirName, Class<? extends WritableComparable> keyClass, Class valClass, SequenceFile.CompressionType compress, CompressionCodec codec, Progressable progress)`
  Deprecated.
  Use Writer(Configuration, Path, Option...) instead.
  ``
  `Writer(Configuration conf, FileSystem fs, String dirName, WritableComparator comparator, Class valClass, SequenceFile.CompressionType compress, CompressionCodec codec, Progressable progress)`
  Deprecated.
  Use Writer(Configuration, Path, Option...) instead.

- ## Uses of CompressionCodec in org.apache.hadoop.io.compress

  Subinterfaces of CompressionCodec in org.apache.hadoop.io.compress
  Modifier and Type
  Interface
  Description
  `interface`
  `DirectDecompressionCodec`
  This class encapsulates a codec which can decompress direct bytebuffers.
  `interface`
  `SplittableCompressionCodec`
  This interface is meant to be implemented by those compression codecs which are capable to compress / de-compress a stream starting at any arbitrary position.
  Classes in org.apache.hadoop.io.compress that implement CompressionCodec
  Modifier and Type
  Class
  Description
  `class`
  `BZip2Codec`
  This class provides output and input streams for bzip2 compression and decompression.
  `class`
  `DefaultCodec`
  `class`
  `DeflateCodec`
  Alias class for DefaultCodec to enable codec discovery by 'deflate' name.
  `class`
  `GzipCodec`
  This class creates gzip compressors/decompressors.
  `class`
  `Lz4Codec`
  This class creates lz4 compressors/decompressors.
  `class`
  `PassthroughCodec`
  This is a special codec which does not transform the output.
  `class`
  `SnappyCodec`
  This class creates snappy compressors/decompressors.
  `class`
  `ZStandardCodec`
  This class creates zstd compressors/decompressors.
  Methods in org.apache.hadoop.io.compress that return CompressionCodec
  Modifier and Type
  Method
  Description
  `CompressionCodec`
  CompressionCodecFactory.`getCodec(Path file)`
  Find the relevant compression codec for the given file based on its filename suffix.
  `CompressionCodec`
  CompressionCodecFactory.`getCodecByClassName(String classname)`
  Find the relevant compression codec for the codec's canonical class name.
  `CompressionCodec`
  CompressionCodecFactory.`getCodecByName(String codecName)`
  Find the relevant compression codec for the codec's canonical class name or by codec alias.
  Methods in org.apache.hadoop.io.compress that return types with arguments of type CompressionCodec
  Modifier and Type
  Method
  Description
  `Class<? extends CompressionCodec>`
  CompressionCodecFactory.`getCodecClassByName(String codecName)`
  Find the relevant compression codec for the codec's canonical class name or by codec alias and returns its implemetation class.
  `static List<Class<? extends CompressionCodec>>`
  CompressionCodecFactory.`getCodecClasses(Configuration conf)`
  Get the list of codecs discovered via a Java ServiceLoader, or listed in the configuration.
  Methods in org.apache.hadoop.io.compress with parameters of type CompressionCodec
  Modifier and Type
  Method
  Description
  `static Compressor`
  CodecPool.`getCompressor(CompressionCodec codec)`
  `static Compressor`
  CodecPool.`getCompressor(CompressionCodec codec, Configuration conf)`
  Get a `Compressor` for the given `CompressionCodec` from the pool or a new one.
  `static Decompressor`
  CodecPool.`getDecompressor(CompressionCodec codec)`
  Get a `Decompressor` for the given `CompressionCodec` from the pool or a new one.
  `static int`
  CodecPool.`getLeasedCompressorsCount(CompressionCodec codec)`
  Return the number of leased `Compressor`s for this `CompressionCodec`.
  `static int`
  CodecPool.`getLeasedDecompressorsCount(CompressionCodec codec)`
  Return the number of leased `Decompressor`s for this `CompressionCodec`.