http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/TemplateException.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/TemplateException.html b/builds/fm3/api/org/apache/freemarker/core/TemplateException.html new file mode 100644 index 0000000..8bb039d --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/TemplateException.html @@ -0,0 +1,783 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_66) on Wed Mar 01 19:40:22 CET 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>TemplateException (FreeMarker 3.0.0-nightly-incubating API)</title> +<meta name="date" content="2017-03-01"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="TemplateException (FreeMarker 3.0.0-nightly-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/TemplateException.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/freemarker/core/TemplateConfiguration.html" title="class in org.apache.freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html" title="interface in org.apache.freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/freemarker/core/TemplateException.html" target="_top">Frames</a></li> +<li><a href="TemplateException.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.freemarker.core</div> +<h2 title="Class TemplateException" class="title">Class TemplateException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">java.lang.Throwable</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">java.lang.Exception</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.freemarker.core.TemplateException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../org/apache/freemarker/core/InvalidReferenceException.html" title="class in org.apache.freemarker.core">InvalidReferenceException</a>, <a href="../../../../org/apache/freemarker/core/NestedContentNotSupportedException.html" title="class in org.apache.freemarker.core">NestedContentNotSupportedException</a>, <a href="../../../../org/apache/freemarker/core/StopException.html" title="class in org.apache.freemarker.core">StopException</a>, <a href="../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a>, <a href="../../../../org/apache/freemarker/core/UnexpectedTypeException.html" title="class in org.apache.freemarker.core">UnexpectedTypeException</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">TemplateException</span> +extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Runtime exception in a template (as opposed to a parsing-time exception: <a href="../../../../org/apache/freemarker/core/ParseException.html" title="class in org.apache.freemarker.core"><code>ParseException</code></a>). + It prints a special stack trace that contains the template-language stack trace along the usual Java stack trace.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../serialized-form.html#org.apache.freemarker.core.TemplateException">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code> </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#TemplateException-org.apache.freemarker.core.Environment-">TemplateException</a></span>(<a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core">Environment</a> env)</code> +<div class="block">Constructs a TemplateException with no specified detail message + or underlying cause.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code> </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#TemplateException-java.lang.Exception-org.apache.freemarker.core.Environment-">TemplateException</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a> cause, + <a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core">Environment</a> env)</code> +<div class="block">The same as <a href="../../../../org/apache/freemarker/core/TemplateException.html#TemplateException-java.lang.Throwable-org.apache.freemarker.core.Environment-"><code>TemplateException(Throwable, Environment)</code></a>; it's exists only for binary + backward-compatibility.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code> </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#TemplateException-java.lang.String-org.apache.freemarker.core.Environment-">TemplateException</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> description, + <a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core">Environment</a> env)</code> +<div class="block">Constructs a TemplateException with the given detail message, + but no underlying cause exception.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code> </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#TemplateException-java.lang.String-java.lang.Exception-org.apache.freemarker.core.Environment-">TemplateException</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> description, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a> cause, + <a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core">Environment</a> env)</code> +<div class="block">The same as <a href="../../../../org/apache/freemarker/core/TemplateException.html#TemplateException-java.lang.String-java.lang.Throwable-org.apache.freemarker.core.Environment-"><code>TemplateException(String, Throwable, Environment)</code></a>; it's exists only for binary + backward-compatibility.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code> </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#TemplateException-java.lang.String-java.lang.Throwable-org.apache.freemarker.core.Environment-">TemplateException</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> description, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause, + <a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core">Environment</a> env)</code> +<div class="block">Constructs a TemplateException with both a description of the error + that occurred and the underlying Exception that caused this exception + to be raised.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code> </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#TemplateException-java.lang.Throwable-org.apache.freemarker.core.Environment-">TemplateException</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause, + <a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core">Environment</a> env)</code> +<div class="block">Constructs a TemplateException with the given underlying Exception, + but no detail message.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#TemplateException-java.lang.Throwable-org.apache.freemarker.core.Environment-org.apache.freemarker.core.ASTExpression-org.apache.freemarker.core._ErrorDescriptionBuilder-">TemplateException</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause, + <a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core">Environment</a> env, + org.apache.freemarker.core.ASTExpression blamedExpr, + org.apache.freemarker.core._ErrorDescriptionBuilder descriptionBuilder)</code> +<div class="block">Don't use this; this is to be used internally by FreeMarker.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#getBlamedExpressionString--">getBlamedExpressionString</a></span>()</code> +<div class="block">If there was a blamed expression attached to this exception, it returns its canonical form, otherwise it returns + <code>null</code>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#getColumnNumber--">getColumnNumber</a></span>()</code> +<div class="block">1-based column number of the failing section, or <code>null</code> if the information is not available.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#getEndColumnNumber--">getEndColumnNumber</a></span>()</code> +<div class="block">1-based column number of the last character of the failing template section, or <code>null</code> if the information + is not available.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#getEndLineNumber--">getEndLineNumber</a></span>()</code> +<div class="block">1-based line number of the last line that contains the failing section, or <code>null</code> if the information is not + available.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core">Environment</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#getEnvironment--">getEnvironment</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#getFTLInstructionStack--">getFTLInstructionStack</a></span>()</code> +<div class="block">Returns the snapshot of the FTL stack trace at the time this exception was created.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#getLineNumber--">getLineNumber</a></span>()</code> +<div class="block">1-based line number of the failing section, or <code>null</code> if the information is not available.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#getMessage--">getMessage</a></span>()</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#getMessageWithoutStackTop--">getMessageWithoutStackTop</a></span>()</code> +<div class="block">Similar to <a href="../../../../org/apache/freemarker/core/TemplateException.html#getMessage--"><code>getMessage()</code></a>, but it doesn't contain the position of the failing instruction at then end + of the text.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#getTemplateSourceName--">getTemplateSourceName</a></span>()</code> +<div class="block">Returns the source name (<a href="../../../../org/apache/freemarker/core/Template.html#getSourceName--"><code>Template.getSourceName()</code></a>) of the template where the error has occurred, or + <code>null</code> if the information isn't available.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#printStackTrace-java.io.PrintStream-">printStackTrace</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true"; title="class or interface in java.io">PrintStream</a> out)</code> +<div class="block">Overrides <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-"; title="class or interface in java.lang"><code>Throwable.printStackTrace(PrintStream)</code></a> so that it will include the FTL stack trace.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#printStackTrace-java.io.PrintStream-boolean-boolean-boolean-">printStackTrace</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true"; title="class or interface in java.io">PrintStream</a> out, + boolean heading, + boolean ftlStackTrace, + boolean javaStackTrace)</code> </td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#printStackTrace-java.io.PrintWriter-">printStackTrace</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> out)</code> +<div class="block">Overrides <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-"; title="class or interface in java.lang"><code>Throwable.printStackTrace(PrintWriter)</code></a> so that it will include the FTL stack trace.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#printStackTrace-java.io.PrintWriter-boolean-boolean-boolean-">printStackTrace</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> out, + boolean heading, + boolean ftlStackTrace, + boolean javaStackTrace)</code> </td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#printStandardStackTrace-java.io.PrintStream-">printStandardStackTrace</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true"; title="class or interface in java.io">PrintStream</a> ps)</code> +<div class="block">Prints the stack trace as if wasn't overridden by <a href="../../../../org/apache/freemarker/core/TemplateException.html" title="class in org.apache.freemarker.core"><code>TemplateException</code></a>.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateException.html#printStandardStackTrace-java.io.PrintWriter-">printStandardStackTrace</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> pw)</code> +<div class="block">Prints the stack trace as if wasn't overridden by <a href="../../../../org/apache/freemarker/core/TemplateException.html" title="class in org.apache.freemarker.core"><code>TemplateException</code></a>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-"; title="class or interface in java.lang">addSuppressed</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--"; title="class or interface in java.lang">fillInStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getCause--"; title="class or interface in java.lang">getCause</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--"; title="class or interface in java.lang">getLocalizedMessage</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--"; title="class or interface in java.lang">getStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--"; title="class or interface in java.lang">getSuppressed</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-"; title="class or interface in java.lang">initCause</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--"; title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-"; title="class or interface in java.lang">setStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="TemplateException-org.apache.freemarker.core.Environment-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TemplateException</h4> +<pre>public TemplateException(<a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core">Environment</a> env)</pre> +<div class="block">Constructs a TemplateException with no specified detail message + or underlying cause.</div> +</li> +</ul> +<a name="TemplateException-java.lang.String-org.apache.freemarker.core.Environment-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TemplateException</h4> +<pre>public TemplateException(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> description, + <a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core">Environment</a> env)</pre> +<div class="block">Constructs a TemplateException with the given detail message, + but no underlying cause exception.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>description</code> - the description of the error that occurred</dd> +</dl> +</li> +</ul> +<a name="TemplateException-java.lang.Exception-org.apache.freemarker.core.Environment-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TemplateException</h4> +<pre>public TemplateException(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a> cause, + <a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core">Environment</a> env)</pre> +<div class="block">The same as <a href="../../../../org/apache/freemarker/core/TemplateException.html#TemplateException-java.lang.Throwable-org.apache.freemarker.core.Environment-"><code>TemplateException(Throwable, Environment)</code></a>; it's exists only for binary + backward-compatibility.</div> +</li> +</ul> +<a name="TemplateException-java.lang.Throwable-org.apache.freemarker.core.Environment-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TemplateException</h4> +<pre>public TemplateException(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause, + <a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core">Environment</a> env)</pre> +<div class="block">Constructs a TemplateException with the given underlying Exception, + but no detail message.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>cause</code> - the underlying <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang"><code>Exception</code></a> that caused this + exception to be raised</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.20</dd> +</dl> +</li> +</ul> +<a name="TemplateException-java.lang.String-java.lang.Exception-org.apache.freemarker.core.Environment-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TemplateException</h4> +<pre>public TemplateException(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> description, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a> cause, + <a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core">Environment</a> env)</pre> +<div class="block">The same as <a href="../../../../org/apache/freemarker/core/TemplateException.html#TemplateException-java.lang.String-java.lang.Throwable-org.apache.freemarker.core.Environment-"><code>TemplateException(String, Throwable, Environment)</code></a>; it's exists only for binary + backward-compatibility.</div> +</li> +</ul> +<a name="TemplateException-java.lang.String-java.lang.Throwable-org.apache.freemarker.core.Environment-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TemplateException</h4> +<pre>public TemplateException(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> description, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause, + <a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core">Environment</a> env)</pre> +<div class="block">Constructs a TemplateException with both a description of the error + that occurred and the underlying Exception that caused this exception + to be raised.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>description</code> - the description of the error that occurred</dd> +<dd><code>cause</code> - the underlying <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang"><code>Exception</code></a> that caused this exception to be raised</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.20</dd> +</dl> +</li> +</ul> +<a name="TemplateException-java.lang.Throwable-org.apache.freemarker.core.Environment-org.apache.freemarker.core.ASTExpression-org.apache.freemarker.core._ErrorDescriptionBuilder-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TemplateException</h4> +<pre>protected TemplateException(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> cause, + <a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core">Environment</a> env, + org.apache.freemarker.core.ASTExpression blamedExpr, + org.apache.freemarker.core._ErrorDescriptionBuilder descriptionBuilder)</pre> +<div class="block">Don't use this; this is to be used internally by FreeMarker. No backward compatibility guarantees.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>blamedExpr</code> - Maybe <code>null</code>. The FTL stack in the <a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core"><code>Environment</code></a> only specifies the error location + with "template element" granularity, and this can be used to point to the expression inside the + template element.</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getFTLInstructionStack--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFTLInstructionStack</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getFTLInstructionStack()</pre> +<div class="block">Returns the snapshot of the FTL stack trace at the time this exception was created.</div> +</li> +</ul> +<a name="getEnvironment--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEnvironment</h4> +<pre>public <a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core">Environment</a> getEnvironment()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the execution environment in which the exception occurred. + <code>null</code> if the exception was deserialized.</dd> +</dl> +</li> +</ul> +<a name="printStackTrace-java.io.PrintStream-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printStackTrace</h4> +<pre>public void printStackTrace(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true"; title="class or interface in java.io">PrintStream</a> out)</pre> +<div class="block">Overrides <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-"; title="class or interface in java.lang"><code>Throwable.printStackTrace(PrintStream)</code></a> so that it will include the FTL stack trace.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-"; title="class or interface in java.lang">printStackTrace</a></code> in class <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a></code></dd> +</dl> +</li> +</ul> +<a name="printStackTrace-java.io.PrintWriter-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printStackTrace</h4> +<pre>public void printStackTrace(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> out)</pre> +<div class="block">Overrides <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-"; title="class or interface in java.lang"><code>Throwable.printStackTrace(PrintWriter)</code></a> so that it will include the FTL stack trace.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-"; title="class or interface in java.lang">printStackTrace</a></code> in class <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a></code></dd> +</dl> +</li> +</ul> +<a name="printStackTrace-java.io.PrintWriter-boolean-boolean-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printStackTrace</h4> +<pre>public void printStackTrace(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> out, + boolean heading, + boolean ftlStackTrace, + boolean javaStackTrace)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>heading</code> - should the heading at the top be printed</dd> +<dd><code>ftlStackTrace</code> - should the FTL stack trace be printed</dd> +<dd><code>javaStackTrace</code> - should the Java stack trace be printed</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.20</dd> +</dl> +</li> +</ul> +<a name="printStackTrace-java.io.PrintStream-boolean-boolean-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printStackTrace</h4> +<pre>public void printStackTrace(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true"; title="class or interface in java.io">PrintStream</a> out, + boolean heading, + boolean ftlStackTrace, + boolean javaStackTrace)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>heading</code> - should the heading at the top be printed</dd> +<dd><code>ftlStackTrace</code> - should the FTL stack trace be printed</dd> +<dd><code>javaStackTrace</code> - should the Java stack trace be printed</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.20</dd> +</dl> +</li> +</ul> +<a name="printStandardStackTrace-java.io.PrintStream-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printStandardStackTrace</h4> +<pre>public void printStandardStackTrace(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true"; title="class or interface in java.io">PrintStream</a> ps)</pre> +<div class="block">Prints the stack trace as if wasn't overridden by <a href="../../../../org/apache/freemarker/core/TemplateException.html" title="class in org.apache.freemarker.core"><code>TemplateException</code></a>.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.20</dd> +</dl> +</li> +</ul> +<a name="printStandardStackTrace-java.io.PrintWriter-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printStandardStackTrace</h4> +<pre>public void printStandardStackTrace(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> pw)</pre> +<div class="block">Prints the stack trace as if wasn't overridden by <a href="../../../../org/apache/freemarker/core/TemplateException.html" title="class in org.apache.freemarker.core"><code>TemplateException</code></a>.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.20</dd> +</dl> +</li> +</ul> +<a name="getMessage--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMessage</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getMessage()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getMessage--"; title="class or interface in java.lang">getMessage</a></code> in class <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a></code></dd> +</dl> +</li> +</ul> +<a name="getMessageWithoutStackTop--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMessageWithoutStackTop</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getMessageWithoutStackTop()</pre> +<div class="block">Similar to <a href="../../../../org/apache/freemarker/core/TemplateException.html#getMessage--"><code>getMessage()</code></a>, 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 <em>expression</em> though as part of the expression + quotation, as that's the part of the description.</div> +</li> +</ul> +<a name="getLineNumber--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLineNumber</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> getLineNumber()</pre> +<div class="block">1-based line number of the failing section, or <code>null</code> if the information is not available.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.21</dd> +</dl> +</li> +</ul> +<a name="getTemplateSourceName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTemplateSourceName</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getTemplateSourceName()</pre> +<div class="block">Returns the source name (<a href="../../../../org/apache/freemarker/core/Template.html#getSourceName--"><code>Template.getSourceName()</code></a>) of the template where the error has occurred, or + <code>null</code> if the information isn't available. This is what should be used for showing the error position.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.22</dd> +</dl> +</li> +</ul> +<a name="getColumnNumber--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getColumnNumber</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> getColumnNumber()</pre> +<div class="block">1-based column number of the failing section, or <code>null</code> if the information is not available.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.21</dd> +</dl> +</li> +</ul> +<a name="getEndLineNumber--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEndLineNumber</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> getEndLineNumber()</pre> +<div class="block">1-based line number of the last line that contains the failing section, or <code>null</code> if the information is not + available.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.21</dd> +</dl> +</li> +</ul> +<a name="getEndColumnNumber--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEndColumnNumber</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> getEndColumnNumber()</pre> +<div class="block">1-based column number of the last character of the failing template section, or <code>null</code> if the information + is not available. Note that unlike with Java string API-s, this column number is inclusive.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.21</dd> +</dl> +</li> +</ul> +<a name="getBlamedExpressionString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getBlamedExpressionString</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getBlamedExpressionString()</pre> +<div class="block">If there was a blamed expression attached to this exception, it returns its canonical form, otherwise it returns + <code>null</code>. This expression should always be inside the failing FTL instruction. + + <p>The typical application of this is getting the undefined expression from <a href="../../../../org/apache/freemarker/core/InvalidReferenceException.html" title="class in org.apache.freemarker.core"><code>InvalidReferenceException</code></a>-s.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.21</dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/TemplateException.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/freemarker/core/TemplateConfiguration.html" title="class in org.apache.freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html" title="interface in org.apache.freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/freemarker/core/TemplateException.html" target="_top">Frames</a></li> +<li><a href="TemplateException.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/TemplateExceptionHandler.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/TemplateExceptionHandler.html b/builds/fm3/api/org/apache/freemarker/core/TemplateExceptionHandler.html new file mode 100644 index 0000000..edd1aa2 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/TemplateExceptionHandler.html @@ -0,0 +1,345 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_66) on Wed Mar 01 19:40:22 CET 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>TemplateExceptionHandler (FreeMarker 3.0.0-nightly-incubating API)</title> +<meta name="date" content="2017-03-01"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="TemplateExceptionHandler (FreeMarker 3.0.0-nightly-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/TemplateExceptionHandler.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/freemarker/core/TemplateException.html" title="class in org.apache.freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/freemarker/core/TemplateNotFoundException.html" title="class in org.apache.freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/freemarker/core/TemplateExceptionHandler.html" target="_top">Frames</a></li> +<li><a href="TemplateExceptionHandler.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.freemarker.core</div> +<h2 title="Interface TemplateExceptionHandler" class="title">Interface TemplateExceptionHandler</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">TemplateExceptionHandler</span></pre> +<div class="block">Used for the <code>template_exception_handler</code> configuration setting; + see <a href="../../../../org/apache/freemarker/core/Configurable.html#setTemplateExceptionHandler-org.apache.freemarker.core.TemplateExceptionHandler-"><code>Configurable.setTemplateExceptionHandler(TemplateExceptionHandler)</code></a> for more.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html" title="interface in org.apache.freemarker.core">TemplateExceptionHandler</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html#DEBUG_HANDLER">DEBUG_HANDLER</a></span></code> +<div class="block"><a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html" title="interface in org.apache.freemarker.core"><code>TemplateExceptionHandler</code></a> useful when you developing non-HTML templates.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html" title="interface in org.apache.freemarker.core">TemplateExceptionHandler</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html#HTML_DEBUG_HANDLER">HTML_DEBUG_HANDLER</a></span></code> +<div class="block"><a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html" title="interface in org.apache.freemarker.core"><code>TemplateExceptionHandler</code></a> useful when you developing HTML templates.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html" title="interface in org.apache.freemarker.core">TemplateExceptionHandler</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html#IGNORE_HANDLER">IGNORE_HANDLER</a></span></code> +<div class="block"><a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html" title="interface in org.apache.freemarker.core"><code>TemplateExceptionHandler</code></a> that simply skips the failing instructions, letting the template continue + executing.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html" title="interface in org.apache.freemarker.core">TemplateExceptionHandler</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html#RETHROW_HANDLER">RETHROW_HANDLER</a></span></code> +<div class="block"><a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html" title="interface in org.apache.freemarker.core"><code>TemplateExceptionHandler</code></a> that simply re-throws the exception; this should be used in most production + systems.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html#handleTemplateException-org.apache.freemarker.core.TemplateException-org.apache.freemarker.core.Environment-java.io.Writer-">handleTemplateException</a></span>(<a href="../../../../org/apache/freemarker/core/TemplateException.html" title="class in org.apache.freemarker.core">TemplateException</a> te, + <a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core">Environment</a> env, + <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> out)</code> +<div class="block">Method called after a <a href="../../../../org/apache/freemarker/core/TemplateException.html" title="class in org.apache.freemarker.core"><code>TemplateException</code></a> was raised inside a template.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="IGNORE_HANDLER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IGNORE_HANDLER</h4> +<pre>static final <a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html" title="interface in org.apache.freemarker.core">TemplateExceptionHandler</a> IGNORE_HANDLER</pre> +<div class="block"><a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html" title="interface in org.apache.freemarker.core"><code>TemplateExceptionHandler</code></a> that simply skips the failing instructions, letting the template continue + executing. It does nothing to handle the event. Note that the exception is still logged, as with all + other <a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html" title="interface in org.apache.freemarker.core"><code>TemplateExceptionHandler</code></a>-s.</div> +</li> +</ul> +<a name="RETHROW_HANDLER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>RETHROW_HANDLER</h4> +<pre>static final <a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html" title="interface in org.apache.freemarker.core">TemplateExceptionHandler</a> RETHROW_HANDLER</pre> +<div class="block"><a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html" title="interface in org.apache.freemarker.core"><code>TemplateExceptionHandler</code></a> that simply re-throws the exception; this should be used in most production + systems.</div> +</li> +</ul> +<a name="DEBUG_HANDLER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEBUG_HANDLER</h4> +<pre>static final <a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html" title="interface in org.apache.freemarker.core">TemplateExceptionHandler</a> DEBUG_HANDLER</pre> +<div class="block"><a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html" title="interface in org.apache.freemarker.core"><code>TemplateExceptionHandler</code></a> useful when you developing non-HTML templates. This handler + outputs the stack trace information to the client and then re-throws the exception.</div> +</li> +</ul> +<a name="HTML_DEBUG_HANDLER"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HTML_DEBUG_HANDLER</h4> +<pre>static final <a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html" title="interface in org.apache.freemarker.core">TemplateExceptionHandler</a> HTML_DEBUG_HANDLER</pre> +<div class="block"><a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html" title="interface in org.apache.freemarker.core"><code>TemplateExceptionHandler</code></a> useful when you developing HTML templates. This handler + outputs the stack trace information to the client, formatting it so that it will be usually well readable + in the browser, and then re-throws the exception.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="handleTemplateException-org.apache.freemarker.core.TemplateException-org.apache.freemarker.core.Environment-java.io.Writer-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>handleTemplateException</h4> +<pre>void handleTemplateException(<a href="../../../../org/apache/freemarker/core/TemplateException.html" title="class in org.apache.freemarker.core">TemplateException</a> te, + <a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core">Environment</a> env, + <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> out) + throws <a href="../../../../org/apache/freemarker/core/TemplateException.html" title="class in org.apache.freemarker.core">TemplateException</a></pre> +<div class="block">Method called after a <a href="../../../../org/apache/freemarker/core/TemplateException.html" title="class in org.apache.freemarker.core"><code>TemplateException</code></a> was raised inside a template. The exception should be re-thrown + unless you want to suppress the exception. + + <p>Note that you can check with <a href="../../../../org/apache/freemarker/core/Environment.html#isInAttemptBlock--"><code>Environment.isInAttemptBlock()</code></a> if you are inside a <code>#attempt</code> + block, which then will handle handle this exception and roll back the output generated inside it. + + <p>Note that <a href="../../../../org/apache/freemarker/core/StopException.html" title="class in org.apache.freemarker.core"><code>StopException</code></a>-s (raised by <code>#stop</code>) won't be captured. + + <p>Note that you shouldn't log the exception in this method unless you suppress it. If there's a concern that the + exception might won't be logged after it bubbles up from <a href="../../../../org/apache/freemarker/core/Template.html#process-java.lang.Object-java.io.Writer-"><code>Template.process(Object, Writer)</code></a>, simply + ensure that <a href="../../../../org/apache/freemarker/core/Configurable.html#getLogTemplateExceptions--"><code>Configurable.getLogTemplateExceptions()</code></a> is <code>true</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>te</code> - The exception that occurred; don't forget to re-throw it unless you want to suppress it</dd> +<dd><code>env</code> - The runtime environment of the template</dd> +<dd><code>out</code> - This is where the output of the template is written</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../org/apache/freemarker/core/TemplateException.html" title="class in org.apache.freemarker.core">TemplateException</a></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/TemplateExceptionHandler.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/freemarker/core/TemplateException.html" title="class in org.apache.freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/freemarker/core/TemplateNotFoundException.html" title="class in org.apache.freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/freemarker/core/TemplateExceptionHandler.html" target="_top">Frames</a></li> +<li><a href="TemplateExceptionHandler.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/TemplateNotFoundException.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/TemplateNotFoundException.html b/builds/fm3/api/org/apache/freemarker/core/TemplateNotFoundException.html new file mode 100644 index 0000000..cc14d0b --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/TemplateNotFoundException.html @@ -0,0 +1,339 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_66) on Wed Mar 01 19:40:22 CET 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>TemplateNotFoundException (FreeMarker 3.0.0-nightly-incubating API)</title> +<meta name="date" content="2017-03-01"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="TemplateNotFoundException (FreeMarker 3.0.0-nightly-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/TemplateNotFoundException.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html" title="interface in org.apache.freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/freemarker/core/UnexpectedTypeException.html" title="class in org.apache.freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/freemarker/core/TemplateNotFoundException.html" target="_top">Frames</a></li> +<li><a href="TemplateNotFoundException.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.freemarker.core</div> +<h2 title="Class TemplateNotFoundException" class="title">Class TemplateNotFoundException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">java.lang.Throwable</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">java.lang.Exception</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">java.io.IOException</a></li> +<li> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true"; title="class or interface in java.io">java.io.FileNotFoundException</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.freemarker.core.TemplateNotFoundException</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></dd> +</dl> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">TemplateNotFoundException</span> +extends <a href="http://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true"; title="class or interface in java.io">FileNotFoundException</a></pre> +<div class="block">Thrown when <a href="../../../../org/apache/freemarker/core/Configuration.html#getTemplate-java.lang.String-"><code>Configuration.getTemplate(String)</code></a> (or similar) doesn't find a template. + This extends <a href="http://docs.oracle.com/javase/8/docs/api/java/io/FileNotFoundException.html?is-external=true"; title="class or interface in java.io"><code>FileNotFoundException</code></a> for backward compatibility, but in fact has nothing to do with files, as + FreeMarker can load templates from many other sources.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.22</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/freemarker/core/templateresolver/MalformedTemplateNameException.html" title="class in org.apache.freemarker.core.templateresolver"><code>MalformedTemplateNameException</code></a>, +<a href="../../../../org/apache/freemarker/core/Configuration.html#getTemplate-java.lang.String-"><code>Configuration.getTemplate(String)</code></a>, +<a href="../../../../serialized-form.html#org.apache.freemarker.core.TemplateNotFoundException">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateNotFoundException.html#TemplateNotFoundException-java.lang.String-java.lang.Object-java.lang.String-">TemplateNotFoundException</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> templateName, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> customLookupCondition, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> message)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateNotFoundException.html#getCustomLookupCondition--">getCustomLookupCondition</a></span>()</code> +<div class="block">The custom lookup condition with which the template was requested, or <code>null</code> if there's no such condition.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/TemplateNotFoundException.html#getTemplateName--">getTemplateName</a></span>()</code> +<div class="block">The name (path) of the template that wasn't found.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-"; title="class or interface in java.lang">addSuppressed</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--"; title="class or interface in java.lang">fillInStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getCause--"; title="class or interface in java.lang">getCause</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--"; title="class or interface in java.lang">getLocalizedMessage</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getMessage--"; title="class or interface in java.lang">getMessage</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--"; title="class or inter face in java.lang">getStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--"; title="class or interface in java.lang">getSuppressed</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-"; title="class or interface in java.lang">initCause</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--"; title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-"; title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-"; title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lan g/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="TemplateNotFoundException-java.lang.String-java.lang.Object-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TemplateNotFoundException</h4> +<pre>public TemplateNotFoundException(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> templateName, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> customLookupCondition, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> message)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getTemplateName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTemplateName</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getTemplateName()</pre> +<div class="block">The name (path) of the template that wasn't found.</div> +</li> +</ul> +<a name="getCustomLookupCondition--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getCustomLookupCondition</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> getCustomLookupCondition()</pre> +<div class="block">The custom lookup condition with which the template was requested, or <code>null</code> if there's no such condition. + See the <code>customLookupCondition</code> parameter of + <a href="../../../../org/apache/freemarker/core/Configuration.html#getTemplate-java.lang.String-java.util.Locale-java.lang.Object-java.lang.String-boolean-boolean-"><code>Configuration.getTemplate(String, java.util.Locale, Object, String, boolean, boolean)</code></a>.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/TemplateNotFoundException.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/freemarker/core/TemplateExceptionHandler.html" title="interface in org.apache.freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/freemarker/core/UnexpectedTypeException.html" title="class in org.apache.freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/freemarker/core/TemplateNotFoundException.html" target="_top">Frames</a></li> +<li><a href="TemplateNotFoundException.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
