org.columba.ristretto.coder

Class EncodedWord

java.lang.Object

org.columba.ristretto.coder.EncodedWord

public class EncodedWord
extends java.lang.Object

Implementation of EncodedWord en- and decoding methods.
RFC(s): 2047

Author:

Timo Stich

Field Summary

Fields

Modifier and Type	Field and Description
static int	BASE64 Base64 Encoding.
static int	QUOTED_PRINTABLE QuotedPritntable Encoding.

Constructor Summary

Constructors

Constructor and Description
EncodedWord()

Method Summary

Modifier and Type	Method and Description
static java.lang.StringBuilder	decode(java.lang.CharSequence input) Decodes a string that contains EncodedWords.
static java.lang.StringBuilder	encode(java.lang.CharSequence input, java.nio.charset.Charset charset, int type) Takes a text in form of a CharSequence encoded in the given charset (e.g.

Methods inherited from class java.lang.Object

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

Field Detail

QUOTED_PRINTABLE

public static final int QUOTED_PRINTABLE

QuotedPritntable Encoding. Default.

See Also:

Constant Field Values

BASE64

public static final int BASE64

Base64 Encoding. Should be used to encode 16bit charsets

See Also:

Constant Field Values

Constructor Detail

EncodedWord

public EncodedWord()

Method Detail

decode

public static java.lang.StringBuilder decode(java.lang.CharSequence input)

Decodes a string that contains EncodedWords.

Parameters:

input - a string containing EncodedWords

Returns:

the decoded string

encode

public static java.lang.StringBuilder encode(java.lang.CharSequence input,
                                             java.nio.charset.Charset charset,
                                             int type)

Takes a text in form of a CharSequence encoded in the given charset (e.g. ISO-8859-1) and makes it US-ASCII compatible and RFC822 compatible for the use as e.g. subject with special characters.
This algorithm tries to achieve several goals when decoding:

never encode a single character but try to encode whole words if two words must be encoded and there a no more than 3 characters inbetween, encode everything in one single encoded word an encoded word must never be longer than 76 characters in total ensure that no encodedWord is in a line-wrap (RFC822 advices to no have more than 78 characters in a headerline)

Parameters:

input - the headerline

charset - the used charset (e.g. ISO-8859-1)

type - the encoding to be used

Returns:

input encoded in EncodedWords