org.antlr.runtime.ClassicToken Class Reference
Public Member Functions | |
| ClassicToken (int type) | |
| ClassicToken (Token oldToken) | |
| ClassicToken (int type, String text) | |
| ClassicToken (int type, String text, int channel) | |
| int | getType () |
| void | setLine (int line) |
| String | getText () |
| void | setText (String text) |
| int | getLine () |
| int | getCharPositionInLine () |
| void | setCharPositionInLine (int charPositionInLine) |
| int | getChannel () |
| void | setChannel (int channel) |
| void | setType (int type) |
| int | getTokenIndex () |
| void | setTokenIndex (int index) |
| CharStream | getInputStream () |
| void | setInputStream (CharStream input) |
| String | toString () |
Protected Attributes | |
| String | text |
| int | type |
| int | line |
| int | charPositionInLine |
| int | channel = DEFAULT_CHANNEL |
| int | index |
Detailed Description
A Token object like we'd use in ANTLR 2.x; has an actual string created and associated with this object. These objects are needed for imaginary tree nodes that have payload objects. We need to create a Token object that has a string; the tree node will point at this token. CommonToken has indexes into a char stream and hence cannot be used to introduce new strings.Definition at line 37 of file ClassicToken.java.
Constructor & Destructor Documentation
| org.antlr.runtime.ClassicToken.ClassicToken | ( | int | type | ) |
Definition at line 47 of file ClassicToken.java.
| org.antlr.runtime.ClassicToken.ClassicToken | ( | Token | oldToken | ) |
Definition at line 51 of file ClassicToken.java.
| org.antlr.runtime.ClassicToken.ClassicToken | ( | int | type, | |
| String | text | |||
| ) |
Definition at line 59 of file ClassicToken.java.
| org.antlr.runtime.ClassicToken.ClassicToken | ( | int | type, | |
| String | text, | |||
| int | channel | |||
| ) |
Definition at line 64 of file ClassicToken.java.
Member Function Documentation
| int org.antlr.runtime.ClassicToken.getType | ( | ) |
| void org.antlr.runtime.ClassicToken.setLine | ( | int | line | ) |
| String org.antlr.runtime.ClassicToken.getText | ( | ) |
Get the text of the token
Implements org.antlr.runtime.Token.
Definition at line 78 of file ClassicToken.java.
| void org.antlr.runtime.ClassicToken.setText | ( | String | text | ) |
| int org.antlr.runtime.ClassicToken.getLine | ( | ) |
The line number on which this token was matched; line=1..n
Implements org.antlr.runtime.Token.
Definition at line 86 of file ClassicToken.java.
| int org.antlr.runtime.ClassicToken.getCharPositionInLine | ( | ) |
The index of the first character relative to the beginning of the line 0..n-1
Implements org.antlr.runtime.Token.
Definition at line 90 of file ClassicToken.java.
| void org.antlr.runtime.ClassicToken.setCharPositionInLine | ( | int | charPositionInLine | ) |
| int org.antlr.runtime.ClassicToken.getChannel | ( | ) |
| void org.antlr.runtime.ClassicToken.setChannel | ( | int | channel | ) |
| void org.antlr.runtime.ClassicToken.setType | ( | int | type | ) |
| int org.antlr.runtime.ClassicToken.getTokenIndex | ( | ) |
An index from 0..n-1 of the token object in the input stream. This must be valid in order to use the ANTLRWorks debugger.
Implements org.antlr.runtime.Token.
Definition at line 110 of file ClassicToken.java.
| void org.antlr.runtime.ClassicToken.setTokenIndex | ( | int | index | ) |
| CharStream org.antlr.runtime.ClassicToken.getInputStream | ( | ) |
From what character stream was this token created? You don't have to implement but it's nice to know where a Token comes from if you have include files etc... on the input.
Implements org.antlr.runtime.Token.
Definition at line 118 of file ClassicToken.java.
| void org.antlr.runtime.ClassicToken.setInputStream | ( | CharStream | input | ) |
| String org.antlr.runtime.ClassicToken.toString | ( | ) |
Definition at line 125 of file ClassicToken.java.
Member Data Documentation
String org.antlr.runtime.ClassicToken.text [protected] |
Definition at line 38 of file ClassicToken.java.
int org.antlr.runtime.ClassicToken.type [protected] |
Definition at line 39 of file ClassicToken.java.
int org.antlr.runtime.ClassicToken.line [protected] |
Definition at line 40 of file ClassicToken.java.
int org.antlr.runtime.ClassicToken.charPositionInLine [protected] |
Definition at line 41 of file ClassicToken.java.
int org.antlr.runtime.ClassicToken.channel = DEFAULT_CHANNEL [protected] |
Definition at line 42 of file ClassicToken.java.
int org.antlr.runtime.ClassicToken.index [protected] |
What token number is this from 0..n-1 tokens
Definition at line 45 of file ClassicToken.java.
The documentation for this class was generated from the following file:
- /Users/parrt/antlr/code/antlr/main/runtime/Java/src/org/antlr/runtime/ClassicToken.java
