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:

Serializable

public class TokenMgrError
extends Error

See Also:

Serialized Form

Constructor Summary

TokenMgrError()

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

TokenMgrError(String message, int reason)

Method Summary

protected static String	addEscapes(String str) Replaces unprintable characters by their espaced (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

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, 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()

TokenMgrError

public TokenMgrError(String message,
                     int reason)

TokenMgrError

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

Method Detail

addEscapes

protected static final String addEscapes(String str)

Replaces unprintable characters by their espaced (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 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 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