QuotedPrintableCodec
extends Objectimplements BinaryDecoder BinaryEncoder StringDecoder StringEncoder
| java.lang.Object | |
| ↳ | org.apache.commons.codec.net.QuotedPrintableCodec |
Class Overview
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.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Default constructor.
| |||||||||||
Constructor which allows for the selection of a default charset
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Decodes an array of quoted-printable characters into an array of original bytes.
| |||||||||||
Decodes a quoted-printable object into its original form.
| |||||||||||
Decodes a quoted-printable string into its original form using the specified string charset.
| |||||||||||
Decodes a quoted-printable string into its original form using the default string charset.
| |||||||||||
Decodes an array quoted-printable characters into an array of original bytes.
| |||||||||||
Encodes an array of bytes into an array of quoted-printable 7-bit characters.
| |||||||||||
Encodes an object into its quoted-printable safe form.
| |||||||||||
Encodes a string into its quoted-printable form using the specified charset.
| |||||||||||
Encodes a string into its quoted-printable form using the default string charset.
| |||||||||||
Encodes an array of bytes into an array of quoted-printable 7-bit characters.
| |||||||||||
Returns the default charset used for string decoding and encoding.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
|
From interface
org.apache.commons.codec.BinaryDecoder
| |||||||||||
|
From interface
org.apache.commons.codec.BinaryEncoder
| |||||||||||
|
From interface
org.apache.commons.codec.Decoder
| |||||||||||
|
From interface
org.apache.commons.codec.Encoder
| |||||||||||
|
From interface
org.apache.commons.codec.StringDecoder
| |||||||||||
|
From interface
org.apache.commons.codec.StringEncoder
| |||||||||||
Public Constructors
public QuotedPrintableCodec ()
Default constructor.
public QuotedPrintableCodec (String charset)
Constructor which allows for the selection of a default charset
Parameters
| charset | the default string charset to use. |
|---|
Public Methods
public byte[] decode (byte[] bytes)
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 |
|---|
Returns
- array of original bytes
Throws
| DecoderException | Thrown if quoted-printable decoding is unsuccessful |
|---|
public Object decode (Object pObject)
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 |
|---|
Returns
- original object
Throws
| DecoderException | Thrown if the argument is not a String or byte[]. Thrown if a failure condition is
encountered during the decode process.
|
|---|
public String decode (String pString, String charset)
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 |
|---|---|
| charset | the original string charset |
Returns
- original string
Throws
| DecoderException | Thrown if quoted-printable decoding is unsuccessful |
|---|---|
| UnsupportedEncodingException | Thrown if charset is not supported |
public String decode (String pString)
Decodes a quoted-printable string into its original form using the default string charset. Escaped characters are converted back to their original representation.
Parameters
| pString | quoted-printable string to convert into its original form |
|---|
Returns
- original string
Throws
| DecoderException | Thrown if quoted-printable decoding is unsuccessful. Thrown if charset is not supported. |
|---|
See Also
public static final byte[] decodeQuotedPrintable (byte[] bytes)
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 |
|---|
Returns
- array of original bytes
Throws
| DecoderException | Thrown if quoted-printable decoding is unsuccessful |
|---|
public byte[] encode (byte[] bytes)
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 |
|---|
Returns
- array of bytes containing quoted-printable data
public Object encode (Object pObject)
Encodes an object into its quoted-printable safe form. Unsafe characters are escaped.
Parameters
| pObject | string to convert to a quoted-printable form |
|---|
Returns
- quoted-printable object
Throws
| EncoderException | Thrown if quoted-printable encoding is not applicable to objects of this type or if encoding is unsuccessful |
|---|
public String encode (String pString, String charset)
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 |
|---|---|
| charset | the charset for pString |
Returns
- quoted-printable string
Throws
| UnsupportedEncodingException | Thrown if the charset is not supported |
|---|
public String encode (String pString)
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 |
|---|
Returns
- quoted-printable string
Throws
| EncoderException | Thrown if quoted-printable encoding is unsuccessful |
|---|
See Also
public static final byte[] encodeQuotedPrintable (BitSet printable, byte[] bytes)
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 |
|---|---|
| bytes | array of bytes to be encoded |
Returns
- array of bytes containing quoted-printable data
public String getDefaultCharset ()
Returns the default charset used for string decoding and encoding.
Returns
- the default string charset.