Token
extends Objectimplements Comparable<T>
| java.lang.Object | |
| ↳ | com.pnfsoftware.jeb.util.encoding.jflex.Token |
Class Overview
A Token in a Document. Tokens do NOT store a reference to the underlying SyntaxDocument, and must generally be obtained from the SyntaxDocument methods. The reason for not storing the SyntaxDocument is simply for memory, as the number of Tokens per document can be large, you may end up with twice the memory in a SyntaxDocument with Tokens than a simple PlainDocument.
Summary
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public final short | kind | The kind of the Document. | |||||||||
| public final int | length | ||||||||||
| public final byte | pairValue | the pair value to use if this token is one of a pair: This is how it is used: The opening part will have a positive number X The closing part will have a negative number X X should be unique for a pair: e.g. | |||||||||
| public final long | start | ||||||||||
| public final TokenType | type | ||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
Token(TokenType type, long start, int length)
Constructs a new token
| |||||||||||
|
Token(TokenType type, long start, int length, byte pairValue)
Construct a new part of pair token
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | compareTo(Token t) | ||||||||||
| long |
end()
return the end position of the token.
| ||||||||||
| boolean | equals(Object obj) | ||||||||||
| int | hashCode() | ||||||||||
| String | toString() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
|
From interface
java.lang.Comparable
| |||||||||||
Fields
public final short kind
The kind of the Document. This is only needed if proper Parsing of a document is needed and it makes certain operations faster. You can use any of the supplied Generic Values, or create your language specific uses by using USER_FIRST + x;
public final int length
public final byte pairValue
the pair value to use if this token is one of a pair: This is how it is used: The opening part will have a positive number X The closing part will have a negative number X X should be unique for a pair: e.g. for [ pairValue = +1 for ] pairValue = -1
public final long start
Public Constructors
public Token (TokenType type, long start, int length, byte pairValue)
Construct a new part of pair token
Public Methods
public long end ()
return the end position of the token.
Returns
- start + length