Package org.apache.tomcat.util.json
Class Token
- java.lang.Object
- 
- org.apache.tomcat.util.json.Token
 
- 
- All Implemented Interfaces:
- java.io.Serializable
 
 public class Token extends java.lang.Object implements java.io.SerializableDescribes the input token stream.- See Also:
- Serialized Form
 
- 
- 
Field SummaryFields Modifier and Type Field Description intbeginColumnThe column number of the first character of this Token.intbeginLineThe line number of the first character of this Token.intendColumnThe column number of the last character of this Token.intendLineThe line number of the last character of this Token.java.lang.StringimageThe string image of the token.intkindAn integer that describes the kind of this token.TokennextA reference to the next regular (non-special) token from the input stream.TokenspecialTokenThis field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token.
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.ObjectgetValue()An optional attribute value of the Token.static TokennewToken(int ofKind)static TokennewToken(int ofKind, java.lang.String image)Returns a new Token object, by default.java.lang.StringtoString()Returns the image.
 
- 
- 
- 
Field Detail- 
kindpublic int kind An integer that describes the kind of this token. This numbering system is determined by JavaCCParser, and a table of these numbers is stored in the file ...Constants.java.
 - 
beginLinepublic int beginLine The line number of the first character of this Token.
 - 
beginColumnpublic int beginColumn The column number of the first character of this Token.
 - 
endLinepublic int endLine The line number of the last character of this Token.
 - 
endColumnpublic int endColumn The column number of the last character of this Token.
 - 
imagepublic java.lang.String image The string image of the token.
 - 
nextpublic Token next A reference to the next regular (non-special) token from the input stream. If this is the last token from the input stream, or if the token manager has not read tokens beyond this one, this field is set to null. This is true only if this token is also a regular token. Otherwise, see below for a description of the contents of this field.
 - 
specialTokenpublic Token specialToken This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token. If there are no such special tokens, this field is set to null. When there are more than one such special token, this field refers to the last of these special tokens, which in turn refers to the next previous special token through its specialToken field, and so on until the first special token (whose specialToken field is null). The next fields of special tokens refer to other special tokens that immediately follow it (without an intervening regular token). If there is no such token, this field is null.
 
- 
 - 
Method Detail- 
getValuepublic java.lang.Object getValue() An optional attribute value of the Token. Tokens which are not used as syntactic sugar will often contain meaningful values that will be used later on by the compiler or interpreter. This attribute value is often different from the image. Any subclass of Token that actually wants to return a non-null value can override this method as appropriate.
 - 
toStringpublic java.lang.String toString() Returns the image.- Overrides:
- toStringin class- java.lang.Object
 
 - 
newTokenpublic static Token newToken(int ofKind, java.lang.String image) Returns a new Token object, by default. However, if you want, you can create and return subclass objects based on the value of ofKind. Simply add the cases to the switch for all those special cases. For example, if you have a subclass of Token called IDToken that you want to create if ofKind is ID, simply add something like : case MyParserConstants.ID : return new IDToken(ofKind, image); to the following switch statement. Then you can cast matchedToken variable to the appropriate type and use sit in your lexical actions.
 - 
newTokenpublic static Token newToken(int ofKind) 
 
- 
 
-