org.eclipse.jface.text.rules

Class CombinedWordRule

java.lang.Object

org.eclipse.jface.text.rules.CombinedWordRule

All Implemented Interfaces:

IRule

public class CombinedWordRule
extends java.lang.Object
implements IRule

An implementation of IRule capable of detecting words.

Word rules also allow for the association of tokens with specific words. That is, not only can the rule be used to provide tokens for exact matches, but also for the generalized notion of a word in the context in which it is used. A word rules uses a word detector to determine what a word is.

This word rule allows a word detector to be shared among different word matchers. Its up to the word matchers to decide if a word matches and, in this a case, which token is associated with that word.

Since:

3.0

See Also:

IWordDetector

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CombinedWordRule.CharacterBuffer Character buffer, mutable or suitable for use as key in hash maps.
static class	CombinedWordRule.WordMatcher Word matcher, that associates matched words with tokens.

Constructor Summary

Constructors

Constructor and Description
CombinedWordRule(IWordDetector detector) Creates a rule which, with the help of an word detector, will return the token associated with the detected word.
CombinedWordRule(IWordDetector detector, CombinedWordRule.WordMatcher matcher) Creates a rule which, with the help of an word detector, will return the token associated with the detected word.
CombinedWordRule(IWordDetector detector, CombinedWordRule.WordMatcher matcher, IToken defaultToken) Creates a rule which, with the help of an word detector, will return the token associated with the detected word.
CombinedWordRule(IWordDetector detector, IToken defaultToken) Creates a rule which, with the help of an word detector, will return the token associated with the detected word.

Method Summary

Modifier and Type	Method and Description
void	addWordMatcher(CombinedWordRule.WordMatcher matcher) Adds the given matcher.
IToken	evaluate(ICharacterScanner scanner) Evaluates the rule by examining the characters available from the provided character scanner.
void	setColumnConstraint(int column) Sets a column constraint for this rule.

Methods inherited from class java.lang.Object

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

Constructor Detail

CombinedWordRule

public CombinedWordRule(IWordDetector detector)

Creates a rule which, with the help of an word detector, will return the token associated with the detected word. If no token has been associated, the scanner will be rolled back and an undefined token will be returned in order to allow any subsequent rules to analyze the characters.

Parameters:

detector - the word detector to be used by this rule, may not be null

See Also:

CombinedWordRule.WordMatcher.addWord(String, IToken)

CombinedWordRule

public CombinedWordRule(IWordDetector detector,
                        IToken defaultToken)

Creates a rule which, with the help of an word detector, will return the token associated with the detected word. If no token has been associated, the specified default token will be returned.

Parameters:

detector - the word detector to be used by this rule, may not be null

defaultToken - the default token to be returned on success if nothing else is specified, may not be null

See Also:

CombinedWordRule.WordMatcher.addWord(String, IToken)

CombinedWordRule

public CombinedWordRule(IWordDetector detector,
                        CombinedWordRule.WordMatcher matcher)

Creates a rule which, with the help of an word detector, will return the token associated with the detected word. If no token has been associated, the scanner will be rolled back and an undefined token will be returned in order to allow any subsequent rules to analyze the characters.

Parameters:

detector - the word detector to be used by this rule, may not be null

matcher - the initial word matcher

See Also:

CombinedWordRule.WordMatcher.addWord(String, IToken)

CombinedWordRule

public CombinedWordRule(IWordDetector detector,
                        CombinedWordRule.WordMatcher matcher,
                        IToken defaultToken)

Creates a rule which, with the help of an word detector, will return the token associated with the detected word. If no token has been associated, the specified default token will be returned.

Parameters:

detector - the word detector to be used by this rule, may not be null

matcher - the initial word matcher

defaultToken - the default token to be returned on success if nothing else is specified, may not be null

See Also:

CombinedWordRule.WordMatcher.addWord(String, IToken)

Method Detail

addWordMatcher

public void addWordMatcher(CombinedWordRule.WordMatcher matcher)

Adds the given matcher.

Parameters:

matcher - the matcher

setColumnConstraint

public void setColumnConstraint(int column)

Sets a column constraint for this rule. If set, the rule's token will only be returned if the pattern is detected starting at the specified column. If the column is smaller then 0, the column constraint is considered removed.

Parameters:

column - the column in which the pattern starts

evaluate

public IToken evaluate(ICharacterScanner scanner)

Description copied from interface: IRule

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 that the rule investigated does not match the rule's requirements

Specified by:

evaluate in interface IRule

Parameters:

scanner - the character scanner to be used by this rule

Returns:

the token computed by the rule