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

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

Constructor Summary

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.

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

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 sequence

token - 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 sequence

token - the token to be returned on success

escapeCharacter - the escape character