Repository: incubator-freemarker-site Updated Branches: refs/heads/asf-site 975692b47 -> 55a5c3145
http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/impl/DefaultArrayAdapter.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/impl/DefaultArrayAdapter.html b/builds/fm3/api/org/apache/freemarker/core/model/impl/DefaultArrayAdapter.html new file mode 100644 index 0000000..ba1a384 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/impl/DefaultArrayAdapter.html @@ -0,0 +1,353 @@ +<!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>DefaultArrayAdapter (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="DefaultArrayAdapter (FreeMarker 3.0.0-nightly-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/DefaultArrayAdapter.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/CollectionAndSequence.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/DefaultEnumerationAdapter.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/DefaultArrayAdapter.html" target="_top">Frames</a></li> +<li><a href="DefaultArrayAdapter.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.impl</div> +<h2 title="Class DefaultArrayAdapter" class="title">Class DefaultArrayAdapter</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/WrappingTemplateModel.html" title="class in org.apache.freemarker.core.model">org.apache.freemarker.core.model.WrappingTemplateModel</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.freemarker.core.model.impl.DefaultArrayAdapter</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>, <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/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>, <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 abstract class <span class="typeNameLabel">DefaultArrayAdapter</span> +extends <a href="../../../../../../org/apache/freemarker/core/model/WrappingTemplateModel.html" title="class in org.apache.freemarker.core.model">WrappingTemplateModel</a> +implements <a href="../../../../../../org/apache/freemarker/core/model/TemplateSequenceModel.html" title="interface in org.apache.freemarker.core.model">TemplateSequenceModel</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="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a></pre> +<div class="block">Adapts an <code>array</code> of a non-primitive elements to the corresponding <a href="../../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> interface(s), most + importantly to <a href="../../../../../../org/apache/freemarker/core/model/TemplateHashModelEx.html" title="interface in org.apache.freemarker.core.model"><code>TemplateHashModelEx</code></a>. If you aren't wrapping an already existing <code>array</code>, but build a + sequence specifically to be used from a template, also consider using <a href="../../../../../../org/apache/freemarker/core/model/impl/SimpleSequence.html" title="class in org.apache.freemarker.core.model.impl"><code>SimpleSequence</code></a> (see comparison there). + + <p> + Thread safety: A <a href="../../../../../../org/apache/freemarker/core/model/impl/DefaultListAdapter.html" title="class in org.apache.freemarker.core.model.impl"><code>DefaultListAdapter</code></a> is as thread-safe as the array that it wraps is. Normally you only + have to consider read-only access, as the FreeMarker template language doesn't allow writing these sequences (though + of course, Java methods called from the template can violate this rule). + + <p> + This adapter is used by <a href="../../../../../../org/apache/freemarker/core/model/impl/DefaultObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl"><code>DefaultObjectWrapper</code></a> if its <code>useAdaptersForCollections</code> property is + <code>true</code>, which is the default when its <code>incompatibleImprovements</code> property is 2.3.22 or higher.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.22</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../../org/apache/freemarker/core/model/impl/SimpleSequence.html" title="class in org.apache.freemarker.core.model.impl"><code>SimpleSequence</code></a>, +<a href="../../../../../../org/apache/freemarker/core/model/impl/DefaultListAdapter.html" title="class in org.apache.freemarker.core.model.impl"><code>DefaultListAdapter</code></a>, +<a href="../../../../../../org/apache/freemarker/core/model/TemplateSequenceModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateSequenceModel</code></a>, +<a href="../../../../../../serialized-form.html#org.apache.freemarker.core.model.impl.DefaultArrayAdapter">Serialized Form</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>static <a href="../../../../../../org/apache/freemarker/core/model/impl/DefaultArrayAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultArrayAdapter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/freemarker/core/model/impl/DefaultArrayAdapter.html#adapt-java.lang.Object-org.apache.freemarker.core.model.ObjectWrapperAndUnwrapper-">adapt</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> array, + <a href="../../../../../../org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapperAndUnwrapper</a> wrapper)</code> +<div class="block">Factory method for creating new adapter instances.</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/DefaultArrayAdapter.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">Retrieves the underlying object, or some other object semantically + equivalent to its value narrowed by the class hint.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.freemarker.core.model.WrappingTemplateModel"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.freemarker.core.model.<a href="../../../../../../org/apache/freemarker/core/model/WrappingTemplateModel.html" title="class in org.apache.freemarker.core.model">WrappingTemplateModel</a></h3> +<code><a href="../../../../../../org/apache/freemarker/core/model/WrappingTemplateModel.html#getObjectWrapper--">getObjectWrapper</a>, <a href="../../../../../../org/apache/freemarker/core/model/WrappingTemplateModel.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#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> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.freemarker.core.model.TemplateSequenceModel"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.freemarker.core.model.<a href="../../../../../../org/apache/freemarker/core/model/TemplateSequenceModel.html" title="interface in org.apache.freemarker.core.model">TemplateSequenceModel</a></h3> +<code><a href="../../../../../../org/apache/freemarker/core/model/TemplateSequenceModel.html#get-int-">get</a>, <a href="../../../../../../org/apache/freemarker/core/model/TemplateSequenceModel.html#size--">size</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.freemarker.core.model.WrapperTemplateModel"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.freemarker.core.model.<a href="../../../../../../org/apache/freemarker/core/model/WrapperTemplateModel.html" title="interface in org.apache.freemarker.core.model">WrapperTemplateModel</a></h3> +<code><a href="../../../../../../org/apache/freemarker/core/model/WrapperTemplateModel.html#getWrappedObject--">getWrappedObject</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="adapt-java.lang.Object-org.apache.freemarker.core.model.ObjectWrapperAndUnwrapper-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>adapt</h4> +<pre>public static <a href="../../../../../../org/apache/freemarker/core/model/impl/DefaultArrayAdapter.html" title="class in org.apache.freemarker.core.model.impl">DefaultArrayAdapter</a> adapt(<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> array, + <a href="../../../../../../org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapperAndUnwrapper</a> wrapper)</pre> +<div class="block">Factory method for creating new adapter instances.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>array</code> - The array to adapt; can't be <code>null</code>. Must be an array.</dd> +<dd><code>wrapper</code> - The <a href="../../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model"><code>ObjectWrapper</code></a> used to wrap the items in the array. Has to be + <a href="../../../../../../org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html" title="interface in org.apache.freemarker.core.model"><code>ObjectWrapperAndUnwrapper</code></a> because of planned future features.</dd> +</dl> +</li> +</ul> +<a name="getAdaptedObject-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getAdaptedObject</h4> +<pre>public 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> 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"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/freemarker/core/model/AdapterTemplateModel.html#getAdaptedObject-java.lang.Class-">AdapterTemplateModel</a></code></span></div> +<div class="block">Retrieves the underlying object, or some other object semantically + equivalent to its value narrowed by the class hint.</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> +</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/DefaultArrayAdapter.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/CollectionAndSequence.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/DefaultEnumerationAdapter.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/DefaultArrayAdapter.html" target="_top">Frames</a></li> +<li><a href="DefaultArrayAdapter.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>
