Package javax.mail.internet

Class HeaderTokenizer.Token

  • Enclosing class:
    HeaderTokenizer

    public static class HeaderTokenizer.Token
extends java.lang.Object
    The Token class represents tokens returned by the HeaderTokenizer.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ATOM
      Token type indicating an ATOM.
      static int COMMENT
      Token type indicating a comment.
      static int EOF
      Token type indicating end of input.
      static int QUOTEDSTRING
      Token type indicating a quoted string.

    • Constructor Summary

      Constructors 
      Constructor Description
      Token​(int type, java.lang.String value)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getType​()
      Return the type of the token.
      java.lang.String getValue​()
      Returns the value of the token just read.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • QUOTEDSTRING

        public static final int QUOTEDSTRING
        Token type indicating a quoted string. The value field contains the string without the quotes.
        See Also:
        Constant Field Values

      • COMMENT

        public static final int COMMENT
        Token type indicating a comment. The value field contains the comment string without the comment start and end symbols.
        See Also:
        Constant Field Values

    • Constructor Detail

      • Token

        public Token​(int type,
             java.lang.String value)
        Constructor.
        Parameters:
        type - Token type
        value - Token value

    • Method Detail

      • getType

        public int getType​()
        Return the type of the token. If the token represents a delimiter or a control character, the type is that character itself, converted to an integer. Otherwise, it's value is one of the following:
        • ATOM A sequence of ASCII characters delimited by either SPACE, CTL, "(", <"> or the specified SPECIALS
        • QUOTEDSTRING A sequence of ASCII characters within quotes
        • COMMENT A sequence of ASCII characters within "(" and ")".
        • EOF End of header
        Returns:
        the token type

      • getValue

        public java.lang.String getValue​()
        Returns the value of the token just read. When the current token is a quoted string, this field contains the body of the string, without the quotes. When the current token is a comment, this field contains the body of the comment.
        Returns:
        token value