Package jsyntaxpane
Class Token
java.lang.Object
jsyntaxpane.Token
- All Implemented Interfaces:
Serializable
,Comparable
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.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionfinal short
The kind of the Document.final int
final byte
the pair value to use if this token is one of a pair: This is how it is used: The openning 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.final int
final TokenType
-
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
type
-
start
public final int start -
length
public final int length -
pairValue
public final byte pairValuethe pair value to use if this token is one of a pair: This is how it is used: The openning 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 -
kind
public final short kindThe 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;- See Also:
-
-
Constructor Details
-
Token
Constructs a new token- Parameters:
type
-start
-length
-
-
Token
Construct a new part of pair token- Parameters:
type
-start
-length
-pairValue
-
-
-
Method Details
-
equals
-
hashCode
public int hashCode() -
toString
-
compareTo
- Specified by:
compareTo
in interfaceComparable
-
end
public int end()return the end position of the token.- Returns:
- start + length
-
getText
Get the text of the token from this document- Parameters:
doc
-- Returns:
-
getString
-