http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/TemplateMethodModel.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateMethodModel.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateMethodModel.html new file mode 100644 index 0000000..3256542 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateMethodModel.html @@ -0,0 +1,283 @@ +<!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>TemplateMethodModel (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="TemplateMethodModel (FreeMarker 3.0.0-nightly-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":38}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated 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/TemplateMethodModel.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/model/TemplateMarkupOutputModel.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/TemplateMethodModelEx.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/TemplateMethodModel.html" target="_top">Frames</a></li> +<li><a href="TemplateMethodModel.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </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.model</div> +<h2 title="Interface TemplateMethodModel" class="title">Interface TemplateMethodModel</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a></dd> +</dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../../org/apache/freemarker/core/model/TemplateMethodModelEx.html" title="interface in org.apache.freemarker.core.model">TemplateMethodModelEx</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/freemarker/core/model/impl/JavaMethodModel.html" title="class in org.apache.freemarker.core.model.impl">JavaMethodModel</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/ResourceBundleModel.html" title="class in org.apache.freemarker.core.model.impl">ResourceBundleModel</a></dd> +</dl> +<hr> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">Use <a href="../../../../../org/apache/freemarker/core/model/TemplateMethodModelEx.html" title="interface in org.apache.freemarker.core.model"><code>TemplateMethodModelEx</code></a> instead. This interface is from the old times when the only kind of + value you could pass in was string.</span></div> +</div> +<br> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public interface <span class="typeNameLabel">TemplateMethodModel</span> +extends <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a></pre> +<div class="block">"method" template language data type: Objects that act like functions. The name comes from that their original + application was calling Java methods via <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl"><code>DefaultObjectWrapper</code></a>. + + <p>In templates they are used like <code>myMethod("foo", "bar")</code> or <code>myJavaObject.myJavaMethod("foo", "bar")</code>.</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> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.freemarker.core.model.TemplateModel"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.freemarker.core.model.<a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a></h3> +<code><a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html#NOTHING">NOTHING</a></code></li> +</ul> +</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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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/model/TemplateMethodModel.html#exec-java.util.List-">exec</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a> arguments)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Executes the method call.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="exec-java.util.List-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>exec</h4> +<pre><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> exec(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a> arguments) + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Executes the method call. All arguments passed to the method call are + coerced to strings before being passed, if the FreeMarker rules allow + the coercion. If some of the passed arguments can not be coerced to a + string, an exception will be raised in the engine and the method will + not be called. If your method would like to act on actual data model + objects instead of on their string representations, implement the + <a href="../../../../../org/apache/freemarker/core/model/TemplateMethodModelEx.html" title="interface in org.apache.freemarker.core.model"><code>TemplateMethodModelEx</code></a> instead.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>arguments</code> - a <tt>List</tt> of <tt>String</tt> objects + containing the values of the arguments passed to the method.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the return value of the method, or <code>null</code>. If the returned value + does not implement <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a>, it will be automatically + wrapped using the <a href="../../../../../org/apache/freemarker/core/Configurable.html#getObjectWrapper--"><code>environment + object wrapper</code></a>.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</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/TemplateMethodModel.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/model/TemplateMarkupOutputModel.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/TemplateMethodModelEx.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/TemplateMethodModel.html" target="_top">Frames</a></li> +<li><a href="TemplateMethodModel.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </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/model/TemplateMethodModelEx.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateMethodModelEx.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateMethodModelEx.html new file mode 100644 index 0000000..18720cd --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateMethodModelEx.html @@ -0,0 +1,273 @@ +<!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>TemplateMethodModelEx (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="TemplateMethodModelEx (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/TemplateMethodModelEx.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/model/TemplateMethodModel.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/TemplateMethodModelEx.html" target="_top">Frames</a></li> +<li><a href="TemplateMethodModelEx.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </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.model</div> +<h2 title="Interface TemplateMethodModelEx" class="title">Interface TemplateMethodModelEx</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../../org/apache/freemarker/core/model/TemplateMethodModel.html" title="interface in org.apache.freemarker.core.model">TemplateMethodModel</a>, <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/freemarker/core/model/impl/JavaMethodModel.html" title="class in org.apache.freemarker.core.model.impl">JavaMethodModel</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/ResourceBundleModel.html" title="class in org.apache.freemarker.core.model.impl">ResourceBundleModel</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">TemplateMethodModelEx</span> +extends <a href="../../../../../org/apache/freemarker/core/model/TemplateMethodModel.html" title="interface in org.apache.freemarker.core.model">TemplateMethodModel</a></pre> +<div class="block">"extended method" template language data type: Objects that act like functions. Their main application is calling + Java methods via <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl"><code>DefaultObjectWrapper</code></a>, but you can implement this interface to create + top-level functions too. They are "extended" compared to the deprecated <a href="../../../../../org/apache/freemarker/core/model/TemplateMethodModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateMethodModel</code></a>, which could only + accept string parameters. + + <p>In templates they are used like <code>myMethod(1, "foo")</code> or <code>myJavaObject.myJavaMethod(1, "foo")</code>.</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> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.freemarker.core.model.TemplateModel"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.freemarker.core.model.<a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a></h3> +<code><a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html#NOTHING">NOTHING</a></code></li> +</ul> +</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><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/model/TemplateMethodModelEx.html#exec-java.util.List-">exec</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a> arguments)</code> +<div class="block">Executes the method call.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="exec-java.util.List-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>exec</h4> +<pre><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> exec(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a> arguments) + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<div class="block">Executes the method call.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../org/apache/freemarker/core/model/TemplateMethodModel.html#exec-java.util.List-">exec</a></code> in interface <code><a href="../../../../../org/apache/freemarker/core/model/TemplateMethodModel.html" title="interface in org.apache.freemarker.core.model">TemplateMethodModel</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>arguments</code> - a <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util"><code>List</code></a> of <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a>-s, + containing the arguments passed to the method. If the implementation absolutely wants + to operate on POJOs, it can use the static utility methods in the <a href="../../../../../org/apache/freemarker/core/util/DeepUnwrap.html" title="class in org.apache.freemarker.core.util"><code>DeepUnwrap</code></a> + class to easily obtain them. However, unwrapping is not always possible (or not perfectly), and isn't always + efficient, so it's recommended to use the original <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> value as much as possible.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the return value of the method, or <code>null</code>. If the returned value + does not implement <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a>, it will be automatically + wrapped using the <a href="../../../../../org/apache/freemarker/core/Configurable.html#getObjectWrapper--"><code>environment's + object wrapper</code></a>.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</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/TemplateMethodModelEx.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/model/TemplateMethodModel.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/TemplateMethodModelEx.html" target="_top">Frames</a></li> +<li><a href="TemplateMethodModelEx.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </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/model/TemplateModel.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateModel.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateModel.html new file mode 100644 index 0000000..97c8235 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateModel.html @@ -0,0 +1,251 @@ +<!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>TemplateModel (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="TemplateModel (FreeMarker 3.0.0-nightly-incubating API)"; + } + } + catch(err) { + } +//--> +</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/TemplateModel.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/model/TemplateMethodModelEx.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/TemplateModelAdapter.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/TemplateModel.html" target="_top">Frames</a></li> +<li><a href="TemplateModel.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>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li>Method</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.model</div> +<h2 title="Interface TemplateModel" class="title">Interface TemplateModel</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../../org/apache/freemarker/core/model/AdapterTemplateModel.html" title="interface in org.apache.freemarker.core.model">AdapterTemplateModel</a>, <a href="../../../../../org/apache/freemarker/core/model/TemplateBooleanModel.html" title="interface in org.apache.freemarker.core.model">TemplateBooleanModel</a>, <a href="../../../../../org/apache/freemarker/core/model/TemplateCollectionModel.html" title="interface in org.apache.freemarker.core.model">TemplateCollectionModel</a>, <a href="../../../../../org/apache/freemarker/core/model/TemplateCollectionModelEx.html" title="interface in org.apache.freemarker.core.model">TemplateCollectionModelEx</a>, <a href="../../../../../org/apache/freemarker/core/model/TemplateDateModel.html" title="interface in org.apache.freemarker.core.model">TemplateDateModel</a>, <a href="../../../../../org/apache/freemarker/core/model/TemplateDirectiveModel.html" title="interface in org.apache.freemarker.core.model">TemplateDirectiveModel< /a>, <a href="../../../../../org/apache/freemarker/core/model/TemplateHashModel.html" title="interface in org.apache.freemarker.core.model">TemplateHashModel</a>, <a href="../../../../../org/apache/freemarker/core/model/TemplateHashModelEx.html" title="interface in org.apache.freemarker.core.model">TemplateHashModelEx</a>, <a href="../../../../../org/apache/freemarker/core/model/TemplateHashModelEx2.html" title="interface in org.apache.freemarker.core.model">TemplateHashModelEx2</a>, <a href="../../../../../org/apache/freemarker/core/model/TemplateMarkupOutputModel.html" title="interface in org.apache.freemarker.core.model">TemplateMarkupOutputModel</a><MO>, <a href="../../../../../org/apache/freemarker/core/model/TemplateMethodModel.html" title="interface in org.apache.freemarker.core.model">TemplateMethodModel</a>, <a href="../../../../../org/apache/freemarker/core/model/TemplateMethodModelEx.html" title="interface in org.apache.freemarker.core.model">TemplateMethodModelEx</ a>, <a href="../../../../../org/apache/freemarker/core/model/TemplateModelWithAPISupport.html" title="interface in org.apache.freemarker.core.model">TemplateModelWithAPISupport</a>, <a href="../../../../../org/apache/freemarker/core/model/TemplateNodeModel.html" title="interface in org.apache.freemarker.core.model">TemplateNodeModel</a>, <a href="../../../../../org/apache/freemarker/core/model/TemplateNodeModelEx.html" title="interface in org.apache.freemarker.core.model">TemplateNodeModelEx</a>, <a href="../../../../../org/apache/freemarker/core/model/TemplateNumberModel.html" title="interface in org.apache.freemarker.core.model">TemplateNumberModel</a>, <a href="../../../../../org/apache/freemarker/core/model/TemplateScalarModel.html" title="interface in org.apache.freemarker.core.model">TemplateScalarModel</a>, <a href="../../../../../org/apache/freemarker/core/model/TemplateSequenceModel.html" title="interface in org.apache.freemarker.core.model">TemplateSequenceModel</a>, <a hr ef="../../../../../org/apache/freemarker/core/model/TemplateTransformModel.html" title="interface in org.apache.freemarker.core.model">TemplateTransformModel</a>, <a href="../../../../../org/apache/freemarker/core/model/WrapperTemplateModel.html" title="interface in org.apache.freemarker.core.model">WrapperTemplateModel</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/freemarker/servlet/AllHttpScopesHashModel.html" title="class in org.apache.freemarker.servlet">AllHttpScopesHashModel</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/BeanAndStringModel.html" title="class in org.apache.freemarker.core.model.impl">BeanAndStringModel</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/BeanModel.html" title="class in org.apache.freemarker.core.model.impl">BeanModel</a>, <a href="../../../../../org/apache/freemarker/core/util/CaptureOutput.html" title="class in org.apache.freemarker.core.util">CaptureOutput</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/CollectionAndSequence.html" title="class in org.apache.freemarker.core.model.impl">CollectionAndSequence</a>, <a href="../../../../../org/apache/freemarker/core/outputformat/CommonTemplateMarkupOutputModel.html" title="class in org.apache.freemarker.core.outputformat">CommonTemplateMarkupOutputModel</a>, <a href=" ../../../../../org/apache/freemarker/core/model/impl/DefaultArrayAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultArrayAdapter</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultEnumerationAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultEnumerationAdapter</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultIterableAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultIterableAdapter</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultIteratorAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultIteratorAdapter</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultListAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultListAdapter</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultMapAdapter.html" title="class in org.apache.freemarker.core.model.impl">Def aultMapAdapter</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultNonListCollectionAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultNonListCollectionAdapter</a>, <a href="../../../../../org/apache/freemarker/core/Environment.Namespace.html" title="class in org.apache.freemarker.core">Environment.Namespace</a>, <a href="../../../../../org/apache/freemarker/core/util/HtmlEscape.html" title="class in org.apache.freemarker.core.util">HtmlEscape</a>, <a href="../../../../../org/apache/freemarker/servlet/HttpRequestHashModel.html" title="class in org.apache.freemarker.servlet">HttpRequestHashModel</a>, <a href="../../../../../org/apache/freemarker/servlet/HttpRequestParametersHashModel.html" title="class in org.apache.freemarker.servlet">HttpRequestParametersHashModel</a>, <a href="../../../../../org/apache/freemarker/servlet/HttpSessionHashModel.html" title="class in org.apache.freemarker.servlet">HttpSessionHashModel</a>, <a href="../../ ../../../org/apache/freemarker/servlet/IncludePage.html" title="class in org.apache.freemarker.servlet">IncludePage</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/JavaMethodModel.html" title="class in org.apache.freemarker.core.model.impl">JavaMethodModel</a>, <a href="../../../../../org/apache/freemarker/dom/NodeModel.html" title="class in org.apache.freemarker.dom">NodeModel</a>, <a href="../../../../../org/apache/freemarker/core/util/NormalizeNewlines.html" title="class in org.apache.freemarker.core.util">NormalizeNewlines</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/ResourceBundleModel.html" title="class in org.apache.freemarker.core.model.impl">ResourceBundleModel</a>, <a href="../../../../../org/apache/freemarker/servlet/ServletContextHashModel.html" title="class in org.apache.freemarker.servlet">ServletContextHashModel</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/SimpleCollection.html" title="class in org.apache. freemarker.core.model.impl">SimpleCollection</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/SimpleDate.html" title="class in org.apache.freemarker.core.model.impl">SimpleDate</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/SimpleHash.html" title="class in org.apache.freemarker.core.model.impl">SimpleHash</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/SimpleNumber.html" title="class in org.apache.freemarker.core.model.impl">SimpleNumber</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/SimpleScalar.html" title="class in org.apache.freemarker.core.model.impl">SimpleScalar</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/SimpleSequence.html" title="class in org.apache.freemarker.core.model.impl">SimpleSequence</a>, <a href="../../../../../org/apache/freemarker/core/util/StandardCompress.html" title="class in org.apache.freemarker.core.util">StandardCompress</a>, <a href="../../../../../org/apa che/freemarker/servlet/jsp/TaglibFactory.html" title="class in org.apache.freemarker.servlet.jsp">TaglibFactory</a>, <a href="../../../../../org/apache/freemarker/core/outputformat/impl/TemplateCombinedMarkupOutputModel.html" title="class in org.apache.freemarker.core.outputformat.impl">TemplateCombinedMarkupOutputModel</a>, <a href="../../../../../org/apache/freemarker/core/outputformat/impl/TemplateHTMLOutputModel.html" title="class in org.apache.freemarker.core.outputformat.impl">TemplateHTMLOutputModel</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/TemplateModelListSequence.html" title="class in org.apache.freemarker.core.model.impl">TemplateModelListSequence</a>, <a href="../../../../../org/apache/freemarker/core/outputformat/impl/TemplateRTFOutputModel.html" title="class in org.apache.freemarker.core.outputformat.impl">TemplateRTFOutputModel</a>, <a href="../../../../../org/apache/freemarker/core/outputformat/impl/TemplateXHTMLOutputModel.html" title="class in org.apache.freemarker.core.outputformat.impl">TemplateXHTMLOutputModel</a>, <a href="../../../../../org/apache/freemarker/core/outputformat/impl/TemplateXMLOutputModel.html" title="class in org.apache.freemarker.core.outputformat.impl">TemplateXMLOutputModel</a>, <a href="../../../../../org/apache/freemarker/core/util/XmlEscape.html" title="class in org.apache.freemarker.core.util">XmlEscape</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">TemplateModel</span></pre> +<div class="block">The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types. + The template language only deals with <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a>-s, not directly with plain Java objects. (For example, + it doesn't understand <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true"; title="class or interface in java.lang"><code>Number</code></a>, but <a href="../../../../../org/apache/freemarker/core/model/TemplateNumberModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateNumberModel</code></a>.) This is why the + data-model (aka. the "template context" in other languages) is (automatically) mapped to a tree of + <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a>-s. + + <p>Mapping the plain Java objects to <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a>-s (or the other way around sometimes) is the + responsibility of the <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model"><code>ObjectWrapper</code></a> (can be set via <a href="../../../../../org/apache/freemarker/core/Configuration.html#setObjectWrapper-org.apache.freemarker.core.model.ObjectWrapper-"><code>Configuration.setObjectWrapper(ObjectWrapper)</code></a>). + But not all <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a>-s are for wrapping a plain object. For example, a value created within a template + is not made to wrap an earlier existing object; it's a value that has always existed in the template language's + domain. Users can also write <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> implementations and put them directly into the data-model for + full control over how that object is seen from the template. Certain <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> interfaces doesn't + even have equivalent in Java. For example the directive type (<a href="../../../../../org/apache/freemarker/core/model/TemplateDirectiveModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateDirectiveModel</code></a>) is like that. + + <p>Because <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> "subclasses" are all interfaces, a value in the template language can have multiple + types. However, to prevent ambiguous situations, it's not recommended to make values that implement more than one of + these types: string, number, boolean, date. The intended applications are like string+hash, string+method, + hash+sequence, etc.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/freemarker/core/util/FTLUtil.html#getTypeDescription-org.apache.freemarker.core.model.TemplateModel-"><code>FTLUtil.getTypeDescription(TemplateModel)</code></a></dd> +</dl> +</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/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html#NOTHING">NOTHING</a></span></code> +<div class="block">A general-purpose object to represent nothing.</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="NOTHING"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>NOTHING</h4> +<pre>static final <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a> NOTHING</pre> +<div class="block">A general-purpose object to represent nothing. It acts as + an empty string, false, empty sequence, empty hash, and + null-returning method model.</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/TemplateModel.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/model/TemplateMethodModelEx.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/TemplateModelAdapter.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/TemplateModel.html" target="_top">Frames</a></li> +<li><a href="TemplateModel.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>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li>Method</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/model/TemplateModelAdapter.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateModelAdapter.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateModelAdapter.html new file mode 100644 index 0000000..fc34357 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateModelAdapter.html @@ -0,0 +1,231 @@ +<!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>TemplateModelAdapter (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="TemplateModelAdapter (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/TemplateModelAdapter.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/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/TemplateModelAdapter.html" target="_top">Frames</a></li> +<li><a href="TemplateModelAdapter.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </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.model</div> +<h2 title="Interface TemplateModelAdapter" class="title">Interface TemplateModelAdapter</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">TemplateModelAdapter</span></pre> +<div class="block">Implemented by classes that serve as adapters for template model objects in + some other object model. Actually a functional inverse of + <a href="../../../../../org/apache/freemarker/core/model/AdapterTemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>AdapterTemplateModel</code></a>. You will rarely implement this interface + directly. It is usually implemented by unwrapping adapter classes of various + object wrapper implementations.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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><a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateModelAdapter.html#getTemplateModel--">getTemplateModel</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getTemplateModel--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getTemplateModel</h4> +<pre><a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a> getTemplateModel()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the template model this object is wrapping.</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/TemplateModelAdapter.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/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/TemplateModelAdapter.html" target="_top">Frames</a></li> +<li><a href="TemplateModelAdapter.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </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/model/TemplateModelException.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateModelException.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateModelException.html new file mode 100644 index 0000000..9b8ab50 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateModelException.html @@ -0,0 +1,452 @@ +<!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>TemplateModelException (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="TemplateModelException (FreeMarker 3.0.0-nightly-incubating API)"; + } + } + catch(err) { + } +//--> +</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/TemplateModelException.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/model/TemplateModelAdapter.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/TemplateModelIterator.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/TemplateModelException.html" target="_top">Frames</a></li> +<li><a href="TemplateModelException.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="#methods.inherited.from.class.org.apache.freemarker.core.TemplateException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</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.model</div> +<h2 title="Class TemplateModelException" class="title">Class TemplateModelException</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="../../../../../org/apache/freemarker/core/TemplateException.html" title="class in org.apache.freemarker.core">org.apache.freemarker.core.TemplateException</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.freemarker.core.model.TemplateModelException</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> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/freemarker/core/model/impl/InvalidPropertyException.html" title="class in org.apache.freemarker.core.model.impl">InvalidPropertyException</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">TemplateModelException</span> +extends <a href="../../../../../org/apache/freemarker/core/TemplateException.html" title="class in org.apache.freemarker.core">TemplateException</a></pre> +<div class="block"><a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> methods throw this exception if the requested data can't be retrieved.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.freemarker.core.model.TemplateModelException">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/model/TemplateModelException.html#TemplateModelException--">TemplateModelException</a></span>()</code> +<div class="block">Constructs a <tt>TemplateModelException</tt> with no + specified detail message.</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/model/TemplateModelException.html#TemplateModelException-java.lang.Exception-">TemplateModelException</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)</code> +<div class="block">The same as <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html#TemplateModelException-java.lang.Throwable-"><code>TemplateModelException(Throwable)</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/model/TemplateModelException.html#TemplateModelException-java.lang.String-">TemplateModelException</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)</code> +<div class="block">Constructs a <tt>TemplateModelException</tt> with the + specified detail message.</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/model/TemplateModelException.html#TemplateModelException-java.lang.String-java.lang.Exception-">TemplateModelException</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)</code> +<div class="block">The same as <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html#TemplateModelException-java.lang.String-java.lang.Throwable-"><code>TemplateModelException(String, Throwable)</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/model/TemplateModelException.html#TemplateModelException-java.lang.String-java.lang.Throwable-">TemplateModelException</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)</code> +<div class="block">Constructs a TemplateModelException 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/model/TemplateModelException.html#TemplateModelException-java.lang.Throwable-">TemplateModelException</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)</code> +<div class="block">Constructs a <tt>TemplateModelException</tt> 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/model/TemplateModelException.html#TemplateModelException-java.lang.Throwable-org.apache.freemarker.core.Environment-org.apache.freemarker.core._ErrorDescriptionBuilder-boolean-">TemplateModelException</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._ErrorDescriptionBuilder descriptionBuilder, + boolean preventAmbiguity)</code> +<div class="block">Don't use this; this is to be used internally by FreeMarker.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html#TemplateModelException-java.lang.Throwable-org.apache.freemarker.core.Environment-java.lang.String-boolean-">TemplateModelException</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, + <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, + boolean preventAmbiguity)</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> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.freemarker.core.TemplateException"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.freemarker.core.<a href="../../../../../org/apache/freemarker/core/TemplateException.html" title="class in org.apache.freemarker.core">TemplateException</a></h3> +<code><a href="../../../../../org/apache/freemarker/core/TemplateException.html#getBlamedExpressionString--">getBlamedExpressionString</a>, <a href="../../../../../org/apache/freemarker/core/TemplateException.html#getColumnNumber--">getColumnNumber</a>, <a href="../../../../../org/apache/freemarker/core/TemplateException.html#getEndColumnNumber--">getEndColumnNumber</a>, <a href="../../../../../org/apache/freemarker/core/TemplateException.html#getEndLineNumber--">getEndLineNumber</a>, <a href="../../../../../org/apache/freemarker/core/TemplateException.html#getEnvironment--">getEnvironment</a>, <a href="../../../../../org/apache/freemarker/core/TemplateException.html#getFTLInstructionStack--">getFTLInstructionStack</a>, <a href="../../../../../org/apache/freemarker/core/TemplateException.html#getLineNumber--">getLineNumber</a>, <a href="../../../../../org/apache/freemarker/core/TemplateException.html#getMessage--">getMessage</a>, <a href="../../../../../org/apache/freemarker/core/Te mplateException.html#getMessageWithoutStackTop--">getMessageWithoutStackTop</a>, <a href="../../../../../org/apache/freemarker/core/TemplateException.html#getTemplateSourceName--">getTemplateSourceName</a>, <a href="../../../../../org/apache/freemarker/core/TemplateException.html#printStackTrace-java.io.PrintStream-">printStackTrace</a>, <a href="../../../../../org/apache/freemarker/core/TemplateException.html#printStackTrace-java.io.PrintStream-boolean-boolean-boolean-">printStackTrace</a>, <a href="../../../../../org/apache/freemarker/core/TemplateException.html#printStackTrace-java.io.PrintWriter-">printStackTrace</a>, <a href="../../../../../org/apache/freemarker/core/TemplateException.html#printStackTrace-java.io.PrintWriter-boolean-boolean-boolean-">printStackTrace</a>, <a href="../../../../../org/apache/freemarker/core/TemplateException.html#printStandardStackTrace-java.io.PrintStream-">printStandardStackTrace</a>, <a href="../../../../../org/apache/freemarker/core/TemplateEx ception.html#printStandardStackTrace-java.io.PrintWriter-">printStandardStackTrace</a></code></li> +</ul> +<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="TemplateModelException--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TemplateModelException</h4> +<pre>public TemplateModelException()</pre> +<div class="block">Constructs a <tt>TemplateModelException</tt> with no + specified detail message.</div> +</li> +</ul> +<a name="TemplateModelException-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TemplateModelException</h4> +<pre>public TemplateModelException(<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)</pre> +<div class="block">Constructs a <tt>TemplateModelException</tt> with the + specified detail message.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>description</code> - the detail message.</dd> +</dl> +</li> +</ul> +<a name="TemplateModelException-java.lang.Exception-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TemplateModelException</h4> +<pre>public TemplateModelException(<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)</pre> +<div class="block">The same as <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html#TemplateModelException-java.lang.Throwable-"><code>TemplateModelException(Throwable)</code></a>; it's exists only for binary + backward-compatibility.</div> +</li> +</ul> +<a name="TemplateModelException-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TemplateModelException</h4> +<pre>public TemplateModelException(<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)</pre> +<div class="block">Constructs a <tt>TemplateModelException</tt> 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> +</dl> +</li> +</ul> +<a name="TemplateModelException-java.lang.String-java.lang.Exception-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TemplateModelException</h4> +<pre>public TemplateModelException(<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)</pre> +<div class="block">The same as <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html#TemplateModelException-java.lang.String-java.lang.Throwable-"><code>TemplateModelException(String, Throwable)</code></a>; it's exists only for binary + backward-compatibility.</div> +</li> +</ul> +<a name="TemplateModelException-java.lang.String-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TemplateModelException</h4> +<pre>public TemplateModelException(<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)</pre> +<div class="block">Constructs a TemplateModelException 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> +</dl> +</li> +</ul> +<a name="TemplateModelException-java.lang.Throwable-org.apache.freemarker.core.Environment-java.lang.String-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TemplateModelException</h4> +<pre>protected TemplateModelException(<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, + <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, + boolean preventAmbiguity)</pre> +<div class="block">Don't use this; this is to be used internally by FreeMarker.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>preventAmbiguity</code> - its value is ignored; it's only to prevent constructor selection ambiguities for + backward-compatibility</dd> +</dl> +</li> +</ul> +<a name="TemplateModelException-java.lang.Throwable-org.apache.freemarker.core.Environment-org.apache.freemarker.core._ErrorDescriptionBuilder-boolean-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TemplateModelException</h4> +<pre>protected TemplateModelException(<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._ErrorDescriptionBuilder descriptionBuilder, + boolean preventAmbiguity)</pre> +<div class="block">Don't use this; this is to be used internally by FreeMarker.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>preventAmbiguity</code> - its value is ignored; it's only to prevent constructor selection ambiguities for + backward-compatibility</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/TemplateModelException.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/model/TemplateModelAdapter.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/TemplateModelIterator.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/TemplateModelException.html" target="_top">Frames</a></li> +<li><a href="TemplateModelException.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="#methods.inherited.from.class.org.apache.freemarker.core.TemplateException">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
