Main Page | Packages | Class Hierarchy | Class List | Directories | File List | Class Members | Related Pages

org.apache.commons.codec.net.QuotedPrintableCodec Class Reference

Inheritance diagram for org.apache.commons.codec.net.QuotedPrintableCodec:

org.apache.commons.codec.BinaryEncoder org.apache.commons.codec.BinaryDecoder org.apache.commons.codec.StringEncoder org.apache.commons.codec.StringDecoder org.apache.commons.codec.Encoder org.apache.commons.codec.Decoder org.apache.commons.codec.Encoder org.apache.commons.codec.Decoder List of all members.

Detailed Description

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.1 2005/07/25 16:24:38 dev Exp

Definition at line 59 of file QuotedPrintableCodec.java.

Public Member Functions

 QuotedPrintableCodec ()
 Default constructor.
 QuotedPrintableCodec (String charset)
 Constructor which allows for the selection of a default charset.
byte[] encode (byte[] bytes)
 Encodes an array of bytes into an array of quoted-printable 7-bit characters.
byte[] decode (byte[] bytes) throws DecoderException
 Decodes an array of quoted-printable characters into an array of original bytes.
String encode (String pString) throws EncoderException
 Encodes a string into its quoted-printable form using the default string charset.
String decode (String pString, String charset) throws DecoderException, UnsupportedEncodingException
 Decodes a quoted-printable string into its original form using the specified string charset.
String decode (String pString) throws DecoderException
 Decodes a quoted-printable string into its original form using the default string charset.
Object encode (Object pObject) throws EncoderException
 Encodes an object into its quoted-printable safe form.
Object decode (Object pObject) throws DecoderException
 Decodes a quoted-printable object into its original form.
String getDefaultCharset ()
 Returns the default charset used for string decoding and encoding.
String encode (String pString, String charset) throws UnsupportedEncodingException
 Encodes a string into its quoted-printable form using the specified charset.

Static Public Member Functions

static final byte[] encodeQuotedPrintable (BitSet printable, byte[] bytes)
 Encodes an array of bytes into an array of quoted-printable 7-bit characters.
static final byte[] decodeQuotedPrintable (byte[] bytes) throws DecoderException
 Decodes an array quoted-printable characters into an array of original bytes.


Constructor & Destructor Documentation

org.apache.commons.codec.net.QuotedPrintableCodec.QuotedPrintableCodec String  charset  ) 
 

Constructor which allows for the selection of a default charset.

Parameters:
charset the default string charset to use.

Definition at line 101 of file QuotedPrintableCodec.java.


Member Function Documentation

Object org.apache.commons.codec.net.QuotedPrintableCodec.decode Object  pObject  )  throws DecoderException
 

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
Exceptions:
DecoderException Thrown if quoted-printable decoding is not applicable to objects of this type if decoding is unsuccessful

Implements org.apache.commons.codec.Decoder.

Definition at line 341 of file QuotedPrintableCodec.java.

References org.apache.commons.codec.net.QuotedPrintableCodec.decode().

String org.apache.commons.codec.net.QuotedPrintableCodec.decode String  pString  )  throws DecoderException
 

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
Exceptions:
DecoderException Thrown if quoted-printable decoding is unsuccessful
UnsupportedEncodingException Thrown if charset is not supported
See also:
getDefaultCharset()

Implements org.apache.commons.codec.StringDecoder.

Definition at line 295 of file QuotedPrintableCodec.java.

References org.apache.commons.codec.net.QuotedPrintableCodec.decode(), and org.apache.commons.codec.net.QuotedPrintableCodec.getDefaultCharset().

String org.apache.commons.codec.net.QuotedPrintableCodec.decode String  pString,
String  charset
throws DecoderException, UnsupportedEncodingException
 

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
Exceptions:
DecoderException Thrown if quoted-printable decoding is unsuccessful
UnsupportedEncodingException Thrown if charset is not supported

Definition at line 275 of file QuotedPrintableCodec.java.

References org.apache.commons.codec.net.QuotedPrintableCodec.decode().

byte [] org.apache.commons.codec.net.QuotedPrintableCodec.decode byte[]  bytes  )  throws DecoderException
 

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
Exceptions:
DecoderException Thrown if quoted-printable decoding is unsuccessful

Implements org.apache.commons.codec.BinaryDecoder.

Definition at line 229 of file QuotedPrintableCodec.java.

References org.apache.commons.codec.net.QuotedPrintableCodec.decodeQuotedPrintable().

Referenced by org.apache.commons.codec.net.QuotedPrintableCodec.decode().

static final byte [] org.apache.commons.codec.net.QuotedPrintableCodec.decodeQuotedPrintable byte[]  bytes  )  throws DecoderException [static]
 

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
Exceptions:
DecoderException Thrown if quoted-printable decoding is unsuccessful

Definition at line 173 of file QuotedPrintableCodec.java.

Referenced by org.apache.commons.codec.net.QuotedPrintableCodec.decode().

String org.apache.commons.codec.net.QuotedPrintableCodec.encode String  pString,
String  charset
throws UnsupportedEncodingException
 

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
Exceptions:
UnsupportedEncodingException Thrown if the charset is not supported

Definition at line 381 of file QuotedPrintableCodec.java.

References org.apache.commons.codec.net.QuotedPrintableCodec.encode().

Object org.apache.commons.codec.net.QuotedPrintableCodec.encode Object  pObject  )  throws EncoderException
 

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
Exceptions:
EncoderException Thrown if quoted-printable encoding is not applicable to objects of this type or if encoding is unsuccessful

Implements org.apache.commons.codec.Encoder.

Definition at line 316 of file QuotedPrintableCodec.java.

References org.apache.commons.codec.net.QuotedPrintableCodec.encode().

String org.apache.commons.codec.net.QuotedPrintableCodec.encode String  pString  )  throws EncoderException
 

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
Exceptions:
EncoderException Thrown if quoted-printable encoding is unsuccessful
See also:
getDefaultCharset()

Implements org.apache.commons.codec.StringEncoder.

Definition at line 250 of file QuotedPrintableCodec.java.

References org.apache.commons.codec.net.QuotedPrintableCodec.encode(), and org.apache.commons.codec.net.QuotedPrintableCodec.getDefaultCharset().

byte [] org.apache.commons.codec.net.QuotedPrintableCodec.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

Implements org.apache.commons.codec.BinaryEncoder.

Definition at line 210 of file QuotedPrintableCodec.java.

Referenced by org.apache.commons.codec.net.QuotedPrintableCodec.encode().

static final byte [] org.apache.commons.codec.net.QuotedPrintableCodec.encodeQuotedPrintable BitSet  printable,
byte[]  bytes
[static]
 

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

Definition at line 136 of file QuotedPrintableCodec.java.

String org.apache.commons.codec.net.QuotedPrintableCodec.getDefaultCharset  ) 
 

Returns the default charset used for string decoding and encoding.

Returns:
the default string charset.

Definition at line 360 of file QuotedPrintableCodec.java.

Referenced by org.apache.commons.codec.net.QuotedPrintableCodec.decode(), and org.apache.commons.codec.net.QuotedPrintableCodec.encode().


The documentation for this class was generated from the following file:
Generated on Wed Dec 14 21:05:37 2005 for OpenMobileIS by  doxygen 1.4.4