http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/b35e4aa5/builds/2.3.24-pre01/_html/api/freemarker/core/CustomAttribute.html ---------------------------------------------------------------------- diff --git a/builds/2.3.24-pre01/_html/api/freemarker/core/CustomAttribute.html b/builds/2.3.24-pre01/_html/api/freemarker/core/CustomAttribute.html new file mode 100644 index 0000000..f20066e --- /dev/null +++ b/builds/2.3.24-pre01/_html/api/freemarker/core/CustomAttribute.html @@ -0,0 +1,629 @@ +<!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_20) on Wed Sep 02 01:20:16 CEST 2015 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>CustomAttribute (FreeMarker 2.3.24-pre01 API)</title> +<meta name="date" content="2015-09-02"> +<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="CustomAttribute (FreeMarker 2.3.24-pre01 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/CustomAttribute.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="../../freemarker/core/Configurable.UnknownSettingException.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/DirectiveCallPlace.html" title="interface in freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/core/CustomAttribute.html" target="_top">Frames</a></li> +<li><a href="CustomAttribute.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">freemarker.core</div> +<h2 title="Class CustomAttribute" class="title">Class CustomAttribute</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>freemarker.core.CustomAttribute</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">CustomAttribute</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">A class that allows one to associate custom data with a <a href="../../freemarker/template/Configuration.html" title="class in freemarker.template"><code>Configuration</code></a>, a <a href="../../freemarker/template/Template.html" title="class in freemarker.template"><code>Template</code></a>, or + <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a>. + + <p>This API has similar approach to that of <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/ThreadLocal.html?is-external=true" title="class or interface in java.lang"><code>ThreadLocal</code></a> (which allows one to associate + custom data with a thread). With an example:</p> + + <pre> + // The object identity itself will serve as the attribute identifier; there's no attribute name String: + public static final CustomAttribute MY_ATTR = new CustomAttribute(CustomAttribute.SCOPE_CONFIGURATION); + ... + // Set the attribute in this particular Configuration object: + MY_ATTR.set(myAttrValue, cfg); + ... + // Read the attribute from this particular Configuration object: + myAttrValue = MY_ATTR.get(cfg); + </pre></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CustomAttribute.html#SCOPE_CONFIGURATION">SCOPE_CONFIGURATION</a></span></code> +<div class="block">Constant used in the constructor specifying that this attribute is <a href="../../freemarker/template/Configuration.html" title="class in freemarker.template"><code>Configuration</code></a>-scoped.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CustomAttribute.html#SCOPE_ENVIRONMENT">SCOPE_ENVIRONMENT</a></span></code> +<div class="block">Constant used in the constructor specifying that this attribute is <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a>-scoped.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CustomAttribute.html#SCOPE_TEMPLATE">SCOPE_TEMPLATE</a></span></code> +<div class="block">Constant used in the constructor specifying that this attribute is <a href="../../freemarker/template/Template.html" title="class in freemarker.template"><code>Template</code></a>-scoped.</div> +</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="../../freemarker/core/CustomAttribute.html#CustomAttribute-int-">CustomAttribute</a></span>(int scope)</code> +<div class="block">Creates a new custom attribute with the specified scope</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CustomAttribute.html#create--">create</a></span>()</code> +<div class="block">This method is invoked when <a href="../../freemarker/core/CustomAttribute.html#get--"><code>get()</code></a> is invoked without + <a href="../../freemarker/core/CustomAttribute.html#set-java.lang.Object-"><code>set(Object)</code></a> being invoked before it to define the value in the + current scope.</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="../../freemarker/core/CustomAttribute.html#get--">get</a></span>()</code> +<div class="block">Same as <a href="../../freemarker/core/CustomAttribute.html#get-freemarker.core.Environment-"><code>get(Environment)</code></a>, but uses <a href="../../freemarker/core/Environment.html#getCurrentEnvironment--"><code>Environment.getCurrentEnvironment()</code></a> to fill the 2nd argument.</div> +</td> +</tr> +<tr id="i2" 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="../../freemarker/core/CustomAttribute.html#get-freemarker.template.Configuration-">get</a></span>(<a href="../../freemarker/template/Configuration.html" title="class in freemarker.template">Configuration</a> cfg)</code> +<div class="block">Gets the value of a <a href="../../freemarker/template/Configuration.html" title="class in freemarker.template"><code>Configuration</code></a>-scope attribute from the given <a href="../../freemarker/template/Configuration.html" title="class in freemarker.template"><code>Configuration</code></a>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CustomAttribute.html#get-freemarker.core.Environment-">get</a></span>(<a href="../../freemarker/core/Environment.html" title="class in freemarker.core">Environment</a> env)</code> +<div class="block">Gets the attribute from the appropriate scope that's accessible through the specified <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a>.</div> +</td> +</tr> +<tr id="i4" 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="../../freemarker/core/CustomAttribute.html#get-freemarker.template.Template-">get</a></span>(<a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a> template)</code> +<div class="block">Gets the value of a <a href="../../freemarker/template/Template.html" title="class in freemarker.template"><code>Template</code></a>-scope attribute from the given <a href="../../freemarker/template/Template.html" title="class in freemarker.template"><code>Template</code></a>.</div> +</td> +</tr> +<tr id="i5" 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="../../freemarker/core/CustomAttribute.html#get-freemarker.core.TemplateConfigurer-">get</a></span>(<a href="../../freemarker/core/TemplateConfigurer.html" title="class in freemarker.core">TemplateConfigurer</a> templateConfigurer)</code> +<div class="block">Same as <a href="../../freemarker/core/CustomAttribute.html#get-freemarker.template.Template-"><code>get(Template)</code></a>, but applies to a <a href="../../freemarker/core/TemplateConfigurer.html" title="class in freemarker.core"><code>TemplateConfigurer</code></a>.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CustomAttribute.html#set-java.lang.Object-">set</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> value)</code> +<div class="block">Same as <a href="../../freemarker/core/CustomAttribute.html#set-java.lang.Object-freemarker.core.Environment-"><code>set(Object, Environment)</code></a>, but uses <a href="../../freemarker/core/Environment.html#getCurrentEnvironment--"><code>Environment.getCurrentEnvironment()</code></a> to fill the 2nd + argument.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CustomAttribute.html#set-java.lang.Object-freemarker.template.Configuration-">set</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> value, + <a href="../../freemarker/template/Configuration.html" title="class in freemarker.template">Configuration</a> cfg)</code> +<div class="block">Sets the value of a <a href="../../freemarker/template/Configuration.html" title="class in freemarker.template"><code>Configuration</code></a>-scope attribute in the given <a href="../../freemarker/template/Configuration.html" title="class in freemarker.template"><code>Configuration</code></a>.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CustomAttribute.html#set-java.lang.Object-freemarker.core.Environment-">set</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> value, + <a href="../../freemarker/core/Environment.html" title="class in freemarker.core">Environment</a> env)</code> +<div class="block">Sets the attribute inside the appropriate scope that's accessible through the specified <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a>.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CustomAttribute.html#set-java.lang.Object-freemarker.template.Template-">set</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> value, + <a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a> template)</code> +<div class="block">Sets the value of a <a href="../../freemarker/template/Template.html" title="class in freemarker.template"><code>Template</code></a>-scope attribute in the given <a href="../../freemarker/template/Template.html" title="class in freemarker.template"><code>Template</code></a>.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CustomAttribute.html#set-java.lang.Object-freemarker.core.TemplateConfigurer-">set</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> value, + <a href="../../freemarker/core/TemplateConfigurer.html" title="class in freemarker.core">TemplateConfigurer</a> templateConfigurer)</code> +<div class="block">Same as <a href="../../freemarker/core/CustomAttribute.html#set-java.lang.Object-freemarker.template.Template-"><code>set(Object, Template)</code></a>, but applicable to a <a href="../../freemarker/core/TemplateConfigurer.html" title="class in freemarker.core"><code>TemplateConfigurer</code></a>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="SCOPE_ENVIRONMENT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SCOPE_ENVIRONMENT</h4> +<pre>public static final int SCOPE_ENVIRONMENT</pre> +<div class="block">Constant used in the constructor specifying that this attribute is <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a>-scoped.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../constant-values.html#freemarker.core.CustomAttribute.SCOPE_ENVIRONMENT">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="SCOPE_TEMPLATE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>SCOPE_TEMPLATE</h4> +<pre>public static final int SCOPE_TEMPLATE</pre> +<div class="block">Constant used in the constructor specifying that this attribute is <a href="../../freemarker/template/Template.html" title="class in freemarker.template"><code>Template</code></a>-scoped.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../constant-values.html#freemarker.core.CustomAttribute.SCOPE_TEMPLATE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="SCOPE_CONFIGURATION"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SCOPE_CONFIGURATION</h4> +<pre>public static final int SCOPE_CONFIGURATION</pre> +<div class="block">Constant used in the constructor specifying that this attribute is <a href="../../freemarker/template/Configuration.html" title="class in freemarker.template"><code>Configuration</code></a>-scoped.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../constant-values.html#freemarker.core.CustomAttribute.SCOPE_CONFIGURATION">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="CustomAttribute-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CustomAttribute</h4> +<pre>public CustomAttribute(int scope)</pre> +<div class="block">Creates a new custom attribute with the specified scope</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>scope</code> - one of <tt>SCOPE_</tt> constants.</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="create--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> create()</pre> +<div class="block">This method is invoked when <a href="../../freemarker/core/CustomAttribute.html#get--"><code>get()</code></a> is invoked without + <a href="../../freemarker/core/CustomAttribute.html#set-java.lang.Object-"><code>set(Object)</code></a> being invoked before it to define the value in the + current scope. Override it to create the attribute value on-demand.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the initial value for the custom attribute. By default returns null.</dd> +</dl> +</li> +</ul> +<a name="get-freemarker.core.Environment-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</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> get(<a href="../../freemarker/core/Environment.html" title="class in freemarker.core">Environment</a> env)</pre> +<div class="block">Gets the attribute from the appropriate scope that's accessible through the specified <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a>. If + the attribute has <a href="../../freemarker/core/CustomAttribute.html#SCOPE_ENVIRONMENT"><code>SCOPE_ENVIRONMENT</code></a> scope, it will be get from the given <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a> directly. + If the attribute has <a href="../../freemarker/core/CustomAttribute.html#SCOPE_TEMPLATE"><code>SCOPE_TEMPLATE</code></a> scope, it will be get from the parent of the given + <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a> (that is, in <a href="../../freemarker/core/Configurable.html#getParent--"><code>Configurable.getParent()</code></a>) directly). If the attribute has + <a href="../../freemarker/core/CustomAttribute.html#SCOPE_CONFIGURATION"><code>SCOPE_CONFIGURATION</code></a> scope, it will be get from <a href="../../freemarker/core/Environment.html#getConfiguration--"><code>Environment.getConfiguration()</code></a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The new value of the attribute (possibly <code>null</code>), or <code>null</code> if the attribute doesn't exist.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - If <code>env</code> is null</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.22</dd> +</dl> +</li> +</ul> +<a name="get--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</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> get()</pre> +<div class="block">Same as <a href="../../freemarker/core/CustomAttribute.html#get-freemarker.core.Environment-"><code>get(Environment)</code></a>, but uses <a href="../../freemarker/core/Environment.html#getCurrentEnvironment--"><code>Environment.getCurrentEnvironment()</code></a> to fill the 2nd argument.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - If there is no current <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a>, which is usually the case when the current thread isn't + processing a template.</dd> +</dl> +</li> +</ul> +<a name="get-freemarker.template.Template-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</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> get(<a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a> template)</pre> +<div class="block">Gets the value of a <a href="../../freemarker/template/Template.html" title="class in freemarker.template"><code>Template</code></a>-scope attribute from the given <a href="../../freemarker/template/Template.html" title="class in freemarker.template"><code>Template</code></a>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - If this custom attribute has different scope than <a href="../../freemarker/core/CustomAttribute.html#SCOPE_TEMPLATE"><code>SCOPE_TEMPLATE</code></a>.</dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - If <code>template</code> is null</dd> +</dl> +</li> +</ul> +<a name="get-freemarker.core.TemplateConfigurer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> get(<a href="../../freemarker/core/TemplateConfigurer.html" title="class in freemarker.core">TemplateConfigurer</a> templateConfigurer)</pre> +<div class="block">Same as <a href="../../freemarker/core/CustomAttribute.html#get-freemarker.template.Template-"><code>get(Template)</code></a>, but applies to a <a href="../../freemarker/core/TemplateConfigurer.html" title="class in freemarker.core"><code>TemplateConfigurer</code></a>.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.24</dd> +</dl> +</li> +</ul> +<a name="get-freemarker.template.Configuration-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</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> get(<a href="../../freemarker/template/Configuration.html" title="class in freemarker.template">Configuration</a> cfg)</pre> +<div class="block">Gets the value of a <a href="../../freemarker/template/Configuration.html" title="class in freemarker.template"><code>Configuration</code></a>-scope attribute from the given <a href="../../freemarker/template/Configuration.html" title="class in freemarker.template"><code>Configuration</code></a>.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - If this custom attribute has different scope than <a href="../../freemarker/core/CustomAttribute.html#SCOPE_CONFIGURATION"><code>SCOPE_CONFIGURATION</code></a>.</dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - If <code>cfg</code> is null</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.22</dd> +</dl> +</li> +</ul> +<a name="set-java.lang.Object-freemarker.core.Environment-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public final void set(<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> value, + <a href="../../freemarker/core/Environment.html" title="class in freemarker.core">Environment</a> env)</pre> +<div class="block">Sets the attribute inside the appropriate scope that's accessible through the specified <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a>. If + the attribute has <a href="../../freemarker/core/CustomAttribute.html#SCOPE_ENVIRONMENT"><code>SCOPE_ENVIRONMENT</code></a> scope, it will be set in the given <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a> directly. If + the attribute has <a href="../../freemarker/core/CustomAttribute.html#SCOPE_TEMPLATE"><code>SCOPE_TEMPLATE</code></a> scope, it will be set in the parent of the given <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a> + (that is, in <a href="../../freemarker/core/Configurable.html#getParent--"><code>Configurable.getParent()</code></a>) directly). If the attribute has <a href="../../freemarker/core/CustomAttribute.html#SCOPE_CONFIGURATION"><code>SCOPE_CONFIGURATION</code></a> scope, + it will be set in <a href="../../freemarker/core/Environment.html#getConfiguration--"><code>Environment.getConfiguration()</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The new value of the attribute. Can be <code>null</code>.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - If <code>env</code> is null</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.22</dd> +</dl> +</li> +</ul> +<a name="set-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public final void set(<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> value)</pre> +<div class="block">Same as <a href="../../freemarker/core/CustomAttribute.html#set-java.lang.Object-freemarker.core.Environment-"><code>set(Object, Environment)</code></a>, but uses <a href="../../freemarker/core/Environment.html#getCurrentEnvironment--"><code>Environment.getCurrentEnvironment()</code></a> to fill the 2nd + argument.</div> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - If there is no current <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a>, which is usually the case when the current thread isn't + processing a template.</dd> +</dl> +</li> +</ul> +<a name="set-java.lang.Object-freemarker.template.Template-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public final void set(<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> value, + <a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a> template)</pre> +<div class="block">Sets the value of a <a href="../../freemarker/template/Template.html" title="class in freemarker.template"><code>Template</code></a>-scope attribute in the given <a href="../../freemarker/template/Template.html" title="class in freemarker.template"><code>Template</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The new value of the attribute. Can be <code>null</code>.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - If this custom attribute has different scope than <a href="../../freemarker/core/CustomAttribute.html#SCOPE_TEMPLATE"><code>SCOPE_TEMPLATE</code></a>.</dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - If <code>template</code> is null</dd> +</dl> +</li> +</ul> +<a name="set-java.lang.Object-freemarker.core.TemplateConfigurer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>set</h4> +<pre>public final void set(<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> value, + <a href="../../freemarker/core/TemplateConfigurer.html" title="class in freemarker.core">TemplateConfigurer</a> templateConfigurer)</pre> +<div class="block">Same as <a href="../../freemarker/core/CustomAttribute.html#set-java.lang.Object-freemarker.template.Template-"><code>set(Object, Template)</code></a>, but applicable to a <a href="../../freemarker/core/TemplateConfigurer.html" title="class in freemarker.core"><code>TemplateConfigurer</code></a>.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.24</dd> +</dl> +</li> +</ul> +<a name="set-java.lang.Object-freemarker.template.Configuration-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>set</h4> +<pre>public final void set(<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> value, + <a href="../../freemarker/template/Configuration.html" title="class in freemarker.template">Configuration</a> cfg)</pre> +<div class="block">Sets the value of a <a href="../../freemarker/template/Configuration.html" title="class in freemarker.template"><code>Configuration</code></a>-scope attribute in the given <a href="../../freemarker/template/Configuration.html" title="class in freemarker.template"><code>Configuration</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - The new value of the attribute. Can be <code>null</code>.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - If this custom attribute has different scope than <a href="../../freemarker/core/CustomAttribute.html#SCOPE_CONFIGURATION"><code>SCOPE_CONFIGURATION</code></a>.</dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - If <code>cfg</code> is null</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/CustomAttribute.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="../../freemarker/core/Configurable.UnknownSettingException.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/DirectiveCallPlace.html" title="interface in freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/core/CustomAttribute.html" target="_top">Frames</a></li> +<li><a href="CustomAttribute.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/b35e4aa5/builds/2.3.24-pre01/_html/api/freemarker/core/DirectiveCallPlace.html ---------------------------------------------------------------------- diff --git a/builds/2.3.24-pre01/_html/api/freemarker/core/DirectiveCallPlace.html b/builds/2.3.24-pre01/_html/api/freemarker/core/DirectiveCallPlace.html new file mode 100644 index 0000000..0e38f7d --- /dev/null +++ b/builds/2.3.24-pre01/_html/api/freemarker/core/DirectiveCallPlace.html @@ -0,0 +1,389 @@ +<!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_20) on Wed Sep 02 01:20:16 CEST 2015 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>DirectiveCallPlace (FreeMarker 2.3.24-pre01 API)</title> +<meta name="date" content="2015-09-02"> +<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="DirectiveCallPlace (FreeMarker 2.3.24-pre01 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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/DirectiveCallPlace.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="../../freemarker/core/CustomAttribute.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/core/DirectiveCallPlace.html" target="_top">Frames</a></li> +<li><a href="DirectiveCallPlace.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">freemarker.core</div> +<h2 title="Interface DirectiveCallPlace" class="title">Interface DirectiveCallPlace</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">DirectiveCallPlace</span></pre> +<div class="block">Gives information about the place where a directive is called from, also lets you attach a custom data object to that + place. Each directive call in a template has its own <a href="../../freemarker/core/DirectiveCallPlace.html" title="interface in freemarker.core"><code>DirectiveCallPlace</code></a> object (even when they call the same + directive with the same parameters). The life cycle of the <a href="../../freemarker/core/DirectiveCallPlace.html" title="interface in freemarker.core"><code>DirectiveCallPlace</code></a> object is bound to the + <a href="../../freemarker/template/Template.html" title="class in freemarker.template"><code>Template</code></a> object that contains the directive call. Hence, the <a href="../../freemarker/core/DirectiveCallPlace.html" title="interface in freemarker.core"><code>DirectiveCallPlace</code></a> object and the custom + data you put into it is cached together with the <a href="../../freemarker/template/Template.html" title="class in freemarker.template"><code>Template</code></a> (and templates are normally cached - see + <a href="../../freemarker/template/Configuration.html#getTemplate-java.lang.String-"><code>Configuration.getTemplate(String)</code></a>). The custom data is normally initialized on demand, that is, when the + directive call is first executed, via <a href="../../freemarker/core/DirectiveCallPlace.html#getOrCreateCustomData-java.lang.Object-freemarker.template.utility.ObjectFactory-"><code>getOrCreateCustomData(Object, ObjectFactory)</code></a>. + + <p> + Currently this method doesn't give you access to the <a href="../../freemarker/template/Template.html" title="class in freemarker.template"><code>Template</code></a> object, because it's probable that future + versions of FreeMarker will be able to use the same parsed representation of a "file" for multiple <a href="../../freemarker/template/Template.html" title="class in freemarker.template"><code>Template</code></a> + objects. Then the call place will be bound to the parsed representation, not to the <a href="../../freemarker/template/Template.html" title="class in freemarker.template"><code>Template</code></a> objects that are + based on it. + + <p> + <b>Don't implement this interface yourself</b>, as new methods can be added to it any time! It's only meant to be + implemented by the FreeMarker core. + + <p> + This interface is currently only used for custom directive calls (that is, a <code><@...></code> that calls a + <a href="../../freemarker/template/TemplateDirectiveModel.html" title="interface in freemarker.template"><code>TemplateDirectiveModel</code></a>, <a href="../../freemarker/template/TemplateTransformModel.html" title="interface in freemarker.template"><code>TemplateTransformModel</code></a>, or a macro).</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="../../freemarker/core/Environment.html#getCurrentDirectiveCallPlace--"><code>Environment.getCurrentDirectiveCallPlace()</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>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/DirectiveCallPlace.html#getBeginColumn--">getBeginColumn</a></span>()</code> +<div class="block">The 1-based column number of the first character of the directive call in the template source code, or -1 if it's + not known.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/DirectiveCallPlace.html#getBeginLine--">getBeginLine</a></span>()</code> +<div class="block">The 1-based line number of the first character of the directive call in the template source code, or -1 if it's + not known.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/DirectiveCallPlace.html#getEndColumn--">getEndColumn</a></span>()</code> +<div class="block">The 1-based column number of the last character of the directive call in the template source code, or -1 if it's + not known.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/DirectiveCallPlace.html#getEndLine--">getEndLine</a></span>()</code> +<div class="block">The 1-based line number of the last character of the directive call in the template source code, or -1 if it's + not known.</div> +</td> +</tr> +<tr id="i4" 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="../../freemarker/core/DirectiveCallPlace.html#getOrCreateCustomData-java.lang.Object-freemarker.template.utility.ObjectFactory-">getOrCreateCustomData</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> providerIdentity, + <a href="../../freemarker/template/utility/ObjectFactory.html" title="interface in freemarker.template.utility">ObjectFactory</a> objectFactory)</code> +<div class="block">Returns the custom data, or if that's <code>null</code>, then it creates and stores it in an atomic operation then + returns it.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/DirectiveCallPlace.html#isNestedOutputCacheable--">isNestedOutputCacheable</a></span>()</code> +<div class="block">Tells if the nested content (the body) can be safely cached, as it only depends on the template content (not on + variable values and such) and has no side-effects (other than writing to the output).</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="getBeginColumn--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBeginColumn</h4> +<pre>int getBeginColumn()</pre> +<div class="block">The 1-based column number of the first character of the directive call in the template source code, or -1 if it's + not known.</div> +</li> +</ul> +<a name="getBeginLine--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBeginLine</h4> +<pre>int getBeginLine()</pre> +<div class="block">The 1-based line number of the first character of the directive call in the template source code, or -1 if it's + not known.</div> +</li> +</ul> +<a name="getEndColumn--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEndColumn</h4> +<pre>int getEndColumn()</pre> +<div class="block">The 1-based column number of the last character of the directive call in the template source code, or -1 if it's + not known. If the directive has an end-tag (<code></@...></code>), then it points to the last character of that.</div> +</li> +</ul> +<a name="getEndLine--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEndLine</h4> +<pre>int getEndLine()</pre> +<div class="block">The 1-based line number of the last character of the directive call in the template source code, or -1 if it's + not known. If the directive has an end-tag (<code></@...></code>), then it points to the last character of that.</div> +</li> +</ul> +<a name="getOrCreateCustomData-java.lang.Object-freemarker.template.utility.ObjectFactory-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOrCreateCustomData</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> getOrCreateCustomData(<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> providerIdentity, + <a href="../../freemarker/template/utility/ObjectFactory.html" title="interface in freemarker.template.utility">ObjectFactory</a> objectFactory) + throws <a href="../../freemarker/core/CallPlaceCustomDataInitializationException.html" title="class in freemarker.core">CallPlaceCustomDataInitializationException</a></pre> +<div class="block">Returns the custom data, or if that's <code>null</code>, then it creates and stores it in an atomic operation then + returns it. This method is thread-safe, however, it doesn't ensure thread safe (like synchronized) access to the + custom data itself. See the top-level documentation of <a href="../../freemarker/core/DirectiveCallPlace.html" title="interface in freemarker.core"><code>DirectiveCallPlace</code></a> to understand the scope and + life-cycle of the custom data. Be sure that the custom data only depends on things that get their final value + during template parsing, not on runtime settings. + + <p> + This method will block other calls while the <code>objectFactory</code> is executing, thus, the object will be + <em>usually</em> created only once, even if multiple threads request the value when it's still <code>null</code>. It + doesn't stand though when <code>providerIdentity</code> mismatches occur (see later). Furthermore, then it's also + possible that multiple objects created by the same <a href="../../freemarker/template/utility/ObjectFactory.html" title="interface in freemarker.template.utility"><code>ObjectFactory</code></a> will be in use on the same time, because + of directive executions already running in parallel, and because of memory synchronization delays (hardware + dependent) between the threads.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>providerIdentity</code> - This is usually the class of the <a href="../../freemarker/template/TemplateDirectiveModel.html" title="interface in freemarker.template"><code>TemplateDirectiveModel</code></a> that creates (and uses) the custom + data, or if you are using your own class for the custom data object (as opposed to a class from some + more generic API), then that class. This is needed as the same call place might calls different + directives depending on runtime conditions, and so it must be ensured that these directives won't + accidentally read each other's custom data, ending up with class cast exceptions or worse. In the + current implementation, if there's a <code>providerIdentity</code> mismatch (means, the + <code>providerIdentity</code> object used when the custom data was last set isn't the exactly same object + as the one provided with the parameter now), the previous custom data will be just ignored as if it + was <code>null</code>. So if multiple directives that use the custom data feature use the same call place, + the caching of the custom data can be inefficient, as they will keep overwriting each other's custom + data. (In a more generic implementation the <code>providerIdentity</code> would be a key in a + <a href="../../freemarker/ext/util/IdentityHashMap.html" title="class in freemarker.ext.util"><code>IdentityHashMap</code></a>, but then this feature would be slower, while <code>providerIdentity</code> + mismatches aren't occurring in most applications.)</dd> +<dd><code>objectFactory</code> - Called when the custom data wasn't yet set, to create its initial value. If this parameter is + <code>null</code> and the custom data wasn't set yet, then <code>null</code> will be returned. The returned + value of <a href="../../freemarker/template/utility/ObjectFactory.html#createObject--"><code>ObjectFactory.createObject()</code></a> can be any kind of object, but can't be <code>null</code>.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The current custom data object, or possibly <code>null</code> if there was no <a href="../../freemarker/template/utility/ObjectFactory.html" title="interface in freemarker.template.utility"><code>ObjectFactory</code></a> provided.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="../../freemarker/core/CallPlaceCustomDataInitializationException.html" title="class in freemarker.core">CallPlaceCustomDataInitializationException</a></code> - If the <a href="../../freemarker/template/utility/ObjectFactory.html" title="interface in freemarker.template.utility"><code>ObjectFactory</code></a> had to be invoked but failed.</dd> +</dl> +</li> +</ul> +<a name="isNestedOutputCacheable--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>isNestedOutputCacheable</h4> +<pre>boolean isNestedOutputCacheable()</pre> +<div class="block">Tells if the nested content (the body) can be safely cached, as it only depends on the template content (not on + variable values and such) and has no side-effects (other than writing to the output). Examples of cases that give + <code>false</code>: <code><@foo>Name: </code> <tt>${name}</tt>, + <code><@foo>Name: <#if showIt>Joe</#if></@foo></code>. Examples of cases that give <code>true</code>: + <code><@foo>Name: Joe</@foo></code>, <code><@foo /></code>. Note that we get <code>true</code> for no nested content, because + that's equivalent with 0-length nested content in FTL. + + <p> + This method returns a pessimistic result. For example, if it sees a custom directive call, it can't know what it + does, so it will assume that it's not cacheable.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar.bottom"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.bottom.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/DirectiveCallPlace.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="../../freemarker/core/CustomAttribute.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/core/DirectiveCallPlace.html" target="_top">Frames</a></li> +<li><a href="DirectiveCallPlace.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/b35e4aa5/builds/2.3.24-pre01/_html/api/freemarker/core/Environment.Namespace.html ---------------------------------------------------------------------- diff --git a/builds/2.3.24-pre01/_html/api/freemarker/core/Environment.Namespace.html b/builds/2.3.24-pre01/_html/api/freemarker/core/Environment.Namespace.html new file mode 100644 index 0000000..bc0dd19 --- /dev/null +++ b/builds/2.3.24-pre01/_html/api/freemarker/core/Environment.Namespace.html @@ -0,0 +1,293 @@ +<!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_20) on Wed Sep 02 01:20:16 CEST 2015 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Environment.Namespace (FreeMarker 2.3.24-pre01 API)</title> +<meta name="date" content="2015-09-02"> +<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="Environment.Namespace (FreeMarker 2.3.24-pre01 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/Environment.Namespace.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="../../freemarker/core/Environment.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/FreeMarkerTree.html" title="class in freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/core/Environment.Namespace.html" target="_top">Frames</a></li> +<li><a href="Environment.Namespace.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">freemarker.core</div> +<h2 title="Class Environment.Namespace" class="title">Class Environment.Namespace</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="../../freemarker/template/WrappingTemplateModel.html" title="class in freemarker.template">freemarker.template.WrappingTemplateModel</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../freemarker/template/SimpleHash.html" title="class in freemarker.template">freemarker.template.SimpleHash</a></li> +<li> +<ul class="inheritance"> +<li>freemarker.core.Environment.Namespace</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../freemarker/template/TemplateHashModel.html" title="interface in freemarker.template">TemplateHashModel</a>, <a href="../../freemarker/template/TemplateHashModelEx.html" title="interface in freemarker.template">TemplateHashModelEx</a>, <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</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></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../freemarker/core/Environment.html" title="class in freemarker.core">Environment</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="typeNameLabel">Environment.Namespace</span> +extends <a href="../../freemarker/template/SimpleHash.html" title="class in freemarker.template">SimpleHash</a></pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../serialized-form.html#freemarker.core.Environment.Namespace">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.freemarker.template.TemplateModel"> +<!-- --> +</a> +<h3>Fields inherited from interface freemarker.template.<a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a></h3> +<code><a href="../../freemarker/template/TemplateModel.html#NOTHING">NOTHING</a></code></li> +</ul> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code><a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.Namespace.html#getTemplate--">getTemplate</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.freemarker.template.SimpleHash"> +<!-- --> +</a> +<h3>Methods inherited from class freemarker.template.<a href="../../freemarker/template/SimpleHash.html" title="class in freemarker.template">SimpleHash</a></h3> +<code><a href="../../freemarker/template/SimpleHash.html#containsKey-java.lang.String-">containsKey</a>, <a href="../../freemarker/template/SimpleHash.html#copyMap-java.util.Map-">copyMap</a>, <a href="../../freemarker/template/SimpleHash.html#get-java.lang.String-">get</a>, <a href="../../freemarker/template/SimpleHash.html#isEmpty--">isEmpty</a>, <a href="../../freemarker/template/SimpleHash.html#keys--">keys</a>, <a href="../../freemarker/template/SimpleHash.html#put-java.lang.String-boolean-">put</a>, <a href="../../freemarker/template/SimpleHash.html#put-java.lang.String-java.lang.Object-">put</a>, <a href="../../freemarker/template/SimpleHash.html#putAll-java.util.Map-">putAll</a>, <a href="../../freemarker/template/SimpleHash.html#remove-java.lang.String-">remove</a>, <a href="../../freemarker/template/SimpleHash.html#size--">size</a>, <a href="../../freemarker/template/SimpleHash.html#synchronizedWrapper--">synchronizedWrapper</a>, <a href="../../freemarker/template/SimpleHa sh.html#toMap--">toMap</a>, <a href="../../freemarker/template/SimpleHash.html#toString--">toString</a>, <a href="../../freemarker/template/SimpleHash.html#values--">values</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.freemarker.template.WrappingTemplateModel"> +<!-- --> +</a> +<h3>Methods inherited from class freemarker.template.<a href="../../freemarker/template/WrappingTemplateModel.html" title="class in freemarker.template">WrappingTemplateModel</a></h3> +<code><a href="../../freemarker/template/WrappingTemplateModel.html#getDefaultObjectWrapper--">getDefaultObjectWrapper</a>, <a href="../../freemarker/template/WrappingTemplateModel.html#getObjectWrapper--">getObjectWrapper</a>, <a href="../../freemarker/template/WrappingTemplateModel.html#setDefaultObjectWrapper-freemarker.template.ObjectWrapper-">setDefaultObjectWrapper</a>, <a href="../../freemarker/template/WrappingTemplateModel.html#setObjectWrapper-freemarker.template.ObjectWrapper-">setObjectWrapper</a>, <a href="../../freemarker/template/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#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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getTemplate--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getTemplate</h4> +<pre>public <a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a> getTemplate()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the Template object with which this Namespace is associated.</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/Environment.Namespace.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="../../freemarker/core/Environment.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/core/FreeMarkerTree.html" title="class in freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../index.html?freemarker/core/Environment.Namespace.html" target="_top">Frames</a></li> +<li><a href="Environment.Namespace.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>