http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/TemplateBooleanModel.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateBooleanModel.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateBooleanModel.html new file mode 100644 index 0000000..30dd1cd --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateBooleanModel.html @@ -0,0 +1,301 @@ +<!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>TemplateBooleanModel (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="TemplateBooleanModel (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/TemplateBooleanModel.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/RichObjectWrapper.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/TemplateCollectionModel.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/TemplateBooleanModel.html" target="_top">Frames</a></li> +<li><a href="TemplateBooleanModel.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 TemplateBooleanModel" class="title">Interface TemplateBooleanModel</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> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">TemplateBooleanModel</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">"boolean" template language data type; same as in Java; either <code>true</code> or <code>false</code>. + + <p> + Objects of this type should be immutable, that is, calling <a href="../../../../../org/apache/freemarker/core/model/TemplateBooleanModel.html#getAsBoolean--"><code>getAsBoolean()</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> +<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/TemplateBooleanModel.html" title="interface in org.apache.freemarker.core.model">TemplateBooleanModel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateBooleanModel.html#FALSE">FALSE</a></span></code> +<div class="block">A singleton object to represent boolean false</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/freemarker/core/model/TemplateBooleanModel.html" title="interface in org.apache.freemarker.core.model">TemplateBooleanModel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateBooleanModel.html#TRUE">TRUE</a></span></code> +<div class="block">A singleton object to represent boolean true</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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateBooleanModel.html#getAsBoolean--">getAsBoolean</a></span>()</code> </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="FALSE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FALSE</h4> +<pre>static final <a href="../../../../../org/apache/freemarker/core/model/TemplateBooleanModel.html" title="interface in org.apache.freemarker.core.model">TemplateBooleanModel</a> FALSE</pre> +<div class="block">A singleton object to represent boolean false</div> +</li> +</ul> +<a name="TRUE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TRUE</h4> +<pre>static final <a href="../../../../../org/apache/freemarker/core/model/TemplateBooleanModel.html" title="interface in org.apache.freemarker.core.model">TemplateBooleanModel</a> TRUE</pre> +<div class="block">A singleton object to represent boolean true</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getAsBoolean--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAsBoolean</h4> +<pre>boolean getAsBoolean() + 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 to interpret this object as true or false in a boolean context</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/TemplateBooleanModel.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/RichObjectWrapper.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/TemplateCollectionModel.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/TemplateBooleanModel.html" target="_top">Frames</a></li> +<li><a href="TemplateBooleanModel.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/TemplateCollectionModel.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateCollectionModel.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateCollectionModel.html new file mode 100644 index 0000000..bbad62d --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateCollectionModel.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>TemplateCollectionModel (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="TemplateCollectionModel (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/TemplateCollectionModel.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/TemplateBooleanModel.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/TemplateCollectionModelEx.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/TemplateCollectionModel.html" target="_top">Frames</a></li> +<li><a href="TemplateCollectionModel.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 TemplateCollectionModel" class="title">Interface TemplateCollectionModel</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/TemplateCollectionModelEx.html" title="interface in org.apache.freemarker.core.model">TemplateCollectionModelEx</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><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/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/DefaultNonListCollectionAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultNonListCollectionAdapter</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/SimpleCollection.html" title="class in org.apache.freemarker.core.model.impl">SimpleCollection</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">TemplateCollectionModel</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">"collection" template language data type: a collection of values that can be enumerated, but can't be or not meant to + be accessed by index or key. As such, this is not a super-interface of <a href="../../../../../org/apache/freemarker/core/model/TemplateSequenceModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateSequenceModel</code></a>, and + implementations of that interface needn't also implement this interface just because they can. They should though, if + enumeration with this interface is significantly faster than enumeration by index. The <code>#list</code> directive will + enumerate using this interface if it's available. + + <p> + The enumeration should be repeatable if that's possible with reasonable effort, otherwise a second enumeration + attempt is allowed to throw an <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model"><code>TemplateModelException</code></a>. Generally, the interface user Java code need not + handle that kind of exception, as in practice only the template author can handle it, by not listing such collections + twice. + + <p> + Note that to wrap Java's <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util"><code>Collection</code></a>, you should implement <a href="../../../../../org/apache/freemarker/core/model/TemplateCollectionModelEx.html" title="interface in org.apache.freemarker.core.model"><code>TemplateCollectionModelEx</code></a>, not just this + interface.</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="../../../../../org/apache/freemarker/core/model/TemplateModelIterator.html" title="interface in org.apache.freemarker.core.model">TemplateModelIterator</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateCollectionModel.html#iterator--">iterator</a></span>()</code> +<div class="block">Retrieves a template model iterator that is used to iterate over the elements in this collection.</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="iterator--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>iterator</h4> +<pre><a href="../../../../../org/apache/freemarker/core/model/TemplateModelIterator.html" title="interface in org.apache.freemarker.core.model">TemplateModelIterator</a> iterator() + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<div class="block">Retrieves a template model iterator that is used to iterate over the elements in this collection.</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/TemplateCollectionModel.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/TemplateBooleanModel.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/TemplateCollectionModelEx.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/TemplateCollectionModel.html" target="_top">Frames</a></li> +<li><a href="TemplateCollectionModel.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/TemplateCollectionModelEx.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateCollectionModelEx.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateCollectionModelEx.html new file mode 100644 index 0000000..4722ee1 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateCollectionModelEx.html @@ -0,0 +1,316 @@ +<!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>TemplateCollectionModelEx (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="TemplateCollectionModelEx (FreeMarker 3.0.0-nightly-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":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/TemplateCollectionModelEx.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/TemplateCollectionModel.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/TemplateDateModel.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/TemplateCollectionModelEx.html" target="_top">Frames</a></li> +<li><a href="TemplateCollectionModelEx.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 TemplateCollectionModelEx" class="title">Interface TemplateCollectionModelEx</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/TemplateCollectionModel.html" title="interface in org.apache.freemarker.core.model">TemplateCollectionModel</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/DefaultNonListCollectionAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultNonListCollectionAdapter</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">TemplateCollectionModelEx</span> +extends <a href="../../../../../org/apache/freemarker/core/model/TemplateCollectionModel.html" title="interface in org.apache.freemarker.core.model">TemplateCollectionModel</a></pre> +<div class="block">"extended collection" template language data type: Adds size/emptiness querybility and "contains" test to + <a href="../../../../../org/apache/freemarker/core/model/TemplateCollectionModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateCollectionModel</code></a>. The added extra operations is provided by all Java <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util"><code>Collection</code></a>-s, and + this interface was added to make that accessible for templates too.</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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateCollectionModelEx.html#contains-org.apache.freemarker.core.model.TemplateModel-">contains</a></span>(<a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a> item)</code> +<div class="block">Tells if a given value occurs in the collection, according the rules of the wrapped collection.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateCollectionModelEx.html#isEmpty--">isEmpty</a></span>()</code> +<div class="block">Returns if the collection contains any elements.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateCollectionModelEx.html#size--">size</a></span>()</code> +<div class="block">Returns the number items in this collection, or <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true#MAX_VALUE"; title="class or interface in java.lang"><code>Integer.MAX_VALUE</code></a>, if there are more than + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true#MAX_VALUE"; title="class or interface in java.lang"><code>Integer.MAX_VALUE</code></a> items.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.freemarker.core.model.TemplateCollectionModel"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.freemarker.core.model.<a href="../../../../../org/apache/freemarker/core/model/TemplateCollectionModel.html" title="interface in org.apache.freemarker.core.model">TemplateCollectionModel</a></h3> +<code><a href="../../../../../org/apache/freemarker/core/model/TemplateCollectionModel.html#iterator--">iterator</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="size--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>size</h4> +<pre>int size() + 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 number items in this collection, or <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true#MAX_VALUE"; title="class or interface in java.lang"><code>Integer.MAX_VALUE</code></a>, if there are more than + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true#MAX_VALUE"; title="class or interface in java.lang"><code>Integer.MAX_VALUE</code></a> items.</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> +<a name="isEmpty--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isEmpty</h4> +<pre>boolean isEmpty() + 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 if the collection contains any elements. This differs from <code>size() != 0</code> only in that the exact + number of items need not be calculated.</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> +<a name="contains-org.apache.freemarker.core.model.TemplateModel-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>contains</h4> +<pre>boolean contains(<a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a> item) + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<div class="block">Tells if a given value occurs in the collection, according the rules of the wrapped collection. As of 2.3.22, + this interface is not yet utilized by FTL, and certainly it won't be earlier than 2.4.0. The usefulness of this + method is questionable, as the equality rules of Java differs from that of FTL, hence, calling this won't be + equivalent with <code>?seq_contains(e)</code>.</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/TemplateCollectionModelEx.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/TemplateCollectionModel.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/TemplateDateModel.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/TemplateCollectionModelEx.html" target="_top">Frames</a></li> +<li><a href="TemplateCollectionModelEx.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/TemplateDateModel.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateDateModel.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateDateModel.html new file mode 100644 index 0000000..652904a --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateDateModel.html @@ -0,0 +1,386 @@ +<!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>TemplateDateModel (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="TemplateDateModel (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/TemplateDateModel.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/TemplateCollectionModelEx.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/TemplateDirectiveBody.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/TemplateDateModel.html" target="_top">Frames</a></li> +<li><a href="TemplateDateModel.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 TemplateDateModel" class="title">Interface TemplateDateModel</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/SimpleDate.html" title="class in org.apache.freemarker.core.model.impl">SimpleDate</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">TemplateDateModel</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">"date", "time" and "date-time" template language data types: corresponds to <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true"; title="class or interface in java.util"><code>Date</code></a>. Contrary to Java, + FreeMarker distinguishes date (no time part), time and date-time values. + + <p> + Objects of this type should be immutable, that is, calling <a href="../../../../../org/apache/freemarker/core/model/TemplateDateModel.html#getAsDate--"><code>getAsDate()</code></a> and <a href="../../../../../org/apache/freemarker/core/model/TemplateDateModel.html#getDateType--"><code>getDateType()</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> +<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 int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateDateModel.html#DATE">DATE</a></span></code> +<div class="block">The date model represents a date value (no time part).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateDateModel.html#DATETIME">DATETIME</a></span></code> +<div class="block">The date model represents a date-time value (also known as timestamp).</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateDateModel.html#TIME">TIME</a></span></code> +<div class="block">The date model represents a time value (no date part).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <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></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateDateModel.html#TYPE_NAMES">TYPE_NAMES</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateDateModel.html#UNKNOWN">UNKNOWN</a></span></code> +<div class="block">It is not known whether the date represents a date, a time, or a date-time value.</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/util/Date.html?is-external=true"; title="class or interface in java.util">Date</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateDateModel.html#getAsDate--">getAsDate</a></span>()</code> +<div class="block">Returns the date value.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateDateModel.html#getDateType--">getDateType</a></span>()</code> +<div class="block">Returns the type of the date.</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="UNKNOWN"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>UNKNOWN</h4> +<pre>static final int UNKNOWN</pre> +<div class="block">It is not known whether the date represents a date, a time, or a date-time value. + This often leads to exceptions in templates due to ambiguities it causes, so avoid it if possible.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.freemarker.core.model.TemplateDateModel.UNKNOWN">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="TIME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TIME</h4> +<pre>static final int TIME</pre> +<div class="block">The date model represents a time value (no date part).</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.freemarker.core.model.TemplateDateModel.TIME">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DATE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DATE</h4> +<pre>static final int DATE</pre> +<div class="block">The date model represents a date value (no time part).</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.freemarker.core.model.TemplateDateModel.DATE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DATETIME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DATETIME</h4> +<pre>static final int DATETIME</pre> +<div class="block">The date model represents a date-time value (also known as timestamp).</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.freemarker.core.model.TemplateDateModel.DATETIME">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="TYPE_NAMES"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>TYPE_NAMES</h4> +<pre>static final <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> TYPE_NAMES</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getAsDate--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAsDate</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true"; title="class or interface in java.util">Date</a> getAsDate() + 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 date value. The return value must not be <code>null</code>.</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> +<a name="getDateType--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getDateType</h4> +<pre>int getDateType()</pre> +<div class="block">Returns the type of the date. It can be any of <a href="../../../../../org/apache/freemarker/core/model/TemplateDateModel.html#TIME"><code>TIME</code></a>, + <a href="../../../../../org/apache/freemarker/core/model/TemplateDateModel.html#DATE"><code>DATE</code></a>, or <a href="../../../../../org/apache/freemarker/core/model/TemplateDateModel.html#DATETIME"><code>DATETIME</code></a>.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/TemplateDateModel.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/TemplateCollectionModelEx.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/TemplateDirectiveBody.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/TemplateDateModel.html" target="_top">Frames</a></li> +<li><a href="TemplateDateModel.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/TemplateDirectiveBody.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateDirectiveBody.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateDirectiveBody.html new file mode 100644 index 0000000..3af6e35 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateDirectiveBody.html @@ -0,0 +1,246 @@ +<!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>TemplateDirectiveBody (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="TemplateDirectiveBody (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/TemplateDirectiveBody.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/TemplateDateModel.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/TemplateDirectiveModel.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/TemplateDirectiveBody.html" target="_top">Frames</a></li> +<li><a href="TemplateDirectiveBody.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 TemplateDirectiveBody" class="title">Interface TemplateDirectiveBody</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">TemplateDirectiveBody</span></pre> +<div class="block">Represents the nested content of a directive (<a href="../../../../../org/apache/freemarker/core/model/TemplateDirectiveModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateDirectiveModel</code></a>) invocation. An implementation of this + class is passed to <a href="../../../../../org/apache/freemarker/core/model/TemplateDirectiveModel.html#execute-org.apache.freemarker.core.Environment-java.util.Map-org.apache.freemarker.core.model.TemplateModel:A-org.apache.freemarker.core.model.TemplateDirectiveBody-"><code>TemplateDirectiveModel.execute(org.apache.freemarker.core.Environment, + java.util.Map, TemplateModel[], TemplateDirectiveBody)</code></a>. The implementation of the method is + free to invoke it for any number of times, with any writer.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.11</dd> +</dl> +</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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateDirectiveBody.html#render-java.io.Writer-">render</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> out)</code> +<div class="block">Renders the body of the directive body to the specified writer.</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="render-java.io.Writer-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>render</h4> +<pre>void render(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> out) + throws <a href="../../../../../org/apache/freemarker/core/TemplateException.html" title="class in org.apache.freemarker.core">TemplateException</a>, + <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Renders the body of the directive body to the specified writer. The + writer is not flushed after the rendering. If you pass the environment's + writer, there is no need to flush it. If you supply your own writer, you + are responsible to flush/close it when you're done with using it (which + might be after multiple renderings).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>out</code> - the writer to write the output to.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/freemarker/core/TemplateException.html" title="class in org.apache.freemarker.core">TemplateException</a></code></dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</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/TemplateDirectiveBody.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/TemplateDateModel.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/TemplateDirectiveModel.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/TemplateDirectiveBody.html" target="_top">Frames</a></li> +<li><a href="TemplateDirectiveBody.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/TemplateDirectiveModel.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateDirectiveModel.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateDirectiveModel.html new file mode 100644 index 0000000..4c198fc --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateDirectiveModel.html @@ -0,0 +1,294 @@ +<!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>TemplateDirectiveModel (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="TemplateDirectiveModel (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/TemplateDirectiveModel.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/TemplateDirectiveBody.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/TemplateHashModel.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/TemplateDirectiveModel.html" target="_top">Frames</a></li> +<li><a href="TemplateDirectiveModel.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 TemplateDirectiveModel" class="title">Interface TemplateDirectiveModel</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/servlet/IncludePage.html" title="class in org.apache.freemarker.servlet">IncludePage</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">TemplateDirectiveModel</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">"directive" template language data type: used as user-defined directives + (much like macros) in templates. They can do arbitrary actions, write arbitrary + text to the template output, and trigger rendering of their nested content for + any number of times. + + <p>They are used in templates like <code><@myDirective foo=1 bar="wombat">...</@myDirective></code> (or as + <code><@myDirective foo=1 bar="wombat" /></code> - the nested content is optional).</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.11</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>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateDirectiveModel.html#execute-org.apache.freemarker.core.Environment-java.util.Map-org.apache.freemarker.core.model.TemplateModel:A-org.apache.freemarker.core.model.TemplateDirectiveBody-">execute</a></span>(<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/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a> params, + <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a>[] loopVars, + <a href="../../../../../org/apache/freemarker/core/model/TemplateDirectiveBody.html" title="interface in org.apache.freemarker.core.model">TemplateDirectiveBody</a> body)</code> +<div class="block">Executes this user-defined directive; called by FreeMarker when the user-defined + directive is called in the template.</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="execute-org.apache.freemarker.core.Environment-java.util.Map-org.apache.freemarker.core.model.TemplateModel:A-org.apache.freemarker.core.model.TemplateDirectiveBody-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>execute</h4> +<pre>void execute(<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/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a> params, + <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a>[] loopVars, + <a href="../../../../../org/apache/freemarker/core/model/TemplateDirectiveBody.html" title="interface in org.apache.freemarker.core.model">TemplateDirectiveBody</a> body) + throws <a href="../../../../../org/apache/freemarker/core/TemplateException.html" title="class in org.apache.freemarker.core">TemplateException</a>, + <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block">Executes this user-defined directive; called by FreeMarker when the user-defined + directive is called in the template.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>env</code> - the current processing environment. Note that you can access + the output <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io"><code>Writer</code></a> by <a href="../../../../../org/apache/freemarker/core/Environment.html#getOut--"><code>Environment.getOut()</code></a>.</dd> +<dd><code>params</code> - the parameters (if any) passed to the directive as a + map of key/value pairs where the keys are <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang"><code>String</code></a>-s and the + values are <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> instances. This is never + <code>null</code>. If you need to convert the template models to POJOs, + you can use the 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.</dd> +<dd><code>loopVars</code> - an array that corresponds to the "loop variables", in + the order as they appear in the directive call. ("Loop variables" are out-parameters + that are available to the nested body of the directive; see in the Manual.) + You set the loop variables by writing this array. The length of the array gives the + number of loop-variables that the caller has specified. + Never <code>null</code>, but can be a zero-length array.</dd> +<dd><code>body</code> - an object that can be used to render the nested content (body) of + the directive call. If the directive call has no nested content (i.e., it's like + <@myDirective /> or <@myDirective></@myDirective>), then this will be + <code>null</code>.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/freemarker/core/TemplateException.html" title="class in org.apache.freemarker.core">TemplateException</a></code> - If any problem occurs that's not an <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io"><code>IOException</code></a> during writing the template + output.</dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - When writing the template output fails.</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/TemplateDirectiveModel.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/TemplateDirectiveBody.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/TemplateHashModel.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/TemplateDirectiveModel.html" target="_top">Frames</a></li> +<li><a href="TemplateDirectiveModel.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>
