org.apache.velocity.runtime.parser
Class TokenMgrError

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Error
              |
              +--org.apache.velocity.runtime.parser.TokenMgrError

All Implemented Interfaces:

java.io.Serializable

public class TokenMgrError

extends java.lang.Error

See Also:

Serialized Form

Field Summary

(package private) int	errorCode Indicates the reason why the exception is thrown.
(package private) static int	INVALID_LEXICAL_STATE Tried to change to an invalid lexical state.
(package private) static int	LEXICAL_ERROR Lexical error occured.
(package private) static int	LOOP_DETECTED Detected (and bailed out of) an infinite loop in the token manager.
(package private) static int	STATIC_LEXER_ERROR An attempt wass made to create a second instance of a static token manager.

Fields inherited from class java.lang.Throwable

backtrace, detailMessage, serialVersionUID

Constructor Summary

TokenMgrError()

TokenMgrError(boolean EOFSeen, int lexState, int errorLine, int errorColumn, java.lang.String errorAfter, char curChar, int reason)

TokenMgrError(java.lang.String message, int reason)

Method Summary

protected static java.lang.String	addEscapes(java.lang.String str) Replaces unprintable characters by their espaced (or unicode escaped) equivalents in the given string
java.lang.String	getMessage() You can also modify the body of this method to customize your error messages.
private static java.lang.String	LexicalError(boolean EOFSeen, int lexState, int errorLine, int errorColumn, java.lang.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

fillInStackTrace, getLocalizedMessage, printStackTrace, printStackTrace, printStackTrace, printStackTrace0, toString

Methods inherited from class java.lang.Object

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

Field Detail

LEXICAL_ERROR

static final int LEXICAL_ERROR

Lexical error occured.

STATIC_LEXER_ERROR

static final int STATIC_LEXER_ERROR

An attempt wass made to create a second instance of a static token manager.

INVALID_LEXICAL_STATE

static final int INVALID_LEXICAL_STATE

Tried to change to an invalid lexical state.

LOOP_DETECTED

static final int LOOP_DETECTED

Detected (and bailed out of) an infinite loop in the token manager.

errorCode

int errorCode

Indicates the reason why the exception is thrown. It will have one of the above 4 values.

Constructor Detail

TokenMgrError

public TokenMgrError()

TokenMgrError

public TokenMgrError(java.lang.String message,
                     int reason)

TokenMgrError

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

Method Detail

addEscapes

protected static final java.lang.String addEscapes(java.lang.String str)

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

LexicalError

private static final java.lang.String LexicalError(boolean EOFSeen,
                                                   int lexState,
                                                   int errorLine,
                                                   int errorColumn,
                                                   java.lang.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 lexicl error curLexState : lexical state in which this error occured errorLine : line number when the error occured errorColumn : column number when the error occured errorAfter : prefix that was seen before this error occured curchar : the offending character Note: You can customize the lexical error message by modifying this method.

getMessage

public java.lang.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 java.lang.Throwable