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.
Version:
- Apache Software Foundation
- 1.3
MIME (Multipurpose Internet Mail Extensions) Part Two:
Message Header Extensions for Non-ASCII Text
protected String | decodeText(java.lang.String text) - Applies an RFC 1522 compliant decoding scheme to the given string of text.
|
protected byte[] | doDecoding(byte[] bytes) - Decodes an array of bytes using the defined encoding scheme
|
protected byte[] | doEncoding(byte[] bytes) - Encodes an array of bytes using the defined encoding scheme
|
protected String | encodeText(java.lang.String text, java.lang.String charset) - Applies an RFC 1522 compliant encoding scheme to the given string of text with the
given charset.
|
protected String | getEncoding() - Returns the codec name (referred to as encoding in the RFC 1522)
|
decodeText
protected String decodeText(java.lang.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.UnsupportedEncodingException
- thrown if charset specified in the "encoded-word"
header is not supported
doDecoding
protected byte[] doDecoding(byte[] bytes)
Decodes an array of bytes using the defined encoding scheme
bytes
- Data to be decoded
- a byte array that contains decoded data
doEncoding
protected byte[] doEncoding(byte[] bytes)
Encodes an array of bytes using the defined encoding scheme
bytes
- Data to be encoded
- A byte array containing the encoded data
encodeText
protected String encodeText(java.lang.String text,
java.lang.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.UnsupportedEncodingException
- thrown if charset is not supported
JRE character
encoding names
getEncoding
protected String getEncoding()
Returns the codec name (referred to as encoding in the RFC 1522)
- name of the codec
commons-codec version 1.3 - Copyright © 2002-2004 - Apache Software Foundation