freemarker.core

Class ParseException

Implemented Interfaces:
freemarker.core.FMParserConstants
Known Direct Subclasses:
Template.WrongEncodingException

public class ParseException
extends java.io.IOException
implements freemarker.core.FMParserConstants

This exception is thrown when parse errors are encountered. You can explicitly create objects of this exception type by calling the method generateParseException in the generated parser. You can modify this class to customize your error reporting mechanisms so long as you retain the public fields.

Field Summary

int
columnNumber
freemarker.core.Token
currentToken
This is the last token that has been consumed successfully.
protected String
eol
The end of line string for this machine.
int[][]
expectedTokenSequences
Each entry in this array is an array of integers.
int
lineNumber
protected boolean
specialConstructor
This variable determines which constructor was used to create this object and thereby affects the semantics of the "getMessage" method (see below).
String[]
tokenImage
This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred.

Fields inherited from interface freemarker.core.FMParserConstants

AND, AS, ASSIGN, ATTEMPT, BLANK, BREAK, BUILT_IN, CALL, CASE, CLOSE_BRACE, CLOSE_BRACKET, CLOSE_PAREN, CLOSE_TAG1, CLOSE_TAG2, COLON, COMMA, COMMENT, COMPRESS, DECIMAL, DEFAUL, DEFAULT, DIGIT, DIRECTIVE_END, DIVIDE, DOT, DOT_DOT, DOUBLE_EQUALS, DOUBLE_STAR, ELLIPSIS, ELSE, ELSE_IF, EMPTY_DIRECTIVE_END, END_ASSIGN, END_ATTEMPT, END_COMPRESS, END_ESCAPE, END_FOREACH, END_FUNCTION, END_GLOBAL, END_IF, END_LIST, END_LOCAL, END_MACRO, END_NOESCAPE, END_RECOVER, END_SWITCH, END_TAG, END_TRANSFORM, EOF, EQUALS, ESCAPE, ESCAPED_CHAR, ESCAPED_GT, ESCAPED_GTE, EXCLAM, EXISTS, EXPRESSION_COMMENT, FALLBACK, FALSE, FALSE_ALERT, FLUSH, FM_EXPRESSION, FOREACH, FTL_HEADER, FUNCTION, GLOBALASSIGN, HALT, ID, IF, IMPORT, IN, INCLUDE, INTEGER, IN_PAREN, KEEP_GOING, LESS_THAN, LESS_THAN_EQUALS, LETTER, LIST, LOCALASSIGN, LONE_LESS_THAN_OR_DASH, LTRIM, MACRO, MAYBE_END, MINUS, NAMED_PARAMETER_EXPRESSION, NATURAL_GT, NATURAL_GTE, NESTED, NODIRECTIVE, NOESCAPE, NOPARSE, NOTRIM, NOT_EQUALS, NO_PARSE, NO_SPACE_EXPRESSION, NUMERICAL_ESCAPE, OPEN_BRACE, OPEN_BRACKET, OPEN_PAREN, OR, OUTPUT_ESCAPE, PERCENT, PLUS, PRINTABLE_CHARS, RAW_STRING, RECOVER, RECURSE, RETURN, RTRIM, SEMICOLON, SETTING, SIMPLE_NESTED, SIMPLE_RECURSE, SIMPLE_RETURN, START_TAG, STOP, STRING_LITERAL, SWITCH, TERMINATING_EXCLAM, TERMINATING_WHITESPACE, TERSE_COMMENT, TERSE_COMMENT_END, TIMES, TRANSFORM, TRIM, TRIVIAL_FTL_HEADER, TRUE, UNIFIED_CALL, UNIFIED_CALL_END, UNKNOWN_DIRECTIVE, USING, VISIT, WHITESPACE, tokenImage

Constructor Summary

ParseException()
The following constructors are for use by you for whatever purpose you can think of.
ParseException(String message, TemplateObject tobj)
ParseException(String message, int lineNumber, int columnNumber)
ParseException(freemarker.core.Token currentTokenVal, int[][] expectedTokenSequencesVal, String[] tokenImageVal)
This constructor is used by the method "generateParseException" in the generated parser.

Method Summary

protected String
add_escapes(String str)
Used to convert raw characters to their escaped version when these raw version cannot be used as part of an ASCII string literal.
int
getColumnNumber()
int
getLineNumber()
String
getMessage()
This method has the standard behavior when this object has been created using the standard constructors.
void
setTemplateName(String templateName)

Field Details

columnNumber

public int columnNumber

currentToken

public freemarker.core.Token currentToken
This is the last token that has been consumed successfully. If this object has been created due to a parse error, the token following this token will (therefore) be the first error token.

eol

protected String eol
The end of line string for this machine.

expectedTokenSequences

public int[][] expectedTokenSequences
Each entry in this array is an array of integers. Each array of integers represents a sequence of tokens (by their ordinal values) that is expected at this point of the parse.

lineNumber

public int lineNumber

specialConstructor

protected boolean specialConstructor
This variable determines which constructor was used to create this object and thereby affects the semantics of the "getMessage" method (see below).

tokenImage

public String[] tokenImage
This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred. This array is defined in the generated ...Constants interface.

Constructor Details

ParseException

protected ParseException()
The following constructors are for use by you for whatever purpose you can think of. Constructing the exception in this manner makes the exception behave in the normal way - i.e., as documented in the class "Throwable". The fields "errorToken", "expectedTokenSequences", and "tokenImage" do not contain relevant information. The JavaCC generated code does not use these constructors.

ParseException

public ParseException(String message,
                      TemplateObject tobj)

ParseException

public ParseException(String message,
                      int lineNumber,
                      int columnNumber)

ParseException

public ParseException(freemarker.core.Token currentTokenVal,
                      int[][] expectedTokenSequencesVal,
                      String[] tokenImageVal)
This constructor is used by the method "generateParseException" in the generated parser. Calling this constructor generates a new object of this type with the fields "currentToken", "expectedTokenSequences", and "tokenImage" set. The boolean flag "specialConstructor" is also set to true to indicate that this constructor was used to create this object. This constructor calls its super class with the empty string to force the "toString" method of parent class "Throwable" to print the error message in the form: ParseException:

Method Details

add_escapes

protected String add_escapes(String str)
Used to convert raw characters to their escaped version when these raw version cannot be used as part of an ASCII string literal.

getColumnNumber

public int getColumnNumber()

getLineNumber

public int getLineNumber()

getMessage

public String getMessage()
This method has the standard behavior when this object has been created using the standard constructors. Otherwise, it uses "currentToken" and "expectedTokenSequences" to generate a parse error message and returns it. If this object has been created due to a parse error, and you do not catch it (it gets thrown from the parser), then this method is called during the printing of the final stack trace, and hence the correct error message gets displayed.

setTemplateName

public void setTemplateName(String templateName)