|
| |
|
| java.lang.Object
 org.apache.commons.codec.net.QuotedPrintableCodec
| QuotedPrintableCodec | | public class QuotedPrintableCodec implements BinaryEncoder,BinaryDecoder,StringEncoder,StringDecoder(Code) | |
Codec for the Quoted-Printable section of RFC 1521 .
The Quoted-Printable encoding is intended to represent data that largely consists of octets that correspond to
printable characters in the ASCII character set. It encodes the data in such a way that the resulting octets are
unlikely to be modified by mail transport. If the data being encoded are mostly ASCII text, the encoded form of the
data remains largely recognizable by humans. A body which is entirely ASCII may also be encoded in Quoted-Printable
to ensure the integrity of the data should the message pass through a character- translating, and/or line-wrapping
gateway.
Note:
Rules #3, #4, and #5 of the quoted-printable spec are not implemented yet because the complete quoted-printable spec
does not lend itself well into the byte[] oriented codec framework. Complete the codec once the steamable codec
framework is ready. The motivation behind providing the codec in a partial form is that it can already come in handy
for those applications that do not require quoted-printable line formatting (rules #3, #4, #5), for instance Q codec.
See Also: RFC 1521 MIME (Multipurpose Internet Mail Extensions) Part One:
* Mechanisms for Specifying and Describing the Format of Internet Message Bodies
author:
Apache Software Foundation
since:
1.3
version:
$Id: QuotedPrintableCodec.java,v 1.7 2004/04/09 22:21:07 ggregory Exp $ |
| Method Summary | |
| public byte[] | decode(byte[] bytes)
Decodes an array of quoted-printable characters into an array of original bytes. | | public String | decode(String pString, String charset)
Decodes a quoted-printable string into its original form using the specified string charset. | | public String | decode(String pString)
Decodes a quoted-printable string into its original form using the default string charset. | | public Object | decode(Object pObject)
Decodes a quoted-printable object into its original form. | | final public static byte[] | decodeQuotedPrintable(byte[] bytes)
Decodes an array quoted-printable characters into an array of original bytes. | | public byte[] | encode(byte[] bytes)
Encodes an array of bytes into an array of quoted-printable 7-bit characters. | | public String | encode(String pString)
Encodes a string into its quoted-printable form using the default string charset. | | public Object | encode(Object pObject)
Encodes an object into its quoted-printable safe form. | | public String | encode(String pString, String charset)
Encodes a string into its quoted-printable form using the specified charset. | | final public static byte[] | encodeQuotedPrintable(BitSet printable, byte[] bytes)
Encodes an array of bytes into an array of quoted-printable 7-bit characters. | | public String | getDefaultCharset()
Returns the default charset used for string decoding and encoding. |
| QuotedPrintableCodec | | public QuotedPrintableCodec()(Code) | | Default constructor.
|
| QuotedPrintableCodec | | public QuotedPrintableCodec(String charset)(Code) | | Constructor which allows for the selection of a default charset
Parameters:
charset - the default string charset to use. |
| decode | | public byte[] decode(byte[] bytes) throws DecoderException(Code) | | Decodes an array of quoted-printable characters into an array of original bytes. Escaped characters are converted
back to their original representation.
This function implements a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in
RFC 1521.
Parameters:
bytes - array of quoted-printable characters array of original bytes
throws:
DecoderException - Thrown if quoted-printable decoding is unsuccessful |
| decode | | public String decode(String pString, String charset) throws DecoderException, UnsupportedEncodingException(Code) | | Decodes a quoted-printable string into its original form using the specified string charset. Escaped characters
are converted back to their original representation.
Parameters:
pString - quoted-printable string to convert into its original form
Parameters:
charset - the original string charset original string
throws:
DecoderException - Thrown if quoted-printable decoding is unsuccessful
throws:
UnsupportedEncodingException - Thrown if charset is not supported |
| decode | | public Object decode(Object pObject) throws DecoderException(Code) | | Decodes a quoted-printable object into its original form. Escaped characters are converted back to their original
representation.
Parameters:
pObject - quoted-printable object to convert into its original form original object
throws:
DecoderException - Thrown if quoted-printable decoding is not applicable to objects of this type if decoding isunsuccessful |
| decodeQuotedPrintable | | final public static byte[] decodeQuotedPrintable(byte[] bytes) throws DecoderException(Code) | | Decodes an array quoted-printable characters into an array of original bytes. Escaped characters are converted
back to their original representation.
This function implements a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in
RFC 1521.
Parameters:
bytes - array of quoted-printable characters array of original bytes
throws:
DecoderException - Thrown if quoted-printable decoding is unsuccessful |
| encode | | public byte[] encode(byte[] bytes)(Code) | | Encodes an array of bytes into an array of quoted-printable 7-bit characters. Unsafe characters are escaped.
This function implements a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in
RFC 1521 and is suitable for encoding binary data and unformatted text.
Parameters:
bytes - array of bytes to be encoded array of bytes containing quoted-printable data |
| encode | | public String encode(String pString) throws EncoderException(Code) | | Encodes a string into its quoted-printable form using the default string charset. Unsafe characters are escaped.
This function implements a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in
RFC 1521 and is suitable for encoding binary data.
Parameters:
pString - string to convert to quoted-printable form quoted-printable string
throws:
EncoderException - Thrown if quoted-printable encoding is unsuccessful
See Also: QuotedPrintableCodec.getDefaultCharset() |
| encode | | public Object encode(Object pObject) throws EncoderException(Code) | | Encodes an object into its quoted-printable safe form. Unsafe characters are escaped.
Parameters:
pObject - string to convert to a quoted-printable form quoted-printable object
throws:
EncoderException - Thrown if quoted-printable encoding is not applicable to objects of this type or if encoding isunsuccessful |
| encode | | public String encode(String pString, String charset) throws UnsupportedEncodingException(Code) | | Encodes a string into its quoted-printable form using the specified charset. Unsafe characters are escaped.
This function implements a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in
RFC 1521 and is suitable for encoding binary data and unformatted text.
Parameters:
pString - string to convert to quoted-printable form
Parameters:
charset - the charset for pString quoted-printable string
throws:
UnsupportedEncodingException - Thrown if the charset is not supported |
| encodeQuotedPrintable | | final public static byte[] encodeQuotedPrintable(BitSet printable, byte[] bytes)(Code) | | Encodes an array of bytes into an array of quoted-printable 7-bit characters. Unsafe characters are escaped.
This function implements a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in
RFC 1521 and is suitable for encoding binary data and unformatted text.
Parameters:
printable - bitset of characters deemed quoted-printable
Parameters:
bytes - array of bytes to be encoded array of bytes containing quoted-printable data |
| getDefaultCharset | | public String getDefaultCharset()(Code) | | Returns the default charset used for string decoding and encoding.
the default string charset. |
|
|
|