http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/core/CustomAttribute.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/core/CustomAttribute.html b/docs/api/freemarker/core/CustomAttribute.html index f9e6938..648e52b 100644 --- a/docs/api/freemarker/core/CustomAttribute.html +++ b/docs/api/freemarker/core/CustomAttribute.html @@ -2,10 +2,10 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_144) on Sun Oct 15 21:19:44 EDT 2017 --> +<!-- Generated by javadoc (1.8.0_144) on Sat Nov 11 19:25:48 CET 2017 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>CustomAttribute (FreeMarker 2.3.27-incubating API)</title> -<meta name="date" content="2017-10-15"> +<meta name="date" content="2017-11-11"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> </head> @@ -98,7 +98,7 @@ var activeTableTab = "activeTableTab"; </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>java.lang.Object</li> <li> <ul class="inheritance"> <li>freemarker.core.CustomAttribute</li> @@ -111,11 +111,11 @@ var activeTableTab = "activeTableTab"; <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> +extends java.lang.Object</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 + <p>This API has similar approach to that of <code>ThreadLocal</code> (which allows one to associate custom data with a thread). With an example:</p> <pre> @@ -199,7 +199,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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="colFirst"><code>protected java.lang.Object</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 @@ -207,66 +207,66 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? </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="colFirst"><code>java.lang.Object</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="colFirst"><code>java.lang.Object</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="colFirst"><code>java.lang.Object</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="colFirst"><code>java.lang.Object</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="colFirst"><code>java.lang.Object</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CustomAttribute.html#get-freemarker.core.TemplateConfiguration-">get</a></span>(<a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core">TemplateConfiguration</a> templateConfiguration)</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/TemplateConfiguration.html" title="class in freemarker.core"><code>TemplateConfiguration</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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CustomAttribute.html#set-java.lang.Object-">set</a></span>(java.lang.Object 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, +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CustomAttribute.html#set-java.lang.Object-freemarker.template.Configuration-">set</a></span>(java.lang.Object 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, +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CustomAttribute.html#set-java.lang.Object-freemarker.core.Environment-">set</a></span>(java.lang.Object 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, +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CustomAttribute.html#set-java.lang.Object-freemarker.template.Template-">set</a></span>(java.lang.Object 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.TemplateConfiguration-">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, +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/CustomAttribute.html#set-java.lang.Object-freemarker.core.TemplateConfiguration-">set</a></span>(java.lang.Object value, <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core">TemplateConfiguration</a> templateConfiguration)</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/TemplateConfiguration.html" title="class in freemarker.core"><code>TemplateConfiguration</code></a>.</div> </td> @@ -276,8 +276,8 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> @@ -371,7 +371,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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> +<pre>protected java.lang.Object 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> @@ -387,7 +387,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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> +<pre>public final java.lang.Object 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 @@ -397,7 +397,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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> +<dd><code>java.lang.NullPointerException</code> - If <code>env</code> is null</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>2.3.22</dd> </dl> @@ -409,11 +409,11 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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> +<pre>public final java.lang.Object 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 +<dd><code>java.lang.IllegalStateException</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> @@ -424,12 +424,12 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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> +<pre>public final java.lang.Object 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> +<dd><code>java.lang.UnsupportedOperationException</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>java.lang.NullPointerException</code> - If <code>template</code> is null</dd> </dl> </li> </ul> @@ -439,7 +439,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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/TemplateConfiguration.html" title="class in freemarker.core">TemplateConfiguration</a> templateConfiguration)</pre> +<pre>public java.lang.Object get(<a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core">TemplateConfiguration</a> templateConfiguration)</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/TemplateConfiguration.html" title="class in freemarker.core"><code>TemplateConfiguration</code></a>.</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> @@ -453,12 +453,12 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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> +<pre>public final java.lang.Object 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> +<dd><code>java.lang.UnsupportedOperationException</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>java.lang.NullPointerException</code> - If <code>cfg</code> is null</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>2.3.22</dd> </dl> @@ -470,7 +470,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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>public final void set(java.lang.Object 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 @@ -481,7 +481,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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> +<dd><code>java.lang.NullPointerException</code> - If <code>env</code> is null</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>2.3.22</dd> </dl> @@ -493,12 +493,12 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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> +<pre>public final void set(java.lang.Object 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 +<dd><code>java.lang.IllegalStateException</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> @@ -509,15 +509,15 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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>public final void set(java.lang.Object 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> +<dd><code>java.lang.UnsupportedOperationException</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>java.lang.NullPointerException</code> - If <code>template</code> is null</dd> </dl> </li> </ul> @@ -527,7 +527,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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>public final void set(java.lang.Object value, <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core">TemplateConfiguration</a> templateConfiguration)</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/TemplateConfiguration.html" title="class in freemarker.core"><code>TemplateConfiguration</code></a>.</div> <dl> @@ -542,15 +542,15 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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, +<pre>public final void set(java.lang.Object 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> +<dd><code>java.lang.UnsupportedOperationException</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>java.lang.NullPointerException</code> - If <code>cfg</code> is null</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>2.3.22</dd> </dl>
http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/core/DirectiveCallPlace.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/core/DirectiveCallPlace.html b/docs/api/freemarker/core/DirectiveCallPlace.html index 4a7ee18..23eea0e 100644 --- a/docs/api/freemarker/core/DirectiveCallPlace.html +++ b/docs/api/freemarker/core/DirectiveCallPlace.html @@ -2,10 +2,10 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_144) on Sun Oct 15 21:19:44 EDT 2017 --> +<!-- Generated by javadoc (1.8.0_144) on Sat Nov 11 19:25:48 CET 2017 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>DirectiveCallPlace (FreeMarker 2.3.27-incubating API)</title> -<meta name="date" content="2017-10-15"> +<meta name="date" content="2017-11-11"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> </head> @@ -177,8 +177,8 @@ var activeTableTab = "activeTableTab"; </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, +<td class="colFirst"><code>java.lang.Object</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>(java.lang.Object 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> @@ -256,9 +256,9 @@ var activeTableTab = "activeTableTab"; <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> +<pre>java.lang.Object getOrCreateCustomData(java.lang.Object 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 http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/core/Environment.Namespace.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/core/Environment.Namespace.html b/docs/api/freemarker/core/Environment.Namespace.html index 52c1df7..3bc6eef 100644 --- a/docs/api/freemarker/core/Environment.Namespace.html +++ b/docs/api/freemarker/core/Environment.Namespace.html @@ -2,10 +2,10 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_144) on Sun Oct 15 21:19:44 EDT 2017 --> +<!-- Generated by javadoc (1.8.0_144) on Sat Nov 11 19:25:48 CET 2017 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>Environment.Namespace (FreeMarker 2.3.27-incubating API)</title> -<meta name="date" content="2017-10-15"> +<meta name="date" content="2017-11-11"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> </head> @@ -98,7 +98,7 @@ var activeTableTab = "activeTableTab"; </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>java.lang.Object</li> <li> <ul class="inheritance"> <li><a href="../../freemarker/template/WrappingTemplateModel.html" title="class in freemarker.template">freemarker.template.WrappingTemplateModel</a></li> @@ -120,7 +120,7 @@ var activeTableTab = "activeTableTab"; <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/TemplateHashModelEx2.html" title="interface in freemarker.template">TemplateHashModelEx2</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> +<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/TemplateHashModelEx2.html" title="interface in freemarker.template">TemplateHashModelEx2</a>, <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a>, java.io.Serializable</dd> </dl> <dl> <dt>Enclosing class:</dt> @@ -205,8 +205,8 @@ extends <a href="../../freemarker/template/SimpleHash.html" title="class in free <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> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> </ul> </li> </ul>
