freemarker.template.TemplateException Maven / Gradle / Ivy
/*
* Copyright (c) 2003 The Visigoth Software Society. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowledgement:
* "This product includes software developed by the
* Visigoth Software Society (http://www.visigoths.org/)."
* Alternately, this acknowledgement may appear in the software itself,
* if and wherever such third-party acknowledgements normally appear.
*
* 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
* project contributors may be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [email protected].
*
* 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
* nor may "FreeMarker" or "Visigoth" appear in their names
* without prior written permission of the Visigoth Software Society.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Visigoth Software Society. For more
* information on the Visigoth Software Society, please see
* http://www.visigoths.org/
*/
package freemarker.template;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.lang.reflect.Method;
import freemarker.core.Environment;
/**
* The FreeMarker classes usually use this exception and its descendants to
* signal FreeMarker specific exceptions.
*
* @version $Id: TemplateException.java,v 1.26.2.1 2006/02/12 20:02:15 revusky Exp $
*/
public class TemplateException extends Exception {
private static final boolean BEFORE_1_4 = before14();
private static boolean before14() {
Class ec = Exception.class;
try {
ec.getMethod("getCause", new Class[]{});
} catch (Throwable e) {
return true;
}
return false;
}
private static final Class[] EMPTY_CLASS_ARRAY = new Class[]{};
private static final Object[] EMPTY_OBJECT_ARRAY = new Object[]{};
/** The underlying cause of this exception, if any */
private final Exception causeException;
private final Environment env;
private final String ftlInstructionStack;
/**
* Constructs a TemplateException with no specified detail message
* or underlying cause.
*/
public TemplateException(Environment env) {
this(null, null, env);
}
/**
* Constructs a TemplateException with the given detail message,
* but no underlying cause exception.
*
* @param description the description of the error that occurred
*/
public TemplateException(String description, Environment env) {
this(description, null, env);
}
/**
* Constructs a TemplateException with the given underlying Exception,
* but no detail message.
*
* @param cause the underlying Exception that caused this
* exception to be raised
*/
public TemplateException(Exception cause, Environment env) {
this(null, cause, env);
}
/**
* Constructs a TemplateException with both a description of the error
* that occurred and the underlying Exception that caused this exception
* to be raised.
*
* @param description the description of the error that occurred
* @param cause the underlying Exception that caused this
* exception to be raised
*/
public TemplateException(String description, Exception cause, Environment env) {
super(getDescription(description, cause));
causeException = cause;
this.env = env;
if(env != null)
{
StringWriter sw = new StringWriter();
PrintWriter pw = new PrintWriter(sw);
env.outputInstructionStack(pw);
pw.flush();
ftlInstructionStack = sw.toString();
}
else
{
ftlInstructionStack = "";
}
}
private static String getDescription(String description, Exception cause) {
if(description != null) {
return description;
}
if(cause != null) {
return cause.getClass().getName() + ": " + cause.getMessage();
}
return "No error message";
}
/**
* 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.
*
* @return the underlying Exception, if any, that caused this
* exception to be raised
*/
public Exception getCauseException() {
return causeException;
}
/**
* Returns the same exception as getCauseException. Provided
* to enable full JDK-generated stack traces when running under JDK 1.4.
*
* @see Throwable#getCause()
* @return the underlying Exception, if any, that caused this
* exception to be raised
*/
public Throwable getCause() {
return causeException;
}
/**
* Returns the quote of the problematic FTL instruction and the FTL stack strace.
*/
public String getFTLInstructionStack() {
return ftlInstructionStack;
}
/**
* @return the execution environment in which the exception occurred
*/
public Environment getEnvironment() {
return env;
}
public void printStackTrace(java.io.PrintStream ps) {
PrintWriter pw = new PrintWriter(new OutputStreamWriter(ps), true);
printStackTrace(pw);
pw.flush();
}
public void printStackTrace(PrintWriter pw) {
pw.println();
pw.println(getMessage());
if (ftlInstructionStack != null && ftlInstructionStack.length() != 0) {
pw.println("The problematic instruction:");
pw.println(ftlInstructionStack);
}
pw.println("Java backtrace for programmers:");
pw.println("----------");
super.printStackTrace(pw);
if (BEFORE_1_4 && causeException != null) {
pw.println("Underlying cause: ");
causeException.printStackTrace(pw);
}
// Dirty hack to fight with stupid ServletException class whose
// getCause() method doesn't work properly. Also an aid for pre-J2xE 1.4
// users.
try {
// Reflection is used to prevent dependency on Servlet classes.
Method m = causeException.getClass().getMethod("getRootCause", EMPTY_CLASS_ARRAY);
Throwable rootCause = (Throwable) m.invoke(causeException, EMPTY_OBJECT_ARRAY);
if (rootCause != null) {
Throwable j14Cause = null;
if (!BEFORE_1_4) {
m = causeException.getClass().getMethod("getCause", EMPTY_CLASS_ARRAY);
j14Cause = (Throwable) m.invoke(causeException, EMPTY_OBJECT_ARRAY);
}
if (j14Cause == null) {
pw.println("ServletException root cause: ");
rootCause.printStackTrace(pw);
}
}
} catch (Throwable exc) {
; // ignore
}
}
}