org.povclipse2.editors.rules

Class ConfigurableWordRule

java.lang.Object

WordRule

org.povclipse2.editors.rules.ConfigurableWordRule

public class ConfigurableWordRule
extends WordRule

This class extends WordRule in order to change the list of known words.

Author:

Wolfgang Möstl

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	clearWords() Clears the lsit of known words.
void	removeWord(java.lang.String word) Removs the given word from the known list.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurableWordRule

public ConfigurableWordRule(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:

#addWord(String, IToken)

ConfigurableWordRule

public ConfigurableWordRule(IWordDetector detector,
                            IToken defaultToken)

Creates a rule which, with the help of a 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:

#addWord(String, IToken)

Method Detail

clearWords

public void clearWords()

Clears the lsit of known words.

removeWord

public void removeWord(java.lang.String word)

Removs the given word from the known list.

Parameters:

word - The word to be removed.