org.eclipse.mtl.ide.ui.editors.template.rules
Interface ISequenceRule

All Superinterfaces:

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

All Known Implementing Classes:

FirstVariableRule, KeywordRule, SequenceBlockRule, SequenceRule

public interface ISequenceRule
extends org.eclipse.jface.text.rules.IPredicateRule

Defines the interface for a rule used in the scanning of a MTL file (document partitioning and text styling).

Method Summary

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 interface org.eclipse.jface.text.rules.IPredicateRule

evaluate, getSuccessToken

Methods inherited from interface org.eclipse.jface.text.rules.IRule

evaluate

Method Detail

read

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

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

Parameters:

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

Returns:

the number of examined characters