Class TemplateModelException

    • 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 as TemplateModelException(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 underlying Exception that caused this exception to be raised
      • TemplateModelException

        public TemplateModelException​(java.lang.String description,
                                      java.lang.Exception cause)
        The same as TemplateModelException(String, Throwable); it's exists only for binary backward-compatibility.
      • 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 occurred
        replaceWithCause - See getReplaceWithCause(); usually false, unless you are forced to wrap TemplateException into a TemplateModelException merely due to API constraints.
        cause - the underlying Exception 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 throw TemplateModelException, but the exception to propagate is a more generic TemplateException. The error handler mechanism of FreeMarker will replace the exception with its Throwable.getCause() when it has bubbled up to a place where that constraint doesn't apply anymore.
        Since:
        2.3.28