Class SingleLineRule

  • All Implemented Interfaces:
    IPredicateRule, IRule
    Direct Known Subclasses:
    EndOfLineRule, WordPatternRule

    public class SingleLineRule
    extends PatternRule
    A specific configuration of pattern rule whereby the pattern begins with a specific sequence and may end with a specific sequence, but will not span more than a single line.
    • Constructor Detail

      • SingleLineRule

        public SingleLineRule​(String startSequence,
                              String endSequence,
                              IToken token)
        Creates a rule for the given starting and ending sequence which, if detected, will return the specified token.
        Parameters:
        startSequence - the pattern's start sequence
        endSequence - the pattern's end sequence
        token - the token to be returned on success
      • SingleLineRule

        public SingleLineRule​(String startSequence,
                              String endSequence,
                              IToken token,
                              char escapeCharacter)
        Creates a rule for the given starting and ending sequence which, if detected, will return the specified token. Any character which follows the given escape character will be ignored.
        Parameters:
        startSequence - the pattern's start sequence
        endSequence - the pattern's end sequence
        token - the token to be returned on success
        escapeCharacter - the escape character
      • SingleLineRule

        public SingleLineRule​(String startSequence,
                              String endSequence,
                              IToken token,
                              char escapeCharacter,
                              boolean breaksOnEOF)
        Creates a rule for the given starting and ending sequence which, if detected, will return the specified token. Alternatively, the line can also be ended with the end of the file. Any character which follows the given escape character will be ignored.
        Parameters:
        startSequence - the pattern's start sequence
        endSequence - the pattern's end sequence
        token - the token to be returned on success
        escapeCharacter - the escape character
        breaksOnEOF - indicates whether the end of the file successfully terminates this rule
        Since:
        2.1
      • SingleLineRule

        public SingleLineRule​(String startSequence,
                              String endSequence,
                              IToken token,
                              char escapeCharacter,
                              boolean breaksOnEOF,
                              boolean escapeContinuesLine)
        Creates a rule for the given starting and ending sequence which, if detected, will return the specified token. Alternatively, the line can also be ended with the end of the file. Any character which follows the given escape character will be ignored. In addition, an escape character immediately before an end of line can be set to continue the line.
        Parameters:
        startSequence - the pattern's start sequence
        endSequence - the pattern's end sequence
        token - the token to be returned on success
        escapeCharacter - the escape character
        breaksOnEOF - indicates whether the end of the file successfully terminates this rule
        escapeContinuesLine - indicates whether the specified escape character is used for line continuation, so that an end of line immediately after the escape character does not terminate the line, even if breakOnEOL is true
        Since:
        3.0