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

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

All Implemented Interfaces:

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

public class FirstVariableRule
extends java.lang.Object
implements ISequenceRule

A rule to detect the first variable of a block.

Constructor Summary

FirstVariableRule(java.lang.String[] previousWords, 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.
protected boolean	validatePreviousWords(org.eclipse.jface.text.rules.ICharacterScanner scanner) Indicates if the previous words are valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

FirstVariableRule

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

Constructor.

Parameters:

previousWords - are the words used before the first variable, '*' can be used to match an unknown java word

token - is the token to use for this rule

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)

validatePreviousWords

protected boolean validatePreviousWords(org.eclipse.jface.text.rules.ICharacterScanner scanner)

Indicates if the previous words are valid.

Parameters:

scanner - is the scanner

Returns:

true if the previous words are valid

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)