org.eclipse.jface.text.rules
Class NumberRule

java.lang.Object
  |
  +--org.eclipse.jface.text.rules.NumberRule

All Implemented Interfaces:

IRule

public class NumberRule

extends Object

implements IRule

An implementation of IRule capable of detecting a numerical value.

Field Summary

protected int	fColumn
protected IToken	fToken
protected static int	UNDEFINED

Constructor Summary

NumberRule(IToken token)
Creates a rule which will return the specified token when a numerical sequence is detected.

Method Summary

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

Field Detail

UNDEFINED

protected static final int UNDEFINED

See Also:

Constant Field Values

fToken

protected IToken fToken

fColumn

protected int fColumn

Constructor Detail

NumberRule

public NumberRule(IToken token)

Creates a rule which will return the specified token when a numerical sequence is detected.

Parameters:

token - the token to be returned

Method Detail

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 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