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

      Nested Classes 
      Modifier and Type Class Description
      static class  HeaderTokenizer.Token
      A token returned by the lexer.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String MIME
      MIME specials.
      static java.lang.String RFC822
      RFC 822 specials.
    • Constructor Summary

      Constructors 
      Constructor Description
      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.
    • 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

      • 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.