org.apache.commons.codec.net

Class QCodec

java.lang.Object

org.apache.commons.codec.net.QCodec

All Implemented Interfaces:

Decoder, Encoder, StringDecoder, StringEncoder

Deprecated.

Please use URL.openConnection() instead. Please visit this webpage for further details.

@Deprecated
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.

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() Deprecated. Default constructor.
QCodec(java.lang.String charset) Deprecated. 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 pObject) Deprecated. Decodes a quoted-printable object into its original form.
java.lang.String	decode(java.lang.String pString) Deprecated. Decodes a quoted-printable string into its original form.
java.lang.Object	encode(java.lang.Object pObject) Deprecated. Encodes an object into its quoted-printable form using the default charset.
java.lang.String	encode(java.lang.String pString) Deprecated. Encodes a string into its quoted-printable form using the default charset.
java.lang.String	encode(java.lang.String pString, java.lang.String charset) Deprecated. Encodes a string into its quoted-printable form using the specified charset.
java.lang.String	getDefaultCharset() Deprecated. The default charset used for string decoding and encoding.
boolean	isEncodeBlanks() Deprecated. Tests if optional tranformation of SPACE characters is to be used
void	setEncodeBlanks(boolean b) Deprecated. Defines whether optional tranformation 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()

Deprecated.

Default constructor.

QCodec

public QCodec(java.lang.String charset)

Deprecated.

Constructor which allows for the selection of a default charset

Parameters:

charset - the default string charset to use.

See Also:

JRE character encoding names

Method Detail

encode

public java.lang.String encode(java.lang.String pString,
                               java.lang.String charset)
                        throws EncoderException

Deprecated.

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

Parameters:

pString - string to convert to quoted-printable form

charset - the charset for pString

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 pString)
                        throws EncoderException

Deprecated.

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

Specified by:

encode in interface StringEncoder

Parameters:

pString - 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 pString)
                        throws DecoderException

Deprecated.

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:

pString - 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 pObject)
                        throws EncoderException

Deprecated.

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

Specified by:

encode in interface Encoder

Parameters:

pObject - 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 pObject)
                        throws DecoderException

Deprecated.

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:

pObject - quoted-printable object to convert into its original form

Returns:

original object

Throws:

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

getDefaultCharset

public java.lang.String getDefaultCharset()

Deprecated.

The default charset used for string decoding and encoding.

Returns:

the default string charset.

isEncodeBlanks

public boolean isEncodeBlanks()

Deprecated.

Tests if optional tranformation of SPACE characters is to be used

Returns:

true if SPACE characters are to be transformed, false otherwise

setEncodeBlanks

public void setEncodeBlanks(boolean b)

Deprecated.

Defines whether optional tranformation of SPACE characters is to be used

Parameters:

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