Package org.apache.commons.codec.net

Class QuotedPrintableCodec

java.lang.Object

org.apache.commons.codec.net.QuotedPrintableCodec

All Implemented Interfaces:

BinaryDecoder, BinaryEncoder, Decoder, Encoder, StringDecoder, StringEncoder

public class QuotedPrintableCodec
extends Object
implements BinaryEncoder, BinaryDecoder, StringEncoder, StringDecoder

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:

Depending on the selected strict parameter, this class will implement a different set of rules of the quoted-printable spec:

• strict=false: only rules #1 and #2 are implemented
• strict=true: all rules #1 through #5 are implemented

Originally, this class only supported the non-strict mode, but the codec in this partial form could already be used for certain applications that do not require quoted-printable line formatting (rules #3, #4, #5), for instance Q codec. The strict mode has been added in 1.10.

This class is immutable and thread-safe.

Since:

1.3

See Also:

RFC 1521 MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies

Constructor Summary

Constructors

Constructor	Description
QuotedPrintableCodec()	Default constructor, assumes default Charset of StandardCharsets.UTF_8
QuotedPrintableCodec(boolean strict)	Constructor which allows for the selection of the strict mode.
QuotedPrintableCodec(String charsetName)	Constructor which allows for the selection of a default Charset.
QuotedPrintableCodec(Charset charset)	Constructor which allows for the selection of a default Charset.
QuotedPrintableCodec(Charset charset, boolean strict)	Constructor which allows for the selection of a default Charset and strict mode.

Method Summary

Modifier and Type	Method	Description
byte[]	decode(byte[] bytes)	Decodes an array of quoted-printable characters into an array of original bytes.
Object	decode(Object obj)	Decodes a quoted-printable object into its original form.
String	decode(String sourceStr)	Decodes a quoted-printable string into its original form using the default string Charset.
String	decode(String sourceStr, String sourceCharset)	Decodes a quoted-printable string into its original form using the specified string Charset.
String	decode(String sourceStr, Charset sourceCharset)	Decodes a quoted-printable string into its original form using the specified string Charset.
static byte[]	decodeQuotedPrintable(byte[] bytes)	Decodes an array quoted-printable characters into an array of original bytes.
byte[]	encode(byte[] bytes)	Encodes an array of bytes into an array of quoted-printable 7-bit characters.
Object	encode(Object obj)	Encodes an object into its quoted-printable safe form.
String	encode(String sourceStr)	Encodes a string into its quoted-printable form using the default string Charset.
String	encode(String sourceStr, String sourceCharset)	Encodes a string into its quoted-printable form using the specified Charset.
String	encode(String sourceStr, Charset sourceCharset)	Encodes a string into its quoted-printable form using the specified Charset.
static byte[]	encodeQuotedPrintable(BitSet printable, byte[] bytes)	Encodes an array of bytes into an array of quoted-printable 7-bit characters.
static byte[]	encodeQuotedPrintable(BitSet printable, byte[] bytes, boolean strict)	Encodes an array of bytes into an array of quoted-printable 7-bit characters.
Charset	getCharset()	Gets the default Charset name used for string decoding and encoding.
String	getDefaultCharset()	Gets the default Charset name used for string decoding and encoding.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QuotedPrintableCodec

public QuotedPrintableCodec()

Default constructor, assumes default Charset of StandardCharsets.UTF_8

QuotedPrintableCodec

public QuotedPrintableCodec(boolean strict)

Constructor which allows for the selection of the strict mode.

Parameters:

strict - if true, soft line breaks will be used

Since:

1.10

QuotedPrintableCodec

public QuotedPrintableCodec(Charset charset)

Constructor which allows for the selection of a default Charset.

Parameters:

charset - the default string Charset to use.

Since:

1.7

QuotedPrintableCodec

public QuotedPrintableCodec(Charset charset,
                            boolean strict)

Constructor which allows for the selection of a default Charset and strict mode.

Parameters:

charset - the default string Charset to use.

strict - if true, soft line breaks will be used

Since:

1.10

QuotedPrintableCodec

public QuotedPrintableCodec(String charsetName)
                     throws IllegalCharsetNameException,
                            IllegalArgumentException,
                            UnsupportedCharsetException

Constructor which allows for the selection of a default Charset.

Parameters:

charsetName - the default string Charset to use.

Throws:

UnsupportedCharsetException - If no support for the named Charset is available in this instance of the Java virtual machine

IllegalArgumentException - If the given charsetName is null

IllegalCharsetNameException - If the given Charset name is illegal

Since:

1.7 throws UnsupportedCharsetException if the named Charset is unavailable

Method Detail

encodeQuotedPrintable

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

encodeQuotedPrintable

public static final byte[] encodeQuotedPrintable(BitSet printable,
                                                 byte[] bytes,
                                                 boolean strict)

Encodes an array of bytes into an array of quoted-printable 7-bit characters. Unsafe characters are escaped.

Depending on the selection of the strict parameter, this function either implements the full ruleset or only 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

strict - if true the full ruleset is used, otherwise only rule #1 and rule #2

Returns:

array of bytes containing quoted-printable data

Since:

1.10

decodeQuotedPrintable

public static final byte[] decodeQuotedPrintable(byte[] bytes)
                                          throws DecoderException

Decodes an array quoted-printable characters into an array of original bytes. Escaped characters are converted back to their original representation.

This function fully implements the quoted-printable encoding specification (rule #1 through rule #5) 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

encode

public byte[] encode(byte[] bytes)

Encodes an array of bytes into an array of quoted-printable 7-bit characters. Unsafe characters are escaped.

Depending on the selection of the strict parameter, this function either implements the full ruleset or only 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.

Specified by:

encode in interface BinaryEncoder

Parameters:

bytes - array of bytes to be encoded

Returns:

array of bytes containing quoted-printable data

decode

public byte[] 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 fully implements the quoted-printable encoding specification (rule #1 through rule #5) as defined in RFC 1521.

Specified by:

decode in interface BinaryDecoder

Parameters:

bytes - array of quoted-printable characters

Returns:

array of original bytes

Throws:

DecoderException - Thrown if quoted-printable decoding is unsuccessful

encode

public String encode(String sourceStr)
              throws EncoderException

Encodes a string into its quoted-printable form using the default string Charset. Unsafe characters are escaped.

Depending on the selection of the strict parameter, this function either implements the full ruleset or only 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.

Specified by:

encode in interface StringEncoder

Parameters:

sourceStr - string to convert to quoted-printable form

Returns:

quoted-printable string

Throws:

EncoderException - Thrown if quoted-printable encoding is unsuccessful

See Also:

getCharset()

decode

public String decode(String sourceStr,
                     Charset sourceCharset)
              throws DecoderException

Decodes a quoted-printable string into its original form using the specified string Charset. Escaped characters are converted back to their original representation.

Parameters:

sourceStr - quoted-printable string to convert into its original form

sourceCharset - the original string Charset

Returns:

original string

Throws:

DecoderException - Thrown if quoted-printable decoding is unsuccessful

Since:

1.7

decode

public String decode(String sourceStr,
                     String sourceCharset)
              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:

sourceStr - quoted-printable string to convert into its original form

sourceCharset - the original string Charset

Returns:

original string

Throws:

DecoderException - Thrown if quoted-printable decoding is unsuccessful

UnsupportedEncodingException - Thrown if Charset is not supported

decode

public String decode(String sourceStr)
              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.

Specified by:

decode in interface StringDecoder

Parameters:

sourceStr - 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:

getCharset()

encode

public Object encode(Object obj)
              throws EncoderException

Encodes an object into its quoted-printable safe form. Unsafe characters are escaped.

Specified by:

encode in interface Encoder

Parameters:

obj - 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

decode

public Object decode(Object obj)
              throws DecoderException

Decodes a quoted-printable object into its original form. Escaped characters are converted back to their original representation.

Specified by:

decode in interface Decoder

Parameters:

obj - 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.

getCharset

public Charset getCharset()

Gets the default Charset name used for string decoding and encoding.

Returns:

the default Charset name

Since:

1.7

getDefaultCharset

public String getDefaultCharset()

Gets the default Charset name used for string decoding and encoding.

Returns:

the default Charset name

encode

public String encode(String sourceStr,
                     Charset sourceCharset)

Encodes a string into its quoted-printable form using the specified Charset. Unsafe characters are escaped.

Depending on the selection of the strict parameter, this function either implements the full ruleset or only 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:

sourceStr - string to convert to quoted-printable form

sourceCharset - the Charset for sourceStr

Returns:

quoted-printable string

Since:

1.7

encode

public String encode(String sourceStr,
                     String sourceCharset)
              throws UnsupportedEncodingException

Encodes a string into its quoted-printable form using the specified Charset. Unsafe characters are escaped.

Depending on the selection of the strict parameter, this function either implements the full ruleset or only 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:

sourceStr - string to convert to quoted-printable form

sourceCharset - the Charset for sourceStr

Returns:

quoted-printable string

Throws:

UnsupportedEncodingException - Thrown if the Charset is not supported