http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/impl/BeanAndStringModel.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/impl/BeanAndStringModel.html b/builds/fm3/api/org/apache/freemarker/core/model/impl/BeanAndStringModel.html new file mode 100644 index 0000000..6e2b1d2 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/impl/BeanAndStringModel.html @@ -0,0 +1,344 @@ +<!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>BeanAndStringModel (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="BeanAndStringModel (FreeMarker 3.0.0-nightly-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":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/BeanAndStringModel.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>Prev Class</li> +<li><a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html" title="class in org.apache.freemarker.core.model.impl"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/freemarker/core/model/impl/BeanAndStringModel.html" target="_top">Frames</a></li> +<li><a href="BeanAndStringModel.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="#fields.inherited.from.class.org.apache.freemarker.core.model.impl.BeanModel">Field</a> | </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.impl</div> +<h2 title="Class BeanAndStringModel" class="title">Class BeanAndStringModel</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html" title="class in org.apache.freemarker.core.model.impl">org.apache.freemarker.core.model.impl.BeanModel</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.freemarker.core.model.impl.BeanAndStringModel</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../../org/apache/freemarker/core/model/AdapterTemplateModel.html" title="interface in org.apache.freemarker.core.model">AdapterTemplateModel</a>, <a href="../../../../../../org/apache/freemarker/core/model/TemplateHashModel.html" title="interface in org.apache.freemarker.core.model">TemplateHashModel</a>, <a href="../../../../../../org/apache/freemarker/core/model/TemplateHashModelEx.html" title="interface in org.apache.freemarker.core.model">TemplateHashModelEx</a>, <a href="../../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a>, <a href="../../../../../../org/apache/freemarker/core/model/TemplateModelWithAPISupport.html" title="interface in org.apache.freemarker.core.model">TemplateModelWithAPISupport</a>, <a href="../../../../../../org/apache/freemarker/core/model/TemplateScalarModel.html" title="interface in org.apache.freemarker.core.model">TemplateScalarModel</a>, < a href="../../../../../../org/apache/freemarker/core/model/WrapperTemplateModel.html" title="interface in org.apache.freemarker.core.model">WrapperTemplateModel</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">BeanAndStringModel</span> +extends <a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html" title="class in org.apache.freemarker.core.model.impl">BeanModel</a> +implements <a href="../../../../../../org/apache/freemarker/core/model/TemplateScalarModel.html" title="interface in org.apache.freemarker.core.model">TemplateScalarModel</a></pre> +<div class="block">Subclass of <a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html" title="class in org.apache.freemarker.core.model.impl"><code>BeanModel</code></a> that exposes the return value of the <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"><code>Object.toString()</code></a> method through the <a href="../../../../../../org/apache/freemarker/core/model/TemplateScalarModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateScalarModel</code></a> + 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.impl.BeanModel"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.freemarker.core.model.impl.<a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html" title="class in org.apache.freemarker.core.model.impl">BeanModel</a></h3> +<code><a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#object">object</a>, <a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#wrapper">wrapper</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.freemarker.core.model.TemplateScalarModel"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.freemarker.core.model.<a href="../../../../../../org/apache/freemarker/core/model/TemplateScalarModel.html" title="interface in org.apache.freemarker.core.model">TemplateScalarModel</a></h3> +<code><a href="../../../../../../org/apache/freemarker/core/model/TemplateScalarModel.html#EMPTY_STRING">EMPTY_STRING</a></code></li> +</ul> +<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> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/freemarker/core/model/impl/BeanAndStringModel.html#BeanAndStringModel-java.lang.Object-org.apache.freemarker.core.model.impl.DefaultObjectWrapper-">BeanAndStringModel</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> object, + <a href="../../../../../../org/apache/freemarker/core/model/impl/DefaultObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl">DefaultObjectWrapper</a> wrapper)</code> +<div class="block">Creates a new model that wraps the specified object with BeanModel + scalar + functionality.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/freemarker/core/model/impl/BeanAndStringModel.html#getAsString--">getAsString</a></span>()</code> +<div class="block">Returns the result of calling <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"><code>Object.toString()</code></a> on the wrapped + object.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.freemarker.core.model.impl.BeanModel"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.freemarker.core.model.impl.<a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html" title="class in org.apache.freemarker.core.model.impl">BeanModel</a></h3> +<code><a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#get-java.lang.String-">get</a>, <a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#getAdaptedObject-java.lang.Class-">getAdaptedObject</a>, <a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#getAPI--">getAPI</a>, <a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#getWrappedObject--">getWrappedObject</a>, <a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#hasPlainGetMethod--">hasPlainGetMethod</a>, <a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#invokeGenericGet-java.util.Map-java.lang.Class-java.lang.String-">invokeGenericGet</a>, <a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#isEmpty--">isEmpty</a>, <a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#keys--">keys</a>, <a href="../../../../../ ../org/apache/freemarker/core/model/impl/BeanModel.html#keySet--">keySet</a>, <a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#size--">size</a>, <a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#toString--">toString</a>, <a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#unwrap-org.apache.freemarker.core.model.TemplateModel-">unwrap</a>, <a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#values--">values</a>, <a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#wrap-java.lang.Object-">wrap</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="BeanAndStringModel-java.lang.Object-org.apache.freemarker.core.model.impl.DefaultObjectWrapper-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BeanAndStringModel</h4> +<pre>public BeanAndStringModel(<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> object, + <a href="../../../../../../org/apache/freemarker/core/model/impl/DefaultObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl">DefaultObjectWrapper</a> wrapper)</pre> +<div class="block">Creates a new model that wraps the specified object with BeanModel + scalar + functionality.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>object</code> - the object to wrap into a model.</dd> +<dd><code>wrapper</code> - the <a href="../../../../../../org/apache/freemarker/core/model/impl/DefaultObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl"><code>DefaultObjectWrapper</code></a> associated with this model. + Every model has to have an associated <a href="../../../../../../org/apache/freemarker/core/model/impl/DefaultObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl"><code>DefaultObjectWrapper</code></a> instance. The + model gains many attributes from its wrapper, including the caching + behavior, method exposure level, method-over-item shadowing policy etc.</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="getAsString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAsString</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> getAsString()</pre> +<div class="block">Returns the result of calling <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"><code>Object.toString()</code></a> on the wrapped + object.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/freemarker/core/model/TemplateScalarModel.html#getAsString--">getAsString</a></code> in interface <code><a href="../../../../../../org/apache/freemarker/core/model/TemplateScalarModel.html" title="interface in org.apache.freemarker.core.model">TemplateScalarModel</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/BeanAndStringModel.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>Prev Class</li> +<li><a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html" title="class in org.apache.freemarker.core.model.impl"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/freemarker/core/model/impl/BeanAndStringModel.html" target="_top">Frames</a></li> +<li><a href="BeanAndStringModel.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="#fields.inherited.from.class.org.apache.freemarker.core.model.impl.BeanModel">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/impl/BeanModel.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/impl/BeanModel.html b/builds/fm3/api/org/apache/freemarker/core/model/impl/BeanModel.html new file mode 100644 index 0000000..640b6af --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/impl/BeanModel.html @@ -0,0 +1,681 @@ +<!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>BeanModel (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="BeanModel (FreeMarker 3.0.0-nightly-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10}; +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/BeanModel.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/impl/BeanAndStringModel.html" title="class in org.apache.freemarker.core.model.impl"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/freemarker/core/model/impl/CollectionAndSequence.html" title="class in org.apache.freemarker.core.model.impl"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/freemarker/core/model/impl/BeanModel.html" target="_top">Frames</a></li> +<li><a href="BeanModel.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><a href="#constructor.summary">Constr</a> | </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><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.impl</div> +<h2 title="Class BeanModel" class="title">Class BeanModel</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.impl.BeanModel</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../../org/apache/freemarker/core/model/AdapterTemplateModel.html" title="interface in org.apache.freemarker.core.model">AdapterTemplateModel</a>, <a href="../../../../../../org/apache/freemarker/core/model/TemplateHashModel.html" title="interface in org.apache.freemarker.core.model">TemplateHashModel</a>, <a href="../../../../../../org/apache/freemarker/core/model/TemplateHashModelEx.html" title="interface in org.apache.freemarker.core.model">TemplateHashModelEx</a>, <a href="../../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a>, <a href="../../../../../../org/apache/freemarker/core/model/TemplateModelWithAPISupport.html" title="interface in org.apache.freemarker.core.model">TemplateModelWithAPISupport</a>, <a href="../../../../../../org/apache/freemarker/core/model/WrapperTemplateModel.html" title="interface in org.apache.freemarker.core.model">WrapperTemplateModel</a>< /dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</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/ResourceBundleModel.html" title="class in org.apache.freemarker.core.model.impl">ResourceBundleModel</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">BeanModel</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> +implements <a href="../../../../../../org/apache/freemarker/core/model/TemplateHashModelEx.html" title="interface in org.apache.freemarker.core.model">TemplateHashModelEx</a>, <a href="../../../../../../org/apache/freemarker/core/model/AdapterTemplateModel.html" title="interface in org.apache.freemarker.core.model">AdapterTemplateModel</a>, <a href="../../../../../../org/apache/freemarker/core/model/WrapperTemplateModel.html" title="interface in org.apache.freemarker.core.model">WrapperTemplateModel</a>, <a href="../../../../../../org/apache/freemarker/core/model/TemplateModelWithAPISupport.html" title="interface in org.apache.freemarker.core.model">TemplateModelWithAPISupport</a></pre> +<div class="block">A class that will wrap an arbitrary object into <a href="../../../../../../org/apache/freemarker/core/model/TemplateHashModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateHashModel</code></a> + interface allowing calls to arbitrary property getters and invocation of + accessible methods on the object from a template using the + <tt>object.foo</tt> to access properties and <tt>object.bar(arg1, arg2)</tt> to + invoke methods on it. You can also use the <tt>object.foo[index]</tt> syntax to + access indexed properties. It uses Beans <a href="http://docs.oracle.com/javase/8/docs/api/java/beans/Introspector.html?is-external=true"; title="class or interface in java.beans"><code>Introspector</code></a> + to dynamically discover the properties and methods.</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>protected <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/impl/BeanModel.html#object">object</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected <a href="../../../../../../org/apache/freemarker/core/model/impl/DefaultObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl">DefaultObjectWrapper</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#wrapper">wrapper</a></span></code> </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> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#BeanModel-java.lang.Object-org.apache.freemarker.core.model.impl.DefaultObjectWrapper-">BeanModel</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> object, + <a href="../../../../../../org/apache/freemarker/core/model/impl/DefaultObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl">DefaultObjectWrapper</a> wrapper)</code> +<div class="block">Creates a new model that wraps the specified object.</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/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/impl/BeanModel.html#get-java.lang.String-">get</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key)</code> +<div class="block">Uses Beans introspection to locate a property or method with name + matching the key name.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<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/impl/BeanModel.html#getAdaptedObject-java.lang.Class-">getAdaptedObject</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> hint)</code> +<div class="block">Returns the same as <a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#getWrappedObject--"><code>getWrappedObject()</code></a>; to ensure that, this method will be final starting from 2.4.</div> +</td> +</tr> +<tr id="i2" 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/impl/BeanModel.html#getAPI--">getAPI</a></span>()</code> +<div class="block">Returns the model that exposes the (Java) API of the value.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<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/impl/BeanModel.html#getWrappedObject--">getWrappedObject</a></span>()</code> +<div class="block">Retrieves the original object wrapped by this model.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>protected boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#hasPlainGetMethod--">hasPlainGetMethod</a></span>()</code> +<div class="block">Whether the model has a plain get(String) or get(Object) method</div> +</td> +</tr> +<tr id="i5" 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/impl/BeanModel.html#invokeGenericGet-java.util.Map-java.lang.Class-java.lang.String-">invokeGenericGet</a></span>(<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> classInfo, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> clazz, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key)</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#isEmpty--">isEmpty</a></span>()</code> +<div class="block">Tells whether the model is considered to be empty.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/freemarker/core/model/TemplateCollectionModel.html" title="interface in org.apache.freemarker.core.model">TemplateCollectionModel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#keys--">keys</a></span>()</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#keySet--">keySet</a></span>()</code> +<div class="block">Helper method to support TemplateHashModelEx.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#size--">size</a></span>()</code> </td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#toString--">toString</a></span>()</code> </td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>protected <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/impl/BeanModel.html#unwrap-org.apache.freemarker.core.model.TemplateModel-">unwrap</a></span>(<a href="../../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a> model)</code> </td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../org/apache/freemarker/core/model/TemplateCollectionModel.html" title="interface in org.apache.freemarker.core.model">TemplateCollectionModel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#values--">values</a></span>()</code> </td> +</tr> +<tr id="i13" 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/impl/BeanModel.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> </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#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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="object"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>object</h4> +<pre>protected final <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> object</pre> +</li> +</ul> +<a name="wrapper"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>wrapper</h4> +<pre>protected final <a href="../../../../../../org/apache/freemarker/core/model/impl/DefaultObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl">DefaultObjectWrapper</a> wrapper</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="BeanModel-java.lang.Object-org.apache.freemarker.core.model.impl.DefaultObjectWrapper-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BeanModel</h4> +<pre>public BeanModel(<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> object, + <a href="../../../../../../org/apache/freemarker/core/model/impl/DefaultObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl">DefaultObjectWrapper</a> wrapper)</pre> +<div class="block">Creates a new model that wraps the specified object. Note that there are + specialized subclasses of this class for wrapping arrays, collections, + enumeration, iterators, and maps. Note also that the superclass can be + used to wrap String objects if only scalar functionality is needed. You + can also choose to delegate the choice over which model class is used for + wrapping to <a href="../../../../../../org/apache/freemarker/core/model/impl/DefaultObjectWrapper.html#wrap-java.lang.Object-"><code>DefaultObjectWrapper.wrap(Object)</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>object</code> - the object to wrap into a model.</dd> +<dd><code>wrapper</code> - the <a href="../../../../../../org/apache/freemarker/core/model/impl/DefaultObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl"><code>DefaultObjectWrapper</code></a> associated with this model. + Every model has to have an associated <a href="../../../../../../org/apache/freemarker/core/model/impl/DefaultObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl"><code>DefaultObjectWrapper</code></a> instance. The + model gains many attributes from its wrapper, including the caching + behavior, method exposure level, method-over-item shadowing policy etc.</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="get-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a> get(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key) + throws <a href="../../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<div class="block">Uses Beans introspection to locate a property or method with name + matching the key name. If a method or property is found, it's wrapped + into <a href="../../../../../../org/apache/freemarker/core/model/TemplateMethodModelEx.html" title="interface in org.apache.freemarker.core.model"><code>TemplateMethodModelEx</code></a> (for a method or + indexed property), or evaluated on-the-fly and the return value wrapped + into appropriate model (for a simple property) Models for various + properties and methods are cached on a per-class basis, so the costly + introspection is performed only once per property or method of a class. + (Side-note: this also implies that any class whose method has been called + will be strongly referred to by the framework and will not become + unloadable until this class has been unloaded first. Normally this is not + an issue, but can be in a rare scenario where you create many classes on- + the-fly. Also, as the cache grows with new classes and methods introduced + to the framework, it may appear as if it were leaking memory. The + framework does, however detect class reloads (if you happen to be in an + environment that does this kind of things--servlet containers do it when + they reload a web application) and flushes the cache. If no method or + property matching the key is found, the framework will try to invoke + methods with signature + <tt>non-void-return-type get(java.lang.String)</tt>, + then <tt>non-void-return-type get(java.lang.Object)</tt>, or + alternatively (if the wrapped object is a resource bundle) + <tt>Object getObject(java.lang.String)</tt>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/freemarker/core/model/TemplateHashModel.html#get-java.lang.String-">get</a></code> in interface <code><a href="../../../../../../org/apache/freemarker/core/model/TemplateHashModel.html" title="interface in org.apache.freemarker.core.model">TemplateHashModel</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>key</code> - the name by which the <tt>TemplateModel</tt> + is identified in the template.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the <tt>TemplateModel</tt> referred to by the key, + or null if not found.</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 there was no property nor method nor + a generic <tt>get</tt> method to invoke.</dd> +</dl> +</li> +</ul> +<a name="hasPlainGetMethod--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasPlainGetMethod</h4> +<pre>protected boolean hasPlainGetMethod()</pre> +<div class="block">Whether the model has a plain get(String) or get(Object) method</div> +</li> +</ul> +<a name="invokeGenericGet-java.util.Map-java.lang.Class-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>invokeGenericGet</h4> +<pre>protected <a href="../../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a> invokeGenericGet(<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> classInfo, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> clazz, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> key) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalAccessException.html?is-external=true"; title="class or interface in java.lang">IllegalAccessException</a>, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/reflect/InvocationTargetException.html?is-external=true"; title="class or interface in java.lang.reflect">InvocationTargetException</a>, + <a href="../../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalAccessException.html?is-external=true"; title="class or interface in java.lang">IllegalAccessException</a></code></dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/reflect/InvocationTargetException.html?is-external=true"; title="class or interface in java.lang.reflect">InvocationTargetException</a></code></dd> +<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="wrap-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>wrap</h4> +<pre>protected <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> +<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="unwrap-org.apache.freemarker.core.model.TemplateModel-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unwrap</h4> +<pre>protected <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> unwrap(<a href="../../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a> model) + 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="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>public boolean isEmpty()</pre> +<div class="block">Tells whether the model is considered to be empty. + It is empty if the wrapped object is a 0 length <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>, or an empty <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> or and empty + <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util"><code>Map</code></a>, or an <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true"; title="class or interface in java.util"><code>Iterator</code></a> that has no more items, or a <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true#FALSE"; title="class or interface in java.lang"><code>Boolean.FALSE</code></a>, or <code>null</code>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/freemarker/core/model/TemplateHashModel.html#isEmpty--">isEmpty</a></code> in interface <code><a href="../../../../../../org/apache/freemarker/core/model/TemplateHashModel.html" title="interface in org.apache.freemarker.core.model">TemplateHashModel</a></code></dd> +</dl> +</li> +</ul> +<a name="getAdaptedObject-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAdaptedObject</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> getAdaptedObject(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> hint)</pre> +<div class="block">Returns the same as <a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html#getWrappedObject--"><code>getWrappedObject()</code></a>; to ensure that, this method will be final starting from 2.4. + This behavior of <a href="../../../../../../org/apache/freemarker/core/model/impl/BeanModel.html" title="class in org.apache.freemarker.core.model.impl"><code>BeanModel</code></a> is assumed by some FreeMarker code.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/freemarker/core/model/AdapterTemplateModel.html#getAdaptedObject-java.lang.Class-">getAdaptedObject</a></code> in interface <code><a href="../../../../../../org/apache/freemarker/core/model/AdapterTemplateModel.html" title="interface in org.apache.freemarker.core.model">AdapterTemplateModel</a></code></dd> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>hint</code> - the desired class of the returned value. An implementation + should make reasonable effort to retrieve an object of the requested + class, but if that is impossible, it must at least return the underlying + object as-is. As a minimal requirement, an implementation must always + return the exact underlying object when + <tt>hint.isInstance(underlyingObject)</tt> holds. When called + with <tt>java.lang.Object.class</tt>, it should return a generic Java + object (i.e. if the model is wrapping a scripting language object that is + further wrapping a Java object, the deepest underlying Java object should + be returned).</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the underlying object, or its value accommodated for the hint + class.</dd> +</dl> +</li> +</ul> +<a name="getWrappedObject--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getWrappedObject</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> getWrappedObject()</pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/freemarker/core/model/WrapperTemplateModel.html#getWrappedObject--">WrapperTemplateModel</a></code></span></div> +<div class="block">Retrieves the original object wrapped by this model.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/freemarker/core/model/WrapperTemplateModel.html#getWrappedObject--">getWrappedObject</a></code> in interface <code><a href="../../../../../../org/apache/freemarker/core/model/WrapperTemplateModel.html" title="interface in org.apache.freemarker.core.model">WrapperTemplateModel</a></code></dd> +</dl> +</li> +</ul> +<a name="size--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>size</h4> +<pre>public int size()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/freemarker/core/model/TemplateHashModelEx.html#size--">size</a></code> in interface <code><a href="../../../../../../org/apache/freemarker/core/model/TemplateHashModelEx.html" title="interface in org.apache.freemarker.core.model">TemplateHashModelEx</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the number of key/value mappings in the hash.</dd> +</dl> +</li> +</ul> +<a name="keys--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>keys</h4> +<pre>public <a href="../../../../../../org/apache/freemarker/core/model/TemplateCollectionModel.html" title="interface in org.apache.freemarker.core.model">TemplateCollectionModel</a> keys()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/freemarker/core/model/TemplateHashModelEx.html#keys--">keys</a></code> in interface <code><a href="../../../../../../org/apache/freemarker/core/model/TemplateHashModelEx.html" title="interface in org.apache.freemarker.core.model">TemplateHashModelEx</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a collection containing the keys in the hash. Every element of + the returned collection must implement the <a href="../../../../../../org/apache/freemarker/core/model/TemplateScalarModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateScalarModel</code></a> + (as the keys of hashes are always strings).</dd> +</dl> +</li> +</ul> +<a name="values--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public <a href="../../../../../../org/apache/freemarker/core/model/TemplateCollectionModel.html" title="interface in org.apache.freemarker.core.model">TemplateCollectionModel</a> values() + 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="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/freemarker/core/model/TemplateHashModelEx.html#values--">values</a></code> in interface <code><a href="../../../../../../org/apache/freemarker/core/model/TemplateHashModelEx.html" title="interface in org.apache.freemarker.core.model">TemplateHashModelEx</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a collection containing the values in the hash. The elements of the + returned collection can be any kind of <a href="../../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a>-s.</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="toString--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><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></code> in class <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></dd> +</dl> +</li> +</ul> +<a name="keySet--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>keySet</h4> +<pre>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a> keySet()</pre> +<div class="block">Helper method to support TemplateHashModelEx. Returns the Set of + Strings which are available via the TemplateHashModel + interface. Subclasses that override <tt>invokeGenericGet</tt> to + provide additional hash keys should also override this method.</div> +</li> +</ul> +<a name="getAPI--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAPI</h4> +<pre>public <a href="../../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a> getAPI() + throws <a href="../../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/freemarker/core/model/TemplateModelWithAPISupport.html#getAPI--">TemplateModelWithAPISupport</a></code></span></div> +<div class="block">Returns the model that exposes the (Java) API of the value. This is usually implemented by delegating to + <a href="../../../../../../org/apache/freemarker/core/model/ObjectWrapperWithAPISupport.html#wrapAsAPI-java.lang.Object-"><code>ObjectWrapperWithAPISupport.wrapAsAPI(Object)</code></a>.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/freemarker/core/model/TemplateModelWithAPISupport.html#getAPI--">getAPI</a></code> in interface <code><a href="../../../../../../org/apache/freemarker/core/model/TemplateModelWithAPISupport.html" title="interface in org.apache.freemarker.core.model">TemplateModelWithAPISupport</a></code></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/BeanModel.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/impl/BeanAndStringModel.html" title="class in org.apache.freemarker.core.model.impl"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/freemarker/core/model/impl/CollectionAndSequence.html" title="class in org.apache.freemarker.core.model.impl"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/freemarker/core/model/impl/BeanModel.html" target="_top">Frames</a></li> +<li><a href="BeanModel.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><a href="#constructor.summary">Constr</a> | </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><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/impl/CollectionAndSequence.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/impl/CollectionAndSequence.html b/builds/fm3/api/org/apache/freemarker/core/model/impl/CollectionAndSequence.html new file mode 100644 index 0000000..0e9eb22 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/impl/CollectionAndSequence.html @@ -0,0 +1,369 @@ +<!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>CollectionAndSequence (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="CollectionAndSequence (FreeMarker 3.0.0-nightly-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":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/CollectionAndSequence.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/impl/BeanModel.html" title="class in org.apache.freemarker.core.model.impl"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/freemarker/core/model/impl/DefaultArrayAdapter.html" title="class in org.apache.freemarker.core.model.impl"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/freemarker/core/model/impl/CollectionAndSequence.html" target="_top">Frames</a></li> +<li><a href="CollectionAndSequence.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.impl</div> +<h2 title="Class CollectionAndSequence" class="title">Class CollectionAndSequence</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.impl.CollectionAndSequence</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</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>, <a href="../../../../../../org/apache/freemarker/core/model/TemplateSequenceModel.html" title="interface in org.apache.freemarker.core.model">TemplateSequenceModel</a></dd> +</dl> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">CollectionAndSequence</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> +implements <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/TemplateSequenceModel.html" title="interface in org.apache.freemarker.core.model">TemplateSequenceModel</a></pre> +<div class="block">Add sequence capabilities to an existing collection, or + vice versa. Used by ?keys and ?values built-ins.</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> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/freemarker/core/model/impl/CollectionAndSequence.html#CollectionAndSequence-org.apache.freemarker.core.model.TemplateCollectionModel-">CollectionAndSequence</a></span>(<a href="../../../../../../org/apache/freemarker/core/model/TemplateCollectionModel.html" title="interface in org.apache.freemarker.core.model">TemplateCollectionModel</a> collection)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/freemarker/core/model/impl/CollectionAndSequence.html#CollectionAndSequence-org.apache.freemarker.core.model.TemplateSequenceModel-">CollectionAndSequence</a></span>(<a href="../../../../../../org/apache/freemarker/core/model/TemplateSequenceModel.html" title="interface in org.apache.freemarker.core.model">TemplateSequenceModel</a> sequence)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../../../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/impl/CollectionAndSequence.html#get-int-">get</a></span>(int i)</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><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/impl/CollectionAndSequence.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> +<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/impl/CollectionAndSequence.html#size--">size</a></span>()</code> </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="CollectionAndSequence-org.apache.freemarker.core.model.TemplateCollectionModel-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>CollectionAndSequence</h4> +<pre>public CollectionAndSequence(<a href="../../../../../../org/apache/freemarker/core/model/TemplateCollectionModel.html" title="interface in org.apache.freemarker.core.model">TemplateCollectionModel</a> collection)</pre> +</li> +</ul> +<a name="CollectionAndSequence-org.apache.freemarker.core.model.TemplateSequenceModel-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CollectionAndSequence</h4> +<pre>public CollectionAndSequence(<a href="../../../../../../org/apache/freemarker/core/model/TemplateSequenceModel.html" title="interface in org.apache.freemarker.core.model">TemplateSequenceModel</a> sequence)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="iterator--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>iterator</h4> +<pre>public <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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/freemarker/core/model/TemplateCollectionModel.html#iterator--">TemplateCollectionModel</a></code></span></div> +<div class="block">Retrieves a template model iterator that is used to iterate over the elements in this collection.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/freemarker/core/model/TemplateCollectionModel.html#iterator--">iterator</a></code> in interface <code><a href="../../../../../../org/apache/freemarker/core/model/TemplateCollectionModel.html" title="interface in org.apache.freemarker.core.model">TemplateCollectionModel</a></code></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="get-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a> get(int i) + throws <a href="../../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/freemarker/core/model/TemplateSequenceModel.html#get-int-">TemplateSequenceModel</a></code></span></div> +<div class="block">Retrieves the i-th template model in this sequence.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/freemarker/core/model/TemplateSequenceModel.html#get-int-">get</a></code> in interface <code><a href="../../../../../../org/apache/freemarker/core/model/TemplateSequenceModel.html" title="interface in org.apache.freemarker.core.model">TemplateSequenceModel</a></code></dd> +<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>public 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="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code><a href="../../../../../../org/apache/freemarker/core/model/TemplateSequenceModel.html#size--">size</a></code> in interface <code><a href="../../../../../../org/apache/freemarker/core/model/TemplateSequenceModel.html" title="interface in org.apache.freemarker.core.model">TemplateSequenceModel</a></code></dd> +<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/CollectionAndSequence.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/impl/BeanModel.html" title="class in org.apache.freemarker.core.model.impl"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../../org/apache/freemarker/core/model/impl/DefaultArrayAdapter.html" title="class in org.apache.freemarker.core.model.impl"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/freemarker/core/model/impl/CollectionAndSequence.html" target="_top">Frames</a></li> +<li><a href="CollectionAndSequence.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>
