Package org.eclipse.jface.text.rules
Class EndOfLineRule
- java.lang.Object
-
- org.eclipse.jface.text.rules.PatternRule
-
- org.eclipse.jface.text.rules.SingleLineRule
-
- org.eclipse.jface.text.rules.EndOfLineRule
-
- All Implemented Interfaces:
IPredicateRule
,IRule
public class EndOfLineRule extends SingleLineRule
A specific configuration of a single line rule whereby the pattern begins with a specific sequence but is only ended by a line delimiter.
-
-
Field Summary
-
Fields inherited from class org.eclipse.jface.text.rules.PatternRule
fBreaksOnEOF, fBreaksOnEOL, fColumn, fEndSequence, fEscapeCharacter, fEscapeContinuesLine, fStartSequence, fToken, UNDEFINED
-
-
Constructor Summary
Constructors 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.
-
Method Summary
-
Methods inherited from class org.eclipse.jface.text.rules.PatternRule
doEvaluate, doEvaluate, endSequenceDetected, evaluate, evaluate, getSuccessToken, sequenceDetected, setColumnConstraint
-
-
-
-
Constructor Detail
-
EndOfLineRule
public EndOfLineRule(String startSequence, IToken token)
Creates a rule for the given starting sequence which, if detected, will return the specified token.- Parameters:
startSequence
- the pattern's start sequencetoken
- the token to be returned on success
-
EndOfLineRule
public EndOfLineRule(String startSequence, IToken token, char escapeCharacter)
Creates a rule for the given starting sequence which, if detected, will return the specified token. Any character which follows the given escape character will be ignored.- Parameters:
startSequence
- the pattern's start sequencetoken
- the token to be returned on successescapeCharacter
- the escape character
-
EndOfLineRule
public 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. Any character which follows the given escape character will be ignored. In addition, an escape character immediately before an end of line can be set to continue the line.- Parameters:
startSequence
- the pattern's start sequencetoken
- the token to be returned on successescapeCharacter
- the escape characterescapeContinuesLine
- indicates whether the specified escape character is used for line continuation, so that an end of line immediately after the escape character does not terminate the line, even ifbreakOnEOL
is true- Since:
- 3.0
-
-