Class WhitespaceRule

  • All Implemented Interfaces:
    IRule

    public class WhitespaceRule
    extends Object
    implements IRule
    An implementation of IRule capable of detecting whitespace. A whitespace rule uses a whitespace detector in order to find out which characters are whitespace characters.
    See Also:
    IWhitespaceDetector
    • Field Detail

      • fWhitespaceToken

        protected final IToken fWhitespaceToken
        The token returned for whitespace.
        Since:
        3.5
    • Constructor Detail

      • WhitespaceRule

        public WhitespaceRule​(IWhitespaceDetector detector)
        Creates a rule which, with the help of an whitespace detector, will return Token.WHITESPACE when a whitespace is detected.
        Parameters:
        detector - the rule's whitespace detector
      • WhitespaceRule

        public WhitespaceRule​(IWhitespaceDetector detector,
                              IToken token)
        Creates a rule which, with the help of an whitespace detector, will return the given whitespace token when a whitespace is detected.
        Parameters:
        detector - the rule's whitespace detector
        token - the token returned for whitespace
        Since:
        3.5
    • 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 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:
        fWhitespaceToken if whitespace got detected, Token.UNDEFINED otherwise