Package freemarker.template
Class TemplateModelException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- freemarker.template.TemplateException
-
- freemarker.template.TemplateModelException
-
- All Implemented Interfaces:
java.io.Serializable
- Direct Known Subclasses:
InvalidPropertyException
public class TemplateModelException extends TemplateException
ObjectWrapper
-s may throw this when wrapping/unwrapping fails, orTemplateModel
methods throw this if the requested data can't be retrieved.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Modifier Constructor Description TemplateModelException()
Constructs a TemplateModelException with no specified detail message.TemplateModelException(java.lang.Exception cause)
The same asTemplateModelException(Throwable)
; it's exists only for binary backward-compatibility.TemplateModelException(java.lang.String description)
Constructs a TemplateModelException with the specified detail message.TemplateModelException(java.lang.String description, boolean replaceWithCause, java.lang.Throwable cause)
Constructs a TemplateModelException with both a description of the error that occurred and the underlying Exception that caused this exception to be raised.TemplateModelException(java.lang.String description, java.lang.Exception cause)
The same asTemplateModelException(String, Throwable)
; it's exists only for binary backward-compatibility.TemplateModelException(java.lang.String description, java.lang.Throwable cause)
TemplateModelException(java.lang.Throwable cause)
Constructs a TemplateModelException with the given underlying Exception, but no detail message.protected
TemplateModelException(java.lang.Throwable cause, Environment env, freemarker.core._ErrorDescriptionBuilder descriptionBuilder, boolean preventAmbiguity)
Don't use this; this is to be used internally by FreeMarker.protected
TemplateModelException(java.lang.Throwable cause, Environment env, java.lang.String description, boolean preventAmbiguity)
Don't use this; this is to be used internally by FreeMarker.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
getReplaceWithCause()
Indicates that the cause exception should be thrown instead of this exception; it was only wrapped into this exception due to API constraints.-
Methods inherited from class freemarker.template.TemplateException
getBlamedExpressionString, getCauseException, getColumnNumber, getEndColumnNumber, getEndLineNumber, getEnvironment, getFTLInstructionStack, getLineNumber, getMessage, getMessageWithoutStackTop, getTemplateName, getTemplateSourceName, printStackTrace, printStackTrace, printStackTrace, printStackTrace, printStandardStackTrace, printStandardStackTrace
-
-
-
-
Constructor Detail
-
TemplateModelException
public TemplateModelException()
Constructs a TemplateModelException with no specified detail message.
-
TemplateModelException
public TemplateModelException(java.lang.String description)
Constructs a TemplateModelException with the specified detail message.- Parameters:
description
- the detail message.
-
TemplateModelException
public TemplateModelException(java.lang.Exception cause)
The same asTemplateModelException(Throwable)
; it's exists only for binary backward-compatibility.
-
TemplateModelException
public TemplateModelException(java.lang.Throwable cause)
Constructs a TemplateModelException with the given underlying Exception, but no detail message.- Parameters:
cause
- the underlyingException
that caused this exception to be raised
-
TemplateModelException
public TemplateModelException(java.lang.String description, java.lang.Exception cause)
The same asTemplateModelException(String, Throwable)
; it's exists only for binary backward-compatibility.
-
TemplateModelException
public TemplateModelException(java.lang.String description, java.lang.Throwable cause)
-
TemplateModelException
public TemplateModelException(java.lang.String description, boolean replaceWithCause, java.lang.Throwable cause)
Constructs a TemplateModelException 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 occurredreplaceWithCause
- SeegetReplaceWithCause()
; usuallyfalse
, unless you are forced to wrapTemplateException
into aTemplateModelException
merely due to API constraints.cause
- the underlyingException
that caused this exception to be raised- Since:
- 2.3.28
-
TemplateModelException
protected TemplateModelException(java.lang.Throwable cause, Environment env, java.lang.String description, 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
-
TemplateModelException
protected TemplateModelException(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
-
getReplaceWithCause
public boolean getReplaceWithCause()
Indicates that the cause exception should be thrown instead of this exception; it was only wrapped into this exception due to API constraints. Such unwanted wrapping typically occurs when you are only allowed to throwTemplateModelException
, but the exception to propagate is a more genericTemplateException
. The error handler mechanism of FreeMarker will replace the exception with itsThrowable.getCause()
when it has bubbled up to a place where that constraint doesn't apply anymore.- Since:
- 2.3.28
-
-