Class RFC1522Codec
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.
This class is immutable and thread-safe.
- Since:
- 1.3
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected 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 charsetName) Applies an RFC 1522 compliant encoding scheme to the given string of text with the given charset.protected String
encodeText
(String text, Charset charset) Applies an RFC 1522 compliant encoding scheme to the given string of text with the given charset.protected abstract String
Returns the codec name (referred to as encoding in the RFC 1522).
-
Field Details
-
SEP
protected static final char SEPSeparator.- See Also:
-
POSTFIX
Prefix.- See Also:
-
PREFIX
Postfix.- See Also:
-
-
Constructor Details
-
RFC1522Codec
RFC1522Codec()
-
-
Method Details
-
encodeText
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 encoding.- Parameters:
text
- a string to encodecharset
- a charset to be used- Returns:
- RFC 1522 compliant "encoded-word"
- Throws:
EncoderException
- thrown if there is an error condition during the Encoding process.- See Also:
-
encodeText
protected String encodeText(String text, String charsetName) 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 encoding.- Parameters:
text
- a string to encodecharsetName
- the charset to use- Returns:
- RFC 1522 compliant "encoded-word"
- Throws:
EncoderException
- thrown if there is an error condition during the Encoding process.UnsupportedEncodingException
- if charset is not available- See Also:
-
decodeText
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
doDecoding(byte[])
method of a concrete class to perform the specific decoding.- Parameters:
text
- a string to decode- Returns:
- A new decoded String or
null
if the input isnull
. - Throws:
DecoderException
- thrown if there is an error condition during the decoding process.UnsupportedEncodingException
- thrown if charset specified in the "encoded-word" header is not supported
-
getEncoding
Returns the codec name (referred to as encoding in the RFC 1522).- Returns:
- name of the codec
-
doEncoding
Encodes an array of bytes using the defined encoding scheme.- Parameters:
bytes
- Data to be encoded- Returns:
- A byte array containing the encoded data
- Throws:
EncoderException
- thrown if the Encoder encounters a failure condition during the encoding process.
-
doDecoding
Decodes an array of bytes using the defined encoding scheme.- Parameters:
bytes
- Data to be decoded- Returns:
- a byte array that contains decoded data
- Throws:
DecoderException
- A decoder exception is thrown if a Decoder encounters a failure condition during the decode process.
-