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.
Modifier and Type | Field and Description |
---|---|
private static byte |
BLANK |
private java.lang.String |
charset
The default charset used for string decoding and encoding.
|
private boolean |
encodeBlanks |
private static java.util.BitSet |
PRINTABLE_CHARS
BitSet of printable characters as defined in RFC 1522.
|
private static byte |
UNDERSCORE |
POSTFIX, PREFIX, SEP
Constructor and Description |
---|
QCodec()
Default constructor.
|
QCodec(java.lang.String charset)
Constructor which allows for the selection of a default charset
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
decode(java.lang.Object pObject)
Decodes a quoted-printable object into its original form.
|
java.lang.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
|
java.lang.Object |
encode(java.lang.Object pObject)
Encodes an object into its quoted-printable form using the default charset.
|
java.lang.String |
encode(java.lang.String pString)
Encodes a string into its quoted-printable form using the default charset.
|
java.lang.String |
encode(java.lang.String pString,
java.lang.String charset)
Encodes a string into its quoted-printable form using the specified charset.
|
java.lang.String |
getDefaultCharset()
The default charset used for string decoding and encoding.
|
protected java.lang.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
|
decodeText, encodeText
private final java.lang.String charset
private static final java.util.BitSet PRINTABLE_CHARS
private static final byte BLANK
private static final byte UNDERSCORE
private boolean encodeBlanks
public QCodec()
public QCodec(java.lang.String charset)
charset
- the default string charset to use.protected java.lang.String getEncoding()
RFC1522Codec
getEncoding
in class RFC1522Codec
protected byte[] doEncoding(byte[] bytes)
RFC1522Codec
doEncoding
in class RFC1522Codec
bytes
- Data to be encodedprotected byte[] doDecoding(byte[] bytes) throws DecoderException
RFC1522Codec
doDecoding
in class RFC1522Codec
bytes
- Data to be decodedDecoderException
- A decoder exception is thrown if a Decoder encounters a
failure condition during the decode process.public java.lang.String encode(java.lang.String pString, java.lang.String charset) throws EncoderException
pString
- string to convert to quoted-printable formcharset
- the charset for pStringEncoderException
- thrown if a failure condition is encountered during the encoding process.public java.lang.String encode(java.lang.String pString) throws EncoderException
encode
in interface StringEncoder
pString
- string to convert to quoted-printable formEncoderException
- thrown if a failure condition is encountered during the encoding process.public java.lang.String decode(java.lang.String pString) throws DecoderException
decode
in interface StringDecoder
pString
- quoted-printable string to convert into its original formDecoderException
- A decoder exception is thrown if a failure condition is encountered during the decode process.public java.lang.Object encode(java.lang.Object pObject) throws EncoderException
encode
in interface Encoder
pObject
- object to convert to quoted-printable formEncoderException
- thrown if a failure condition is encountered during the encoding process.public java.lang.Object decode(java.lang.Object pObject) throws DecoderException
decode
in interface Decoder
pObject
- quoted-printable object to convert into its original formDecoderException
- Thrown if the argument is not a String
. Thrown if a failure condition is
encountered during the decode process.public java.lang.String getDefaultCharset()
public boolean isEncodeBlanks()
true
if SPACE characters are to be transformed, false
otherwisepublic void setEncodeBlanks(boolean b)
b
- true
if SPACE characters are to be transformed, false
otherwisecommons-codec version 1.4 - Copyright © 2002-2019 - Apache Software Foundation