org.jwat.common

Class EncodedWords

java.lang.Object

org.jwat.common.EncodedWords

public class EncodedWords
extends java.lang.Object

Class used to decode and validate an Encoded-Word string as specified in RFC 2047. Examples: =?US-ASCII?Q?Keith_Moore?= =?ISO-8859-1?Q?Keld_J=F8rn_Simonsen?= =?ISO-8859-1?Q?Andr=E9?= =?ISO-8859-1?B?SWYgeW91IGNhbiByZWFkIHRoaXMgeW8=?= =?ISO-8859-2?B?dSB1bmRlcnN0YW5kIHRoZSBleGFtcGxlLg==?=

Author:

nicl

Field Summary

Fields

Modifier and Type	Field and Description
boolean	bConversionError Indicates whether there were errors during character conversion.
boolean	bIsValid Indicates where the encoded words could be validated and decoded.
boolean	bValidCharset Indicates whether the charset is valid or not.
protected static int	CC_CONTROL Control character characteristic.
protected static int	CC_SEPARATOR_WS Separator character characteristic.
protected static byte[]	charCharacteristicsTab Table of separator and control characters.
java.lang.String	charsetStr Raw charset name.
java.lang.String	decoded_text Decoded text, after decoding and character conversion.
static int	ENC_BASE64 Base64 encoding id.
static int	ENC_QUOTEDPRINTABLE Quoted-Printable encoding id.
java.lang.String	encoded_text Raw encoded text string
int	encoding Identified encoding, 0 indicates an unknown encoding.
java.lang.String	encodingStr Raw encoding name.
byte[]	line Raw bytes parsed, usable to re-insert original string after validation.
protected static int	S_CHARSET Reading the charset state.
protected static int	S_ENCODED_WORDS Reading the encoded words state.
protected static int	S_ENCODING Reading the encoding state.
protected static int	S_END_EQ Looking for the last equal sign state.
protected static int	S_START_EQ Looking for an equal sign state.
protected static int	S_START_QM Looking for a question mark state.
protected static java.lang.String	separators rfc2616 separator minus space and tab.

Constructor Summary

Constructors

Constructor and Description
EncodedWords()

Method Summary

Modifier and Type	Method and Description
static EncodedWords	parseEncodedWords(java.io.InputStream in, boolean bParseEqQm) Attempt to validate and decode an encoded-word from the input stream.

Methods inherited from class java.lang.Object

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

Field Detail

S_START_EQ

protected static final int S_START_EQ

Looking for an equal sign state.

See Also:

Constant Field Values

S_START_QM

protected static final int S_START_QM

Looking for a question mark state.

See Also:

Constant Field Values

S_CHARSET

protected static final int S_CHARSET

Reading the charset state.

See Also:

Constant Field Values

S_ENCODING

protected static final int S_ENCODING

Reading the encoding state.

See Also:

Constant Field Values

S_ENCODED_WORDS

protected static final int S_ENCODED_WORDS

Reading the encoded words state.

See Also:

Constant Field Values

S_END_EQ

protected static final int S_END_EQ

Looking for the last equal sign state.

See Also:

Constant Field Values

ENC_BASE64

public static final int ENC_BASE64

Base64 encoding id.

See Also:

Constant Field Values

ENC_QUOTEDPRINTABLE

public static final int ENC_QUOTEDPRINTABLE

Quoted-Printable encoding id.

See Also:

Constant Field Values

CC_CONTROL

protected static final int CC_CONTROL

Control character characteristic.

See Also:

Constant Field Values

CC_SEPARATOR_WS

protected static final int CC_SEPARATOR_WS

Separator character characteristic.

See Also:

Constant Field Values

separators

protected static final java.lang.String separators

rfc2616 separator minus space and tab.

See Also:

Constant Field Values

charCharacteristicsTab

protected static final byte[] charCharacteristicsTab

Table of separator and control characters.

bValidCharset

public boolean bValidCharset

Indicates whether the charset is valid or not.

charsetStr

public java.lang.String charsetStr

Raw charset name.

encoding

public int encoding

Identified encoding, 0 indicates an unknown encoding.

encodingStr

public java.lang.String encodingStr

Raw encoding name.

encoded_text

public java.lang.String encoded_text

Raw encoded text string

bConversionError

public boolean bConversionError

Indicates whether there were errors during character conversion.

decoded_text

public java.lang.String decoded_text

Decoded text, after decoding and character conversion.

line

public byte[] line

Raw bytes parsed, usable to re-insert original string after validation.

bIsValid

public boolean bIsValid

Indicates where the encoded words could be validated and decoded.

Constructor Detail

EncodedWords

public EncodedWords()

Method Detail

parseEncodedWords

public static EncodedWords parseEncodedWords(java.io.InputStream in,
                                             boolean bParseEqQm)
                                      throws java.io.IOException

Attempt to validate and decode an encoded-word from the input stream. In case of failure the already parsed raw data is available for further processing.

Parameters:

in - input stream containing a possible encoded-word

bParseEqQm - true if we should look for leading "=?", false if not

Returns:

result of the validation and decoding

Throws:

java.io.IOException - if an I/O error occurs during parsing