# Uses of Interface
org.eclipse.jface.text.rules.IToken

Packages that use IToken
Package
Description
org.eclipse.jface.text.rules
Provides a framework for rule based text scanning and uses the framework to provide rule-driven default implementations of `IPresentationDamager`, `IPresentationRepairer` and `IDocumentPartitioner`.

## Uses of IToken in org.eclipse.jface.text.rules

Classes in org.eclipse.jface.text.rules that implement IToken
Modifier and Type
Class
Description
`class`
`Token`
Standard implementation of `IToken`.
Fields in org.eclipse.jface.text.rules declared as IToken
Modifier and Type
Field
Description
`static final IToken`
Token.`EOF`
Standard token: End Of File.
`protected IToken`
RuleBasedScanner.`fDefaultReturnToken`
The token to be returned by default if no rule fires
`protected IToken`
WordRule.`fDefaultToken`
The default token to be returned on success and if nothing else has been specified.
`protected IToken`
NumberRule.`fToken`
The token to be returned when this rule is successful
`protected IToken`
PatternRule.`fToken`
The token to be returned on success
`protected final IToken`
WhitespaceRule.`fWhitespaceToken`
The token returned for whitespace.
`static final IToken`
Token.`OTHER`
Deprecated.
will be removed
`static final IToken`
Token.`UNDEFINED`
Standard token: Undefined.
`static final IToken`
Token.`WHITESPACE`
Standard token: Whitespace.
Fields in org.eclipse.jface.text.rules with type parameters of type IToken
Modifier and Type
Field
Description
`protected Map<String,IToken>`
WordRule.`fWords`
The table of predefined words and token for this rule.
Methods in org.eclipse.jface.text.rules that return IToken
Modifier and Type
Method
Description
`protected IToken`
PatternRule.`doEvaluate(ICharacterScanner scanner)`
Evaluates this rules without considering any column constraints.
`protected IToken`
PatternRule.`doEvaluate(ICharacterScanner scanner, boolean resume)`
Evaluates this rules without considering any column constraints.
`IToken`
IPredicateRule.`evaluate(ICharacterScanner scanner, boolean resume)`
Evaluates the rule by examining the characters available from the provided character scanner.
`IToken`
IRule.`evaluate(ICharacterScanner scanner)`
Evaluates the rule by examining the characters available from the provided character scanner.
`IToken`
NumberRule.`evaluate(ICharacterScanner scanner)`
`IToken`
PatternRule.`evaluate(ICharacterScanner scanner)`
`IToken`
PatternRule.`evaluate(ICharacterScanner scanner, boolean resume)`
`IToken`
WhitespaceRule.`evaluate(ICharacterScanner scanner)`
Evaluates the rule by examining the characters available from the provided character scanner.
`IToken`
WordRule.`evaluate(ICharacterScanner scanner)`
`IToken`
IPredicateRule.`getSuccessToken()`
Returns the success token of this predicate rule.
`IToken`
PatternRule.`getSuccessToken()`
`IToken`
ITokenScanner.`nextToken()`
Returns the next token in the document.
`IToken`
RuleBasedPartitionScanner.`nextToken()`
`IToken`
RuleBasedScanner.`nextToken()`
Methods in org.eclipse.jface.text.rules with parameters of type IToken
Modifier and Type
Method
Description
`void`
WordRule.`addWord(String word, IToken token)`
Adds a word and the token to be returned if it is detected.
`protected String`
DefaultPartitioner.`getTokenContentType(IToken token)`
Deprecated.
Returns a content type encoded in the given token.
`protected String`
FastPartitioner.`getTokenContentType(IToken token)`
Returns a content type encoded in the given token.
`protected String`
RuleBasedPartitioner.`getTokenContentType(IToken token)`
Deprecated.
Returns a content type encoded in the given token.
`protected TextAttribute`
DefaultDamagerRepairer.`getTokenTextAttribute(IToken token)`
Returns a text attribute encoded in the given token.
`void`
RuleBasedScanner.`setDefaultReturnToken(IToken defaultReturnToken)`
Configures the scanner's default return token.
Constructors in org.eclipse.jface.text.rules with parameters of type IToken
Modifier
Constructor
Description
``
`EndOfLineRule(String startSequence, IToken token)`
Creates a rule for the given starting sequence which, if detected, will return the specified token.
``
`EndOfLineRule(String startSequence, IToken token, char escapeCharacter)`
Creates a rule for the given starting sequence which, if detected, will return the specified token.
``
`EndOfLineRule(String startSequence, IToken token, char escapeCharacter, boolean escapeContinuesLine)`
Creates a rule for the given starting sequence which, if detected, will return the specified token.
``
`MultiLineRule(String startSequence, String endSequence, IToken token)`
Creates a rule for the given starting and ending sequence which, if detected, will return the specified token.
``
`MultiLineRule(String startSequence, String endSequence, IToken token, char escapeCharacter)`
Creates a rule for the given starting and ending sequence which, if detected, will return the specific token.
``
`MultiLineRule(String startSequence, String endSequence, IToken token, char escapeCharacter, boolean breaksOnEOF)`
Creates a rule for the given starting and ending sequence which, if detected, will return the specific token.
``
`NumberRule(IToken token)`
Creates a rule which will return the specified token when a numerical sequence is detected.
``
`PatternRule(String startSequence, String endSequence, IToken token, char escapeCharacter, boolean breaksOnEOL)`
Creates a rule for the given starting and ending sequence.
``
`PatternRule(String startSequence, String endSequence, IToken token, char escapeCharacter, boolean breaksOnEOL, boolean breaksOnEOF)`
Creates a rule for the given starting and ending sequence.
``
`PatternRule(String startSequence, String endSequence, IToken token, char escapeCharacter, boolean breaksOnEOL, boolean breaksOnEOF, boolean escapeContinuesLine)`
Creates a rule for the given starting and ending sequence.
``
`SingleLineRule(String startSequence, String endSequence, IToken token)`
Creates a rule for the given starting and ending sequence which, if detected, will return the specified token.
``
`SingleLineRule(String startSequence, String endSequence, IToken token, char escapeCharacter)`
Creates a rule for the given starting and ending sequence which, if detected, will return the specified token.
``
`SingleLineRule(String startSequence, String endSequence, IToken token, char escapeCharacter, boolean breaksOnEOF)`
Creates a rule for the given starting and ending sequence which, if detected, will return the specified token.
``
`SingleLineRule(String startSequence, String endSequence, IToken token, char escapeCharacter, boolean breaksOnEOF, boolean escapeContinuesLine)`
Creates a rule for the given starting and ending sequence which, if detected, will return the specified token.
``
`WhitespaceRule(IWhitespaceDetector detector, IToken token)`
Creates a rule which, with the help of an whitespace detector, will return the given whitespace token when a whitespace is detected.
``
`WordPatternRule(IWordDetector detector, String startSequence, String endSequence, IToken token)`
Creates a rule for the given starting and ending word pattern which, if detected, will return the specified token.
``
`WordPatternRule(IWordDetector detector, String startSequence, String endSequence, IToken token, char escapeCharacter)`
/** Creates a rule for the given starting and ending word pattern which, if detected, will return the specified token.
``
`WordRule(IWordDetector detector, IToken defaultToken)`
Creates a rule which, with the help of a word detector, will return the token associated with the detected word.
``
`WordRule(IWordDetector detector, IToken defaultToken, boolean ignoreCase)`
Creates a rule which, with the help of a word detector, will return the token associated with the detected word.