org.apache.commons.codec.net
Class QCodec
- Decoder, Encoder, StringDecoder, StringEncoder
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.
Version:
- Apache Software Foundation
- 1.3
MIME (Multipurpose Internet Mail Extensions) Part Two: Message
Header Extensions for Non-ASCII Text
QCodec() - Default constructor.
|
QCodec(java.lang.String charset) - Constructor which allows for the selection of a default charset
|
Object | decode(Object pObject) - Decodes a quoted-printable object into its original form.
|
String | decode(java.lang.String pString) - Decodes a quoted-printable string into its original form.
|
protected byte[] | doDecoding(byte[] bytes) - Decodes an array of bytes using the defined encoding scheme
|
protected byte[] | doEncoding(byte[] bytes) - Encodes an array of bytes using the defined encoding scheme
|
Object | encode(Object pObject) - Encodes an object into its quoted-printable form using the default charset.
|
String | encode(java.lang.String pString) - Encodes a string into its quoted-printable form using the default charset.
|
String | encode(java.lang.String pString, java.lang.String charset) - Encodes a string into its quoted-printable form using the specified charset.
|
String | getDefaultCharset() - The default charset used for string decoding and encoding.
|
protected String | getEncoding() - Returns the codec name (referred to as encoding in the RFC 1522)
|
boolean | isEncodeBlanks() - Tests if optional tranformation of SPACE characters is to be used
|
void | setEncodeBlanks(boolean b) - Defines whether optional tranformation of SPACE characters is to be used
|
BLANK
private static byte BLANK
PRINTABLE_CHARS
private static final BitSet PRINTABLE_CHARS
BitSet of printable characters as defined in RFC 1522.
UNDERSCORE
private static byte UNDERSCORE
charset
private String charset
The default charset used for string decoding and encoding.
encodeBlanks
private boolean encodeBlanks
QCodec
public QCodec()
Default constructor.
QCodec
public QCodec(java.lang.String charset)
Constructor which allows for the selection of a default charset
charset
- the default string charset to use.
JRE character
encoding names
decode
public Object decode(Object pObject)
throws DecoderException
Decodes a quoted-printable object into its original form. Escaped characters are converted back to their original
representation.
- decode in interface Decoder
pObject
- quoted-printable object to convert into its original form
- original object
DecoderException
- A decoder exception is thrown if a failure condition is encountered during the decode process.
decode
public String decode(java.lang.String pString)
throws DecoderException
Decodes a quoted-printable string into its original form. Escaped characters are converted back to their original
representation.
- decode in interface StringDecoder
pString
- quoted-printable string to convert into its original form
- original string
DecoderException
- A decoder exception is thrown if a failure condition is encountered during the decode process.
doDecoding
protected byte[] doDecoding(byte[] bytes)
throws DecoderException
Decodes an array of bytes using the defined encoding scheme
- doDecoding in interface RFC1522Codec
bytes
- Data to be decoded
- a byte array that contains decoded data
DecoderException
- A decoder exception is thrown if a Decoder encounters a
failure condition during the decode process.
doEncoding
protected byte[] doEncoding(byte[] bytes)
throws EncoderException
Encodes an array of bytes using the defined encoding scheme
- doEncoding in interface RFC1522Codec
bytes
- Data to be encoded
- A byte array containing the encoded data
EncoderException
- thrown if the Encoder encounters a failure condition
during the encoding process.
encode
public Object encode(Object pObject)
throws EncoderException
Encodes an object into its quoted-printable form using the default charset. Unsafe characters are escaped.
- encode in interface Encoder
pObject
- object to convert to quoted-printable form
- quoted-printable object
EncoderException
- thrown if a failure condition is encountered during the encoding process.
encode
public String encode(java.lang.String pString)
throws EncoderException
Encodes a string into its quoted-printable form using the default charset. Unsafe characters are escaped.
- encode in interface StringEncoder
pString
- string to convert to quoted-printable form
- quoted-printable string
EncoderException
- thrown if a failure condition is encountered during the encoding process.
encode
public String encode(java.lang.String pString,
java.lang.String charset)
throws EncoderException
Encodes a string into its quoted-printable form using the specified charset. Unsafe characters are escaped.
pString
- string to convert to quoted-printable formcharset
- the charset for pString
- quoted-printable string
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.
- the default string charset.
getEncoding
protected String getEncoding()
Returns the codec name (referred to as encoding in the RFC 1522)
- getEncoding in interface RFC1522Codec
- name of the codec
isEncodeBlanks
public boolean isEncodeBlanks()
Tests if optional tranformation of SPACE characters is to be used
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
b
- true
if SPACE characters are to be transformed, false
otherwise
commons-codec version 1.3 - Copyright © 2002-2004 - Apache Software Foundation