com.helger.commons.codec

Class RFC1522QCodec

java.lang.Object

com.helger.commons.codec.AbstractCodec

com.helger.commons.codec.AbstractRFC1522Codec

com.helger.commons.codec.RFC1522QCodec

All Implemented Interfaces:

IByteArrayDecoder, IByteArrayEncoder, ICodec, IStringCodec, IDecoder<byte[]>, IEncoder<byte[]>

public class RFC1522QCodec
extends AbstractRFC1522Codec

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.

This class is conditionally thread-safe. The instance field m_bEncodeBlanks is mutable setEncodeBlanks(boolean) but is not volatile, and accesses are not synchronised. If an instance of the class is shared between threads, the caller needs to ensure that suitable synchronisation is used to ensure safe publication of the value between threads, and must not invoke setEncodeBlanks(boolean) after initial setup.

See Also:

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

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENCODE_BLANKS

Fields inherited from class com.helger.commons.codec.AbstractRFC1522Codec

POSTFIX, PREFIX, SEP

Constructor Summary

Constructors

Constructor and Description
RFC1522QCodec() Default constructor with the UTF-8 charset.
RFC1522QCodec(Charset aCharset) Constructor which allows for the selection of a default charset.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	decode(byte[] aBuffer) Decode a byte array.
String	decodeText(String sText) Decodes a quoted-printable string into its original form.
byte[]	encode(byte[] aBuffer) Encode a byte array.
String	encodeText(String sText) Encodes a string into its quoted-printable form using the default charset.
Charset	getCharset() Gets the default charset name used for string decoding and encoding.
protected String	getRFC1522Encoding() Returns the codec name (referred to as encoding in the RFC 1522).
boolean	isEncodeBlanks() Tests if optional transformation of SPACE characters is to be used
void	setEncodeBlanks(boolean bEncodeBlanks) Defines whether optional transformation of SPACE characters is to be used

Methods inherited from class com.helger.commons.codec.AbstractRFC1522Codec

encodeText

Methods inherited from class com.helger.commons.codec.AbstractCodec

decode, encode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.helger.commons.codec.ICodec

decode, encode

Field Detail

DEFAULT_ENCODE_BLANKS

public static final boolean DEFAULT_ENCODE_BLANKS

See Also:

Constant Field Values

Constructor Detail

RFC1522QCodec

public RFC1522QCodec()

Default constructor with the UTF-8 charset.

RFC1522QCodec

public RFC1522QCodec(@Nonnull
             Charset aCharset)

Constructor which allows for the selection of a default charset.

Parameters:

aCharset - the default string charset to use.

Method Detail

getRFC1522Encoding

protected String getRFC1522Encoding()

Description copied from class: AbstractRFC1522Codec

Returns the codec name (referred to as encoding in the RFC 1522).

Specified by:

getRFC1522Encoding in class AbstractRFC1522Codec

Returns:

name of the codec

getCharset

@Nonnull
public Charset getCharset()

Description copied from interface: IStringCodec

Gets the default charset name used for string decoding and encoding.

Returns:

the default charset. Never null.

isEncodeBlanks

public boolean isEncodeBlanks()

Tests if optional transformation of SPACE characters is to be used

Returns:

true if SPACE characters are to be transformed, false otherwise

setEncodeBlanks

public void setEncodeBlanks(boolean bEncodeBlanks)

Defines whether optional transformation of SPACE characters is to be used

Parameters:

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

encode

@Nullable
public byte[] encode(@Nullable
                     byte[] aBuffer)

Description copied from interface: IByteArrayEncoder

Encode a byte array.

Parameters:

aBuffer - The byte array to be encoded. May be null.

Returns:

The encoded byte array or null if the parameter was null.

decode

@Nullable
public byte[] decode(@Nullable
                     byte[] aBuffer)
              throws DecoderException

Description copied from interface: IByteArrayDecoder

Decode a byte array.

Parameters:

aBuffer - The byte array to be decoded. May not be null.

Returns:

The decoded byte array or null if the parameter was null.

Throws:

DecoderException - in case something goes wrong

encodeText

@Nullable
public String encodeText(@Nullable
                         String sText)
                  throws EncoderException

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

Parameters:

sText - string to convert to quoted-printable form

Returns:

quoted-printable string

Throws:

EncoderException - thrown if a failure condition is encountered during the encoding process.

decodeText

@Nullable
public String decodeText(@Nullable
                         String sText)
                  throws DecoderException

Decodes a quoted-printable string into its original form. Escaped characters are converted back to their original representation.

Specified by:

decodeText in interface IStringCodec

Overrides:

decodeText in class AbstractRFC1522Codec

Parameters:

sText - 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.