org.apache.lucene.queryparser.classic

## Class TokenMgrError

- java.lang.Object
- - java.lang.Throwable
  - - java.lang.Error
    - - org.apache.lucene.queryparser.classic.TokenMgrError

- All Implemented Interfaces:
    Serializable

      public class TokenMgrError
      extends Error

  Token Manager Error.
  See Also:
    Serialized Form

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `TokenMgrError()` No arg constructor.
    `TokenMgrError(boolean EOFSeen, int lexState, int errorLine, int errorColumn, String errorAfter, char curChar, int reason)` Full Constructor.
    `TokenMgrError(String message, int reason)` Constructor with message and reason.

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected static String` | `addEscapes(String str)` Replaces unprintable characters by their escaped (or unicode escaped) equivalents in the given string
    `String` | `getMessage()` You can also modify the body of this method to customize your error messages.
    `protected static String` | `LexicalError(boolean EOFSeen, int lexState, int errorLine, int errorColumn, String errorAfter, char curChar)` Returns a detailed message for the Error when it is thrown by the token manager to indicate a lexical error.

    - ### Methods inherited from class java.lang.Throwable

      `addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### TokenMgrError

          public TokenMgrError()

      No arg constructor.

    - #### TokenMgrError

          public TokenMgrError(String message,
                               int reason)

      Constructor with message and reason.

    - #### TokenMgrError

          public TokenMgrError(boolean EOFSeen,
                               int lexState,
                               int errorLine,
                               int errorColumn,
                               String errorAfter,
                               char curChar,
                               int reason)

      Full Constructor.

  - ### Method Detail

    - #### addEscapes

          protected static final String addEscapes(String str)

      Replaces unprintable characters by their escaped (or unicode escaped) equivalents in the given string

    - #### LexicalError

          protected static String LexicalError(boolean EOFSeen,
                                               int lexState,
                                               int errorLine,
                                               int errorColumn,
                                               String errorAfter,
                                               char curChar)

      Returns a detailed message for the Error when it is thrown by the token manager to indicate a lexical error. Parameters : EOFSeen : indicates if EOF caused the lexical error curLexState : lexical state in which this error occurred errorLine : line number when the error occurred errorColumn : column number when the error occurred errorAfter : prefix that was seen before this error occurred curchar : the offending character Note: You can customize the lexical error message by modifying this method.

    - #### getMessage

          public String getMessage()

      You can also modify the body of this method to customize your error messages. For example, cases like LOOP_DETECTED and INVALID_LEXICAL_STATE are not of end-users concern, so you can return something like : "Internal Error : Please file a bug report .... " from this method for such cases in the release version of your parser.
      Overrides:
        `getMessage` in class `Throwable`

Copyright © 2000-2019 Apache Software Foundation. All Rights Reserved.