Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.jface.text.rules
Class EndOfLineRule

java.lang.Object
  extended by 

org.eclipse.jface.text.rules.PatternRule
      extended by 

org.eclipse.jface.text.rules.SingleLineRule
          extended by 
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
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
 
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

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 sequence
token - the token to be returned on success
escapeCharacter - the escape character
escapeContinuesLine - 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 if breakOnEOL is true
Since:
3.0

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire