|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.commons.codec.net.RFC1522Codec
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.
This class is immutable and thread-safe.
Field Summary | |
---|---|
protected static java.lang.String |
POSTFIX
Prefix. |
protected static java.lang.String |
PREFIX
Postfix. |
protected static char |
SEP
Separator. |
Constructor Summary | |
---|---|
RFC1522Codec()
|
Method Summary | |
---|---|
protected java.lang.String |
decodeText(java.lang.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 java.lang.String |
encodeText(java.lang.String text,
java.nio.charset.Charset charset)
Applies an RFC 1522 compliant encoding scheme to the given string of text with the given charset. |
protected java.lang.String |
encodeText(java.lang.String text,
java.lang.String charsetName)
Applies an RFC 1522 compliant encoding scheme to the given string of text with the given charset. |
protected abstract java.lang.String |
getEncoding()
Returns the codec name (referred to as encoding in the RFC 1522). |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final char SEP
protected static final java.lang.String POSTFIX
protected static final java.lang.String PREFIX
Constructor Detail |
---|
RFC1522Codec()
Method Detail |
---|
protected java.lang.String encodeText(java.lang.String text, java.nio.charset.Charset charset) throws EncoderException
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.
text
- a string to encodecharset
- a charset to be used
EncoderException
- thrown if there is an error condition during the Encoding process.protected java.lang.String encodeText(java.lang.String text, java.lang.String charsetName) throws EncoderException, java.io.UnsupportedEncodingException
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.
text
- a string to encodecharsetName
- the charset to use
EncoderException
- thrown if there is an error condition during the Encoding process.
java.io.UnsupportedEncodingException
- if charset is not availableprotected java.lang.String decodeText(java.lang.String text) throws DecoderException, java.io.UnsupportedEncodingException
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 decoding.
text
- a string to decode
null
if the input is null
.
DecoderException
- thrown if there is an error condition during the decoding process.
java.io.UnsupportedEncodingException
- thrown if charset specified in the "encoded-word" header is not supportedprotected abstract java.lang.String getEncoding()
protected abstract byte[] doEncoding(byte[] bytes) throws EncoderException
bytes
- Data to be encoded
EncoderException
- thrown if the Encoder encounters a failure condition during the encoding process.protected abstract byte[] doDecoding(byte[] bytes) throws DecoderException
bytes
- Data to be decoded
DecoderException
- A decoder exception is thrown if a Decoder encounters a failure condition during the decode process.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |