http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/template/ObjectWrapper.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/template/ObjectWrapper.html b/docs/api/freemarker/template/ObjectWrapper.html index 63a7c73..f543c13 100644 --- a/docs/api/freemarker/template/ObjectWrapper.html +++ b/docs/api/freemarker/template/ObjectWrapper.html @@ -2,10 +2,10 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_144) on Sun Oct 15 21:19:46 EDT 2017 --> +<!-- Generated by javadoc (1.8.0_144) on Sat Nov 11 19:25:50 CET 2017 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>ObjectWrapper (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> @@ -114,10 +114,10 @@ var activeTableTab = "activeTableTab"; <div class="block">Maps Java objects to the type-system of FreeMarker Template Language (see the <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> interfaces). Thus this is what decides what parts of the Java objects will be accessible in the templates and how. - <p>For example, with a <a href="../../freemarker/ext/beans/BeansWrapper.html" title="class in freemarker.ext.beans"><code>BeansWrapper</code></a> both the items of <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> and the JavaBean properties (the getters) + <p>For example, with a <a href="../../freemarker/ext/beans/BeansWrapper.html" title="class in freemarker.ext.beans"><code>BeansWrapper</code></a> both the items of <code>Map</code> and the JavaBean properties (the getters) of an object are accessible in template uniformly with the <code>myObject.foo</code> syntax, where "foo" is the map key or the property name. This is because both kind of object is wrapped by <a href="../../freemarker/ext/beans/BeansWrapper.html" title="class in freemarker.ext.beans"><code>BeansWrapper</code></a> into a - <a href="../../freemarker/template/TemplateHashModel.html" title="interface in freemarker.template"><code>TemplateHashModel</code></a> implementation that will call <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true#get-java.lang.Object-" title="class or interface in java.util"><code>Map.get(Object)</code></a> or the getter method, transparently + <a href="../../freemarker/template/TemplateHashModel.html" title="interface in freemarker.template"><code>TemplateHashModel</code></a> implementation that will call <code>Map.get(Object)</code> or the getter method, transparently to the template language.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> @@ -185,7 +185,7 @@ var activeTableTab = "activeTableTab"; </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code><a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/ObjectWrapper.html#wrap-java.lang.Object-">wrap</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/ObjectWrapper.html#wrap-java.lang.Object-">wrap</a></span>(java.lang.Object obj)</code> <div class="block">Makes a <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> out of a non-<a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> object, usually by "wrapping" it into a <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> implementation that delegates to the original object.</div> </td> @@ -211,13 +211,13 @@ var activeTableTab = "activeTableTab"; <ul class="blockList"> <li class="blockList"> <h4>BEANS_WRAPPER</h4> -<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> +<pre>@Deprecated static final <a href="../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template">ObjectWrapper</a> BEANS_WRAPPER</pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../freemarker/ext/beans/BeansWrapperBuilder.html#build--"><code>BeansWrapperBuilder.build()</code></a> instead; this instance isn't read-only and thus can't be trusted.</span></div> <div class="block">An <a href="../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template"><code>ObjectWrapper</code></a> that exposes the object methods and JavaBeans properties as hash elements, and has - custom handling for Java <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a>-s, <a href="http://docs.oracle.com/javase/8/docs/api/java/util/ResourceBundle.html?is-external=true" title="class or interface in java.util"><code>ResourceBundle</code></a>-s, etc. It doesn't treat - <a href="http://docs.oracle.com/javase/8/docs/api/org/w3c/dom/Node.html?is-external=true" title="class or interface in org.w3c.dom"><code>Node</code></a>-s and Jython objects specially, however. As of 2.3.22, using + custom handling for Java <code>Map</code>-s, <code>ResourceBundle</code>-s, etc. It doesn't treat + <code>Node</code>-s and Jython objects specially, however. As of 2.3.22, using <a href="../../freemarker/template/DefaultObjectWrapper.html" title="class in freemarker.template"><code>DefaultObjectWrapper</code></a> with its <code>incompatibleImprovements</code> property set to 2.3.22 (or higher) is recommended instead.</div> </li> @@ -228,7 +228,7 @@ static final <a href="../../freemarker/template/ObjectWrapper.html" title=" <ul class="blockList"> <li class="blockList"> <h4>DEFAULT_WRAPPER</h4> -<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> +<pre>@Deprecated static final <a href="../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template">ObjectWrapper</a> DEFAULT_WRAPPER</pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../freemarker/template/DefaultObjectWrapperBuilder.html#build--"><code>DefaultObjectWrapperBuilder.build()</code></a> instead; this instance isn't read-only and thus can't be trusted.</span></div> @@ -242,7 +242,7 @@ static final <a href="../../freemarker/template/ObjectWrapper.html" title=" <ul class="blockListLast"> <li class="blockList"> <h4>SIMPLE_WRAPPER</h4> -<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> +<pre>@Deprecated static final <a href="../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template">ObjectWrapper</a> SIMPLE_WRAPPER</pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">No replacement as it was seldom if ever used by anyone; this instance isn't read-only and thus can't be trusted.</span></div> @@ -267,7 +267,7 @@ static final <a href="../../freemarker/template/ObjectWrapper.html" title=" <ul class="blockListLast"> <li class="blockList"> <h4>wrap</h4> -<pre><a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> wrap(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj) +<pre><a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> wrap(java.lang.Object obj) throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> <div class="block">Makes a <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> out of a non-<a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> object, usually by "wrapping" it into a <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> implementation that delegates to the original object.</div>
http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/template/ObjectWrapperAndUnwrapper.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/template/ObjectWrapperAndUnwrapper.html b/docs/api/freemarker/template/ObjectWrapperAndUnwrapper.html index 1a2f957..626c4fd 100644 --- a/docs/api/freemarker/template/ObjectWrapperAndUnwrapper.html +++ b/docs/api/freemarker/template/ObjectWrapperAndUnwrapper.html @@ -2,10 +2,10 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_144) on Sun Oct 15 21:19:46 EDT 2017 --> +<!-- Generated by javadoc (1.8.0_144) on Sat Nov 11 19:25:50 CET 2017 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>ObjectWrapperAndUnwrapper (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> @@ -150,7 +150,7 @@ extends <a href="../../freemarker/template/ObjectWrapper.html" title="interface <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> -<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> +<td class="colFirst"><code>static java.lang.Object</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/ObjectWrapperAndUnwrapper.html#CANT_UNWRAP_TO_TARGET_CLASS">CANT_UNWRAP_TO_TARGET_CLASS</a></span></code> <div class="block">Indicates that while the unwrapping is <em>maybe</em> possible, the result surely can't be the instance of the desired class, nor it can be <code>null</code>.</div> @@ -179,15 +179,15 @@ extends <a href="../../freemarker/template/ObjectWrapper.html" title="interface <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> +<td class="colFirst"><code>java.lang.Object</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/ObjectWrapperAndUnwrapper.html#tryUnwrapTo-freemarker.template.TemplateModel-java.lang.Class-">tryUnwrapTo</a></span>(<a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> tm, - <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> targetClass)</code> + java.lang.Class<?> targetClass)</code> <div class="block">Attempts to unwrap a <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> to a plain Java object that's the instance of the given class (or is <code>null</code>).</div> </td> </tr> <tr id="i1" class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> +<td class="colFirst"><code>java.lang.Object</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/ObjectWrapperAndUnwrapper.html#unwrap-freemarker.template.TemplateModel-">unwrap</a></span>(<a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> tm)</code> <div class="block">Unwraps a <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> to a plain Java object.</div> </td> @@ -220,7 +220,7 @@ extends <a href="../../freemarker/template/ObjectWrapper.html" title="interface <ul class="blockListLast"> <li class="blockList"> <h4>CANT_UNWRAP_TO_TARGET_CLASS</h4> -<pre>static final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> CANT_UNWRAP_TO_TARGET_CLASS</pre> +<pre>static final java.lang.Object CANT_UNWRAP_TO_TARGET_CLASS</pre> <div class="block">Indicates that while the unwrapping is <em>maybe</em> possible, the result surely can't be the instance of the desired class, nor it can be <code>null</code>.</div> <dl> @@ -245,8 +245,8 @@ extends <a href="../../freemarker/template/ObjectWrapper.html" title="interface <ul class="blockList"> <li class="blockList"> <h4>unwrap</h4> -<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> unwrap(<a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> tm) - throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> +<pre>java.lang.Object unwrap(<a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> tm) + throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> <div class="block">Unwraps a <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> to a plain Java object.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -268,9 +268,9 @@ extends <a href="../../freemarker/template/ObjectWrapper.html" title="interface <ul class="blockListLast"> <li class="blockList"> <h4>tryUnwrapTo</h4> -<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> tryUnwrapTo(<a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> tm, - <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> targetClass) - throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> +<pre>java.lang.Object tryUnwrapTo(<a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> tm, + java.lang.Class<?> targetClass) + throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> <div class="block">Attempts to unwrap a <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> to a plain Java object that's the instance of the given class (or is <code>null</code>).</div> <dl> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/template/ResourceBundleLocalizedString.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/template/ResourceBundleLocalizedString.html b/docs/api/freemarker/template/ResourceBundleLocalizedString.html index dd9fc24..f270d54 100644 --- a/docs/api/freemarker/template/ResourceBundleLocalizedString.html +++ b/docs/api/freemarker/template/ResourceBundleLocalizedString.html @@ -2,10 +2,10 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_144) on Sun Oct 15 21:19:46 EDT 2017 --> +<!-- Generated by javadoc (1.8.0_144) on Sat Nov 11 19:25:50 CET 2017 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>ResourceBundleLocalizedString (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/LocalizedString.html" title="class in freemarker.template">freemarker.template.LocalizedString</a></li> @@ -122,7 +122,7 @@ var activeTableTab = "activeTableTab"; <pre>public class <span class="typeNameLabel">ResourceBundleLocalizedString</span> extends <a href="../../freemarker/template/LocalizedString.html" title="class in freemarker.template">LocalizedString</a></pre> <div class="block">A concrete implementation of <a href="../../freemarker/template/LocalizedString.html" title="class in freemarker.template"><code>LocalizedString</code></a> that gets - a localized string from a <a href="http://docs.oracle.com/javase/8/docs/api/java/util/ResourceBundle.html?is-external=true" title="class or interface in java.util"><code>ResourceBundle</code></a></div> + a localized string from a <code>ResourceBundle</code></div> </li> </ul> </div> @@ -163,8 +163,8 @@ extends <a href="../../freemarker/template/LocalizedString.html" title="class in <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/ResourceBundleLocalizedString.html#ResourceBundleLocalizedString-java.lang.String-java.lang.String-">ResourceBundleLocalizedString</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> resourceBundleLookupKey, - <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> resourceKey)</code> </td> +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/ResourceBundleLocalizedString.html#ResourceBundleLocalizedString-java.lang.String-java.lang.String-">ResourceBundleLocalizedString</a></span>(java.lang.String resourceBundleLookupKey, + java.lang.String resourceKey)</code> </td> </tr> </table> </li> @@ -182,8 +182,8 @@ extends <a href="../../freemarker/template/LocalizedString.html" title="class in <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/ResourceBundleLocalizedString.html#getLocalizedString-java.util.Locale-">getLocalizedString</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)</code> </td> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/ResourceBundleLocalizedString.html#getLocalizedString-java.util.Locale-">getLocalizedString</a></span>(java.util.Locale locale)</code> </td> </tr> </table> <ul class="blockList"> @@ -197,8 +197,8 @@ extends <a href="../../freemarker/template/LocalizedString.html" title="class in <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> @@ -220,8 +220,8 @@ extends <a href="../../freemarker/template/LocalizedString.html" title="class in <ul class="blockListLast"> <li class="blockList"> <h4>ResourceBundleLocalizedString</h4> -<pre>public ResourceBundleLocalizedString(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> resourceBundleLookupKey, - <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> resourceKey)</pre> +<pre>public ResourceBundleLocalizedString(java.lang.String resourceBundleLookupKey, + java.lang.String resourceKey)</pre> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>resourceBundleLookupKey</code> - The lookup key for the resource bundle</dd> @@ -243,8 +243,8 @@ extends <a href="../../freemarker/template/LocalizedString.html" title="class in <ul class="blockListLast"> <li class="blockList"> <h4>getLocalizedString</h4> -<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getLocalizedString(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale) - throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> +<pre>public java.lang.String getLocalizedString(java.util.Locale locale) + throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../freemarker/template/LocalizedString.html#getLocalizedString-java.util.Locale-">getLocalizedString</a></code> in class <code><a href="../../freemarker/template/LocalizedString.html" title="class in freemarker.template">LocalizedString</a></code></dd> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/template/SimpleCollection.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/template/SimpleCollection.html b/docs/api/freemarker/template/SimpleCollection.html index e4e54f5..b89ea81 100644 --- a/docs/api/freemarker/template/SimpleCollection.html +++ b/docs/api/freemarker/template/SimpleCollection.html @@ -2,10 +2,10 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_144) on Sun Oct 15 21:19:46 EDT 2017 --> +<!-- Generated by javadoc (1.8.0_144) on Sat Nov 11 19:25:50 CET 2017 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>SimpleCollection (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> @@ -115,13 +115,13 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> -<dd><a href="../../freemarker/template/TemplateCollectionModel.html" title="interface in freemarker.template">TemplateCollectionModel</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/TemplateCollectionModel.html" title="interface in freemarker.template">TemplateCollectionModel</a>, <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a>, java.io.Serializable</dd> </dl> <hr> <br> <pre>public class <span class="typeNameLabel">SimpleCollection</span> extends <a href="../../freemarker/template/WrappingTemplateModel.html" title="class in freemarker.template">WrappingTemplateModel</a> -implements <a href="../../freemarker/template/TemplateCollectionModel.html" title="interface in freemarker.template">TemplateCollectionModel</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> +implements <a href="../../freemarker/template/TemplateCollectionModel.html" title="interface in freemarker.template">TemplateCollectionModel</a>, java.io.Serializable</pre> <div class="block">A simple implementation of <a href="../../freemarker/template/TemplateCollectionModel.html" title="interface in freemarker.template"><code>TemplateCollectionModel</code></a>. It's able to wrap <tt>java.util.Iterator</tt>-s and <tt>java.util.Collection</tt>-s. If you wrap an <tt>Iterator</tt>, the variable can be <#list>-ed only once! @@ -172,38 +172,38 @@ implements <a href="../../freemarker/template/TemplateCollectionModel.html" titl <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleCollection.html#SimpleCollection-java.util.Collection-">SimpleCollection</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> collection)</code> +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleCollection.html#SimpleCollection-java.util.Collection-">SimpleCollection</a></span>(java.util.Collection collection)</code> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="block"><span class="deprecationComment">Use <a href="../../freemarker/template/SimpleCollection.html#SimpleCollection-java.lang.Iterable-freemarker.template.ObjectWrapper-"><code>SimpleCollection(Iterable, ObjectWrapper)</code></a> instead.</span></div> </div> </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleCollection.html#SimpleCollection-java.util.Collection-freemarker.template.ObjectWrapper-">SimpleCollection</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> collection, +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleCollection.html#SimpleCollection-java.util.Collection-freemarker.template.ObjectWrapper-">SimpleCollection</a></span>(java.util.Collection collection, <a href="../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template">ObjectWrapper</a> wrapper)</code> <div class="block">Same as <a href="../../freemarker/template/SimpleCollection.html#SimpleCollection-java.lang.Iterable-freemarker.template.ObjectWrapper-"><code>SimpleCollection(Iterable, ObjectWrapper)</code></a>; kept for binary compatibility.</div> </td> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleCollection.html#SimpleCollection-java.lang.Iterable-">SimpleCollection</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a> iterable)</code> +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleCollection.html#SimpleCollection-java.lang.Iterable-">SimpleCollection</a></span>(java.lang.Iterable iterable)</code> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="block"><span class="deprecationComment">Use <a href="../../freemarker/template/SimpleCollection.html#SimpleCollection-java.lang.Iterable-freemarker.template.ObjectWrapper-"><code>SimpleCollection(Iterable, ObjectWrapper)</code></a> instead.</span></div> </div> </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleCollection.html#SimpleCollection-java.lang.Iterable-freemarker.template.ObjectWrapper-">SimpleCollection</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a> iterable, +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleCollection.html#SimpleCollection-java.lang.Iterable-freemarker.template.ObjectWrapper-">SimpleCollection</a></span>(java.lang.Iterable iterable, <a href="../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template">ObjectWrapper</a> wrapper)</code> </td> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleCollection.html#SimpleCollection-java.util.Iterator-">SimpleCollection</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a> iterator)</code> +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleCollection.html#SimpleCollection-java.util.Iterator-">SimpleCollection</a></span>(java.util.Iterator iterator)</code> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="block"><span class="deprecationComment">Use <a href="../../freemarker/template/SimpleCollection.html#SimpleCollection-java.util.Iterator-freemarker.template.ObjectWrapper-"><code>SimpleCollection(Iterator, ObjectWrapper)</code></a></span></div> </div> </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleCollection.html#SimpleCollection-java.util.Iterator-freemarker.template.ObjectWrapper-">SimpleCollection</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a> iterator, +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleCollection.html#SimpleCollection-java.util.Iterator-freemarker.template.ObjectWrapper-">SimpleCollection</a></span>(java.util.Iterator iterator, <a href="../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template">ObjectWrapper</a> wrapper)</code> </td> </tr> </table> @@ -239,8 +239,8 @@ implements <a href="../../freemarker/template/TemplateCollectionModel.html" titl <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> @@ -262,8 +262,8 @@ implements <a href="../../freemarker/template/TemplateCollectionModel.html" titl <ul class="blockList"> <li class="blockList"> <h4>SimpleCollection</h4> -<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> -public SimpleCollection(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a> iterator)</pre> +<pre>@Deprecated +public SimpleCollection(java.util.Iterator iterator)</pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../freemarker/template/SimpleCollection.html#SimpleCollection-java.util.Iterator-freemarker.template.ObjectWrapper-"><code>SimpleCollection(Iterator, ObjectWrapper)</code></a></span></div> </li> </ul> @@ -273,8 +273,8 @@ public SimpleCollection(<a href="http://docs.oracle.com/javase/8/docs/api/j <ul class="blockList"> <li class="blockList"> <h4>SimpleCollection</h4> -<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> -public SimpleCollection(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a> iterable)</pre> +<pre>@Deprecated +public SimpleCollection(java.lang.Iterable iterable)</pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../freemarker/template/SimpleCollection.html#SimpleCollection-java.lang.Iterable-freemarker.template.ObjectWrapper-"><code>SimpleCollection(Iterable, ObjectWrapper)</code></a> instead.</span></div> </li> </ul> @@ -284,8 +284,8 @@ public SimpleCollection(<a href="http://docs.oracle.com/javase/8/docs/api/j <ul class="blockList"> <li class="blockList"> <h4>SimpleCollection</h4> -<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> -public SimpleCollection(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> collection)</pre> +<pre>@Deprecated +public SimpleCollection(java.util.Collection collection)</pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../freemarker/template/SimpleCollection.html#SimpleCollection-java.lang.Iterable-freemarker.template.ObjectWrapper-"><code>SimpleCollection(Iterable, ObjectWrapper)</code></a> instead.</span></div> <div class="block">Same as <a href="../../freemarker/template/SimpleCollection.html#SimpleCollection-java.lang.Iterable-"><code>SimpleCollection(Iterable)</code></a>; kept for binary compatibility.</div> </li> @@ -296,7 +296,7 @@ public SimpleCollection(<a href="http://docs.oracle.com/javase/8/docs/api/j <ul class="blockList"> <li class="blockList"> <h4>SimpleCollection</h4> -<pre>public SimpleCollection(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a> collection, +<pre>public SimpleCollection(java.util.Collection collection, <a href="../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template">ObjectWrapper</a> wrapper)</pre> <div class="block">Same as <a href="../../freemarker/template/SimpleCollection.html#SimpleCollection-java.lang.Iterable-freemarker.template.ObjectWrapper-"><code>SimpleCollection(Iterable, ObjectWrapper)</code></a>; kept for binary compatibility.</div> </li> @@ -307,7 +307,7 @@ public SimpleCollection(<a href="http://docs.oracle.com/javase/8/docs/api/j <ul class="blockList"> <li class="blockList"> <h4>SimpleCollection</h4> -<pre>public SimpleCollection(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a> iterator, +<pre>public SimpleCollection(java.util.Iterator iterator, <a href="../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template">ObjectWrapper</a> wrapper)</pre> </li> </ul> @@ -317,11 +317,11 @@ public SimpleCollection(<a href="http://docs.oracle.com/javase/8/docs/api/j <ul class="blockListLast"> <li class="blockList"> <h4>SimpleCollection</h4> -<pre>public SimpleCollection(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a> iterable, +<pre>public SimpleCollection(java.lang.Iterable iterable, <a href="../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template">ObjectWrapper</a> wrapper)</pre> <dl> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>iterable</code> - Note that this was a <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a> before 2.3.27, not an <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang"><code>Iterable</code></a></dd> +<dd><code>iterable</code> - Note that this was a <code>Collection</code> before 2.3.27, not an <code>Iterable</code></dd> </dl> </li> </ul> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/template/SimpleDate.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/template/SimpleDate.html b/docs/api/freemarker/template/SimpleDate.html index 9795653..313e985 100644 --- a/docs/api/freemarker/template/SimpleDate.html +++ b/docs/api/freemarker/template/SimpleDate.html @@ -2,10 +2,10 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_144) on Sun Oct 15 21:19:46 EDT 2017 --> +<!-- Generated by javadoc (1.8.0_144) on Sat Nov 11 19:25:50 CET 2017 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>SimpleDate (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.template.SimpleDate</li> @@ -115,7 +115,7 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre>public class <span class="typeNameLabel">SimpleDate</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> +extends java.lang.Object implements <a href="../../freemarker/template/TemplateDateModel.html" title="interface in freemarker.template">TemplateDateModel</a></pre> <div class="block">A simple implementation of the <tt>TemplateDateModel</tt> interface. Note that this class is immutable. @@ -160,26 +160,26 @@ implements <a href="../../freemarker/template/TemplateDateModel.html" title="int <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleDate.html#SimpleDate-java.sql.Date-">SimpleDate</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/sql/Date.html?is-external=true" title="class or interface in java.sql">Date</a> date)</code> +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleDate.html#SimpleDate-java.sql.Date-">SimpleDate</a></span>(java.sql.Date date)</code> <div class="block">Creates a new date model wrapping the specified date object and having DATE type.</div> </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleDate.html#SimpleDate-java.util.Date-int-">SimpleDate</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> date, +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleDate.html#SimpleDate-java.util.Date-int-">SimpleDate</a></span>(java.util.Date date, int type)</code> <div class="block">Creates a new date model wrapping the specified date object and having the specified type.</div> </td> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleDate.html#SimpleDate-java.sql.Time-">SimpleDate</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/sql/Time.html?is-external=true" title="class or interface in java.sql">Time</a> time)</code> +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleDate.html#SimpleDate-java.sql.Time-">SimpleDate</a></span>(java.sql.Time time)</code> <div class="block">Creates a new date model wrapping the specified time object and having TIME type.</div> </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleDate.html#SimpleDate-java.sql.Timestamp-">SimpleDate</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html?is-external=true" title="class or interface in java.sql">Timestamp</a> datetime)</code> +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleDate.html#SimpleDate-java.sql.Timestamp-">SimpleDate</a></span>(java.sql.Timestamp datetime)</code> <div class="block">Creates a new date model wrapping the specified time object and having DATETIME type.</div> </td> @@ -200,7 +200,7 @@ implements <a href="../../freemarker/template/TemplateDateModel.html" title="int <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a></code></td> +<td class="colFirst"><code>java.util.Date</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleDate.html#getAsDate--">getAsDate</a></span>()</code> <div class="block">Returns the date value.</div> </td> @@ -212,7 +212,7 @@ implements <a href="../../freemarker/template/TemplateDateModel.html" title="int </td> </tr> <tr id="i2" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleDate.html#toString--">toString</a></span>()</code> </td> </tr> </table> @@ -220,8 +220,8 @@ implements <a href="../../freemarker/template/TemplateDateModel.html" title="int <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> @@ -243,7 +243,7 @@ implements <a href="../../freemarker/template/TemplateDateModel.html" title="int <ul class="blockList"> <li class="blockList"> <h4>SimpleDate</h4> -<pre>public SimpleDate(<a href="http://docs.oracle.com/javase/8/docs/api/java/sql/Date.html?is-external=true" title="class or interface in java.sql">Date</a> date)</pre> +<pre>public SimpleDate(java.sql.Date date)</pre> <div class="block">Creates a new date model wrapping the specified date object and having DATE type.</div> </li> @@ -254,7 +254,7 @@ implements <a href="../../freemarker/template/TemplateDateModel.html" title="int <ul class="blockList"> <li class="blockList"> <h4>SimpleDate</h4> -<pre>public SimpleDate(<a href="http://docs.oracle.com/javase/8/docs/api/java/sql/Time.html?is-external=true" title="class or interface in java.sql">Time</a> time)</pre> +<pre>public SimpleDate(java.sql.Time time)</pre> <div class="block">Creates a new date model wrapping the specified time object and having TIME type.</div> </li> @@ -265,7 +265,7 @@ implements <a href="../../freemarker/template/TemplateDateModel.html" title="int <ul class="blockList"> <li class="blockList"> <h4>SimpleDate</h4> -<pre>public SimpleDate(<a href="http://docs.oracle.com/javase/8/docs/api/java/sql/Timestamp.html?is-external=true" title="class or interface in java.sql">Timestamp</a> datetime)</pre> +<pre>public SimpleDate(java.sql.Timestamp datetime)</pre> <div class="block">Creates a new date model wrapping the specified time object and having DATETIME type.</div> </li> @@ -276,7 +276,7 @@ implements <a href="../../freemarker/template/TemplateDateModel.html" title="int <ul class="blockListLast"> <li class="blockList"> <h4>SimpleDate</h4> -<pre>public SimpleDate(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> date, +<pre>public SimpleDate(java.util.Date date, int type)</pre> <div class="block">Creates a new date model wrapping the specified date object and having the specified type.</div> @@ -296,7 +296,7 @@ implements <a href="../../freemarker/template/TemplateDateModel.html" title="int <ul class="blockList"> <li class="blockList"> <h4>getAsDate</h4> -<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util">Date</a> getAsDate()</pre> +<pre>public java.util.Date getAsDate()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../freemarker/template/TemplateDateModel.html#getAsDate--">TemplateDateModel</a></code></span></div> <div class="block">Returns the date value. The return value must not be <code>null</code>.</div> <dl> @@ -327,10 +327,10 @@ implements <a href="../../freemarker/template/TemplateDateModel.html" title="int <ul class="blockListLast"> <li class="blockList"> <h4>toString</h4> -<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> +<pre>public java.lang.String toString()</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> -<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/template/SimpleHash.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/template/SimpleHash.html b/docs/api/freemarker/template/SimpleHash.html index bcf58fc..7596a34 100644 --- a/docs/api/freemarker/template/SimpleHash.html +++ b/docs/api/freemarker/template/SimpleHash.html @@ -2,10 +2,10 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_144) on Sun Oct 15 21:19:46 EDT 2017 --> +<!-- Generated by javadoc (1.8.0_144) on Sat Nov 11 19:25:50 CET 2017 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>SimpleHash (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> @@ -115,7 +115,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>Direct Known Subclasses:</dt> @@ -125,9 +125,9 @@ var activeTableTab = "activeTableTab"; <br> <pre>public class <span class="typeNameLabel">SimpleHash</span> extends <a href="../../freemarker/template/WrappingTemplateModel.html" title="class in freemarker.template">WrappingTemplateModel</a> -implements <a href="../../freemarker/template/TemplateHashModelEx2.html" title="interface in freemarker.template">TemplateHashModelEx2</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> -<div class="block">A simple implementation of the <a href="../../freemarker/template/TemplateHashModelEx.html" title="interface in freemarker.template"><code>TemplateHashModelEx</code></a> interface, using its own underlying <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> or - <a href="http://docs.oracle.com/javase/8/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util"><code>SortedMap</code></a> for storing the hash entries. If you are wrapping an already existing <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a>, you should +implements <a href="../../freemarker/template/TemplateHashModelEx2.html" title="interface in freemarker.template">TemplateHashModelEx2</a>, java.io.Serializable</pre> +<div class="block">A simple implementation of the <a href="../../freemarker/template/TemplateHashModelEx.html" title="interface in freemarker.template"><code>TemplateHashModelEx</code></a> interface, using its own underlying <code>Map</code> or + <code>SortedMap</code> for storing the hash entries. If you are wrapping an already existing <code>Map</code>, you should certainly use <a href="../../freemarker/template/DefaultMapAdapter.html" title="class in freemarker.template"><code>DefaultMapAdapter</code></a> instead (see comparison below). <p> @@ -140,25 +140,25 @@ implements <a href="../../freemarker/template/TemplateHashModelEx2.html" title=" <b><a href="../../freemarker/template/SimpleHash.html" title="class in freemarker.template"><code>SimpleHash</code></a> VS <a href="../../freemarker/template/DefaultMapAdapter.html" title="class in freemarker.template"><code>DefaultMapAdapter</code></a> - Which to use when?</b> <p> - For a <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> that exists regardless of FreeMarker, only you need to access it from templates, + For a <code>Map</code> that exists regardless of FreeMarker, only you need to access it from templates, <a href="../../freemarker/template/DefaultMapAdapter.html" title="class in freemarker.template"><code>DefaultMapAdapter</code></a> should be the default choice, as it reflects the exact behavior of the underlying - <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> (no surprises), can be unwrapped to the originally wrapped object (important when passing it to Java + <code>Map</code> (no surprises), can be unwrapped to the originally wrapped object (important when passing it to Java methods from the template), and has more predictable performance (no spikes). <p> For a hash that's made specifically to be used from templates, creating an empty <a href="../../freemarker/template/SimpleHash.html" title="class in freemarker.template"><code>SimpleHash</code></a> then filling it with <a href="../../freemarker/template/SimpleHash.html#put-java.lang.String-java.lang.Object-"><code>put(String, Object)</code></a> is usually the way to go, as the resulting hash is significantly faster to read from templates than a <a href="../../freemarker/template/DefaultMapAdapter.html" title="class in freemarker.template"><code>DefaultMapAdapter</code></a> (though it's somewhat slower to read from a plain Java method - to which it had to be passed adapted to a <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a>). + to which it had to be passed adapted to a <code>Map</code>). <p> - It also matters if for how many times will the <em>same</em> <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> entry be read from the template(s) later, on + It also matters if for how many times will the <em>same</em> <code>Map</code> entry be read from the template(s) later, on average. If, on average, you read each entry for more than 4 times, <a href="../../freemarker/template/SimpleHash.html" title="class in freemarker.template"><code>SimpleHash</code></a> will be most certainly faster, but if for 2 times or less (and especially if not at all) then <a href="../../freemarker/template/DefaultMapAdapter.html" title="class in freemarker.template"><code>DefaultMapAdapter</code></a> will be faster. Before choosing based on performance though, pay attention to the behavioral differences; <a href="../../freemarker/template/SimpleHash.html" title="class in freemarker.template"><code>SimpleHash</code></a> will - shallow-copy the original <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> at construction time, so key order will be lost in some cases, and it won't - reflect <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> content changes after the <a href="../../freemarker/template/SimpleHash.html" title="class in freemarker.template"><code>SimpleHash</code></a> construction, also <a href="../../freemarker/template/SimpleHash.html" title="class in freemarker.template"><code>SimpleHash</code></a> can't be - unwrapped to the original <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> instance.</div> + shallow-copy the original <code>Map</code> at construction time, so key order will be lost in some cases, and it won't + reflect <code>Map</code> content changes after the <a href="../../freemarker/template/SimpleHash.html" title="class in freemarker.template"><code>SimpleHash</code></a> construction, also <a href="../../freemarker/template/SimpleHash.html" title="class in freemarker.template"><code>SimpleHash</code></a> can't be + unwrapped to the original <code>Map</code> instance.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../freemarker/template/DefaultMapAdapter.html" title="class in freemarker.template"><code>DefaultMapAdapter</code></a>, @@ -220,14 +220,14 @@ implements <a href="../../freemarker/template/TemplateHashModelEx2.html" title=" </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleHash.html#SimpleHash-java.util.Map-">SimpleHash</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> map)</code> +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleHash.html#SimpleHash-java.util.Map-">SimpleHash</a></span>(java.util.Map map)</code> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <div class="block"><span class="deprecationComment">Use <a href="../../freemarker/template/SimpleHash.html#SimpleHash-java.util.Map-freemarker.template.ObjectWrapper-"><code>SimpleHash(Map, ObjectWrapper)</code></a></span></div> </div> </td> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleHash.html#SimpleHash-java.util.Map-freemarker.template.ObjectWrapper-">SimpleHash</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> map, +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleHash.html#SimpleHash-java.util.Map-freemarker.template.ObjectWrapper-">SimpleHash</a></span>(java.util.Map map, <a href="../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template">ObjectWrapper</a> wrapper)</code> <div class="block">Creates a new hash by shallow-coping (possibly cloning) the underlying map; in many applications you should use <a href="../../freemarker/template/DefaultMapAdapter.html" title="class in freemarker.template"><code>DefaultMapAdapter</code></a> instead.</div> @@ -255,17 +255,17 @@ implements <a href="../../freemarker/template/TemplateHashModelEx2.html" title=" </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleHash.html#containsKey-java.lang.String-">containsKey</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleHash.html#containsKey-java.lang.String-">containsKey</a></span>(java.lang.String key)</code> <div class="block">Tells if the map contains a key or not, regardless if the associated value is <code>null</code> or not.</div> </td> </tr> <tr id="i1" class="rowColor"> -<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleHash.html#copyMap-java.util.Map-">copyMap</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> map)</code> </td> +<td class="colFirst"><code>protected java.util.Map</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleHash.html#copyMap-java.util.Map-">copyMap</a></span>(java.util.Map map)</code> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code><a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleHash.html#get-java.lang.String-">get</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleHash.html#get-java.lang.String-">get</a></span>(java.lang.String key)</code> <div class="block">Gets a <tt>TemplateModel</tt> from the hash.</div> </td> </tr> @@ -283,27 +283,27 @@ implements <a href="../../freemarker/template/TemplateHashModelEx2.html" title=" </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleHash.html#put-java.lang.String-boolean-">put</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleHash.html#put-java.lang.String-boolean-">put</a></span>(java.lang.String key, boolean b)</code> <div class="block">Puts a boolean in the map</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/template/SimpleHash.html#put-java.lang.String-java.lang.Object-">put</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, - <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/template/SimpleHash.html#put-java.lang.String-java.lang.Object-">put</a></span>(java.lang.String key, + java.lang.Object value)</code> <div class="block">Adds a key-value entry to this hash.</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/template/SimpleHash.html#putAll-java.util.Map-">putAll</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> m)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleHash.html#putAll-java.util.Map-">putAll</a></span>(java.util.Map m)</code> <div class="block">Adds all the key/value entries in the map</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/template/SimpleHash.html#remove-java.lang.String-">remove</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleHash.html#remove-java.lang.String-">remove</a></span>(java.lang.String key)</code> <div class="block">Removes the given key from the underlying map.</div> </td> </tr> @@ -316,16 +316,16 @@ implements <a href="../../freemarker/template/TemplateHashModelEx2.html" title=" <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleHash.html#synchronizedWrapper--">synchronizedWrapper</a></span>()</code> </td> </tr> <tr id="i12" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a></code></td> +<td class="colFirst"><code>java.util.Map</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleHash.html#toMap--">toMap</a></span>()</code> <div class="block">Note that this method creates and returns a deep-copy of the underlying hash used internally.</div> </td> </tr> <tr id="i13" class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/template/SimpleHash.html#toString--">toString</a></span>()</code> -<div class="block">Returns the <code>toString()</code> of the underlying <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a>.</div> +<div class="block">Returns the <code>toString()</code> of the underlying <code>Map</code>.</div> </td> </tr> <tr id="i14" class="altColor"> @@ -344,8 +344,8 @@ implements <a href="../../freemarker/template/TemplateHashModelEx2.html" title=" <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> @@ -367,7 +367,7 @@ implements <a href="../../freemarker/template/TemplateHashModelEx2.html" title=" <ul class="blockList"> <li class="blockList"> <h4>SimpleHash</h4> -<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> +<pre>@Deprecated public SimpleHash()</pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../freemarker/template/SimpleHash.html#SimpleHash-freemarker.template.ObjectWrapper-"><code>SimpleHash(ObjectWrapper)</code></a></span></div> <div class="block">Constructs an empty hash that uses the default wrapper set in @@ -380,8 +380,8 @@ public SimpleHash()</pre> <ul class="blockList"> <li class="blockList"> <h4>SimpleHash</h4> -<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> -public SimpleHash(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> map)</pre> +<pre>@Deprecated +public SimpleHash(java.util.Map map)</pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../freemarker/template/SimpleHash.html#SimpleHash-java.util.Map-freemarker.template.ObjectWrapper-"><code>SimpleHash(Map, ObjectWrapper)</code></a></span></div> <div class="block">Creates a new simple hash with the copy of the underlying map and the default wrapper set in @@ -389,9 +389,9 @@ public SimpleHash(<a href="http://docs.oracle.com/javase/8/docs/api/java/ut <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>map</code> - The Map to use for the key/value pairs. It makes a copy for - internal use. If the map implements the <a href="http://docs.oracle.com/javase/8/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util"><code>SortedMap</code></a> interface, the - internal copy will be a <a href="http://docs.oracle.com/javase/8/docs/api/java/util/TreeMap.html?is-external=true" title="class or interface in java.util"><code>TreeMap</code></a>, otherwise it will be a - <a href="http://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html?is-external=true" title="class or interface in java.util"><code>HashMap</code></a>.</dd> + internal use. If the map implements the <code>SortedMap</code> interface, the + internal copy will be a <code>TreeMap</code>, otherwise it will be a + <code>HashMap</code>.</dd> </dl> </li> </ul> @@ -418,14 +418,14 @@ public SimpleHash(<a href="http://docs.oracle.com/javase/8/docs/api/java/ut <ul class="blockListLast"> <li class="blockList"> <h4>SimpleHash</h4> -<pre>public SimpleHash(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> map, +<pre>public SimpleHash(java.util.Map map, <a href="../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template">ObjectWrapper</a> wrapper)</pre> <div class="block">Creates a new hash by shallow-coping (possibly cloning) the underlying map; in many applications you should use <a href="../../freemarker/template/DefaultMapAdapter.html" title="class in freemarker.template"><code>DefaultMapAdapter</code></a> instead.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>map</code> - The Map to use for the key/value pairs. It makes a copy for internal use. If the map implements the - <a href="http://docs.oracle.com/javase/8/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util"><code>SortedMap</code></a> interface, the internal copy will be a <a href="http://docs.oracle.com/javase/8/docs/api/java/util/TreeMap.html?is-external=true" title="class or interface in java.util"><code>TreeMap</code></a>, otherwise it will be a</dd> + <code>SortedMap</code> interface, the internal copy will be a <code>TreeMap</code>, otherwise it will be a</dd> <dd><code>wrapper</code> - The object wrapper to use to wrap contained objects into <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> instances. Using <code>null</code> is deprecated but allowed, in which case the deprecated default wrapper set in <a href="../../freemarker/template/WrappingTemplateModel.html#setDefaultObjectWrapper-freemarker.template.ObjectWrapper-"><code>WrappingTemplateModel.setDefaultObjectWrapper(ObjectWrapper)</code></a> is used.</dd> @@ -446,7 +446,7 @@ public SimpleHash(<a href="http://docs.oracle.com/javase/8/docs/api/java/ut <ul class="blockList"> <li class="blockList"> <h4>copyMap</h4> -<pre>protected <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> copyMap(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> map)</pre> +<pre>protected java.util.Map copyMap(java.util.Map map)</pre> </li> </ul> <a name="put-java.lang.String-java.lang.Object-"> @@ -455,8 +455,8 @@ public SimpleHash(<a href="http://docs.oracle.com/javase/8/docs/api/java/ut <ul class="blockList"> <li class="blockList"> <h4>put</h4> -<pre>public void put(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, - <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 void put(java.lang.String key, + java.lang.Object value)</pre> <div class="block">Adds a key-value entry to this hash.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -472,7 +472,7 @@ public SimpleHash(<a href="http://docs.oracle.com/javase/8/docs/api/java/ut <ul class="blockList"> <li class="blockList"> <h4>put</h4> -<pre>public void put(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, +<pre>public void put(java.lang.String key, boolean b)</pre> <div class="block">Puts a boolean in the map</div> <dl> @@ -489,7 +489,7 @@ public SimpleHash(<a href="http://docs.oracle.com/javase/8/docs/api/java/ut <ul class="blockList"> <li class="blockList"> <h4>get</h4> -<pre>public <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> get(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key) +<pre>public <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> get(java.lang.String key) throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../freemarker/template/TemplateHashModel.html#get-java.lang.String-">TemplateHashModel</a></code></span></div> <div class="block">Gets a <tt>TemplateModel</tt> from the hash.</div> @@ -513,7 +513,7 @@ public SimpleHash(<a href="http://docs.oracle.com/javase/8/docs/api/java/ut <ul class="blockList"> <li class="blockList"> <h4>containsKey</h4> -<pre>public boolean containsKey(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> +<pre>public boolean containsKey(java.lang.String key)</pre> <div class="block">Tells if the map contains a key or not, regardless if the associated value is <code>null</code> or not.</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> @@ -527,7 +527,7 @@ public SimpleHash(<a href="http://docs.oracle.com/javase/8/docs/api/java/ut <ul class="blockList"> <li class="blockList"> <h4>remove</h4> -<pre>public void remove(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key)</pre> +<pre>public void remove(java.lang.String key)</pre> <div class="block">Removes the given key from the underlying map.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -541,7 +541,7 @@ public SimpleHash(<a href="http://docs.oracle.com/javase/8/docs/api/java/ut <ul class="blockList"> <li class="blockList"> <h4>putAll</h4> -<pre>public void putAll(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> m)</pre> +<pre>public void putAll(java.util.Map m)</pre> <div class="block">Adds all the key/value entries in the map</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -555,8 +555,8 @@ public SimpleHash(<a href="http://docs.oracle.com/javase/8/docs/api/java/ut <ul class="blockList"> <li class="blockList"> <h4>toMap</h4> -<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a> toMap() - throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> +<pre>public java.util.Map toMap() + throws <a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></pre> <div class="block">Note that this method creates and returns a deep-copy of the underlying hash used internally. This could be a gotcha for some people at some point who want to alter something in the data model, @@ -574,11 +574,11 @@ public SimpleHash(<a href="http://docs.oracle.com/javase/8/docs/api/java/ut <ul class="blockList"> <li class="blockList"> <h4>toString</h4> -<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> -<div class="block">Returns the <code>toString()</code> of the underlying <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a>.</div> +<pre>public java.lang.String toString()</pre> +<div class="block">Returns the <code>toString()</code> of the underlying <code>Map</code>.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> -<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> +<dd><code>toString</code> in class <code>java.lang.Object</code></dd> </dl> </li> </ul>
