freemarker.core

Class ParseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

freemarker.core.ParseException

All Implemented Interfaces:

FMParserConstants, Serializable

Direct Known Subclasses:

Template.WrongEncodingException

public class ParseException
extends IOException
implements FMParserConstants

Parsing-time exception in a template (as opposed to a runtime exception, a TemplateException). This usually signals syntactical/lexical errors. Note that on JavaCC-level lexical errors throw TokenMgrError instead of this, however with the API-s that most users use those will be wrapped into ParseException-s. This is a modified version of file generated by JavaCC from FTL.jj. You can modify this class to customize the error reporting mechanisms so long as the public interface remains compatible with the original.

See Also:

TokenMgrError, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	columnNumber
Token	currentToken This is the last token that has been consumed successfully.
int	endColumnNumber
int	endLineNumber
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 Deprecated. Will be remove without replacement in 2.4.
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

_INCLUDE, AND, AS, ASCII_DIGIT, ASSIGN, ATTEMPT, BLANK, BREAK, BUILT_IN, CALL, CASE, CLOSE_BRACKET, CLOSE_PAREN, CLOSE_TAG1, CLOSE_TAG2, CLOSING_CURLY_BRACKET, COLON, COMMA, COMMENT, COMPRESS, DECIMAL, DEFAUL, DEFAULT, DIRECTIVE_END, DIV_EQUALS, DIVIDE, DOLLAR_INTERPOLATION_OPENING, DOT, DOT_DOT, DOT_DOT_ASTERISK, DOT_DOT_LESS, 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_ITEMS, END_LIST, END_LOCAL, END_MACRO, END_NOESCAPE, END_RECOVER, END_SEP, END_SWITCH, END_TAG, END_TRANSFORM, EOF, EQUALS, ESCAPE, ESCAPED_CHAR, ESCAPED_GT, ESCAPED_GTE, ESCAPED_ID_CHAR, EXCLAM, EXISTS, EXPRESSION_COMMENT, FALLBACK, FALSE, FLUSH, FM_EXPRESSION, FOREACH, FTL_HEADER, FUNCTION, GLOBALASSIGN, HALT, HASH_INTERPOLATION_OPENING, ID, ID_START_CHAR, IF, IMPORT, IN, IN_PAREN, INTEGER, ITEMS, KEEP_GOING, LESS_THAN, LESS_THAN_EQUALS, LIST, LOCALASSIGN, LONE_LESS_THAN_OR_DASH, LTRIM, MACRO, MAYBE_END, MINUS, MINUS_EQUALS, MINUS_MINUS, MOD_EQUALS, NAMED_PARAMETER_EXPRESSION, NATURAL_GT, NATURAL_GTE, NESTED, NO_PARSE, NO_SPACE_EXPRESSION, NODIRECTIVE, NOESCAPE, NON_ESCAPED_ID_START_CHAR, NOPARSE, NOT_EQUALS, NOTRIM, OPEN_BRACKET, OPEN_MISPLACED_INTERPOLATION, OPEN_PAREN, OPENING_CURLY_BRACKET, OR, PERCENT, PLUS, PLUS_EQUALS, PLUS_PLUS, RAW_STRING, RECOVER, RECURSE, RETURN, RTRIM, SEMICOLON, SEP, SETTING, SIMPLE_NESTED, SIMPLE_RECURSE, SIMPLE_RETURN, START_TAG, STATIC_TEXT_FALSE_ALARM, STATIC_TEXT_NON_WS, STATIC_TEXT_WS, STOP, STRING_LITERAL, SWITCH, TERMINATING_EXCLAM, TERMINATING_WHITESPACE, TERSE_COMMENT, TERSE_COMMENT_END, TIMES, TIMES_EQUALS, TRANSFORM, TRIM, TRIVIAL_FTL_HEADER, TRUE, UNIFIED_CALL, UNIFIED_CALL_END, UNKNOWN_DIRECTIVE, USING, VISIT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ParseException() Deprecated. Use a constructor to which you pass description, template, and positions.
	ParseException(String description, int lineNumber, int columnNumber) Deprecated. Use a constructor to which you can also pass the template, and the end positions.
	ParseException(String description, Template template, int lineNumber, int columnNumber) Deprecated. Use ParseException(String, Template, int, int, int, int) instead, as IDE-s need the end position of the error too.
	ParseException(String description, Template template, int lineNumber, int columnNumber, int endLineNumber, int endColumnNumber)
	ParseException(String description, Template template, int lineNumber, int columnNumber, int endLineNumber, int endColumnNumber, Throwable cause)
	ParseException(String description, Template template, int lineNumber, int columnNumber, Throwable cause) Deprecated. Use ParseException(String, Template, int, int, int, int, Throwable) instead, as IDE-s need the end position of the error too.
	ParseException(String description, TemplateObject tobj)
	ParseException(String description, TemplateObject tobj, Throwable cause)
	ParseException(String description, Template template, Token tk)
	ParseException(String description, Template template, Token tk, Throwable cause)
	ParseException(Token currentTokenVal, int[][] expectedTokenSequencesVal, String[] tokenImageVal) This constructor is used by the method "generateParseException" in the generated parser.

