javax.mail.internet

Class HeaderTokenizer


public class HeaderTokenizer
extends java.lang.Object

A lexer for RFC 822 and MIME headers.
Version:
1.4
Author:
Chris Burdess

Nested Class Summary

static class
HeaderTokenizer.Token
A token returned by the lexer.

Field Summary

static String
MIME
MIME specials.
static String
RFC822
RFC 822 specials.

Constructor Summary

HeaderTokenizer(String header)
Constructor.
HeaderTokenizer(String header, String delimiters)
Constructor.
HeaderTokenizer(String header, String delimiters, boolean skipComments)
Constructor.

Method Summary

String
getRemainder()
Returns the rest of the header.
HeaderTokenizer.Token
next()
Returns the next token.
HeaderTokenizer.Token
peek()
Peeks at the next token.

Field Details

MIME

public static final String MIME
MIME specials.

RFC822

public static final String RFC822
RFC 822 specials.

Constructor Details

HeaderTokenizer

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

HeaderTokenizer

public HeaderTokenizer(String header,
                       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(String header,
                       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

Method Details

getRemainder

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

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:

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