com.helger.commons.codec

Class AbstractRFC1522Codec

java.lang.Object

com.helger.commons.codec.AbstractByteArrayDecoder

com.helger.commons.codec.AbstractByteArrayCodec

com.helger.commons.codec.AbstractRFC1522Codec

All Implemented Interfaces:

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

Direct Known Subclasses:

RFC1522BCodec, RFC1522QCodec

public abstract class AbstractRFC1522Codec
extends AbstractByteArrayCodec

Implements methods common to all codecs defined in RFC 1522.

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 immutable and thread-safe.

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
protected static String	POSTFIX Postfix.
protected static String	PREFIX Prefix.
protected static char	SEP Separator.

Constructor Summary

Constructors

Constructor and Description
AbstractRFC1522Codec()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDecodedText(String sEncodedText) Applies an RFC 1522 compliant decoding scheme to the given string of text.
protected String	getEncodedText(String sText, Charset aSourceCharset) Applies an RFC 1522 compliant encoding scheme to the given string of text with the given charset.
protected abstract String	getRFC1522Encoding() Returns the codec name (referred to as encoding in the RFC 1522).

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

getEncoded

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

getDecoded

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

getEncoded

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

getDecoded, getDecoded

Field Detail

SEP

protected static final char SEP

Separator.

See Also:

Constant Field Values

PREFIX

protected static final String PREFIX

Prefix.

See Also:

Constant Field Values

POSTFIX

protected static final String POSTFIX

Postfix.

See Also:

Constant Field Values

Constructor Detail

AbstractRFC1522Codec

public AbstractRFC1522Codec()

Method Detail

getRFC1522Encoding

@Nonnull
@Nonempty
protected abstract String getRFC1522Encoding()

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

Returns:

name of the codec

getEncodedText

@Nullable
protected String getEncodedText(@Nullable
                             String sText,
                             @Nonnull
                             Charset aSourceCharset)
                         throws EncodeException

Applies an RFC 1522 compliant encoding scheme to the given string of text with the given charset.

This method constructs the "encoded-word" header common to all the RFC 1522 codecs and then invokes IByteArrayEncoder.getEncoded(byte []) method of a concrete class to perform the specific encoding.

Parameters:

sText - a string to encode

aSourceCharset - a charset to be used

Returns:

RFC 1522 compliant "encoded-word"

Throws:

EncodeException - thrown if there is an error condition during the Encoding process.

See Also:

Standard charsets

getDecodedText

@Nullable
public String getDecodedText(@Nullable
                             String sEncodedText)
                      throws DecodeException

Applies an RFC 1522 compliant decoding scheme to the given string of text.

This method processes the "encoded-word" header common to all the RFC 1522 codecs and then invokes IByteArrayDecoder.getDecoded(byte []) method of a concrete class to perform the specific decoding.

Parameters:

sEncodedText - a string to decode

Returns:

A new decoded String or null if the input is null.

Throws:

DecodeException - thrown if there is an error condition during the decoding process.