org.eclipse.mtl.ide.ui.editors.template.rules
Class SequenceRule

java.lang.Object
  org.eclipse.mtl.ide.ui.editors.template.rules.SequenceRule

All Implemented Interfaces:

org.eclipse.jface.text.rules.IPredicateRule, org.eclipse.jface.text.rules.IRule, ISequenceRule

public class SequenceRule
extends java.lang.Object
implements ISequenceRule

Creates a rule for the given starting and ending sequence which, if detected, will return the specified token. It can also return the specified token if the rule breaks on the end of the line, or if the EOF character is read.

Field Summary

protected org.eclipse.jface.text.rules.IToken	token The token to be returned on success.
protected java.lang.String[]	words The words of the sequence.

Constructor Summary

SequenceRule(java.lang.String[] words)
Constructor.

SequenceRule(java.lang.String[] words, org.eclipse.jface.text.rules.IToken token)
Constructor.

Method Summary

org.eclipse.jface.text.rules.IToken	evaluate(org.eclipse.jface.text.rules.ICharacterScanner scanner)
org.eclipse.jface.text.rules.IToken	evaluate(org.eclipse.jface.text.rules.ICharacterScanner scanner, boolean resume)
org.eclipse.jface.text.rules.IToken	getSuccessToken()
int	read(org.eclipse.jface.text.rules.ICharacterScanner scanner) Evaluates the rule by examining the characters available from the provided character scanner.

Methods inherited from class java.lang.Object

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

Field Detail

words

protected java.lang.String[] words

The words of the sequence.

token

protected org.eclipse.jface.text.rules.IToken token

The token to be returned on success.

Constructor Detail

SequenceRule

public SequenceRule(java.lang.String[] words)

Constructor. A default token will be created.

new Token(IDocument.DEFAULT_CONTENT_TYPE)

Parameters:

words - are the words of the sequence

SequenceRule

public SequenceRule(java.lang.String[] words,
                    org.eclipse.jface.text.rules.IToken token)

Constructor.

Parameters:

words - are the words of the sequence

token - is the token to create

Method Detail

getSuccessToken

public org.eclipse.jface.text.rules.IToken getSuccessToken()

Specified by:

getSuccessToken in interface org.eclipse.jface.text.rules.IPredicateRule

See Also:

IPredicateRule.getSuccessToken()

evaluate

public org.eclipse.jface.text.rules.IToken evaluate(org.eclipse.jface.text.rules.ICharacterScanner scanner)

Specified by:

evaluate in interface org.eclipse.jface.text.rules.IRule

See Also:

IRule.evaluate(org.eclipse.jface.text.rules.ICharacterScanner)

read

public int read(org.eclipse.jface.text.rules.ICharacterScanner scanner)

Evaluates the rule by examining the characters available from the provided character scanner.

Specified by:

read in interface ISequenceRule

Parameters:

scanner - is the character scanner to be used by this rule

Returns:

the number of examined characters

See Also:

ISequenceRule.read(org.eclipse.jface.text.rules.ICharacterScanner)

evaluate

public org.eclipse.jface.text.rules.IToken evaluate(org.eclipse.jface.text.rules.ICharacterScanner scanner,
                                                    boolean resume)

Specified by:

evaluate in interface org.eclipse.jface.text.rules.IPredicateRule

See Also:

IPredicateRule.evaluate(org.eclipse.jface.text.rules.ICharacterScanner, boolean)