com.singularsys.jep.configurableparser.matchers

## Interface TokenMatcher

- All Superinterfaces:
    java.io.Serializable
  All Known Subinterfaces:
    TokenBuilder
  All Known Implementing Classes:
    CommentTokenMatcher, HexNumberTokenMatcher, IdentifierTokenMatcher, MultiLineMatcher, MultiLineToken, NumberTokenMatcher, OperatorTokenMatcher, RegExpTokenMatcher, StringTokenMatcher, StringTokenMatcher2, SymbolTokenMatcher, TerminatorTokenMatcher, UpperCaseOperatorTokenMatcher, WhiteSpaceTokenMatcher

      public interface TokenMatcher
      extends java.io.Serializable

  Interface defining classes which match tokens
  Author:
    Richard Morris
  See Also:
    `Token`

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `init(Jep jep)` Initialize the matcher when the Jep instance is known.
    `Token` | `match(java.lang.String s)` Attempts to match the start of the string.

- - ### Method Detail

    - #### match

          Token match(java.lang.String s)
               throws ParseException

      Attempts to match the start of the string. Note new objects should be created each time as error reporting information is later attached to tokens.
      Parameters:
        `s` - the string to match against
      Returns:
        if successful returns the corresponding token, return null if failed to match
      Throws:
        `ParseException` - on syntax error

    - #### init

          void init(Jep jep)

      Initialize the matcher when the Jep instance is known.
      Parameters:
        `jep` - Jep instance

Copyright © 2018 Singular Systems http://www.singularsys.com/jep