org.apache.commons.codec.net

Class QCodec

java.lang.Object

org.apache.commons.codec.net.QCodec

All Implemented Interfaces:

Decoder, Encoder, StringDecoder, StringEncoder

public class QCodec
extends java.lang.Object
implements StringEncoder, StringDecoder

Similar to the Quoted-Printable content-transfer-encoding defined in RFC 1521 and designed to allow text containing mostly ASCII characters to be decipherable on an ASCII terminal without decoding.

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 conditionally thread-safe. The instance field for encoding blanks is mutable setEncodeBlanks(boolean) but is not volatile, and accesses are not synchronised. If an instance of the class is shared between threads, the caller needs to ensure that suitable synchronisation is used to ensure safe publication of the value between threads, and must not invoke setEncodeBlanks(boolean) after initial setup.

Since:

1.3

See Also:

MIME (Multipurpose Internet Mail Extensions) Part Two: Message Header Extensions for Non-ASCII Text

Constructor Summary

Constructors

Constructor and Description
QCodec() Default constructor.
QCodec(java.nio.charset.Charset charset) Constructor which allows for the selection of a default Charset.
QCodec(java.lang.String charsetName) Constructor which allows for the selection of a default Charset.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	decode(java.lang.Object obj) Decodes a quoted-printable object into its original form.
java.lang.String	decode(java.lang.String str) Decodes a quoted-printable string into its original form.
java.lang.Object	encode(java.lang.Object obj) Encodes an object into its quoted-printable form using the default Charset.
java.lang.String	encode(java.lang.String sourceStr) Encodes a string into its quoted-printable form using the default Charset.
java.lang.String	encode(java.lang.String sourceStr, java.nio.charset.Charset sourceCharset) Encodes a string into its quoted-printable form using the specified Charset.
java.lang.String	encode(java.lang.String sourceStr, java.lang.String sourceCharset) Encodes a string into its quoted-printable form using the specified Charset.
java.nio.charset.Charset	getCharset() Gets the default Charset name used for string decoding and encoding.
java.lang.String	getDefaultCharset() Gets the default Charset name used for string decoding and encoding.
boolean	isEncodeBlanks() Tests if optional transformation of SPACE characters is to be used
void	setEncodeBlanks(boolean b) Defines whether optional transformation of SPACE characters is to be used

Methods inherited from class java.lang.Object

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

Constructor Detail

QCodec

public QCodec()

Default constructor.

QCodec

public QCodec(java.nio.charset.Charset charset)

Constructor which allows for the selection of a default Charset.

Parameters:

charset - the default string Charset to use.

Since:

1.7

See Also:

Standard charsets

QCodec

public QCodec(java.lang.String charsetName)

Constructor which allows for the selection of a default Charset.

Parameters:

charsetName - the Charset to use.

Throws:

java.nio.charset.UnsupportedCharsetException - If the named Charset is unavailable

Since:

1.7 throws UnsupportedCharsetException if the named Charset is unavailable

See Also:

Standard charsets

Method Detail

encode

public java.lang.String encode(java.lang.String sourceStr,
                               java.nio.charset.Charset sourceCharset)
                        throws EncoderException

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

Parameters:

sourceStr - string to convert to quoted-printable form

sourceCharset - the Charset for sourceStr

Returns:

quoted-printable string

Throws:

EncoderException - thrown if a failure condition is encountered during the encoding process.

Since:

1.7

encode

public java.lang.String encode(java.lang.String sourceStr,
                               java.lang.String sourceCharset)
                        throws EncoderException

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

Parameters:

sourceStr - string to convert to quoted-printable form

sourceCharset - the Charset for sourceStr

Returns:

quoted-printable string

Throws:

EncoderException - thrown if a failure condition is encountered during the encoding process.

encode

public java.lang.String encode(java.lang.String sourceStr)
                        throws EncoderException

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

Specified by:

encode in interface StringEncoder

Parameters:

sourceStr - string to convert to quoted-printable form

Returns:

quoted-printable string

Throws:

EncoderException - thrown if a failure condition is encountered during the encoding process.

decode

public java.lang.String decode(java.lang.String str)
                        throws DecoderException

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

Specified by:

decode in interface StringDecoder

Parameters:

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

Returns:

original string

Throws:

DecoderException - A decoder exception is thrown if a failure condition is encountered during the decode process.

encode

public java.lang.Object encode(java.lang.Object obj)
                        throws EncoderException

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

Specified by:

encode in interface Encoder

Parameters:

obj - object to convert to quoted-printable form

Returns:

quoted-printable object

Throws:

EncoderException - thrown if a failure condition is encountered during the encoding process.

decode

public java.lang.Object decode(java.lang.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. Thrown if a failure condition is encountered during the decode process.

getCharset

public java.nio.charset.Charset getCharset()

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

Returns:

the default Charset name

Since:

1.7

getDefaultCharset

public java.lang.String getDefaultCharset()

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

Returns:

the default Charset name

isEncodeBlanks

public boolean isEncodeBlanks()

Tests if optional transformation of SPACE characters is to be used

Returns:

true if SPACE characters are to be transformed, false otherwise

setEncodeBlanks

public void setEncodeBlanks(boolean b)

Defines whether optional transformation of SPACE characters is to be used

Parameters:

b - true if SPACE characters are to be transformed, false otherwise