org.apache.commons.codec.net
Class RFC1522Codec
(package private) abstract class RFC1522Codec
Implements methods common to all codecs defined in RFC 1522.
RFC 1522
describes techniques to allow the encoding of non-ASCII text in
various portions of a RFC 822 [2] message header, in a manner which
is unlikely to confuse existing message handling software.
$Id: RFC1522Codec.java,v 1.2 2004/04/09 22:21:43 ggregory Exp $- Apache Software Foundation
protected String | decodeText(String text) - Applies an RFC 1522 compliant decoding scheme to the given string of text.
|
protected abstract byte[] | doDecoding(byte[] bytes) - Decodes an array of bytes using the defined encoding scheme
|
protected abstract byte[] | doEncoding(byte[] bytes) - Encodes an array of bytes using the defined encoding scheme
|
protected String | encodeText(String text, String charset) - Applies an RFC 1522 compliant encoding scheme to the given string of text with the
given charset.
|
protected abstract String | getEncoding() - Returns the codec name (referred to as encoding in the RFC 1522)
|
decodeText
protected String decodeText(String text)
throws DecoderException,
UnsupportedEncodingException
Applies an RFC 1522 compliant decoding scheme to the given string of text. This method
processes the "encoded-word" header common to all the RFC 1522 codecs and then invokes
doEncoding(byte [])
method of a concrete class to perform the specific deconding.
text
- a string to decode
DecoderException
- thrown if there is an error conidition during the Decoding
process.
doDecoding
protected abstract byte[] doDecoding(byte[] bytes)
throws DecoderException
Decodes an array of bytes using the defined encoding scheme
bytes
- Data to be decoded
- a byte array that contains decoded data
DecoderException
- A decoder exception is thrown if a Decoder encounters a
failure condition during the decode process.
doEncoding
protected abstract byte[] doEncoding(byte[] bytes)
throws EncoderException
Encodes an array of bytes using the defined encoding scheme
bytes
- Data to be encoded
- A byte array containing the encoded data
EncoderException
- thrown if the Encoder encounters a failure condition
during the encoding process.
encodeText
protected String encodeText(String text,
String charset)
throws EncoderException,
UnsupportedEncodingException
Applies an RFC 1522 compliant encoding scheme to the given string of text with the
given charset. This method constructs the "encoded-word" header common to all the
RFC 1522 codecs and then invokes doEncoding(byte [])
method of a concrete
class to perform the specific enconding.
text
- a string to encodecharset
- a charset to be used
- RFC 1522 compliant "encoded-word"
EncoderException
- thrown if there is an error conidition during the Encoding
process.
getEncoding
protected abstract String getEncoding()
Returns the codec name (referred to as encoding in the RFC 1522)
commons-codec version 1.3 - Copyright © 2002-2004 - Apache Software Foundation