http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/TemplateModelIterator.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateModelIterator.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateModelIterator.html new file mode 100644 index 0000000..68a8b70 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateModelIterator.html @@ -0,0 +1,253 @@ +<!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>TemplateModelIterator (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="TemplateModelIterator (FreeMarker 3.0.0-nightly-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":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/TemplateModelIterator.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/TemplateModelException.html" title="class in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/TemplateModelWithAPISupport.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/TemplateModelIterator.html" target="_top">Frames</a></li> +<li><a href="TemplateModelIterator.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 TemplateModelIterator" class="title">Interface TemplateModelIterator</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">TemplateModelIterator</span></pre> +<div class="block">Used to iterate over a set of template models <em>once</em>; usually returned from + <a href="../../../../../org/apache/freemarker/core/model/TemplateCollectionModel.html#iterator--"><code>TemplateCollectionModel.iterator()</code></a>. Note that it's not a <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a>.</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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateModelIterator.html#hasNext--">hasNext</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<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/TemplateModelIterator.html#next--">next</a></span>()</code> +<div class="block">Returns the next model.</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="next--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>next</h4> +<pre><a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a> next() + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<div class="block">Returns the next model.</div> +<dl> +<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> - if the next model can not be retrieved + (i.e. because the iterator is exhausted).</dd> +</dl> +</li> +</ul> +<a name="hasNext--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>hasNext</h4> +<pre>boolean hasNext() + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether there are any more items to iterate over.</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/TemplateModelIterator.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/TemplateModelException.html" title="class in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/TemplateModelWithAPISupport.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/TemplateModelIterator.html" target="_top">Frames</a></li> +<li><a href="TemplateModelIterator.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/TemplateModelWithAPISupport.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateModelWithAPISupport.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateModelWithAPISupport.html new file mode 100644 index 0000000..0e5136b --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateModelWithAPISupport.html @@ -0,0 +1,264 @@ +<!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>TemplateModelWithAPISupport (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="TemplateModelWithAPISupport (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/TemplateModelWithAPISupport.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/TemplateModelIterator.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/TemplateNodeModel.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/TemplateModelWithAPISupport.html" target="_top">Frames</a></li> +<li><a href="TemplateModelWithAPISupport.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 TemplateModelWithAPISupport" class="title">Interface TemplateModelWithAPISupport</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 Implementing Classes:</dt> +<dd><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/model/impl/DefaultIterableAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultIterableAdapter</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">DefaultMapAdapter</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultNonListCollectionAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultNonListCollec tionAdapter</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">TemplateModelWithAPISupport</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"><b>Experimental - subject to change:</b> A <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> on which the <code>?api</code> operation can be applied. + + <p> + <b>Experimental status warning:</b> This interface is subject to change on non-backward compatible ways, hence, it + shouldn't be implemented outside FreeMarker yet.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.22</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> +<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="../../../../../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/TemplateModelWithAPISupport.html#getAPI--">getAPI</a></span>()</code> +<div class="block">Returns the model that exposes the (Java) API of the value.</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="getAPI--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAPI</h4> +<pre><a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a> getAPI() + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<div class="block">Returns the model that exposes the (Java) API of the value. This is usually implemented by delegating to + <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperWithAPISupport.html#wrapAsAPI-java.lang.Object-"><code>ObjectWrapperWithAPISupport.wrapAsAPI(Object)</code></a>.</div> +<dl> +<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/TemplateModelWithAPISupport.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/TemplateModelIterator.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/TemplateNodeModel.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/TemplateModelWithAPISupport.html" target="_top">Frames</a></li> +<li><a href="TemplateModelWithAPISupport.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/TemplateNodeModel.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateNodeModel.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateNodeModel.html new file mode 100644 index 0000000..40de5a2 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateNodeModel.html @@ -0,0 +1,366 @@ +<!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>TemplateNodeModel (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="TemplateNodeModel (FreeMarker 3.0.0-nightly-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":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/TemplateNodeModel.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/TemplateModelWithAPISupport.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/TemplateNodeModelEx.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/TemplateNodeModel.html" target="_top">Frames</a></li> +<li><a href="TemplateNodeModel.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 TemplateNodeModel" class="title">Interface TemplateNodeModel</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/TemplateNodeModelEx.html" title="interface in org.apache.freemarker.core.model">TemplateNodeModelEx</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/freemarker/dom/NodeModel.html" title="class in org.apache.freemarker.dom">NodeModel</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">TemplateNodeModel</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">"node" template language data type: an object that is a node in a tree. + A tree of nodes can be recursively <em>visited</em> using the <#visit...> and <#recurse...> + directives. This API is largely based on the W3C Document Object Model + (DOM_WRAPPER) API. However, it's meant to be generally useful for describing + any tree of objects that you wish to navigate using a recursive visitor + design pattern (or simply through being able to get the parent + and child nodes). + + <p>See the <a href="http://freemarker.org/docs/xgui.html" target="_blank">XML + Processing Guide</a> for a concrete application.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>FreeMarker 2.3</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> +<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="../../../../../org/apache/freemarker/core/model/TemplateSequenceModel.html" title="interface in org.apache.freemarker.core.model">TemplateSequenceModel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateNodeModel.html#getChildNodes--">getChildNodes</a></span>()</code> </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/model/TemplateNodeModel.html#getNodeName--">getNodeName</a></span>()</code> </td> +</tr> +<tr id="i2" 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/model/TemplateNodeModel.html#getNodeNamespace--">getNodeNamespace</a></span>()</code> </td> +</tr> +<tr id="i3" 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/model/TemplateNodeModel.html#getNodeType--">getNodeType</a></span>()</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/freemarker/core/model/TemplateNodeModel.html" title="interface in org.apache.freemarker.core.model">TemplateNodeModel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateNodeModel.html#getParentNode--">getParentNode</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="getParentNode--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getParentNode</h4> +<pre><a href="../../../../../org/apache/freemarker/core/model/TemplateNodeModel.html" title="interface in org.apache.freemarker.core.model">TemplateNodeModel</a> getParentNode() + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the parent of this node or null, in which case + this node is the root of the tree.</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> +<a name="getChildNodes--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getChildNodes</h4> +<pre><a href="../../../../../org/apache/freemarker/core/model/TemplateSequenceModel.html" title="interface in org.apache.freemarker.core.model">TemplateSequenceModel</a> getChildNodes() + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a sequence containing this node's children. + If the returned value is null or empty, this is essentially + a leaf node.</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> +<a name="getNodeName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNodeName</h4> +<pre><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> getNodeName() + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a String that is used to determine the processing + routine to use. In the XML implementation, if the node + is an element, it returns the element's tag name. If it + is an attribute, it returns the attribute's name. It + returns "@text" for text nodes, "@pi" for processing instructions, + and so on.</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> +<a name="getNodeType--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNodeType</h4> +<pre><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> getNodeType() + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a String describing the <em>type</em> of node this is. + In the W3C DOM_WRAPPER, this should be "element", "text", "attribute", etc. + A TemplateNodeModel implementation that models other kinds of + trees could return whatever it appropriate for that application. It + can be null, if you don't want to use node-types.</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> +<a name="getNodeNamespace--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getNodeNamespace</h4> +<pre><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> getNodeNamespace() + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the XML namespace URI with which this node is + associated. If this TemplateNodeModel implementation is + not XML-related, it will almost certainly be null. Even + for XML nodes, this will often be null.</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/TemplateNodeModel.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/TemplateModelWithAPISupport.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/TemplateNodeModelEx.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/TemplateNodeModel.html" target="_top">Frames</a></li> +<li><a href="TemplateNodeModel.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/TemplateNodeModelEx.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateNodeModelEx.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateNodeModelEx.html new file mode 100644 index 0000000..cd8acdd --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateNodeModelEx.html @@ -0,0 +1,285 @@ +<!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>TemplateNodeModelEx (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="TemplateNodeModelEx (FreeMarker 3.0.0-nightly-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":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/TemplateNodeModelEx.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/TemplateNodeModel.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/TemplateNumberModel.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/TemplateNodeModelEx.html" target="_top">Frames</a></li> +<li><a href="TemplateNodeModelEx.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 TemplateNodeModelEx" class="title">Interface TemplateNodeModelEx</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>, <a href="../../../../../org/apache/freemarker/core/model/TemplateNodeModel.html" title="interface in org.apache.freemarker.core.model">TemplateNodeModel</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/freemarker/dom/NodeModel.html" title="class in org.apache.freemarker.dom">NodeModel</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">TemplateNodeModelEx</span> +extends <a href="../../../../../org/apache/freemarker/core/model/TemplateNodeModel.html" title="interface in org.apache.freemarker.core.model">TemplateNodeModel</a></pre> +<div class="block">A <a href="../../../../../org/apache/freemarker/dom/NodeModel.html" title="class in org.apache.freemarker.dom"><code>NodeModel</code></a> that supports navigating to the previous and next sibling nodes.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.26</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> +<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="../../../../../org/apache/freemarker/core/model/TemplateNodeModelEx.html" title="interface in org.apache.freemarker.core.model">TemplateNodeModelEx</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateNodeModelEx.html#getNextSibling--">getNextSibling</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/freemarker/core/model/TemplateNodeModelEx.html" title="interface in org.apache.freemarker.core.model">TemplateNodeModelEx</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateNodeModelEx.html#getPreviousSibling--">getPreviousSibling</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.freemarker.core.model.TemplateNodeModel"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.freemarker.core.model.<a href="../../../../../org/apache/freemarker/core/model/TemplateNodeModel.html" title="interface in org.apache.freemarker.core.model">TemplateNodeModel</a></h3> +<code><a href="../../../../../org/apache/freemarker/core/model/TemplateNodeModel.html#getChildNodes--">getChildNodes</a>, <a href="../../../../../org/apache/freemarker/core/model/TemplateNodeModel.html#getNodeName--">getNodeName</a>, <a href="../../../../../org/apache/freemarker/core/model/TemplateNodeModel.html#getNodeNamespace--">getNodeNamespace</a>, <a href="../../../../../org/apache/freemarker/core/model/TemplateNodeModel.html#getNodeType--">getNodeType</a>, <a href="../../../../../org/apache/freemarker/core/model/TemplateNodeModel.html#getParentNode--">getParentNode</a></code></li> +</ul> +</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="getPreviousSibling--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPreviousSibling</h4> +<pre><a href="../../../../../org/apache/freemarker/core/model/TemplateNodeModelEx.html" title="interface in org.apache.freemarker.core.model">TemplateNodeModelEx</a> getPreviousSibling() + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The immediate previous sibling of this node, or <code>null</code> if there's no such node.</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> +<a name="getNextSibling--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getNextSibling</h4> +<pre><a href="../../../../../org/apache/freemarker/core/model/TemplateNodeModelEx.html" title="interface in org.apache.freemarker.core.model">TemplateNodeModelEx</a> getNextSibling() + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The immediate next sibling of this node, or <code>null</code> if there's no such node.</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/TemplateNodeModelEx.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/TemplateNodeModel.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/TemplateNumberModel.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/TemplateNodeModelEx.html" target="_top">Frames</a></li> +<li><a href="TemplateNodeModelEx.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/TemplateNumberModel.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateNumberModel.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateNumberModel.html new file mode 100644 index 0000000..8735fab --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateNumberModel.html @@ -0,0 +1,263 @@ +<!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>TemplateNumberModel (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="TemplateNumberModel (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/TemplateNumberModel.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/TemplateNodeModelEx.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/TemplateScalarModel.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/TemplateNumberModel.html" target="_top">Frames</a></li> +<li><a href="TemplateNumberModel.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 TemplateNumberModel" class="title">Interface TemplateNumberModel</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 Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/freemarker/core/model/impl/SimpleNumber.html" title="class in org.apache.freemarker.core.model.impl">SimpleNumber</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">TemplateNumberModel</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">"number" template language data type; an object that stores a number. There's only one numerical type as far as the + template language is concerned, but it can store its value using whatever Java number type. Making operations between + numbers (and so the coercion rules) is up to the <a href="../../../../../org/apache/freemarker/core/arithmetic/ArithmeticEngine.html" title="class in org.apache.freemarker.core.arithmetic"><code>ArithmeticEngine</code></a>. + + <p> + Objects of this type should be immutable, that is, calling <a href="../../../../../org/apache/freemarker/core/model/TemplateNumberModel.html#getAsNumber--"><code>getAsNumber()</code></a> should always return the same value + as for the first time.</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/Number.html?is-external=true" title="class or interface in java.lang">Number</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateNumberModel.html#getAsNumber--">getAsNumber</a></span>()</code> +<div class="block">Returns the numeric value.</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="getAsNumber--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAsNumber</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Number.html?is-external=true" title="class or interface in java.lang">Number</a> getAsNumber() + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<div class="block">Returns the numeric value. The return value must not be <code>null</code>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the <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> instance associated with this number model.</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/TemplateNumberModel.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/TemplateNodeModelEx.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/TemplateScalarModel.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/TemplateNumberModel.html" target="_top">Frames</a></li> +<li><a href="TemplateNumberModel.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/TemplateScalarModel.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateScalarModel.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateScalarModel.html new file mode 100644 index 0000000..c17e234 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateScalarModel.html @@ -0,0 +1,292 @@ +<!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>TemplateScalarModel (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="TemplateScalarModel (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/TemplateScalarModel.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/TemplateNumberModel.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/TemplateSequenceModel.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/TemplateScalarModel.html" target="_top">Frames</a></li> +<li><a href="TemplateScalarModel.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.model</div> +<h2 title="Interface TemplateScalarModel" class="title">Interface TemplateScalarModel</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 Implementing Classes:</dt> +<dd><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/SimpleScalar.html" title="class in org.apache.freemarker.core.model.impl">SimpleScalar</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">TemplateScalarModel</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">"string" template language data-type; like in Java, an unmodifiable UNICODE character sequence. + (The name of this interface should be <code>TemplateStringModel</code>. The misnomer is inherited from the + old times, when this was the only single-value type in FreeMarker.)</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/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/TemplateScalarModel.html#EMPTY_STRING">EMPTY_STRING</a></span></code> +<div class="block">A constant value to use as the empty string.</div> +</td> +</tr> +</table> +<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/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/model/TemplateScalarModel.html#getAsString--">getAsString</a></span>()</code> +<div class="block">Returns the string representation of this model.</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="EMPTY_STRING"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EMPTY_STRING</h4> +<pre>static final <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a> EMPTY_STRING</pre> +<div class="block">A constant value to use as the empty string.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getAsString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAsString</h4> +<pre><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> getAsString() + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<div class="block">Returns the string representation of this model. Don't return <code>null</code>, as that will cause exception. + + <p> + Objects of this type should be immutable, that is, calling <a href="../../../../../org/apache/freemarker/core/model/TemplateScalarModel.html#getAsString--"><code>getAsString()</code></a> should always return the same + value as for the first time.</div> +<dl> +<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/TemplateScalarModel.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/TemplateNumberModel.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/TemplateSequenceModel.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/TemplateScalarModel.html" target="_top">Frames</a></li> +<li><a href="TemplateScalarModel.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>
