Class MultiLineRule

  • All Implemented Interfaces:
    IPredicateRule, IRule

    public class MultiLineRule
    extends PatternRule
    A rule for detecting patterns which begin with a given sequence and may end with a given sequence thereby spanning multiple lines.
    • Constructor Detail

      • MultiLineRule

        public MultiLineRule​(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
      • MultiLineRule

        public MultiLineRule​(String startSequence,
                             String endSequence,
                             IToken token,
                             char escapeCharacter)
        Creates a rule for the given starting and ending sequence which, if detected, will return the specific 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
      • MultiLineRule

        public MultiLineRule​(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 specific token. Any character that follows the given escape character will be ignored. breakOnEOF indicates whether EOF is equivalent to detecting the endSequence.
        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 terminates this rule successfully
        Since:
        2.1