http://git-wip-us.apache.org/repos/asf/freemarker-site/blob/a4a53cb9/builds/2.3.28-voting/documentation/api/freemarker/cache/FirstMatchTemplateConfigurationFactory.html ---------------------------------------------------------------------- diff --git a/builds/2.3.28-voting/documentation/api/freemarker/cache/FirstMatchTemplateConfigurationFactory.html b/builds/2.3.28-voting/documentation/api/freemarker/cache/FirstMatchTemplateConfigurationFactory.html deleted file mode 100644 index 2fbb43a..0000000 --- a/builds/2.3.28-voting/documentation/api/freemarker/cache/FirstMatchTemplateConfigurationFactory.html +++ /dev/null @@ -1,438 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (1.8.0_144) on Fri Mar 30 23:10:41 CEST 2018 --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>FirstMatchTemplateConfigurationFactory (FreeMarker 2.3.28 API)</title> -<meta name="date" content="2018-03-30"> -<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="FirstMatchTemplateConfigurationFactory (FreeMarker 2.3.28 API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/FirstMatchTemplateConfigurationFactory.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../index-all.html">Index</a></li> -<li><a href="../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../freemarker/cache/FileTemplateLoader.html" title="class in freemarker.cache"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../freemarker/cache/MergingTemplateConfigurationFactory.html" title="class in freemarker.cache"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../index.html?freemarker/cache/FirstMatchTemplateConfigurationFactory.html" target="_top">Frames</a></li> -<li><a href="FirstMatchTemplateConfigurationFactory.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">freemarker.cache</div> -<h2 title="Class FirstMatchTemplateConfigurationFactory" class="title">Class FirstMatchTemplateConfigurationFactory</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li><a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache">freemarker.cache.TemplateConfigurationFactory</a></li> -<li> -<ul class="inheritance"> -<li>freemarker.cache.FirstMatchTemplateConfigurationFactory</li> -</ul> -</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public class <span class="typeNameLabel">FirstMatchTemplateConfigurationFactory</span> -extends <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache">TemplateConfigurationFactory</a></pre> -<div class="block">Returns the first non-<code>null</code> result of the child factories, ignoring all further child factories. The child - factories are called in the order as they were added.</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ======== CONSTRUCTOR SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.summary"> -<!-- --> -</a> -<h3>Constructor Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> -<caption><span>Constructors</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Constructor and Description</th> -</tr> -<tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#FirstMatchTemplateConfigurationFactory-freemarker.cache.TemplateConfigurationFactory...-">FirstMatchTemplateConfigurationFactory</a></span>(<a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache">TemplateConfigurationFactory</a>... templateConfigurationFactories)</code> </td> -</tr> -</table> -</li> -</ul> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr id="i0" class="altColor"> -<td class="colFirst"><code><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html" title="class in freemarker.cache">FirstMatchTemplateConfigurationFactory</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#allowNoMatch-boolean-">allowNoMatch</a></span>(boolean allow)</code> -<div class="block">Same as <a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#setAllowNoMatch-boolean-"><code>setAllowNoMatch(boolean)</code></a>, but return this object to support "fluent API" style.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code><a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core">TemplateConfiguration</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#get-java.lang.String-java.lang.Object-">get</a></span>(java.lang.String sourceName, - java.lang.Object templateSource)</code> -<div class="block">Returns (maybe creates) the <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core"><code>TemplateConfiguration</code></a> for the given template source.</div> -</td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#getAllowNoMatch--">getAllowNoMatch</a></span>()</code> -<div class="block">Getter pair of <a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#setAllowNoMatch-boolean-"><code>setAllowNoMatch(boolean)</code></a>.</div> -</td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#getNoMatchErrorDetails--">getNoMatchErrorDetails</a></span>()</code> -<div class="block">Use this to specify the text added to the exception error message when there was no matching choice.</div> -</td> -</tr> -<tr id="i4" class="altColor"> -<td class="colFirst"><code><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html" title="class in freemarker.cache">FirstMatchTemplateConfigurationFactory</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#noMatchErrorDetails-java.lang.String-">noMatchErrorDetails</a></span>(java.lang.String message)</code> -<div class="block">Same as <a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#setNoMatchErrorDetails-java.lang.String-"><code>setNoMatchErrorDetails(String)</code></a>, but return this object to support "fluent API" style.</div> -</td> -</tr> -<tr id="i5" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#setAllowNoMatch-boolean-">setAllowNoMatch</a></span>(boolean allowNoMatch)</code> -<div class="block">Use this to specify if having no matching choice is an error.</div> -</td> -</tr> -<tr id="i6" class="altColor"> -<td class="colFirst"><code>protected void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#setConfigurationOfChildren-freemarker.template.Configuration-">setConfigurationOfChildren</a></span>(<a href="../../freemarker/template/Configuration.html" title="class in freemarker.template">Configuration</a> cfg)</code> -<div class="block">Calls <a href="../../freemarker/core/TemplateConfiguration.html#setParentConfiguration-freemarker.template.Configuration-"><code>TemplateConfiguration.setParentConfiguration(Configuration)</code></a> on each enclosed - <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core"><code>TemplateConfiguration</code></a> and <a href="../../freemarker/cache/TemplateConfigurationFactory.html#setConfiguration-freemarker.template.Configuration-"><code>TemplateConfigurationFactory.setConfiguration(Configuration)</code></a> - on each enclosed <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache"><code>TemplateConfigurationFactory</code></a> objects.</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/cache/FirstMatchTemplateConfigurationFactory.html#setNoMatchErrorDetails-java.lang.String-">setNoMatchErrorDetails</a></span>(java.lang.String noMatchErrorDetails)</code> </td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.freemarker.cache.TemplateConfigurationFactory"> -<!-- --> -</a> -<h3>Methods inherited from class freemarker.cache.<a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache">TemplateConfigurationFactory</a></h3> -<code><a href="../../freemarker/cache/TemplateConfigurationFactory.html#getConfiguration--">getConfiguration</a>, <a href="../../freemarker/cache/TemplateConfigurationFactory.html#setConfiguration-freemarker.template.Configuration-">setConfiguration</a></code></li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.Object</h3> -<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========= CONSTRUCTOR DETAIL ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.detail"> -<!-- --> -</a> -<h3>Constructor Detail</h3> -<a name="FirstMatchTemplateConfigurationFactory-freemarker.cache.TemplateConfigurationFactory...-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>FirstMatchTemplateConfigurationFactory</h4> -<pre>public FirstMatchTemplateConfigurationFactory(<a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache">TemplateConfigurationFactory</a>... templateConfigurationFactories)</pre> -</li> -</ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="get-java.lang.String-java.lang.Object-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>get</h4> -<pre>public <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core">TemplateConfiguration</a> get(java.lang.String sourceName, - java.lang.Object templateSource) - throws java.io.IOException, - <a href="../../freemarker/cache/TemplateConfigurationFactoryException.html" title="class in freemarker.cache">TemplateConfigurationFactoryException</a></pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/cache/TemplateConfigurationFactory.html#get-java.lang.String-java.lang.Object-">TemplateConfigurationFactory</a></code></span></div> -<div class="block">Returns (maybe creates) the <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core"><code>TemplateConfiguration</code></a> for the given template source.</div> -<dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../freemarker/cache/TemplateConfigurationFactory.html#get-java.lang.String-java.lang.Object-">get</a></code> in class <code><a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache">TemplateConfigurationFactory</a></code></dd> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>sourceName</code> - The name (path) that was used for <a href="../../freemarker/cache/TemplateLoader.html#findTemplateSource-java.lang.String-"><code>TemplateLoader.findTemplateSource(String)</code></a>. See - <a href="../../freemarker/template/Template.html#getSourceName--"><code>Template.getSourceName()</code></a> for details.</dd> -<dd><code>templateSource</code> - The object returned by <a href="../../freemarker/cache/TemplateLoader.html#findTemplateSource-java.lang.String-"><code>TemplateLoader.findTemplateSource(String)</code></a>.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core"><code>TemplateConfiguration</code></a> to apply, or <code>null</code> if the there's no <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core"><code>TemplateConfiguration</code></a> for - this template source.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.io.IOException</code> - Typically, if there factory needs further I/O to find out more about the template source, but that - fails.</dd> -<dd><code><a href="../../freemarker/cache/TemplateConfigurationFactoryException.html" title="class in freemarker.cache">TemplateConfigurationFactoryException</a></code> - If there's a problem that's specific to the factory logic.</dd> -</dl> -</li> -</ul> -<a name="getAllowNoMatch--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getAllowNoMatch</h4> -<pre>public boolean getAllowNoMatch()</pre> -<div class="block">Getter pair of <a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#setAllowNoMatch-boolean-"><code>setAllowNoMatch(boolean)</code></a>.</div> -</li> -</ul> -<a name="setAllowNoMatch-boolean-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setAllowNoMatch</h4> -<pre>public void setAllowNoMatch(boolean allowNoMatch)</pre> -<div class="block">Use this to specify if having no matching choice is an error. The default is <code>false</code>, that is, it's an - error if there was no matching choice.</div> -<dl> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#setNoMatchErrorDetails-java.lang.String-"><code>setNoMatchErrorDetails(String)</code></a></dd> -</dl> -</li> -</ul> -<a name="getNoMatchErrorDetails--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getNoMatchErrorDetails</h4> -<pre>public java.lang.String getNoMatchErrorDetails()</pre> -<div class="block">Use this to specify the text added to the exception error message when there was no matching choice. - The default is <code>null</code> (no error details).</div> -<dl> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#setAllowNoMatch-boolean-"><code>setAllowNoMatch(boolean)</code></a></dd> -</dl> -</li> -</ul> -<a name="setNoMatchErrorDetails-java.lang.String-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setNoMatchErrorDetails</h4> -<pre>public void setNoMatchErrorDetails(java.lang.String noMatchErrorDetails)</pre> -</li> -</ul> -<a name="allowNoMatch-boolean-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>allowNoMatch</h4> -<pre>public <a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html" title="class in freemarker.cache">FirstMatchTemplateConfigurationFactory</a> allowNoMatch(boolean allow)</pre> -<div class="block">Same as <a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#setAllowNoMatch-boolean-"><code>setAllowNoMatch(boolean)</code></a>, but return this object to support "fluent API" style.</div> -</li> -</ul> -<a name="noMatchErrorDetails-java.lang.String-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>noMatchErrorDetails</h4> -<pre>public <a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html" title="class in freemarker.cache">FirstMatchTemplateConfigurationFactory</a> noMatchErrorDetails(java.lang.String message)</pre> -<div class="block">Same as <a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#setNoMatchErrorDetails-java.lang.String-"><code>setNoMatchErrorDetails(String)</code></a>, but return this object to support "fluent API" style.</div> -</li> -</ul> -<a name="setConfigurationOfChildren-freemarker.template.Configuration-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>setConfigurationOfChildren</h4> -<pre>protected void setConfigurationOfChildren(<a href="../../freemarker/template/Configuration.html" title="class in freemarker.template">Configuration</a> cfg)</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/cache/TemplateConfigurationFactory.html#setConfigurationOfChildren-freemarker.template.Configuration-">TemplateConfigurationFactory</a></code></span></div> -<div class="block">Calls <a href="../../freemarker/core/TemplateConfiguration.html#setParentConfiguration-freemarker.template.Configuration-"><code>TemplateConfiguration.setParentConfiguration(Configuration)</code></a> on each enclosed - <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core"><code>TemplateConfiguration</code></a> and <a href="../../freemarker/cache/TemplateConfigurationFactory.html#setConfiguration-freemarker.template.Configuration-"><code>TemplateConfigurationFactory.setConfiguration(Configuration)</code></a> - on each enclosed <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache"><code>TemplateConfigurationFactory</code></a> objects. It only supposed to call these on the direct - "children" of this object, not on the children of the children.</div> -<dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../freemarker/cache/TemplateConfigurationFactory.html#setConfigurationOfChildren-freemarker.template.Configuration-">setConfigurationOfChildren</a></code> in class <code><a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache">TemplateConfigurationFactory</a></code></dd> -</dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/FirstMatchTemplateConfigurationFactory.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../index-all.html">Index</a></li> -<li><a href="../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../freemarker/cache/FileTemplateLoader.html" title="class in freemarker.cache"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../freemarker/cache/MergingTemplateConfigurationFactory.html" title="class in freemarker.cache"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../index.html?freemarker/cache/FirstMatchTemplateConfigurationFactory.html" target="_top">Frames</a></li> -<li><a href="FirstMatchTemplateConfigurationFactory.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html>
http://git-wip-us.apache.org/repos/asf/freemarker-site/blob/a4a53cb9/builds/2.3.28-voting/documentation/api/freemarker/cache/MergingTemplateConfigurationFactory.html ---------------------------------------------------------------------- diff --git a/builds/2.3.28-voting/documentation/api/freemarker/cache/MergingTemplateConfigurationFactory.html b/builds/2.3.28-voting/documentation/api/freemarker/cache/MergingTemplateConfigurationFactory.html deleted file mode 100644 index f14d9fd..0000000 --- a/builds/2.3.28-voting/documentation/api/freemarker/cache/MergingTemplateConfigurationFactory.html +++ /dev/null @@ -1,340 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (1.8.0_144) on Fri Mar 30 23:10:41 CEST 2018 --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>MergingTemplateConfigurationFactory (FreeMarker 2.3.28 API)</title> -<meta name="date" content="2018-03-30"> -<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="MergingTemplateConfigurationFactory (FreeMarker 2.3.28 API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":10,"i1":10}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/MergingTemplateConfigurationFactory.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../index-all.html">Index</a></li> -<li><a href="../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html" title="class in freemarker.cache"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../freemarker/cache/MruCacheStorage.html" title="class in freemarker.cache"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../index.html?freemarker/cache/MergingTemplateConfigurationFactory.html" target="_top">Frames</a></li> -<li><a href="MergingTemplateConfigurationFactory.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">freemarker.cache</div> -<h2 title="Class MergingTemplateConfigurationFactory" class="title">Class MergingTemplateConfigurationFactory</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li><a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache">freemarker.cache.TemplateConfigurationFactory</a></li> -<li> -<ul class="inheritance"> -<li>freemarker.cache.MergingTemplateConfigurationFactory</li> -</ul> -</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public class <span class="typeNameLabel">MergingTemplateConfigurationFactory</span> -extends <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache">TemplateConfigurationFactory</a></pre> -<div class="block">Returns the merged results of all the child factories. The factories are merged in the order as they were added. - <code>null</code> results from the child factories will be ignored. If all child factories return <code>null</code>, the result - of this factory will be <code>null</code> too.</div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>2.3.24</dd> -</dl> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ======== CONSTRUCTOR SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.summary"> -<!-- --> -</a> -<h3>Constructor Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> -<caption><span>Constructors</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Constructor and Description</th> -</tr> -<tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/cache/MergingTemplateConfigurationFactory.html#MergingTemplateConfigurationFactory-freemarker.cache.TemplateConfigurationFactory...-">MergingTemplateConfigurationFactory</a></span>(<a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache">TemplateConfigurationFactory</a>... templateConfigurationFactories)</code> </td> -</tr> -</table> -</li> -</ul> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr id="i0" class="altColor"> -<td class="colFirst"><code><a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core">TemplateConfiguration</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/MergingTemplateConfigurationFactory.html#get-java.lang.String-java.lang.Object-">get</a></span>(java.lang.String sourceName, - java.lang.Object templateSource)</code> -<div class="block">Returns (maybe creates) the <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core"><code>TemplateConfiguration</code></a> for the given template source.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code>protected void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/MergingTemplateConfigurationFactory.html#setConfigurationOfChildren-freemarker.template.Configuration-">setConfigurationOfChildren</a></span>(<a href="../../freemarker/template/Configuration.html" title="class in freemarker.template">Configuration</a> cfg)</code> -<div class="block">Calls <a href="../../freemarker/core/TemplateConfiguration.html#setParentConfiguration-freemarker.template.Configuration-"><code>TemplateConfiguration.setParentConfiguration(Configuration)</code></a> on each enclosed - <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core"><code>TemplateConfiguration</code></a> and <a href="../../freemarker/cache/TemplateConfigurationFactory.html#setConfiguration-freemarker.template.Configuration-"><code>TemplateConfigurationFactory.setConfiguration(Configuration)</code></a> - on each enclosed <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache"><code>TemplateConfigurationFactory</code></a> objects.</div> -</td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.freemarker.cache.TemplateConfigurationFactory"> -<!-- --> -</a> -<h3>Methods inherited from class freemarker.cache.<a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache">TemplateConfigurationFactory</a></h3> -<code><a href="../../freemarker/cache/TemplateConfigurationFactory.html#getConfiguration--">getConfiguration</a>, <a href="../../freemarker/cache/TemplateConfigurationFactory.html#setConfiguration-freemarker.template.Configuration-">setConfiguration</a></code></li> -</ul> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.Object</h3> -<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========= CONSTRUCTOR DETAIL ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.detail"> -<!-- --> -</a> -<h3>Constructor Detail</h3> -<a name="MergingTemplateConfigurationFactory-freemarker.cache.TemplateConfigurationFactory...-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>MergingTemplateConfigurationFactory</h4> -<pre>public MergingTemplateConfigurationFactory(<a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache">TemplateConfigurationFactory</a>... templateConfigurationFactories)</pre> -</li> -</ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="get-java.lang.String-java.lang.Object-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>get</h4> -<pre>public <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core">TemplateConfiguration</a> get(java.lang.String sourceName, - java.lang.Object templateSource) - throws java.io.IOException, - <a href="../../freemarker/cache/TemplateConfigurationFactoryException.html" title="class in freemarker.cache">TemplateConfigurationFactoryException</a></pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/cache/TemplateConfigurationFactory.html#get-java.lang.String-java.lang.Object-">TemplateConfigurationFactory</a></code></span></div> -<div class="block">Returns (maybe creates) the <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core"><code>TemplateConfiguration</code></a> for the given template source.</div> -<dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../freemarker/cache/TemplateConfigurationFactory.html#get-java.lang.String-java.lang.Object-">get</a></code> in class <code><a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache">TemplateConfigurationFactory</a></code></dd> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>sourceName</code> - The name (path) that was used for <a href="../../freemarker/cache/TemplateLoader.html#findTemplateSource-java.lang.String-"><code>TemplateLoader.findTemplateSource(String)</code></a>. See - <a href="../../freemarker/template/Template.html#getSourceName--"><code>Template.getSourceName()</code></a> for details.</dd> -<dd><code>templateSource</code> - The object returned by <a href="../../freemarker/cache/TemplateLoader.html#findTemplateSource-java.lang.String-"><code>TemplateLoader.findTemplateSource(String)</code></a>.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core"><code>TemplateConfiguration</code></a> to apply, or <code>null</code> if the there's no <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core"><code>TemplateConfiguration</code></a> for - this template source.</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.io.IOException</code> - Typically, if there factory needs further I/O to find out more about the template source, but that - fails.</dd> -<dd><code><a href="../../freemarker/cache/TemplateConfigurationFactoryException.html" title="class in freemarker.cache">TemplateConfigurationFactoryException</a></code> - If there's a problem that's specific to the factory logic.</dd> -</dl> -</li> -</ul> -<a name="setConfigurationOfChildren-freemarker.template.Configuration-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>setConfigurationOfChildren</h4> -<pre>protected void setConfigurationOfChildren(<a href="../../freemarker/template/Configuration.html" title="class in freemarker.template">Configuration</a> cfg)</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/cache/TemplateConfigurationFactory.html#setConfigurationOfChildren-freemarker.template.Configuration-">TemplateConfigurationFactory</a></code></span></div> -<div class="block">Calls <a href="../../freemarker/core/TemplateConfiguration.html#setParentConfiguration-freemarker.template.Configuration-"><code>TemplateConfiguration.setParentConfiguration(Configuration)</code></a> on each enclosed - <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core"><code>TemplateConfiguration</code></a> and <a href="../../freemarker/cache/TemplateConfigurationFactory.html#setConfiguration-freemarker.template.Configuration-"><code>TemplateConfigurationFactory.setConfiguration(Configuration)</code></a> - on each enclosed <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache"><code>TemplateConfigurationFactory</code></a> objects. It only supposed to call these on the direct - "children" of this object, not on the children of the children.</div> -<dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../freemarker/cache/TemplateConfigurationFactory.html#setConfigurationOfChildren-freemarker.template.Configuration-">setConfigurationOfChildren</a></code> in class <code><a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache">TemplateConfigurationFactory</a></code></dd> -</dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/MergingTemplateConfigurationFactory.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../index-all.html">Index</a></li> -<li><a href="../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html" title="class in freemarker.cache"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../freemarker/cache/MruCacheStorage.html" title="class in freemarker.cache"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../index.html?freemarker/cache/MergingTemplateConfigurationFactory.html" target="_top">Frames</a></li> -<li><a href="MergingTemplateConfigurationFactory.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/freemarker-site/blob/a4a53cb9/builds/2.3.28-voting/documentation/api/freemarker/cache/MruCacheStorage.html ---------------------------------------------------------------------- diff --git a/builds/2.3.28-voting/documentation/api/freemarker/cache/MruCacheStorage.html b/builds/2.3.28-voting/documentation/api/freemarker/cache/MruCacheStorage.html deleted file mode 100644 index dd728d4..0000000 --- a/builds/2.3.28-voting/documentation/api/freemarker/cache/MruCacheStorage.html +++ /dev/null @@ -1,486 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (1.8.0_144) on Fri Mar 30 23:10:41 CEST 2018 --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>MruCacheStorage (FreeMarker 2.3.28 API)</title> -<meta name="date" content="2018-03-30"> -<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="MruCacheStorage (FreeMarker 2.3.28 API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/MruCacheStorage.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../index-all.html">Index</a></li> -<li><a href="../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../freemarker/cache/MergingTemplateConfigurationFactory.html" title="class in freemarker.cache"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../freemarker/cache/MultiTemplateLoader.html" title="class in freemarker.cache"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../index.html?freemarker/cache/MruCacheStorage.html" target="_top">Frames</a></li> -<li><a href="MruCacheStorage.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">freemarker.cache</div> -<h2 title="Class MruCacheStorage" class="title">Class MruCacheStorage</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li>freemarker.cache.MruCacheStorage</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>All Implemented Interfaces:</dt> -<dd><a href="../../freemarker/cache/CacheStorage.html" title="interface in freemarker.cache">CacheStorage</a>, <a href="../../freemarker/cache/CacheStorageWithGetSize.html" title="interface in freemarker.cache">CacheStorageWithGetSize</a></dd> -</dl> -<hr> -<br> -<pre>public class <span class="typeNameLabel">MruCacheStorage</span> -extends java.lang.Object -implements <a href="../../freemarker/cache/CacheStorageWithGetSize.html" title="interface in freemarker.cache">CacheStorageWithGetSize</a></pre> -<div class="block">A cache storage that implements a two-level Most Recently Used cache. In the - first level, items are strongly referenced up to the specified maximum. When - the maximum is exceeded, the least recently used item is moved into the - second level cache, where they are softly referenced, up to another - specified maximum. When the second level maximum is also exceeded, the least - recently used item is discarded altogether. This cache storage is a - generalization of both <a href="../../freemarker/cache/StrongCacheStorage.html" title="class in freemarker.cache"><code>StrongCacheStorage</code></a> and - <a href="../../freemarker/cache/SoftCacheStorage.html" title="class in freemarker.cache"><code>SoftCacheStorage</code></a> - the effect of both of them can be achieved by - setting one maximum to zero and the other to the largest positive integer. - On the other hand, if you wish to use this storage in a strong-only mode, or - in a soft-only mode, you might consider using <a href="../../freemarker/cache/StrongCacheStorage.html" title="class in freemarker.cache"><code>StrongCacheStorage</code></a> or - <a href="../../freemarker/cache/SoftCacheStorage.html" title="class in freemarker.cache"><code>SoftCacheStorage</code></a> instead, as they can be used by - <a href="../../freemarker/cache/TemplateCache.html" title="class in freemarker.cache"><code>TemplateCache</code></a> concurrently without any synchronization on a 5.0 or - later JRE. - - <p>This class is <em>NOT</em> thread-safe. If it's accessed from multiple - threads concurrently, proper synchronization must be provided by the callers. - Note that <a href="../../freemarker/cache/TemplateCache.html" title="class in freemarker.cache"><code>TemplateCache</code></a>, the natural user of this class provides the - necessary synchronizations when it uses the class. - Also you might consider whether you need this sort of a mixed storage at all - in your solution, as in most cases SoftCacheStorage can also be sufficient. - SoftCacheStorage will use Java soft references, and they already use access - timestamps internally to bias the garbage collector against clearing - recently used references, so you can get reasonably good (and - memory-sensitive) most-recently-used caching through - <a href="../../freemarker/cache/SoftCacheStorage.html" title="class in freemarker.cache"><code>SoftCacheStorage</code></a> as well.</div> -<dl> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../freemarker/template/Configuration.html#setCacheStorage-freemarker.cache.CacheStorage-"><code>Configuration.setCacheStorage(CacheStorage)</code></a></dd> -</dl> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ======== CONSTRUCTOR SUMMARY ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.summary"> -<!-- --> -</a> -<h3>Constructor Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> -<caption><span>Constructors</span><span class="tabEnd"> </span></caption> -<tr> -<th class="colOne" scope="col">Constructor and Description</th> -</tr> -<tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/cache/MruCacheStorage.html#MruCacheStorage-int-int-">MruCacheStorage</a></span>(int strongSizeLimit, - int softSizeLimit)</code> -<div class="block">Creates a new MRU cache storage with specified maximum cache sizes.</div> -</td> -</tr> -</table> -</li> -</ul> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr id="i0" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/MruCacheStorage.html#clear--">clear</a></span>()</code> </td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code>java.lang.Object</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/MruCacheStorage.html#get-java.lang.Object-">get</a></span>(java.lang.Object key)</code> </td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/MruCacheStorage.html#getSize--">getSize</a></span>()</code> -<div class="block">Returns a close approximation of the current number of cache entries.</div> -</td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/MruCacheStorage.html#getSoftSize--">getSoftSize</a></span>()</code> -<div class="block">Returns a close approximation of the <em>current</em> number of soft cache entries.</div> -</td> -</tr> -<tr id="i4" class="altColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/MruCacheStorage.html#getSoftSizeLimit--">getSoftSizeLimit</a></span>()</code> -<div class="block">Returns the configured upper limit of the number of soft cache entries.</div> -</td> -</tr> -<tr id="i5" class="rowColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/MruCacheStorage.html#getStrongSize--">getStrongSize</a></span>()</code> -<div class="block">Returns the <em>current</em> number of strong cache entries.</div> -</td> -</tr> -<tr id="i6" class="altColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/MruCacheStorage.html#getStrongSizeLimit--">getStrongSizeLimit</a></span>()</code> -<div class="block">Returns the configured upper limit of the number of strong cache entries.</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/cache/MruCacheStorage.html#put-java.lang.Object-java.lang.Object-">put</a></span>(java.lang.Object key, - java.lang.Object value)</code> </td> -</tr> -<tr id="i8" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/MruCacheStorage.html#remove-java.lang.Object-">remove</a></span>(java.lang.Object key)</code> </td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.Object</h3> -<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========= CONSTRUCTOR DETAIL ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.detail"> -<!-- --> -</a> -<h3>Constructor Detail</h3> -<a name="MruCacheStorage-int-int-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>MruCacheStorage</h4> -<pre>public MruCacheStorage(int strongSizeLimit, - int softSizeLimit)</pre> -<div class="block">Creates a new MRU cache storage with specified maximum cache sizes. Each - cache size can vary between 0 and <code>Integer.MAX_VALUE</code>.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>strongSizeLimit</code> - the maximum number of strongly referenced templates; when exceeded, the entry used - the least recently will be moved into the soft cache.</dd> -<dd><code>softSizeLimit</code> - the maximum number of softly referenced templates; when exceeded, the entry used - the least recently will be discarded.</dd> -</dl> -</li> -</ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="get-java.lang.Object-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>get</h4> -<pre>public java.lang.Object get(java.lang.Object key)</pre> -<dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../freemarker/cache/CacheStorage.html#get-java.lang.Object-">get</a></code> in interface <code><a href="../../freemarker/cache/CacheStorage.html" title="interface in freemarker.cache">CacheStorage</a></code></dd> -</dl> -</li> -</ul> -<a name="put-java.lang.Object-java.lang.Object-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>put</h4> -<pre>public void put(java.lang.Object key, - java.lang.Object value)</pre> -<dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../freemarker/cache/CacheStorage.html#put-java.lang.Object-java.lang.Object-">put</a></code> in interface <code><a href="../../freemarker/cache/CacheStorage.html" title="interface in freemarker.cache">CacheStorage</a></code></dd> -</dl> -</li> -</ul> -<a name="remove-java.lang.Object-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>remove</h4> -<pre>public void remove(java.lang.Object key)</pre> -<dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../freemarker/cache/CacheStorage.html#remove-java.lang.Object-">remove</a></code> in interface <code><a href="../../freemarker/cache/CacheStorage.html" title="interface in freemarker.cache">CacheStorage</a></code></dd> -</dl> -</li> -</ul> -<a name="clear--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>clear</h4> -<pre>public void clear()</pre> -<dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../freemarker/cache/CacheStorage.html#clear--">clear</a></code> in interface <code><a href="../../freemarker/cache/CacheStorage.html" title="interface in freemarker.cache">CacheStorage</a></code></dd> -</dl> -</li> -</ul> -<a name="getStrongSizeLimit--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getStrongSizeLimit</h4> -<pre>public int getStrongSizeLimit()</pre> -<div class="block">Returns the configured upper limit of the number of strong cache entries.</div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>2.3.21</dd> -</dl> -</li> -</ul> -<a name="getSoftSizeLimit--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getSoftSizeLimit</h4> -<pre>public int getSoftSizeLimit()</pre> -<div class="block">Returns the configured upper limit of the number of soft cache entries.</div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>2.3.21</dd> -</dl> -</li> -</ul> -<a name="getStrongSize--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getStrongSize</h4> -<pre>public int getStrongSize()</pre> -<div class="block">Returns the <em>current</em> number of strong cache entries.</div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>2.3.21</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../freemarker/cache/MruCacheStorage.html#getStrongSizeLimit--"><code>getStrongSizeLimit()</code></a></dd> -</dl> -</li> -</ul> -<a name="getSoftSize--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getSoftSize</h4> -<pre>public int getSoftSize()</pre> -<div class="block">Returns a close approximation of the <em>current</em> number of soft cache entries.</div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>2.3.21</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../freemarker/cache/MruCacheStorage.html#getSoftSizeLimit--"><code>getSoftSizeLimit()</code></a></dd> -</dl> -</li> -</ul> -<a name="getSize--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>getSize</h4> -<pre>public int getSize()</pre> -<div class="block">Returns a close approximation of the current number of cache entries.</div> -<dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../freemarker/cache/CacheStorageWithGetSize.html#getSize--">getSize</a></code> in interface <code><a href="../../freemarker/cache/CacheStorageWithGetSize.html" title="interface in freemarker.cache">CacheStorageWithGetSize</a></code></dd> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>2.3.21</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../freemarker/cache/MruCacheStorage.html#getStrongSize--"><code>getStrongSize()</code></a>, -<a href="../../freemarker/cache/MruCacheStorage.html#getSoftSize--"><code>getSoftSize()</code></a></dd> -</dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/MruCacheStorage.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../index-all.html">Index</a></li> -<li><a href="../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../freemarker/cache/MergingTemplateConfigurationFactory.html" title="class in freemarker.cache"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../freemarker/cache/MultiTemplateLoader.html" title="class in freemarker.cache"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../index.html?freemarker/cache/MruCacheStorage.html" target="_top">Frames</a></li> -<li><a href="MruCacheStorage.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li><a href="#constructor.summary">Constr</a> | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html>
