org.apache.commons.codec.net

Class QCodec

public class QCodec extends RFC1522Codec 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

Version: $Id: QCodec.java 130370 2004-05-24 00:25:22Z ggregory $

Author: Apache Software Foundation

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

Field Summary
static byteBLANK
Stringcharset
The default charset used for string decoding and encoding.
booleanencodeBlanks
static BitSetPRINTABLE_CHARS
BitSet of printable characters as defined in RFC 1522.
static byteUNDERSCORE
Constructor Summary
QCodec()
Default constructor.
QCodec(String charset)
Constructor which allows for the selection of a default charset
Method Summary
Stringdecode(String pString)
Decodes a quoted-printable string into its original form.
Objectdecode(Object pObject)
Decodes a quoted-printable object into its original form.
protected byte[]doDecoding(byte[] bytes)
protected byte[]doEncoding(byte[] bytes)
Stringencode(String pString, String charset)
Encodes a string into its quoted-printable form using the specified charset.
Stringencode(String pString)
Encodes a string into its quoted-printable form using the default charset.
Objectencode(Object pObject)
Encodes an object into its quoted-printable form using the default charset.
StringgetDefaultCharset()
The default charset used for string decoding and encoding.
protected StringgetEncoding()
booleanisEncodeBlanks()
Tests if optional tranformation of SPACE characters is to be used
voidsetEncodeBlanks(boolean b)
Defines whether optional tranformation of SPACE characters is to be used

Field Detail

BLANK

private static byte BLANK

charset

private String charset
The default charset used for string decoding and encoding.

encodeBlanks

private boolean encodeBlanks

PRINTABLE_CHARS

private static final BitSet PRINTABLE_CHARS
BitSet of printable characters as defined in RFC 1522.

UNDERSCORE

private static byte UNDERSCORE

Constructor Detail

QCodec

public QCodec()
Default constructor.

QCodec

public QCodec(String charset)
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

decode

public String decode(String pString)
Decodes a quoted-printable string into its original form. 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 A decoder exception is thrown if a failure condition is encountered during the decode process.

decode

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 A decoder exception is thrown if a failure condition is encountered during the decode process.

doDecoding

protected byte[] doDecoding(byte[] bytes)

doEncoding

protected byte[] doEncoding(byte[] bytes)

encode

public String encode(String pString, String charset)
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 String encode(String pString)
Encodes a string into its quoted-printable form using the default charset. Unsafe characters are escaped.

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.

encode

public Object encode(Object pObject)
Encodes an object into its quoted-printable form using the default charset. Unsafe characters are escaped.

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.

getDefaultCharset

public String getDefaultCharset()
The default charset used for string decoding and encoding.

Returns: the default string charset.

getEncoding

protected String getEncoding()

isEncodeBlanks

public boolean isEncodeBlanks()
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)
Defines whether optional tranformation of SPACE characters is to be used

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

commons-codec version 1.3 - Copyright © 2002-2004 - Apache Software Foundation