http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/TemplateSequenceModel.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateSequenceModel.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateSequenceModel.html new file mode 100644 index 0000000..909e675 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateSequenceModel.html @@ -0,0 +1,289 @@ +<!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>TemplateSequenceModel (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="TemplateSequenceModel (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/TemplateSequenceModel.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/TemplateScalarModel.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/TemplateTransformModel.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/TemplateSequenceModel.html" target="_top">Frames</a></li> +<li><a href="TemplateSequenceModel.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 TemplateSequenceModel" class="title">Interface TemplateSequenceModel</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/CollectionAndSequence.html" title="class in org.apache.freemarker.core.model.impl">CollectionAndSequence</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultArrayAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultArrayAdapter</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultListAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultListAdapter</a>, <a href="../../../../../org/apache/freemarker/dom/NodeModel.html" title="class in org.apache.freemarker.dom">NodeModel</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/SimpleSequence.html" title="class in org.apache.freemarker.core.model.impl">SimpleSequence</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/TemplateModelListSequence.html" title="class in org.apache.freemarker.core.model.impl">TemplateModelListSequence</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">TemplateSequenceModel</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">"sequence" template language data type; an object that contains other objects accessible through an integer 0-based + index. + + <p> + Used in templates like: <code>mySeq[index]</code>, <code><#list mySeq as i>...</#list></code>, <code>mySeq?size</code>, etc.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/freemarker/core/model/TemplateCollectionModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateCollectionModel</code></a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<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/TemplateSequenceModel.html#get-int-">get</a></span>(int index)</code> +<div class="block">Retrieves the i-th template model in this sequence.</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/TemplateSequenceModel.html#size--">size</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="get-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre><a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a> get(int index) + 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 the i-th template model in this sequence.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the item at the specified index, or <code>null</code> if the index is out of bounds. Note that a + <code>null</code> value is interpreted by FreeMarker as "variable does not exist", and accessing a + missing variables is usually considered as an error in the FreeMarker Template Language, so the usage of + a bad index will not remain hidden, unless the default value for that case was also specified in the + template.</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="size--"> +<!-- --> +</a> +<ul class="blockListLast"> +<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> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the number of items in the list.</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/TemplateSequenceModel.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/TemplateScalarModel.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/TemplateTransformModel.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/TemplateSequenceModel.html" target="_top">Frames</a></li> +<li><a href="TemplateSequenceModel.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/TemplateTransformModel.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TemplateTransformModel.html b/builds/fm3/api/org/apache/freemarker/core/model/TemplateTransformModel.html new file mode 100644 index 0000000..6878a74 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TemplateTransformModel.html @@ -0,0 +1,278 @@ +<!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>TemplateTransformModel (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="TemplateTransformModel (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/TemplateTransformModel.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/TemplateSequenceModel.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/TransformControl.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/TemplateTransformModel.html" target="_top">Frames</a></li> +<li><a href="TemplateTransformModel.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 TemplateTransformModel" class="title">Interface TemplateTransformModel</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/util/CaptureOutput.html" title="class in org.apache.freemarker.core.util">CaptureOutput</a>, <a href="../../../../../org/apache/freemarker/core/util/HtmlEscape.html" title="class in org.apache.freemarker.core.util">HtmlEscape</a>, <a href="../../../../../org/apache/freemarker/core/util/NormalizeNewlines.html" title="class in org.apache.freemarker.core.util">NormalizeNewlines</a>, <a href="../../../../../org/apache/freemarker/core/util/StandardCompress.html" title="class in org.apache.freemarker.core.util">StandardCompress</a>, <a href="../../../../../org/apache/freemarker/core/util/XmlEscape.html" title="class in org.apache.freemarker.core.util">XmlEscape</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">TemplateTransformModel</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">"transform" template language data type: user-defined directives + (much like macros) specialized on filtering output; you should rather use the newer <a href="../../../../../org/apache/freemarker/core/model/TemplateDirectiveModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateDirectiveModel</code></a> + instead. This certainly will be deprecated in FreeMarker 2.4.</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/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TemplateTransformModel.html#getWriter-java.io.Writer-java.util.Map-">getWriter</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, + <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> args)</code> +<div class="block">Returns a writer that will be used by the engine to feed the + transformation input to the transform.</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="getWriter-java.io.Writer-java.util.Map-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getWriter</h4> +<pre><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> getWriter(<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, + <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> args) + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</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">Returns a writer that will be used by the engine to feed the + transformation input to the transform. Each call to this method + must return a new instance of the writer so that the transformation + is thread-safe.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>out</code> - the character stream to which to write the transformed output</dd> +<dd><code>args</code> - the arguments (if any) passed to the transformation as a + map of key/value pairs where the keys are strings and the arguments are + TemplateModel instances. This is never null. 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> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a writer to which the engine will feed the transformation + input, or null if the transform does not support nested content (body). + The returned writer can implement the <a href="../../../../../org/apache/freemarker/core/model/TransformControl.html" title="interface in org.apache.freemarker.core.model"><code>TransformControl</code></a> + interface if it needs advanced control over the evaluation of the + transformation body.</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> +<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/TemplateTransformModel.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/TemplateSequenceModel.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/TransformControl.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/TemplateTransformModel.html" target="_top">Frames</a></li> +<li><a href="TemplateTransformModel.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/TransformControl.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/TransformControl.html b/builds/fm3/api/org/apache/freemarker/core/model/TransformControl.html new file mode 100644 index 0000000..7fb9d11 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/TransformControl.html @@ -0,0 +1,423 @@ +<!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>TransformControl (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="TransformControl (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/TransformControl.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/TemplateTransformModel.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/WrapperTemplateModel.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/TransformControl.html" target="_top">Frames</a></li> +<li><a href="TransformControl.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 TransformControl" class="title">Interface TransformControl</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">TransformControl</span></pre> +<div class="block">An interface that can be implemented by writers returned from + <a href="../../../../../org/apache/freemarker/core/model/TemplateTransformModel.html#getWriter-java.io.Writer-java.util.Map-"><code>TemplateTransformModel.getWriter(java.io.Writer, java.util.Map)</code></a>. The + methods on this + interfaces are callbacks that will be called by the template engine and that + give the writer a chance to better control the evaluation of the transform + body. The writer can instruct the engine to skip or to repeat body + evaluation, and gets notified about exceptions that are thrown during the + body evaluation.</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/TransformControl.html#END_EVALUATION">END_EVALUATION</a></span></code> +<div class="block">Constant returned from <a href="../../../../../org/apache/freemarker/core/model/TransformControl.html#afterBody--"><code>afterBody()</code></a> that tells the + template engine to end the transform and close the writer.</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/TransformControl.html#EVALUATE_BODY">EVALUATE_BODY</a></span></code> +<div class="block">Constant returned from <a href="../../../../../org/apache/freemarker/core/model/TransformControl.html#onStart--"><code>onStart()</code></a> that tells the + template engine to evaluate the body.</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/TransformControl.html#REPEAT_EVALUATION">REPEAT_EVALUATION</a></span></code> +<div class="block">Constant returned from <a href="../../../../../org/apache/freemarker/core/model/TransformControl.html#afterBody--"><code>afterBody()</code></a> that tells the + template engine to repeat transform body evaluation and feed + it again to the transform.</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/TransformControl.html#SKIP_BODY">SKIP_BODY</a></span></code> +<div class="block">Constant returned from <a href="../../../../../org/apache/freemarker/core/model/TransformControl.html#onStart--"><code>onStart()</code></a> that tells the + template engine to skip evaluation of the body.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TransformControl.html#afterBody--">afterBody</a></span>()</code> +<div class="block">Called after the body has been evaluated.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/TransformControl.html#onError-java.lang.Throwable-">onError</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> t)</code> +<div class="block">Called if any exception occurs during the transform between the + <a href="../../../../../org/apache/freemarker/core/model/TemplateTransformModel.html#getWriter-java.io.Writer-java.util.Map-"><code>TemplateTransformModel.getWriter(java.io.Writer, java.util.Map)</code></a> call + and the <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true#close--"; title="class or interface in java.io"><code>Writer.close()</code></a> call.</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/TransformControl.html#onStart--">onStart</a></span>()</code> +<div class="block">Called before the body is evaluated for the first time.</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="REPEAT_EVALUATION"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>REPEAT_EVALUATION</h4> +<pre>static final int REPEAT_EVALUATION</pre> +<div class="block">Constant returned from <a href="../../../../../org/apache/freemarker/core/model/TransformControl.html#afterBody--"><code>afterBody()</code></a> that tells the + template engine to repeat transform body evaluation and feed + it again to the transform.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.freemarker.core.model.TransformControl.REPEAT_EVALUATION">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="END_EVALUATION"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>END_EVALUATION</h4> +<pre>static final int END_EVALUATION</pre> +<div class="block">Constant returned from <a href="../../../../../org/apache/freemarker/core/model/TransformControl.html#afterBody--"><code>afterBody()</code></a> that tells the + template engine to end the transform and close the writer.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.freemarker.core.model.TransformControl.END_EVALUATION">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="SKIP_BODY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SKIP_BODY</h4> +<pre>static final int SKIP_BODY</pre> +<div class="block">Constant returned from <a href="../../../../../org/apache/freemarker/core/model/TransformControl.html#onStart--"><code>onStart()</code></a> that tells the + template engine to skip evaluation of the body.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.freemarker.core.model.TransformControl.SKIP_BODY">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="EVALUATE_BODY"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EVALUATE_BODY</h4> +<pre>static final int EVALUATE_BODY</pre> +<div class="block">Constant returned from <a href="../../../../../org/apache/freemarker/core/model/TransformControl.html#onStart--"><code>onStart()</code></a> that tells the + template engine to evaluate the body.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../constant-values.html#org.apache.freemarker.core.model.TransformControl.EVALUATE_BODY">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="onStart--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>onStart</h4> +<pre>int onStart() + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</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">Called before the body is evaluated for the first time.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><ul> + <li><tt>SKIP_BODY</tt> if the transform wants to ignore the body. In this + case, only <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true#close--"; title="class or interface in java.io"><code>Writer.close()</code></a> is called next and processing ends.</li> + <li><tt>EVALUATE_BODY</tt> to normally evaluate the body of the transform + and feed it to the writer</li> + </ul></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> +<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> +<a name="afterBody--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>afterBody</h4> +<pre>int afterBody() + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</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">Called after the body has been evaluated.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><ul> + <li><tt>END_EVALUATION</tt> if the transformation should be ended.</li> + <li><tt>REPEAT_EVALUATION</tt> to have the engine re-evaluate the + transform body and feed it again to the writer.</li> + </ul></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> +<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> +<a name="onError-java.lang.Throwable-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>onError</h4> +<pre>void onError(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a> t) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a></pre> +<div class="block">Called if any exception occurs during the transform between the + <a href="../../../../../org/apache/freemarker/core/model/TemplateTransformModel.html#getWriter-java.io.Writer-java.util.Map-"><code>TemplateTransformModel.getWriter(java.io.Writer, java.util.Map)</code></a> call + and the <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true#close--"; title="class or interface in java.io"><code>Writer.close()</code></a> call.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>t</code> - the throwable that represents the exception. It can be any + non-checked throwable, as well as <a href="../../../../../org/apache/freemarker/core/TemplateException.html" title="class in org.apache.freemarker.core"><code>TemplateException</code></a> and + <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>.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true"; title="class or interface in java.lang">Throwable</a></code> - is recommended that the methods rethrow the received + throwable. If the method wants to throw another throwable, it should + either throw a non-checked throwable, or an instance of + <a href="../../../../../org/apache/freemarker/core/TemplateException.html" title="class in org.apache.freemarker.core"><code>TemplateException</code></a> and <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>. Throwing any + other checked exception will cause the engine to rethrow it as + a <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/reflect/UndeclaredThrowableException.html?is-external=true"; title="class or interface in java.lang.reflect"><code>UndeclaredThrowableException</code></a>.</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/TransformControl.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/TemplateTransformModel.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/WrapperTemplateModel.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/TransformControl.html" target="_top">Frames</a></li> +<li><a href="TransformControl.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/WrapperTemplateModel.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/WrapperTemplateModel.html b/builds/fm3/api/org/apache/freemarker/core/model/WrapperTemplateModel.html new file mode 100644 index 0000000..298859b --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/WrapperTemplateModel.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>WrapperTemplateModel (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="WrapperTemplateModel (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/WrapperTemplateModel.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/TransformControl.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/WrappingTemplateModel.html" title="class in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/WrapperTemplateModel.html" target="_top">Frames</a></li> +<li><a href="WrapperTemplateModel.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 WrapperTemplateModel" class="title">Interface WrapperTemplateModel</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/DefaultArrayAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultArrayAdapter</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultEnumerationAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultEnumerationAdapter</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultIterableAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultIterableAdapter</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultIteratorAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultIter atorAdapter</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">DefaultNonListCollectionAdapter</a>, <a href="../../../../../org/apache/freemarker/dom/NodeModel.html" title="class in org.apache.freemarker.dom">NodeModel</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">WrapperTemplateModel</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">A generic interface for template models that wrap some underlying + object, and wish to provide access to that wrapped object. + + <p>You may also want to implement <a href="../../../../../org/apache/freemarker/core/model/AdapterTemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>AdapterTemplateModel</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.freemarker.core.model.TemplateModel"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.freemarker.core.model.<a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a></h3> +<code><a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html#NOTHING">NOTHING</a></code></li> +</ul> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/WrapperTemplateModel.html#getWrappedObject--">getWrappedObject</a></span>()</code> +<div class="block">Retrieves the original object wrapped by this 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="getWrappedObject--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getWrappedObject</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> getWrappedObject()</pre> +<div class="block">Retrieves the original object wrapped by this model.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/WrapperTemplateModel.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/TransformControl.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/WrappingTemplateModel.html" title="class in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/WrapperTemplateModel.html" target="_top">Frames</a></li> +<li><a href="WrapperTemplateModel.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/WrappingTemplateModel.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/WrappingTemplateModel.html b/builds/fm3/api/org/apache/freemarker/core/model/WrappingTemplateModel.html new file mode 100644 index 0000000..0a0056e --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/WrappingTemplateModel.html @@ -0,0 +1,341 @@ +<!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>WrappingTemplateModel (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="WrappingTemplateModel (FreeMarker 3.0.0-nightly-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/WrappingTemplateModel.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/WrapperTemplateModel.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/WrappingTemplateModel.html" target="_top">Frames</a></li> +<li><a href="WrappingTemplateModel.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.freemarker.core.model</div> +<h2 title="Class WrappingTemplateModel" class="title">Class WrappingTemplateModel</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.freemarker.core.model.WrappingTemplateModel</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../../org/apache/freemarker/core/model/impl/DefaultArrayAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultArrayAdapter</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultEnumerationAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultEnumerationAdapter</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultIterableAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultIterableAdapter</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultIteratorAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultIteratorAdapter</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultListAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultListAdapter</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultMapAdapter.html" title="class in org.apache.freemarker.core.mo del.impl">DefaultMapAdapter</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>, <a href="../../../../../org/apache/freemarker/core/model/impl/SimpleHash.html" title="class in org.apache.freemarker.core.model.impl">SimpleHash</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/SimpleSequence.html" title="class in org.apache.freemarker.core.model.impl">SimpleSequence</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="typeNameLabel">WrappingTemplateModel</span> +extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">Convenience base-class for containers that wrap their contained arbitrary Java objects into <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> + instances.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/WrappingTemplateModel.html#WrappingTemplateModel--">WrappingTemplateModel</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">Use <a href="../../../../../org/apache/freemarker/core/model/WrappingTemplateModel.html#WrappingTemplateModel-org.apache.freemarker.core.model.ObjectWrapper-"><code>WrappingTemplateModel(ObjectWrapper)</code></a> instead; this method uses the deprecated.</span></div> +</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/WrappingTemplateModel.html#WrappingTemplateModel-org.apache.freemarker.core.model.ObjectWrapper-">WrappingTemplateModel</a></span>(<a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapper</a> objectWrapper)</code> +<div class="block">Protected constructor that creates a new wrapping template model using the specified object wrapper.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapper</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/WrappingTemplateModel.html#getObjectWrapper--">getObjectWrapper</a></span>()</code> +<div class="block">Returns the object wrapper instance used by this wrapping template model.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>protected <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/WrappingTemplateModel.html#wrap-java.lang.Object-">wrap</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> obj)</code> +<div class="block">Wraps the passed object into a template model using this object's object + wrapper.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="WrappingTemplateModel--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>WrappingTemplateModel</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +protected WrappingTemplateModel()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../../../../org/apache/freemarker/core/model/WrappingTemplateModel.html#WrappingTemplateModel-org.apache.freemarker.core.model.ObjectWrapper-"><code>WrappingTemplateModel(ObjectWrapper)</code></a> instead; this method uses the deprecated.</span></div> +<div class="block">Protected constructor that creates a new wrapping template model using + the default object wrapper.</div> +</li> +</ul> +<a name="WrappingTemplateModel-org.apache.freemarker.core.model.ObjectWrapper-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>WrappingTemplateModel</h4> +<pre>protected WrappingTemplateModel(<a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapper</a> objectWrapper)</pre> +<div class="block">Protected constructor that creates a new wrapping template model using the specified object wrapper.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>objectWrapper</code> - the wrapper to use. Passing <code>null</code> to it + is allowed but deprecated. If <code>null</code> is passed, the deprecated default object wrapper + is used.</dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getObjectWrapper--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getObjectWrapper</h4> +<pre>public <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapper</a> getObjectWrapper()</pre> +<div class="block">Returns the object wrapper instance used by this wrapping template model.</div> +</li> +</ul> +<a name="wrap-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>wrap</h4> +<pre>protected final <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a> wrap(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> obj) + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<div class="block">Wraps the passed object into a template model using this object's object + wrapper.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>obj</code> - the object to wrap</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the template model that wraps the object</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> - if the wrapper does not know how to + wrap the passed object.</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/WrappingTemplateModel.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/WrapperTemplateModel.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/WrappingTemplateModel.html" target="_top">Frames</a></li> +<li><a href="WrappingTemplateModel.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
