javax.mail.internet
Class HeaderTokenizer

java.lang.Object
  extended by javax.mail.internet.HeaderTokenizer

public class HeaderTokenizer
extends java.lang.Object

A lexer for RFC 822 and MIME headers.

Version:
1.3
Author:
Chris Burdess

Nested Class Summary
static class HeaderTokenizer.Token
          A token returned by the lexer.
 
Field Summary
static java.lang.String MIME
          MIME specials.
static java.lang.String RFC822
          RFC 822 specials.
 
Constructor Summary
HeaderTokenizer(java.lang.String header)
          Constructor.
HeaderTokenizer(java.lang.String header, java.lang.String delimiters)
          Constructor.
HeaderTokenizer(java.lang.String header, java.lang.String delimiters, boolean skipComments)
          Constructor.
 
Method Summary
 java.lang.String getRemainder()
          Returns the rest of the header.
 HeaderTokenizer.Token next()
          Returns the next token.
 HeaderTokenizer.Token peek()
          Peeks at the next token.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RFC822

public static final java.lang.String RFC822
RFC 822 specials.

See Also:
Constant Field Values

MIME

public static final java.lang.String MIME
MIME specials.

See Also:
Constant Field Values
Constructor Detail

HeaderTokenizer

public HeaderTokenizer(java.lang.String header,
                       java.lang.String delimiters,
                       boolean skipComments)
Constructor.

Parameters:
header - the RFC 822 header to be tokenized
delimiters - the delimiter characters to be used to delimit ATOMs
skipComments - whether to skip comments

HeaderTokenizer

public HeaderTokenizer(java.lang.String header,
                       java.lang.String delimiters)
Constructor. Comments are ignored.

Parameters:
header - the RFC 822 header to be tokenized
delimiters - the delimiter characters to be used to delimit ATOMs

HeaderTokenizer

public HeaderTokenizer(java.lang.String header)
Constructor. The RFC822-defined delimiters are used to delimit ATOMs. Comments are ignored.

Method Detail

next

public HeaderTokenizer.Token next()
                           throws ParseException
Returns the next token.

Returns:
the next token
Throws:
ParseException - if the parse fails

peek

public HeaderTokenizer.Token peek()
                           throws ParseException
Peeks at the next token. The token will still be available to be read by next(). Invoking this method multiple times returns successive tokens, until next() is called.

Parameters:
ParseException - if the parse fails
Throws:
ParseException

getRemainder

public java.lang.String getRemainder()
Returns the rest of the header.



© Copyright 2003, 2004 The Free Software Foundation, All rights reserved