javax.mail.internet

类 HeaderTokenizer

java.lang.Object

javax.mail.internet.HeaderTokenizer

public class HeaderTokenizer
extends Object

This class tokenizes RFC822 and MIME headers into the basic symbols specified by RFC822 and MIME.

This class handles folded headers (ie headers with embedded CRLF SPACE sequences). The folds are removed in the returned tokens.

作者:

John Mani, Bill Shannon

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	HeaderTokenizer.Token The Token class represents tokens returned by the HeaderTokenizer.

字段概要

字段

限定符和类型	字段和说明
static String	MIME MIME specials
static String	RFC822 RFC822 specials

构造器概要

构造器

构造器和说明
HeaderTokenizer(String header) Constructor.
HeaderTokenizer(String header, String delimiters) Constructor.
HeaderTokenizer(String header, String delimiters, boolean skipComments) Constructor that takes a rfc822 style header.

方法概要

限定符和类型	方法和说明
String	getRemainder() Return the rest of the Header.
HeaderTokenizer.Token	next() Parses the next token from this String.
HeaderTokenizer.Token	next(char endOfAtom) Parses the next token from this String.
HeaderTokenizer.Token	next(char endOfAtom, boolean keepEscapes) Parses the next token from this String.
HeaderTokenizer.Token	peek() Peek at the next token, without actually removing the token from the parse stream.

从类继承的方法 java.lang.Object

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

字段详细资料

RFC822

public static final String RFC822

RFC822 specials

另请参阅:

常量字段值

MIME

public static final String MIME

MIME specials

另请参阅:

常量字段值

构造器详细资料

HeaderTokenizer

public HeaderTokenizer(String header,
                       String delimiters,
                       boolean skipComments)

Constructor that takes a rfc822 style header.

参数:

header - The rfc822 header to be tokenized

delimiters - Set of delimiter characters to be used to delimit ATOMS. These are usually RFC822 or MIME

skipComments - If true, comments are skipped and not returned as tokens

HeaderTokenizer

public HeaderTokenizer(String header,
                       String delimiters)

Constructor. Comments are ignored and not returned as tokens

参数:

header - The header that is tokenized

delimiters - The delimiters to be used

HeaderTokenizer

public HeaderTokenizer(String header)

Constructor. The RFC822 defined delimiters - RFC822 - are used to delimit ATOMS. Also comments are skipped and not returned as tokens

参数:

header - the header string

方法详细资料

next

public HeaderTokenizer.Token next()
                           throws ParseException

Parses the next token from this String.

Clients sit in a loop calling next() to parse successive tokens until an EOF Token is returned.

返回:

the next Token

抛出:

ParseException - if the parse fails

next

public HeaderTokenizer.Token next(char endOfAtom)
                           throws ParseException

Parses the next token from this String. If endOfAtom is not NUL, the token extends until the endOfAtom character is seen, or to the end of the header. This method is useful when parsing headers that don't obey the MIME specification, e.g., by failing to quote parameter values that contain spaces.

参数:

endOfAtom - if not NUL, character marking end of token

返回:

the next Token

抛出:

ParseException - if the parse fails

从以下版本开始:

JavaMail 1.5

next

public HeaderTokenizer.Token next(char endOfAtom,
                                  boolean keepEscapes)
                           throws ParseException

Parses the next token from this String. endOfAtom is handled as above. If keepEscapes is true, any backslash escapes are preserved in the returned string. This method is useful when parsing headers that don't obey the MIME specification, e.g., by failing to escape backslashes in the filename parameter.

参数:

endOfAtom - if not NUL, character marking end of token

keepEscapes - keep all backslashes in returned string?

返回:

the next Token

抛出:

ParseException - if the parse fails

从以下版本开始:

JavaMail 1.5

peek

public HeaderTokenizer.Token peek()
                           throws ParseException

Peek at the next token, without actually removing the token from the parse stream. Invoking this method multiple times will return successive tokens, until next() is called.

返回:

the next Token

抛出:

ParseException - if the parse fails

getRemainder

public String getRemainder()

Return the rest of the Header.

返回:

String rest of header. null is returned if we are already at end of header