org.apache.commons.codec (Apache Commons Codec 1.22.0 API)
Description: declaration: package: org.apache.commons.codec

# Package org.apache.commons.codec

package org.apache.commons.codec
Interfaces and classes used by the various implementations in the sub-packages.

Definitive implementations of commonly used encoders and decoders.

Codec is currently comprised of a modest set of utilities and a simple framework for String encoding and decoding in the following packages:

- Binary codecs: Base16, Base32, and Base64.
- Command line utility.
- Digests and hashers
- Common language and phonetic encoders.
- Beider-Morse codec.
- Network codecs.

- Related Packages
  Package
  Description
  org.apache.commons.codec.binary
  Base64, Base32, Base16, BaseN, Binary, and Hexadecimal String encoding and decoding.
  org.apache.commons.codec.cli
  Command line utility.
  org.apache.commons.codec.digest
  Simplifies common `MessageDigest` tasks and includes a libc crypt(3) compatible crypt method that supports DES, MD5, SHA-256 and SHA-512 based algorithms as well as the Apache specific "$apr1$" variant.
  org.apache.commons.codec.language
  Language and phonetic encoders.
  org.apache.commons.codec.net
  Network related encoding and decoding.
- Class
  Description
  BinaryDecoder
  Defines common decoding methods for byte array decoders.
  BinaryEncoder
  Defines common encoding methods for byte array encoders.
  CharEncoding
  Character encoding names required of every implementation of the Java platform.
  Charsets
  Charsets required of every implementation of the Java platform.
  CodecPolicy
  Enumerates encoding and decoding policies.
  Decoder
  Provides the highest level of abstraction for Decoders.
  DecoderException
  Thrown when there is a failure condition during the decoding process.
  Encoder
  Provides the highest level of abstraction for Encoders.
  EncoderException
  Thrown when there is a failure condition during the encoding process.
  Resources
  Consider this class package private.
  StringDecoder
  Defines common decoding methods for String decoders.
  StringEncoder
  Defines common encoding methods for String encoders.
  StringEncoderComparator
  Compares Strings using a `StringEncoder`.