org.eclipse.jface.text.rules
Class SingleLineRule

java.lang.Object
  |
  +--org.eclipse.jface.text.rules.PatternRule
        |
        +--org.eclipse.jface.text.rules.SingleLineRule

All Implemented Interfaces:

IPredicateRule, IRule

Direct Known Subclasses:

EndOfLineRule, WordPatternRule

public class SingleLineRule

extends PatternRule

A specific configuration of pattern rule whereby the pattern begins with a specific sequence and may end with a specific sequence, but will not span more than a single line.

Field Summary

Fields inherited from class org.eclipse.jface.text.rules.PatternRule

fBreaksOnEOF, fBreaksOnEOL, fColumn, fEndSequence, fEscapeCharacter, fStartSequence, fToken, UNDEFINED

Constructor Summary

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.

Methods inherited from class org.eclipse.jface.text.rules.PatternRule

doEvaluate, doEvaluate, endSequenceDetected, evaluate, evaluate, getSuccessToken, sequenceDetected, setColumnConstraint

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SingleLineRule

public 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.

Parameters:

startSequence - the pattern's start sequence

token - the token to be returned on success

SingleLineRule

public 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. Any character which follows the given escape character will be ignored.

Parameters:

startSequence - the pattern's start sequence

endSequence - the pattern's end sequence

token - the token to be returned on success

escapeCharacter - the escape character

SingleLineRule

public 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. Alternatively, the line can also be ended with the end of the file. Any character which follows the given escape character will be ignored.

Parameters:

startSequence - the pattern's start sequence

endSequence - the pattern's end sequence

token - the token to be returned on success

escapeCharacter - the escape character

breaksOnEOF - indicates whether the end of the file successfully terminates this rule

Since:

2.1