Package org.apache.commons.codec

A small set of interfaces 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 three categories: Binary Encoders, Language Encoders, and Network Encoders.

Binary Encoders

org.apache.commons.codec.binary.Base64 Provides Base64 content-transfer-encoding as defined in RFC 2045 Production
org.apache.commons.codec.binary.Hex Converts an array of bytes into an array of characters representing the hexidecimal values of each byte in order Production

Language Encoders

Codec contains a number of commonly used language and phonetic encoders

org.apache.commons.codec.language.Soundex Implementation of the Soundex algorithm. Production
org.apache.commons.codec.language.Metaphone Implementation of the Metaphone algorithm. Production

Network Encoders

Codec contains network related encoders

org.apache.commons.codec.net.URLCodec Implements the 'www-form-urlencoded' encoding scheme. Production

  • Interface Summary
    Interface Description
    BinaryDecoder
    Defines common decoding methods for byte array decoders.
    BinaryEncoder
    Defines common encoding methods for byte array encoders.
    Decoder
    Provides the highest level of abstraction for Decoders.
    Encoder
    Provides the highest level of abstraction for Encoders.
    StringDecoder
    Decodes a String into a String.
    StringEncoder
    Encodes a String into a String.
  • Class Summary
    Class Description
    StringEncoderComparator
    Strings are comparable, and this comparator allows you to configure it with an instance of a class which implements StringEncoder.
  • Exception Summary
    Exception Description
    DecoderException
    Thrown when a Decoder has encountered a failure condition during a decode.
    EncoderException
    Thrown when there is a failure condition during the encoding process.