Class EndOfLineRule

  • All Implemented Interfaces:
    IPredicateRule, IRule

    public class EndOfLineRule
    extends SingleLineRule
    A specific configuration of a single line rule whereby the pattern begins with a specific sequence but is only ended by a line delimiter.
    • Constructor Detail

      • EndOfLineRule

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

        public EndOfLineRule​(String startSequence,
                             IToken token,
                             char escapeCharacter)
        Creates a rule for the given starting 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
        token - the token to be returned on success
        escapeCharacter - the escape character
      • EndOfLineRule

        public EndOfLineRule​(String startSequence,
                             IToken token,
                             char escapeCharacter,
                             boolean escapeContinuesLine)
        Creates a rule for the given starting sequence which, if detected, will return the specified token. 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
        token - the token to be returned on success
        escapeCharacter - the escape character
        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