freemarker.template.TemplateExceptionHandler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.apache.servicemix.bundles.freemarker
Show all versions of org.apache.servicemix.bundles.freemarker
This OSGi bundle wraps ${pkgArtifactId} ${pkgVersion} jar file.
/*
* 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.Writer;
import java.io.PrintWriter;
import freemarker.core.Environment;
/**
* An API for objects that handle exceptions that are thrown during
* template rendering.
* @author Jonathan Revusky
*/
public interface TemplateExceptionHandler {
/**
* handle the exception.
* @param te the exception that occurred.
* @param env The environment object that represents the rendering context
* @param out the character output stream to output to.
*/
void handleTemplateException(TemplateException te, Environment env, Writer out)
throws TemplateException;
/**
* This is a TemplateExceptionHandler which simply skips errors. It does nothing
* to handle the event. Note that the exception is still logged in any case, before
* being passed to the handler.
*/
TemplateExceptionHandler IGNORE_HANDLER = new TemplateExceptionHandler() {
public void handleTemplateException(TemplateException te, Environment env, Writer out) {
}
};
/**
* This is a TemplateExceptionHandler that simply rethrows the exception.
* Note that the exception is logged before being rethrown.
*/
TemplateExceptionHandler RETHROW_HANDLER =new TemplateExceptionHandler() {
public void handleTemplateException(TemplateException te, Environment env, Writer out)
throws TemplateException
{
throw te;
}
};
/**
* This is a TemplateExceptionHandler used when you develop the templates. This handler
* outputs the stack trace information to the client and then rethrows the exception.
*/
TemplateExceptionHandler DEBUG_HANDLER =new TemplateExceptionHandler() {
public void handleTemplateException(TemplateException te, Environment env, Writer out)
throws TemplateException
{
PrintWriter pw = (out instanceof PrintWriter)
? (PrintWriter) out
: new PrintWriter(out);
te.printStackTrace(pw);
pw.flush();
throw te;
}
};
/**
* This is a TemplateExceptionHandler used when you develop HTML templates. This handler
* outputs the stack trace information to the client and then rethrows the exception, and
* surrounds it with tags to make the error message readable with the browser.
*/
TemplateExceptionHandler HTML_DEBUG_HANDLER =new TemplateExceptionHandler() {
public void handleTemplateException(TemplateException te, Environment env, Writer out)
throws TemplateException
{
PrintWriter pw = (out instanceof PrintWriter)
? (PrintWriter) out
: new PrintWriter(out);
pw.println(""
+ ""
+ ""
+ ""
+ ""
+ ""
+ ""
+ "FreeMarker template error!"
+ "
"); te.printStackTrace(pw); pw.println("