This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
javax.mail.internet
class HeaderTokenizer.Token
- Enclosing class:
- HeaderTokenizer
public static class HeaderTokenizer.Token
extends Object
The Token class represents tokens returned by the
HeaderTokenizer.
Field Summary |
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 |
Constructor.
|
Method Summary |
int |
Return the type of the token.
|
String |
Returns the value of the token just read.
|
ATOM
public static final int ATOM
-
Token type indicating an ATOM.
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.
EOF
public static final int EOF
-
Token type indicating end of input.
QUOTEDSTRING
public static final int QUOTEDSTRING
-
Token type indicating a quoted string. The value
field contains the string without the quotes.
HeaderTokenizer.Token
public HeaderTokenizer.Token(int type,
String value)
-
Constructor.
- Parameters:
type
- Token type
value
- Token value
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
getValue
public 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
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.