Method Summary

Modifier and Type	Method and Description
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() 1-based column number of the failing section, or 0 is the information is not available.
String	getEditorMessage() Returns the description of the error without error location or source quotations, or null if there's no description available.
int	getEndColumnNumber() 1-based column number of the last character of the failing section, or 0 if the information is not available.
int	getEndLineNumber() 1-based line number of the last line that contains the failing section, or 0 if the information is not available.
int	getLineNumber() 1-based line number of the failing section, or 0 is the information is not available.
String	getMessage() Returns the error location plus the error description.
String	getTemplateName() Returns the name (template-root relative path) of the template whose parsing was failed.
void	setTemplateName(String templateName) Should be used internally only; sets the name of the template that contains the 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

Field Detail

currentToken

public 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.

columnNumber

public int columnNumber

lineNumber

public int lineNumber

endColumnNumber

public int endColumnNumber

endLineNumber

public int endLineNumber

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.

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.

eol

protected String eol

The end of line string for this machine.

specialConstructor

protected boolean specialConstructor

Deprecated. Will be remove without replacement in 2.4.

Constructor Detail

ParseException

public ParseException(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. 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: <result of getMessage>

ParseException

protected ParseException()

Deprecated. Use a constructor to which you pass description, template, and positions.

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 description,
                      int lineNumber,
                      int columnNumber)

Deprecated. Use a constructor to which you can also pass the template, and the end positions.

ParseException

public ParseException(String description,
                      Template template,
                      int lineNumber,
                      int columnNumber,
                      int endLineNumber,
                      int endColumnNumber)

Since:

2.3.21

ParseException

public ParseException(String description,
                      Template template,
                      int lineNumber,
                      int columnNumber,
                      int endLineNumber,
                      int endColumnNumber,
                      Throwable cause)

Since:

2.3.21

ParseException

public ParseException(String description,
                      Template template,
                      int lineNumber,
                      int columnNumber)

Deprecated. Use ParseException(String, Template, int, int, int, int) instead, as IDE-s need the end position of the error too.

Since:

2.3.20

ParseException

public ParseException(String description,
                      Template template,
                      int lineNumber,
                      int columnNumber,
                      Throwable cause)

Deprecated. Use ParseException(String, Template, int, int, int, int, Throwable) instead, as IDE-s need the end position of the error too.

Since:

2.3.20

ParseException

public ParseException(String description,
                      Template template,
                      Token tk)

Since:

2.3.20

ParseException

public ParseException(String description,
                      Template template,
                      Token tk,
                      Throwable cause)

Since:

2.3.20

ParseException

public ParseException(String description,
                      TemplateObject tobj)

Since:

2.3.20

ParseException

public ParseException(String description,
                      TemplateObject tobj,
                      Throwable cause)

Since:

2.3.20

Method Detail

setTemplateName

public void setTemplateName(String templateName)

Should be used internally only; sets the name of the template that contains the error. This is needed as the constructor that JavaCC automatically calls doesn't pass in the template, so we set it somewhere later in an exception handler.

getMessage

public String getMessage()

Returns the error location plus the error description.

Overrides:

getMessage in class Throwable

See Also:

getDescription(), getTemplateName(), getLineNumber(), getColumnNumber()

getEditorMessage

public String getEditorMessage()

Returns the description of the error without error location or source quotations, or null if there's no description available. This is useful in editors (IDE-s) where the error markers and the editor window itself already carry this information, so it's redundant the repeat in the error dialog.

getTemplateName

public String getTemplateName()

Returns the name (template-root relative path) of the template whose parsing was failed. Maybe null if this is a non-stored template.

Since:

2.3.20

getLineNumber

public int getLineNumber()

1-based line number of the failing section, or 0 is the information is not available.

getColumnNumber

public int getColumnNumber()

1-based column number of the failing section, or 0 is the information is not available.

getEndLineNumber

public int getEndLineNumber()

1-based line number of the last line that contains the failing section, or 0 if the information is not available.

Since:

2.3.21

getEndColumnNumber

public int getEndColumnNumber()

1-based column number of the last character of the failing section, or 0 if the information is not available. Note that unlike with Java string API-s, this column number is inclusive.

Since:

2.3.21

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.