Package org.eclipse.jface.text.rules
Class WhitespaceRule
- java.lang.Object
-
- org.eclipse.jface.text.rules.WhitespaceRule
-
- All Implemented Interfaces:
IRule
public class WhitespaceRule extends Object implements IRule
An implementation ofIRule
capable of detecting whitespace. A whitespace rule uses a whitespace detector in order to find out which characters are whitespace characters.- See Also:
IWhitespaceDetector
-
-
Field Summary
Fields Modifier and Type Field Description protected IWhitespaceDetector
fDetector
The whitespace detector used by this ruleprotected IToken
fWhitespaceToken
The token returned for whitespace.
-
Constructor Summary
Constructors Constructor Description WhitespaceRule(IWhitespaceDetector detector)
Creates a rule which, with the help of an whitespace detector, will returnToken.WHITESPACE
when a whitespace is detected.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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IToken
evaluate(ICharacterScanner scanner)
Evaluates the rule by examining the characters available from the provided character scanner.
-
-
-
Field Detail
-
fDetector
protected IWhitespaceDetector fDetector
The whitespace detector used by this rule
-
fWhitespaceToken
protected final IToken fWhitespaceToken
The token returned for whitespace.- Since:
- 3.5
-
-
Constructor Detail
-
WhitespaceRule
public WhitespaceRule(IWhitespaceDetector detector)
Creates a rule which, with the help of an whitespace detector, will returnToken.WHITESPACE
when a whitespace is detected.- Parameters:
detector
- the rule's whitespace detector
-
WhitespaceRule
public 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.- Parameters:
detector
- the rule's whitespace detectortoken
- the token returned for whitespace- Since:
- 3.5
-
-
Method Detail
-
evaluate
public IToken evaluate(ICharacterScanner scanner)
Evaluates the rule by examining the characters available from the provided character scanner. The token returned by this rule returnstrue
when callingisUndefined
, if the text that the rule investigated does not match the rule's requirements- Specified by:
evaluate
in interfaceIRule
- Parameters:
scanner
- the character scanner to be used by this rule- Returns:
fWhitespaceToken
if whitespace got detected,Token.UNDEFINED
otherwise
-
-