freemarker.template

Class TemplateException

java.lang.Object

java.lang.Throwable

java.lang.Exception

freemarker.template.TemplateException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

freemarker.core._MiscTemplateException, InvalidReferenceException, StopException, TemplateModelException, UnexpectedTypeException

public class TemplateException
extends java.lang.Exception

Runtime exception in a template (as opposed to a parsing-time exception: ParseException). It prints a special stack trace that contains the template-language stack trace along the usual Java stack trace.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	TemplateException(Environment env) Constructs a TemplateException with no specified detail message or underlying cause.
	TemplateException(java.lang.Exception cause, Environment env) The same as TemplateException(Throwable, Environment); it's exists only for binary backward-compatibility.
	TemplateException(java.lang.String description, Environment env) Constructs a TemplateException with the given detail message, but no underlying cause exception.
	TemplateException(java.lang.String description, java.lang.Exception cause, Environment env) The same as TemplateException(String, Throwable, Environment); it's exists only for binary backward-compatibility.
	TemplateException(java.lang.String description, java.lang.Throwable cause, Environment env) Constructs a TemplateException with both a description of the error that occurred and the underlying Exception that caused this exception to be raised.
protected	TemplateException(java.lang.Throwable cause, Environment env, freemarker.core._ErrorDescriptionBuilder descriptionBuilder, boolean preventAmbiguity) Don't use this; this is to be used internally by FreeMarker.
	TemplateException(java.lang.Throwable cause, Environment env) Constructs a TemplateException with the given underlying Exception, but no detail message.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Throwable	getCause() Returns the cause exception.
java.lang.Exception	getCauseException() Deprecated. Use getCause() instead, as this can't return runtime exceptions and errors as is.
Environment	getEnvironment()
java.lang.String	getFTLInstructionStack() Returns the snapshot of the FTL stack strace at the time this exception was created.
java.lang.String	getMessage()
java.lang.String	getMessageWithoutStackTop() Similar to getMessage(), but it doesn't contain the position of the failing instruction at then end of the text.
void	printStackTrace(java.io.PrintStream out) Overrides Throwable.printStackTrace(PrintStream) so that it will include the FTL stack trace.
void	printStackTrace(java.io.PrintStream out, boolean heading, boolean ftlStackTrace, boolean javaStackTrace)
void	printStackTrace(java.io.PrintWriter out) Overrides Throwable.printStackTrace(PrintWriter) so that it will include the FTL stack trace.
void	printStackTrace(java.io.PrintWriter out, boolean heading, boolean ftlStackTrace, boolean javaStackTrace)
void	printStandardStackTrace(java.io.PrintStream ps) Prints the stack trace as if wasn't overridden by TemplateException.
void	printStandardStackTrace(java.io.PrintWriter pw) Prints the stack trace as if wasn't overridden by TemplateException.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateException

public TemplateException(Environment env)

Constructs a TemplateException with no specified detail message or underlying cause.

TemplateException

public TemplateException(java.lang.String description,
                 Environment env)

Constructs a TemplateException with the given detail message, but no underlying cause exception.

Parameters:

description - the description of the error that occurred

TemplateException

public TemplateException(java.lang.Exception cause,
                 Environment env)

The same as TemplateException(Throwable, Environment); it's exists only for binary backward-compatibility.

TemplateException

public TemplateException(java.lang.Throwable cause,
                 Environment env)

Constructs a TemplateException with the given underlying Exception, but no detail message.

Parameters:

cause - the underlying Exception that caused this exception to be raised

Since:

2.3.20

TemplateException

public TemplateException(java.lang.String description,
                 java.lang.Exception cause,
                 Environment env)

The same as TemplateException(String, Throwable, Environment); it's exists only for binary backward-compatibility.

TemplateException

public TemplateException(java.lang.String description,
                 java.lang.Throwable cause,
                 Environment env)

Constructs a TemplateException with both a description of the error that occurred and the underlying Exception that caused this exception to be raised.

Parameters:

description - the description of the error that occurred

cause - the underlying Exception that caused this exception to be raised

Since:

2.3.20

TemplateException

protected TemplateException(java.lang.Throwable cause,
                 Environment env,
                 freemarker.core._ErrorDescriptionBuilder descriptionBuilder,
                 boolean preventAmbiguity)

Don't use this; this is to be used internally by FreeMarker.

Parameters:

preventAmbiguity - its value is ignored; it's only to prevent constructor selection ambiguities for backward-compatibility

Method Detail

getCauseException

public java.lang.Exception getCauseException()

Deprecated. Use getCause() instead, as this can't return runtime exceptions and errors as is.

Returns the underlying exception that caused this exception to be generated.

Note:
avoided calling it getCause to avoid name clash with JDK 1.4 method. This would be problematic because the JDK 1.4 method returns a Throwable rather than an Exception.

Returns:

the underlying Exception, if any, that caused this exception to be raised

getCause

public java.lang.Throwable getCause()

Returns the cause exception.

Overrides:

getCause in class java.lang.Throwable

Returns:

the underlying Exception, if any, that caused this exception to be raised

See Also:

Throwable.getCause()

getFTLInstructionStack

public java.lang.String getFTLInstructionStack()

Returns the snapshot of the FTL stack strace at the time this exception was created.

getEnvironment

public Environment getEnvironment()

Returns:

the execution environment in which the exception occurred. null if the exception was deserialized.

printStackTrace

public void printStackTrace(java.io.PrintStream out)

Overrides Throwable.printStackTrace(PrintStream) so that it will include the FTL stack trace.

Overrides:

printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintWriter out)

Overrides Throwable.printStackTrace(PrintWriter) so that it will include the FTL stack trace.

Overrides:

printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintWriter out,
                   boolean heading,
                   boolean ftlStackTrace,
                   boolean javaStackTrace)

Parameters:

heading - should the heading at the top be printed

ftlStackTrace - should the FTL stack trace be printed

javaStackTrace - should the Java stack trace be printed

Since:

2.3.20

printStackTrace

public void printStackTrace(java.io.PrintStream out,
                   boolean heading,
                   boolean ftlStackTrace,
                   boolean javaStackTrace)

Parameters:

heading - should the heading at the top be printed

ftlStackTrace - should the FTL stack trace be printed

javaStackTrace - should the Java stack trace be printed

Since:

2.3.20

printStandardStackTrace

public void printStandardStackTrace(java.io.PrintStream ps)

Prints the stack trace as if wasn't overridden by TemplateException.

Since:

2.3.20

printStandardStackTrace

public void printStandardStackTrace(java.io.PrintWriter pw)

Prints the stack trace as if wasn't overridden by TemplateException.

Since:

2.3.20

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

getMessageWithoutStackTop

public java.lang.String getMessageWithoutStackTop()

Similar to getMessage(), but it doesn't contain the position of the failing instruction at then end of the text. It might contains the position of the failing expression though as part of the expression quotation, as that's the part of the description.