public class QuotedPrintableCodec extends java.lang.Object implements BinaryEncoder, BinaryDecoder, StringEncoder, StringDecoder
The Quoted-Printable encoding is intended to represent data that largely consists of octets that correspond to printable characters in the ASCII character set. It encodes the data in such a way that the resulting octets are unlikely to be modified by mail transport. If the data being encoded are mostly ASCII text, the encoded form of the data remains largely recognizable by humans. A body which is entirely ASCII may also be encoded in Quoted-Printable to ensure the integrity of the data should the message pass through a character- translating, and/or line-wrapping gateway.
Note:
Depending on the selected strict
parameter, this class will implement a different set of rules of the
quoted-printable spec:
strict=false
: only rules #1 and #2 are implemented
strict=true
: all rules #1 through #5 are implemented
This class is immutable and thread-safe.
Modifier and Type | Field and Description |
---|---|
private java.nio.charset.Charset |
charset
The default charset used for string decoding and encoding.
|
private static byte |
CR |
private static byte |
ESCAPE_CHAR |
private static byte |
LF |
private static java.util.BitSet |
PRINTABLE_CHARS
BitSet of printable characters as defined in RFC 1521.
|
private static int |
SAFE_LENGTH
Safe line length for quoted printable encoded text.
|
private static byte |
SPACE |
private boolean |
strict
Indicates whether soft line breaks shall be used during encoding (rule #3-5).
|
private static byte |
TAB |
Constructor and Description |
---|
QuotedPrintableCodec()
Default constructor, assumes default charset of
Charsets.UTF_8 |
QuotedPrintableCodec(boolean strict)
Constructor which allows for the selection of the strict mode.
|
QuotedPrintableCodec(java.nio.charset.Charset charset)
Constructor which allows for the selection of a default charset.
|
QuotedPrintableCodec(java.nio.charset.Charset charset,
boolean strict)
Constructor which allows for the selection of a default charset and strict mode.
|
QuotedPrintableCodec(java.lang.String charsetName)
Constructor which allows for the selection of a default charset.
|
Modifier and Type | Method and Description |
---|---|
byte[] |
decode(byte[] bytes)
Decodes an array of quoted-printable characters into an array of original bytes.
|
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 using the default string charset.
|
java.lang.String |
decode(java.lang.String str,
java.nio.charset.Charset charset)
Decodes a quoted-printable string into its original form using the specified string charset.
|
java.lang.String |
decode(java.lang.String str,
java.lang.String charset)
Decodes a quoted-printable string into its original form using the specified string charset.
|
static byte[] |
decodeQuotedPrintable(byte[] bytes)
Decodes an array quoted-printable characters into an array of original bytes.
|
byte[] |
encode(byte[] bytes)
Encodes an array of bytes into an array of quoted-printable 7-bit characters.
|
java.lang.Object |
encode(java.lang.Object obj)
Encodes an object into its quoted-printable safe form.
|
java.lang.String |
encode(java.lang.String str)
Encodes a string into its quoted-printable form using the default string charset.
|
java.lang.String |
encode(java.lang.String str,
java.nio.charset.Charset charset)
Encodes a string into its quoted-printable form using the specified charset.
|
java.lang.String |
encode(java.lang.String str,
java.lang.String charset)
Encodes a string into its quoted-printable form using the specified charset.
|
private static int |
encodeByte(int b,
boolean encode,
java.io.ByteArrayOutputStream buffer)
Write a byte to the buffer.
|
static byte[] |
encodeQuotedPrintable(java.util.BitSet printable,
byte[] bytes)
Encodes an array of bytes into an array of quoted-printable 7-bit characters.
|
static byte[] |
encodeQuotedPrintable(java.util.BitSet printable,
byte[] bytes,
boolean strict)
Encodes an array of bytes into an array of quoted-printable 7-bit characters.
|
private static int |
encodeQuotedPrintable(int b,
java.io.ByteArrayOutputStream buffer)
Encodes byte into its quoted-printable representation.
|
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.
|
private static int |
getUnsignedOctet(int index,
byte[] bytes)
Return the byte at position
index of the byte array and
make sure it is unsigned. |
private static boolean |
isWhitespace(int b)
Checks whether the given byte is whitespace.
|
private final java.nio.charset.Charset charset
private final boolean strict
private static final java.util.BitSet PRINTABLE_CHARS
private static final byte ESCAPE_CHAR
private static final byte TAB
private static final byte SPACE
private static final byte CR
private static final byte LF
private static final int SAFE_LENGTH
public QuotedPrintableCodec()
Charsets.UTF_8
public QuotedPrintableCodec(boolean strict)
strict
- if true
, soft line breaks will be usedpublic QuotedPrintableCodec(java.nio.charset.Charset charset)
charset
- the default string charset to use.public QuotedPrintableCodec(java.nio.charset.Charset charset, boolean strict)
charset
- the default string charset to use.strict
- if true
, soft line breaks will be usedpublic QuotedPrintableCodec(java.lang.String charsetName) throws java.nio.charset.IllegalCharsetNameException, java.lang.IllegalArgumentException, java.nio.charset.UnsupportedCharsetException
charsetName
- the default string charset to use.java.nio.charset.UnsupportedCharsetException
- If no support for the named charset is available
in this instance of the Java virtual machinejava.lang.IllegalArgumentException
- If the given charsetName is nulljava.nio.charset.IllegalCharsetNameException
- If the given charset name is illegalprivate static final int encodeQuotedPrintable(int b, java.io.ByteArrayOutputStream buffer)
b
- byte to encodebuffer
- the buffer to write tobuffer
private static int getUnsignedOctet(int index, byte[] bytes)
index
of the byte array and
make sure it is unsigned.index
- position in the arraybytes
- the byte arrayindex
from the arrayprivate static int encodeByte(int b, boolean encode, java.io.ByteArrayOutputStream buffer)
b
- byte to writeencode
- indicates whether the octet shall be encodedbuffer
- the buffer to write toprivate static boolean isWhitespace(int b)
b
- byte to be checkedtrue
if the byte is either a space or tab characterpublic static final byte[] encodeQuotedPrintable(java.util.BitSet printable, byte[] bytes)
This function implements a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in RFC 1521 and is suitable for encoding binary data and unformatted text.
printable
- bitset of characters deemed quoted-printablebytes
- array of bytes to be encodedpublic static final byte[] encodeQuotedPrintable(java.util.BitSet printable, byte[] bytes, boolean strict)
Depending on the selection of the strict
parameter, this function either implements the full ruleset
or only a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in
RFC 1521 and is suitable for encoding binary data and unformatted text.
printable
- bitset of characters deemed quoted-printablebytes
- array of bytes to be encodedstrict
- if true
the full ruleset is used, otherwise only rule #1 and rule #2public static final byte[] decodeQuotedPrintable(byte[] bytes) throws DecoderException
This function fully implements the quoted-printable encoding specification (rule #1 through rule #5) as defined in RFC 1521.
bytes
- array of quoted-printable charactersDecoderException
- Thrown if quoted-printable decoding is unsuccessfulpublic byte[] encode(byte[] bytes)
Depending on the selection of the strict
parameter, this function either implements the full ruleset
or only a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in
RFC 1521 and is suitable for encoding binary data and unformatted text.
encode
in interface BinaryEncoder
bytes
- array of bytes to be encodedpublic byte[] decode(byte[] bytes) throws DecoderException
This function fully implements the quoted-printable encoding specification (rule #1 through rule #5) as defined in RFC 1521.
decode
in interface BinaryDecoder
bytes
- array of quoted-printable charactersDecoderException
- Thrown if quoted-printable decoding is unsuccessfulpublic java.lang.String encode(java.lang.String str) throws EncoderException
Depending on the selection of the strict
parameter, this function either implements the full ruleset
or only a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in
RFC 1521 and is suitable for encoding binary data and unformatted text.
encode
in interface StringEncoder
str
- string to convert to quoted-printable formEncoderException
- Thrown if quoted-printable encoding is unsuccessfulgetCharset()
public java.lang.String decode(java.lang.String str, java.nio.charset.Charset charset) throws DecoderException
str
- quoted-printable string to convert into its original formcharset
- the original string charsetDecoderException
- Thrown if quoted-printable decoding is unsuccessfulpublic java.lang.String decode(java.lang.String str, java.lang.String charset) throws DecoderException, java.io.UnsupportedEncodingException
str
- quoted-printable string to convert into its original formcharset
- the original string charsetDecoderException
- Thrown if quoted-printable decoding is unsuccessfuljava.io.UnsupportedEncodingException
- Thrown if charset is not supportedpublic java.lang.String decode(java.lang.String str) throws DecoderException
decode
in interface StringDecoder
str
- quoted-printable string to convert into its original formDecoderException
- Thrown if quoted-printable decoding is unsuccessful. Thrown if charset is not supported.getCharset()
public java.lang.Object encode(java.lang.Object obj) throws EncoderException
encode
in interface Encoder
obj
- string to convert to a quoted-printable formEncoderException
- Thrown if quoted-printable encoding is not applicable to objects of this type or if encoding is
unsuccessfulpublic java.lang.Object decode(java.lang.Object obj) throws DecoderException
decode
in interface Decoder
obj
- quoted-printable object to convert into its original formDecoderException
- Thrown if the argument is not a String
or byte[]
. Thrown if a failure
condition is encountered during the decode process.public java.nio.charset.Charset getCharset()
public java.lang.String getDefaultCharset()
public java.lang.String encode(java.lang.String str, java.nio.charset.Charset charset)
Depending on the selection of the strict
parameter, this function either implements the full ruleset
or only a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in
RFC 1521 and is suitable for encoding binary data and unformatted text.
str
- string to convert to quoted-printable formcharset
- the charset for strpublic java.lang.String encode(java.lang.String str, java.lang.String charset) throws java.io.UnsupportedEncodingException
Depending on the selection of the strict
parameter, this function either implements the full ruleset
or only a subset of quoted-printable encoding specification (rule #1 and rule #2) as defined in
RFC 1521 and is suitable for encoding binary data and unformatted text.
str
- string to convert to quoted-printable formcharset
- the charset for strjava.io.UnsupportedEncodingException
- Thrown if the charset is not supported