Package com.buck.common.codec

Defines codecs, decoders, and encoders, for translating between binary content and encoded bytes.

See:
Description

Class Summary

Base16	Encodes and decodes data using the Base16 encoding.
Base32	Codec for RFC 4648 Base32.
Base32Hex	Codec for RFC 4648 Base32 Encoding with Extended Hex Alphabet This implementation does not encode/decode streaming data.
Base64	Codec for RFC 4648 Base64.
Base64URL	Codec for RFC 4648 Base64 URL Safe.
Codec	A named mapping between encoded sequences of bytes and raw binary data.
CodecDecoder	An engine that can transform a sequence of bytes in a specific encoding into a sequence of bytes.
CodecEncoder	An engine that can transform raw data, represented as a sequence of bytes, to a specific encoding, into a sequence of bytes.
FastCodecProvider	Abstract base class for fast codec providers.
PercentEncoded	Codec for the percent-encoded encoding scheme.
QuotedPrintable	Codec for the quoted-printable encoding scheme.
URLEncoded	Codec for the www-form-urlencoded encoding scheme.
UUIDCoder	Encodes and decodes UUID objects using a supplied codec.

Exception Summary

IllegalCodecNameException	Unchecked exception thrown when a string that is not a legal codec name is used as such.
MalformedInputException	Checked exception thrown when an input byte sequence is not legal for the given codec.
UnsupportedCodecException	Unchecked exception thrown when a string that is not a legal codec name is used as such.

Error Summary

CodecMalfunctionError

Error thrown when the decode method of a CodecDecoder, or the encode method of a CodecEncoder, throws an unexpected exception.

Package com.buck.common.codec Description

Defines codecs, decoders, and encoders, for translating between binary content and encoded bytes.

Class name	Description
Codec	A named mapping between characters and bytes
CodecDecoder	Decodes encoded bytes into binary content
CodecEncoder	Encodes binary content into bytes

A codec is named mapping between sequences of raw bytes, and sequences of encoded bytex, in the sense defined in RFC 4648. A decoder is an engine which transforms encoded bytes in a specific encoding into raw bytes (binary content), and an encoder is an engine which transforms bytes (binary content) into an encoded sequence of bytes. Encoders and decoders operate on byte buffers. They are collectively referred to as codecs.

The Codec class defines methods for creating coders for a given codec and for retrieving the various names associated with a codec. It also defines static methods for testing whether a particular codec is supported, for locating codec instances by name, and for constructing a map that contains every codec for which support is available in the current Java virtual machine.

Most users will not use these classes directly; instead they will use the existing codec-related services such as XML serialization, which may have been reworked to make use of the codec facilities defined in this package.

Support for new codecs can be made available via the interface defined in the CodecProvider class in the com.buck.common.codec.spi package.

Author:

Robert J. Buck