org.eclipse.jface.text.rules
Interface IRule

All Known Subinterfaces:

IPredicateRule

All Known Implementing Classes:

NumberRule, PatternRule, WhitespaceRule, WordRule

public interface IRule

Defines the interface for a rule used in the scanning of text for the purpose of document partitioning or text styling.

See Also:

ICharacterScanner

Method Summary

IToken

evaluate(ICharacterScanner scanner) Evaluates the rule by examining the characters available from the provided character scanner.

Method Detail

evaluate

public IToken evaluate(ICharacterScanner scanner)

Evaluates the rule by examining the characters available from the provided character scanner. The token returned by this rule returns true when calling isUndefined, if the text the rule investigated does not match the rule's requirements.

Parameters:

scanner - the character scanner to be used by this rule

Returns:

the token computed by the rule