http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/Constants.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/Constants.html b/builds/fm3/api/org/apache/freemarker/core/model/Constants.html new file mode 100644 index 0000000..0e6f28f --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/Constants.html @@ -0,0 +1,398 @@ +<!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>Constants (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="Constants (FreeMarker 3.0.0-nightly-incubating API)"; + } + } + catch(err) { + } +//--> +</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/Constants.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/AdapterTemplateModel.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/Constants.html" target="_top">Frames</a></li> +<li><a href="Constants.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="#methods.inherited.from.class.java.lang.Object">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>Method</li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.freemarker.core.model</div> +<h2 title="Class Constants" class="title">Class Constants</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.Constants</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">Constants</span> +extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">Frequently used constant <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> values. + + <p>These constants should be stored in the <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> + sub-interfaces, but for bacward compatibility they are stored here instead. + Starting from FreeMarker 2.4 they should be copyed (not moved!) into the + <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> sub-interfaces, and this class should be marked as + deprecated.</p></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/freemarker/core/model/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/Constants.html#EMPTY_COLLECTION">EMPTY_COLLECTION</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/freemarker/core/model/TemplateHashModelEx.html" title="interface in org.apache.freemarker.core.model">TemplateHashModelEx</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/Constants.html#EMPTY_HASH">EMPTY_HASH</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <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/Constants.html#EMPTY_ITERATOR">EMPTY_ITERATOR</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/freemarker/core/model/TemplateSequenceModel.html" title="interface in org.apache.freemarker.core.model">TemplateSequenceModel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/Constants.html#EMPTY_SEQUENCE">EMPTY_SEQUENCE</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/freemarker/core/model/TemplateScalarModel.html" title="interface in org.apache.freemarker.core.model">TemplateScalarModel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/Constants.html#EMPTY_STRING">EMPTY_STRING</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/freemarker/core/model/TemplateBooleanModel.html" title="interface in org.apache.freemarker.core.model">TemplateBooleanModel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/Constants.html#FALSE">FALSE</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/freemarker/core/model/TemplateNumberModel.html" title="interface in org.apache.freemarker.core.model">TemplateNumberModel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/Constants.html#MINUS_ONE">MINUS_ONE</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/freemarker/core/model/TemplateNumberModel.html" title="interface in org.apache.freemarker.core.model">TemplateNumberModel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/Constants.html#ONE">ONE</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/freemarker/core/model/TemplateBooleanModel.html" title="interface in org.apache.freemarker.core.model">TemplateBooleanModel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/Constants.html#TRUE">TRUE</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/freemarker/core/model/TemplateNumberModel.html" title="interface in org.apache.freemarker.core.model">TemplateNumberModel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/Constants.html#ZERO">ZERO</a></span></code> </td> +</tr> +</table> +</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/Constants.html#Constants--">Constants</a></span>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="TRUE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>TRUE</h4> +<pre>public static final <a href="../../../../../org/apache/freemarker/core/model/TemplateBooleanModel.html" title="interface in org.apache.freemarker.core.model">TemplateBooleanModel</a> TRUE</pre> +</li> +</ul> +<a name="FALSE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FALSE</h4> +<pre>public static final <a href="../../../../../org/apache/freemarker/core/model/TemplateBooleanModel.html" title="interface in org.apache.freemarker.core.model">TemplateBooleanModel</a> FALSE</pre> +</li> +</ul> +<a name="EMPTY_STRING"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EMPTY_STRING</h4> +<pre>public static final <a href="../../../../../org/apache/freemarker/core/model/TemplateScalarModel.html" title="interface in org.apache.freemarker.core.model">TemplateScalarModel</a> EMPTY_STRING</pre> +</li> +</ul> +<a name="ZERO"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ZERO</h4> +<pre>public static final <a href="../../../../../org/apache/freemarker/core/model/TemplateNumberModel.html" title="interface in org.apache.freemarker.core.model">TemplateNumberModel</a> ZERO</pre> +</li> +</ul> +<a name="ONE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ONE</h4> +<pre>public static final <a href="../../../../../org/apache/freemarker/core/model/TemplateNumberModel.html" title="interface in org.apache.freemarker.core.model">TemplateNumberModel</a> ONE</pre> +</li> +</ul> +<a name="MINUS_ONE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MINUS_ONE</h4> +<pre>public static final <a href="../../../../../org/apache/freemarker/core/model/TemplateNumberModel.html" title="interface in org.apache.freemarker.core.model">TemplateNumberModel</a> MINUS_ONE</pre> +</li> +</ul> +<a name="EMPTY_ITERATOR"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EMPTY_ITERATOR</h4> +<pre>public static final <a href="../../../../../org/apache/freemarker/core/model/TemplateModelIterator.html" title="interface in org.apache.freemarker.core.model">TemplateModelIterator</a> EMPTY_ITERATOR</pre> +</li> +</ul> +<a name="EMPTY_COLLECTION"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EMPTY_COLLECTION</h4> +<pre>public static final <a href="../../../../../org/apache/freemarker/core/model/TemplateCollectionModel.html" title="interface in org.apache.freemarker.core.model">TemplateCollectionModel</a> EMPTY_COLLECTION</pre> +</li> +</ul> +<a name="EMPTY_SEQUENCE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EMPTY_SEQUENCE</h4> +<pre>public static final <a href="../../../../../org/apache/freemarker/core/model/TemplateSequenceModel.html" title="interface in org.apache.freemarker.core.model">TemplateSequenceModel</a> EMPTY_SEQUENCE</pre> +</li> +</ul> +<a name="EMPTY_HASH"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>EMPTY_HASH</h4> +<pre>public static final <a href="../../../../../org/apache/freemarker/core/model/TemplateHashModelEx.html" title="interface in org.apache.freemarker.core.model">TemplateHashModelEx</a> EMPTY_HASH</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Constants--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Constants</h4> +<pre>public Constants()</pre> +</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/Constants.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/AdapterTemplateModel.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/Constants.html" target="_top">Frames</a></li> +<li><a href="Constants.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="#methods.inherited.from.class.java.lang.Object">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>Method</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/ObjectWrapper.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/ObjectWrapper.html b/builds/fm3/api/org/apache/freemarker/core/model/ObjectWrapper.html new file mode 100644 index 0000000..312f80b --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/ObjectWrapper.html @@ -0,0 +1,264 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_66) on Wed Mar 01 19:40:22 CET 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ObjectWrapper (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="ObjectWrapper (FreeMarker 3.0.0-nightly-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ObjectWrapper.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/Constants.html" title="class in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/ObjectWrapper.html" target="_top">Frames</a></li> +<li><a href="ObjectWrapper.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.freemarker.core.model</div> +<h2 title="Interface ObjectWrapper" class="title">Interface ObjectWrapper</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapperAndUnwrapper</a>, <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperWithAPISupport.html" title="interface in org.apache.freemarker.core.model">ObjectWrapperWithAPISupport</a>, <a href="../../../../../org/apache/freemarker/core/model/RichObjectWrapper.html" title="interface in org.apache.freemarker.core.model">RichObjectWrapper</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/freemarker/core/model/impl/DefaultObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl">DefaultObjectWrapper</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/RestrictedObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl">RestrictedObjectWrapper</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ObjectWrapper</span></pre> +<div class="block">Maps Java objects to the type-system of FreeMarker Template Language (see the <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> + interfaces). Thus this is what decides what parts of the Java objects will be accessible in the templates and how. + + <p>For example, with a <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl"><code>DefaultObjectWrapper</code></a> both the items of <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> and the JavaBean properties (the getters) + of an object are accessible in template uniformly with the <code>myObject.foo</code> syntax, where "foo" is the map key or + the property name. This is because both kind of object is wrapped by <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl"><code>DefaultObjectWrapper</code></a> into a + <a href="../../../../../org/apache/freemarker/core/model/TemplateHashModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateHashModel</code></a> implementation that will call <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#get-java.lang.Object-"; title="class or interface in java.util"><code>Map.get(Object)</code></a> or the getter method, transparently + to the template language.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../org/apache/freemarker/core/Configuration.html#setObjectWrapper-org.apache.freemarker.core.model.ObjectWrapper-"><code>Configuration.setObjectWrapper(ObjectWrapper)</code></a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><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/ObjectWrapper.html#wrap-java.lang.Object-">wrap</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> obj)</code> +<div class="block">Makes a <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> out of a non-<a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> object, usually by "wrapping" it into a + <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> implementation that delegates to the original object.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="wrap-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>wrap</h4> +<pre><a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a> wrap(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> obj) + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<div class="block">Makes a <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> out of a non-<a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> object, usually by "wrapping" it into a + <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> implementation that delegates to the original object.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>obj</code> - The object to wrap into a <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a>. If it already implements <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a>, + it should just return the object as is. If it's <code>null</code>, the method should return <code>null</code> + (however, <a href="../../../../../org/apache/freemarker/core/model/impl/DefaultObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl"><code>DefaultObjectWrapper</code></a>, has a legacy option for returning a null model object instead, but it's not + a good idea).</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> wrapper of the object passed in. To support un-wrapping, you may consider the + return value to implement <a href="../../../../../org/apache/freemarker/core/model/WrapperTemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>WrapperTemplateModel</code></a> and <a href="../../../../../org/apache/freemarker/core/model/AdapterTemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>AdapterTemplateModel</code></a>. + The default expectation is that the <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> isn't less thread safe than the wrapped object. + If the <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model"><code>ObjectWrapper</code></a> returns less thread safe objects, that should be clearly documented, as it + restricts how it can be used, like, then it can't be used to wrap "shared variables" + (<a href="../../../../../org/apache/freemarker/core/Configuration.html#setSharedVaribles-java.util.Map-"><code>Configuration.setSharedVaribles(Map)</code></a>).</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/ObjectWrapper.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/Constants.html" title="class in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/ObjectWrapper.html" target="_top">Frames</a></li> +<li><a href="ObjectWrapper.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html b/builds/fm3/api/org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html new file mode 100644 index 0000000..a79b49a --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html @@ -0,0 +1,360 @@ +<!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>ObjectWrapperAndUnwrapper (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="ObjectWrapperAndUnwrapper (FreeMarker 3.0.0-nightly-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ObjectWrapperAndUnwrapper.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/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperWithAPISupport.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html" target="_top">Frames</a></li> +<li><a href="ObjectWrapperAndUnwrapper.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.freemarker.core.model</div> +<h2 title="Interface ObjectWrapperAndUnwrapper" class="title">Interface ObjectWrapperAndUnwrapper</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapper</a></dd> +</dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../../org/apache/freemarker/core/model/RichObjectWrapper.html" title="interface in org.apache.freemarker.core.model">RichObjectWrapper</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/freemarker/core/model/impl/DefaultObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl">DefaultObjectWrapper</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/RestrictedObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl">RestrictedObjectWrapper</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ObjectWrapperAndUnwrapper</span> +extends <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapper</a></pre> +<div class="block"><b>Experimental - subject to change:</b> Adds functionality to <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model"><code>ObjectWrapper</code></a> that creates a plain Java object + from a <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a>. This is usually implemented by <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model"><code>ObjectWrapper</code></a>-s and reverses + <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html#wrap-java.lang.Object-"><code>ObjectWrapper.wrap(Object)</code></a>. However, an implementation of this interface should make a reasonable effort to + "unwrap" <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a>-s that wasn't the result of object wrapping (such as those created directly in FTL), + or which was created by another <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model"><code>ObjectWrapper</code></a>. The author of an <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html" title="interface in org.apache.freemarker.core.model"><code>ObjectWrapperAndUnwrapper</code></a> should be + aware of the <a href="../../../../../org/apache/freemarker/core/model/TemplateModelAdapter.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModelAdapter</code></a> and <a href="../../../../../org/apache/freemarker/core/model/WrapperTemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>WrapperTemplateModel</code></a> interfaces, which should be used for + unwrapping if the <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> implements them. + + <p> + <b>Experimental status warning:</b> This interface is subject to change on non-backward compatible ways, hence, it + shouldn't be implemented outside FreeMarker yet.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.22</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="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/ObjectWrapperAndUnwrapper.html#CANT_UNWRAP_TO_TARGET_CLASS">CANT_UNWRAP_TO_TARGET_CLASS</a></span></code> +<div class="block">Indicates that while the unwrapping is <em>maybe</em> possible, the result surely can't be the instance of the + desired class, nor it can be <code>null</code>.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><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/ObjectWrapperAndUnwrapper.html#tryUnwrapTo-org.apache.freemarker.core.model.TemplateModel-java.lang.Class-">tryUnwrapTo</a></span>(<a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a> tm, + <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><?> targetClass)</code> +<div class="block">Attempts to unwrap a <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> to a plain Java object that's the instance of the given class (or is + <code>null</code>).</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/ObjectWrapperAndUnwrapper.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> tm)</code> +<div class="block">Unwraps a <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> to a plain Java object.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.freemarker.core.model.ObjectWrapper"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.freemarker.core.model.<a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapper</a></h3> +<code><a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html#wrap-java.lang.Object-">wrap</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="CANT_UNWRAP_TO_TARGET_CLASS"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CANT_UNWRAP_TO_TARGET_CLASS</h4> +<pre>static 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> CANT_UNWRAP_TO_TARGET_CLASS</pre> +<div class="block">Indicates that while the unwrapping is <em>maybe</em> possible, the result surely can't be the instance of the + desired class, nor it can be <code>null</code>.</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/ObjectWrapperAndUnwrapper.html#tryUnwrapTo-org.apache.freemarker.core.model.TemplateModel-java.lang.Class-"><code>tryUnwrapTo(TemplateModel, Class)</code></a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="unwrap-org.apache.freemarker.core.model.TemplateModel-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>unwrap</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> unwrap(<a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a> tm) + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<div class="block">Unwraps a <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> to a plain Java object.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The plain Java object. Can be <code>null</code>, if <code>null</code> is the appropriate Java value to represent + the template model. <code>null</code> must not be used to indicate an unwrapping failure. It must NOT be + <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html#CANT_UNWRAP_TO_TARGET_CLASS"><code>CANT_UNWRAP_TO_TARGET_CLASS</code></a>.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></code> - If the unwrapping fails from any reason.</dd> +<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/ObjectWrapperAndUnwrapper.html#tryUnwrapTo-org.apache.freemarker.core.model.TemplateModel-java.lang.Class-"><code>tryUnwrapTo(TemplateModel, Class)</code></a></dd> +</dl> +</li> +</ul> +<a name="tryUnwrapTo-org.apache.freemarker.core.model.TemplateModel-java.lang.Class-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>tryUnwrapTo</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> tryUnwrapTo(<a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model">TemplateModel</a> tm, + <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><?> targetClass) + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<div class="block">Attempts to unwrap a <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> to a plain Java object that's the instance of the given class (or is + <code>null</code>).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>targetClass</code> - The class that the return value must be an instance of (except when the return value is <code>null</code>). + Can't be <code>null</code>; if the caller doesn't care, it should either use {#unwrap(TemplateModel)}, or + <code>Object.class</code> as the parameter value.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The unwrapped value that's either an instance of <code>targetClass</code>, or is <code>null</code> (if <code>null</code> + is the appropriate Java value to represent the template model), or is + <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html#CANT_UNWRAP_TO_TARGET_CLASS"><code>CANT_UNWRAP_TO_TARGET_CLASS</code></a> if the unwrapping can't satisfy the <code>targetClass</code> (nor the + result can be <code>null</code>). However, <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html#CANT_UNWRAP_TO_TARGET_CLASS"><code>CANT_UNWRAP_TO_TARGET_CLASS</code></a> must not be returned if the + <code>targetClass</code> parameter was <code>Object.class</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> - If the unwrapping fails for a reason than doesn't fit the meaning of the + <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html#CANT_UNWRAP_TO_TARGET_CLASS"><code>CANT_UNWRAP_TO_TARGET_CLASS</code></a> return value.</dd> +<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/ObjectWrapperAndUnwrapper.html#unwrap-org.apache.freemarker.core.model.TemplateModel-"><code>unwrap(TemplateModel)</code></a></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ObjectWrapperAndUnwrapper.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/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperWithAPISupport.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html" target="_top">Frames</a></li> +<li><a href="ObjectWrapperAndUnwrapper.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/ObjectWrapperWithAPISupport.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/ObjectWrapperWithAPISupport.html b/builds/fm3/api/org/apache/freemarker/core/model/ObjectWrapperWithAPISupport.html new file mode 100644 index 0000000..77d1319 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/ObjectWrapperWithAPISupport.html @@ -0,0 +1,266 @@ +<!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>ObjectWrapperWithAPISupport (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="ObjectWrapperWithAPISupport (FreeMarker 3.0.0-nightly-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ObjectWrapperWithAPISupport.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/ObjectWrapperAndUnwrapper.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/RichObjectWrapper.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/ObjectWrapperWithAPISupport.html" target="_top">Frames</a></li> +<li><a href="ObjectWrapperWithAPISupport.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.freemarker.core.model</div> +<h2 title="Interface ObjectWrapperWithAPISupport" class="title">Interface ObjectWrapperWithAPISupport</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapper</a></dd> +</dl> +<dl> +<dt>All Known Subinterfaces:</dt> +<dd><a href="../../../../../org/apache/freemarker/core/model/RichObjectWrapper.html" title="interface in org.apache.freemarker.core.model">RichObjectWrapper</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/freemarker/core/model/impl/DefaultObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl">DefaultObjectWrapper</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/RestrictedObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl">RestrictedObjectWrapper</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ObjectWrapperWithAPISupport</span> +extends <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapper</a></pre> +<div class="block"><b>Experimental - subject to change:</b> Implemented by <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model"><code>ObjectWrapper</code></a>-s to help <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a>-s to + implement the <code>someValue?api</code> operation. + + <p> + <b>Experimental status warning:</b> This interface is subject to change on non-backward compatible ways, hence, it + shouldn't be implemented outside FreeMarker yet.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.22</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/freemarker/core/model/TemplateHashModel.html" title="interface in org.apache.freemarker.core.model">TemplateHashModel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperWithAPISupport.html#wrapAsAPI-java.lang.Object-">wrapAsAPI</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> obj)</code> +<div class="block">Wraps an object to a <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> that exposes the object's "native" (usually, Java) API.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.freemarker.core.model.ObjectWrapper"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.freemarker.core.model.<a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapper</a></h3> +<code><a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html#wrap-java.lang.Object-">wrap</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="wrapAsAPI-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>wrapAsAPI</h4> +<pre><a href="../../../../../org/apache/freemarker/core/model/TemplateHashModel.html" title="interface in org.apache.freemarker.core.model">TemplateHashModel</a> wrapAsAPI(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> obj) + throws <a href="../../../../../org/apache/freemarker/core/model/TemplateModelException.html" title="class in org.apache.freemarker.core.model">TemplateModelException</a></pre> +<div class="block">Wraps an object to a <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> that exposes the object's "native" (usually, Java) API.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>obj</code> - The object for which the API model has to be returned. Shouldn't be <code>null</code>.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The <a href="../../../../../org/apache/freemarker/core/model/TemplateModel.html" title="interface in org.apache.freemarker.core.model"><code>TemplateModel</code></a> through which the API of the object can be accessed. Can't be <code>null</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> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.22</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/ObjectWrapperWithAPISupport.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/ObjectWrapperAndUnwrapper.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/RichObjectWrapper.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/ObjectWrapperWithAPISupport.html" target="_top">Frames</a></li> +<li><a href="ObjectWrapperWithAPISupport.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/model/RichObjectWrapper.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/model/RichObjectWrapper.html b/builds/fm3/api/org/apache/freemarker/core/model/RichObjectWrapper.html new file mode 100644 index 0000000..ccedf7a --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/model/RichObjectWrapper.html @@ -0,0 +1,237 @@ +<!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>RichObjectWrapper (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="RichObjectWrapper (FreeMarker 3.0.0-nightly-incubating API)"; + } + } + catch(err) { + } +//--> +</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/RichObjectWrapper.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/ObjectWrapperWithAPISupport.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/TemplateBooleanModel.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/RichObjectWrapper.html" target="_top">Frames</a></li> +<li><a href="RichObjectWrapper.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>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.freemarker.core.model</div> +<h2 title="Interface RichObjectWrapper" class="title">Interface RichObjectWrapper</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapper</a>, <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapperAndUnwrapper</a>, <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperWithAPISupport.html" title="interface in org.apache.freemarker.core.model">ObjectWrapperWithAPISupport</a></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/freemarker/core/model/impl/DefaultObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl">DefaultObjectWrapper</a>, <a href="../../../../../org/apache/freemarker/core/model/impl/RestrictedObjectWrapper.html" title="class in org.apache.freemarker.core.model.impl">RestrictedObjectWrapper</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">RichObjectWrapper</span> +extends <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapperAndUnwrapper</a>, <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperWithAPISupport.html" title="interface in org.apache.freemarker.core.model">ObjectWrapperWithAPISupport</a></pre> +<div class="block"><b>Experimental - subject to change:</b> Union of the interfaces that a typical feature rich <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model"><code>ObjectWrapper</code></a> is + expected to implement. + + <p> + <b>Experimental status warning:</b> This interface is subject to change on non-backward compatible ways, hence, it + shouldn't be implemented outside FreeMarker yet.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.22</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.freemarker.core.model.ObjectWrapperAndUnwrapper"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.freemarker.core.model.<a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapperAndUnwrapper</a></h3> +<code><a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html#CANT_UNWRAP_TO_TARGET_CLASS">CANT_UNWRAP_TO_TARGET_CLASS</a></code></li> +</ul> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.freemarker.core.model.ObjectWrapperAndUnwrapper"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.freemarker.core.model.<a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapperAndUnwrapper</a></h3> +<code><a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html#tryUnwrapTo-org.apache.freemarker.core.model.TemplateModel-java.lang.Class-">tryUnwrapTo</a>, <a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperAndUnwrapper.html#unwrap-org.apache.freemarker.core.model.TemplateModel-">unwrap</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.freemarker.core.model.ObjectWrapperWithAPISupport"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.freemarker.core.model.<a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperWithAPISupport.html" title="interface in org.apache.freemarker.core.model">ObjectWrapperWithAPISupport</a></h3> +<code><a href="../../../../../org/apache/freemarker/core/model/ObjectWrapperWithAPISupport.html#wrapAsAPI-java.lang.Object-">wrapAsAPI</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.freemarker.core.model.ObjectWrapper"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.freemarker.core.model.<a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapper</a></h3> +<code><a href="../../../../../org/apache/freemarker/core/model/ObjectWrapper.html#wrap-java.lang.Object-">wrap</a></code></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/RichObjectWrapper.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/ObjectWrapperWithAPISupport.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/freemarker/core/model/TemplateBooleanModel.html" title="interface in org.apache.freemarker.core.model"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/freemarker/core/model/RichObjectWrapper.html" target="_top">Frames</a></li> +<li><a href="RichObjectWrapper.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>Method</li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li>Method</li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
