http://git-wip-us.apache.org/repos/asf/freemarker-site/blob/a4a53cb9/builds/2.3.28-voting/documentation/api/freemarker/cache/ByteArrayTemplateLoader.html ---------------------------------------------------------------------- diff --git a/builds/2.3.28-voting/documentation/api/freemarker/cache/ByteArrayTemplateLoader.html b/builds/2.3.28-voting/documentation/api/freemarker/cache/ByteArrayTemplateLoader.html deleted file mode 100644 index 47dca03..0000000 --- a/builds/2.3.28-voting/documentation/api/freemarker/cache/ByteArrayTemplateLoader.html +++ /dev/null @@ -1,511 +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>ByteArrayTemplateLoader (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="ByteArrayTemplateLoader (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/ByteArrayTemplateLoader.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/AndMatcher.html" title="class in freemarker.cache"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../freemarker/cache/CacheStorage.html" title="interface in freemarker.cache"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../index.html?freemarker/cache/ByteArrayTemplateLoader.html" target="_top">Frames</a></li> -<li><a href="ByteArrayTemplateLoader.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 ByteArrayTemplateLoader" class="title">Class ByteArrayTemplateLoader</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li>freemarker.cache.ByteArrayTemplateLoader</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>All Implemented Interfaces:</dt> -<dd><a href="../../freemarker/cache/TemplateLoader.html" title="interface in freemarker.cache">TemplateLoader</a></dd> -</dl> -<hr> -<br> -<pre>public class <span class="typeNameLabel">ByteArrayTemplateLoader</span> -extends java.lang.Object -implements <a href="../../freemarker/cache/TemplateLoader.html" title="interface in freemarker.cache">TemplateLoader</a></pre> -<div class="block">A <a href="../../freemarker/cache/TemplateLoader.html" title="interface in freemarker.cache"><code>TemplateLoader</code></a> that uses a <code>Map</code> with <code>byte[]</code> as its source of templates. This is similar to - <a href="../../freemarker/cache/StringTemplateLoader.html" title="class in freemarker.cache"><code>StringTemplateLoader</code></a>, but uses <code>byte[]</code> instead of <code>String</code>; see more details there.</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/ByteArrayTemplateLoader.html#ByteArrayTemplateLoader--">ByteArrayTemplateLoader</a></span>()</code> </td> -</tr> -</table> -</li> -</ul> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<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/ByteArrayTemplateLoader.html#closeTemplateSource-java.lang.Object-">closeTemplateSource</a></span>(java.lang.Object templateSource)</code> -<div class="block">Closes the template source, releasing any resources held that are only required for reading the template and/or - its metadata.</div> -</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/ByteArrayTemplateLoader.html#findTemplateSource-java.lang.String-">findTemplateSource</a></span>(java.lang.String name)</code> -<div class="block">Finds the template in the backing storage and returns an object that identifies the storage location where the - template can be loaded from.</div> -</td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>long</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/ByteArrayTemplateLoader.html#getLastModified-java.lang.Object-">getLastModified</a></span>(java.lang.Object templateSource)</code> -<div class="block">Returns the time of last modification of the specified template source.</div> -</td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code>java.io.Reader</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/ByteArrayTemplateLoader.html#getReader-java.lang.Object-java.lang.String-">getReader</a></span>(java.lang.Object templateSource, - java.lang.String encoding)</code> -<div class="block">Returns the character stream of a template represented by the specified template source.</div> -</td> -</tr> -<tr id="i4" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/ByteArrayTemplateLoader.html#putTemplate-java.lang.String-byte:A-">putTemplate</a></span>(java.lang.String name, - byte[] templateContent)</code> -<div class="block">Adds a template to this template loader; see <a href="../../freemarker/cache/StringTemplateLoader.html#putTemplate-java.lang.String-java.lang.String-"><code>StringTemplateLoader.putTemplate(String, String)</code></a> for more.</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/ByteArrayTemplateLoader.html#putTemplate-java.lang.String-byte:A-long-">putTemplate</a></span>(java.lang.String name, - byte[] templateContent, - long lastModified)</code> -<div class="block">Adds a template to this template loader; see <a href="../../freemarker/cache/StringTemplateLoader.html#putTemplate-java.lang.String-java.lang.String-long-"><code>StringTemplateLoader.putTemplate(String, String, long)</code></a> for - more.</div> -</td> -</tr> -<tr id="i6" class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/ByteArrayTemplateLoader.html#removeTemplate-java.lang.String-">removeTemplate</a></span>(java.lang.String name)</code> -<div class="block">Removes the template with the specified name if it was added earlier.; see - <a href="../../freemarker/cache/StringTemplateLoader.html#removeTemplate-java.lang.String-"><code>StringTemplateLoader.removeTemplate(String)</code></a> for more details.</div> -</td> -</tr> -<tr id="i7" class="rowColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/ByteArrayTemplateLoader.html#toString--">toString</a></span>()</code> -<div class="block">Show class name and some details that are useful in template-not-found errors.</div> -</td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> -<!-- --> -</a> -<h3>Methods inherited from class java.lang.Object</h3> -<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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="ByteArrayTemplateLoader--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>ByteArrayTemplateLoader</h4> -<pre>public ByteArrayTemplateLoader()</pre> -</li> -</ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="putTemplate-java.lang.String-byte:A-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>putTemplate</h4> -<pre>public void putTemplate(java.lang.String name, - byte[] templateContent)</pre> -<div class="block">Adds a template to this template loader; see <a href="../../freemarker/cache/StringTemplateLoader.html#putTemplate-java.lang.String-java.lang.String-"><code>StringTemplateLoader.putTemplate(String, String)</code></a> for more.</div> -</li> -</ul> -<a name="putTemplate-java.lang.String-byte:A-long-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>putTemplate</h4> -<pre>public void putTemplate(java.lang.String name, - byte[] templateContent, - long lastModified)</pre> -<div class="block">Adds a template to this template loader; see <a href="../../freemarker/cache/StringTemplateLoader.html#putTemplate-java.lang.String-java.lang.String-long-"><code>StringTemplateLoader.putTemplate(String, String, long)</code></a> for - more.</div> -</li> -</ul> -<a name="removeTemplate-java.lang.String-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>removeTemplate</h4> -<pre>public boolean removeTemplate(java.lang.String name)</pre> -<div class="block">Removes the template with the specified name if it was added earlier.; see - <a href="../../freemarker/cache/StringTemplateLoader.html#removeTemplate-java.lang.String-"><code>StringTemplateLoader.removeTemplate(String)</code></a> for more details.</div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>2.3.26</dd> -</dl> -</li> -</ul> -<a name="closeTemplateSource-java.lang.Object-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>closeTemplateSource</h4> -<pre>public void closeTemplateSource(java.lang.Object templateSource)</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../freemarker/cache/TemplateLoader.html#closeTemplateSource-java.lang.Object-">TemplateLoader</a></code></span></div> -<div class="block">Closes the template source, releasing any resources held that are only required for reading the template and/or - its metadata. This is the last method that is called by the <a href="../../freemarker/cache/TemplateCache.html" title="class in freemarker.cache"><code>TemplateCache</code></a> for a template source, except - that <code>Object.equals(Object)</code> is might called later too. <a href="../../freemarker/cache/TemplateCache.html" title="class in freemarker.cache"><code>TemplateCache</code></a> ensures that this method will - be called on every object that is returned from <a href="../../freemarker/cache/TemplateLoader.html#findTemplateSource-java.lang.String-"><code>TemplateLoader.findTemplateSource(String)</code></a>.</div> -<dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../freemarker/cache/TemplateLoader.html#closeTemplateSource-java.lang.Object-">closeTemplateSource</a></code> in interface <code><a href="../../freemarker/cache/TemplateLoader.html" title="interface in freemarker.cache">TemplateLoader</a></code></dd> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>templateSource</code> - the template source that should be closed.</dd> -</dl> -</li> -</ul> -<a name="findTemplateSource-java.lang.String-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>findTemplateSource</h4> -<pre>public java.lang.Object findTemplateSource(java.lang.String name)</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../freemarker/cache/TemplateLoader.html#findTemplateSource-java.lang.String-">TemplateLoader</a></code></span></div> -<div class="block">Finds the template in the backing storage and returns an object that identifies the storage location where the - template can be loaded from. See the return value for more information.</div> -<dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../freemarker/cache/TemplateLoader.html#findTemplateSource-java.lang.String-">findTemplateSource</a></code> in interface <code><a href="../../freemarker/cache/TemplateLoader.html" title="interface in freemarker.cache">TemplateLoader</a></code></dd> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>name</code> - The name (template root directory relative path) of the template, already localized and normalized by - the <a href="../../freemarker/cache/TemplateCache.html" title="class in freemarker.cache"><code>cache</code></a>. It is completely up to the loader implementation to - interpret the name, however it should expect to receive hierarchical paths where path components are - separated by a slash (not backslash). Backslashes (or any other OS specific separator character) are - not considered as separators by FreeMarker, and thus they will not be replaced with slash before - passing to this method, so it's up to the template loader to handle them (say, by throwing an - exception that tells the user that the path (s)he has entered is invalid, as (s)he must use slash -- - typical mistake of Windows users). The passed names are always considered relative to some - loader-defined root location (often referred as the "template root directory"), and will never start - with a slash, nor will they contain a path component consisting of either a single or a double dot -- - these are all resolved by the template cache before passing the name to the loader. As a side effect, - paths that trivially reach outside template root directory, such as <tt>../my.ftl</tt>, will be - rejected by the template cache, so they never reach the template loader. Note again, that if the path - uses backslash as path separator instead of slash as (the template loader should not accept that), the - normalization will not properly happen, as FreeMarker (the cache) recognizes only the slashes as - separators.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>An object representing the template source, which can be supplied in subsequent calls to - <a href="../../freemarker/cache/TemplateLoader.html#getLastModified-java.lang.Object-"><code>TemplateLoader.getLastModified(Object)</code></a> and <a href="../../freemarker/cache/TemplateLoader.html#getReader-java.lang.Object-java.lang.String-"><code>TemplateLoader.getReader(Object, String)</code></a>, when those are called on the - same <a href="../../freemarker/cache/TemplateLoader.html" title="interface in freemarker.cache"><code>TemplateLoader</code></a>. <code>null</code> must be returned if the source for the template doesn't exist; - don't throw exception then! The exact type of this object is up to the <a href="../../freemarker/cache/TemplateLoader.html" title="interface in freemarker.cache"><code>TemplateLoader</code></a> - implementation. As this object is possibly used as hash key in caches, and is surly compared with another - template source for equality, <b>it must have a proper <code>Object.equals(Object)</code> and - <code>Object.hashCode()</code>) implementation</b>. Especially, template sources that refer to the same - physical source must be equivalent, otherwise template caching can become inefficient. This is only - expected from <code>Object.equals(Object)</code> when the compared template sources came from the same - <a href="../../freemarker/cache/TemplateLoader.html" title="interface in freemarker.cache"><code>TemplateLoader</code></a> instance. Also, it must not influence the equality if the source is open or - closed (<a href="../../freemarker/cache/TemplateLoader.html#closeTemplateSource-java.lang.Object-"><code>TemplateLoader.closeTemplateSource(Object)</code></a>).</dd> -</dl> -</li> -</ul> -<a name="getLastModified-java.lang.Object-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getLastModified</h4> -<pre>public long getLastModified(java.lang.Object templateSource)</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../freemarker/cache/TemplateLoader.html#getLastModified-java.lang.Object-">TemplateLoader</a></code></span></div> -<div class="block">Returns the time of last modification of the specified template source. This method is called after - <code>findTemplateSource()</code>.</div> -<dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../freemarker/cache/TemplateLoader.html#getLastModified-java.lang.Object-">getLastModified</a></code> in interface <code><a href="../../freemarker/cache/TemplateLoader.html" title="interface in freemarker.cache">TemplateLoader</a></code></dd> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>templateSource</code> - an object representing a template source, obtained through a prior call to - <a href="../../freemarker/cache/TemplateLoader.html#findTemplateSource-java.lang.String-"><code>TemplateLoader.findTemplateSource(String)</code></a>. This must be an object on which - <a href="../../freemarker/cache/TemplateLoader.html#closeTemplateSource-java.lang.Object-"><code>TemplateLoader.closeTemplateSource(Object)</code></a> wasn't applied yet.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>the time of last modification of the specified template source, or -1 if the time is not known.</dd> -</dl> -</li> -</ul> -<a name="getReader-java.lang.Object-java.lang.String-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getReader</h4> -<pre>public java.io.Reader getReader(java.lang.Object templateSource, - java.lang.String encoding) - throws java.io.UnsupportedEncodingException</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../freemarker/cache/TemplateLoader.html#getReader-java.lang.Object-java.lang.String-">TemplateLoader</a></code></span></div> -<div class="block">Returns the character stream of a template represented by the specified template source. This method is possibly - called for multiple times for the same template source object, and it must always return a <code>Reader</code> that - reads the template from its beginning. Before this method is called for the second time (or later), its caller - must close the previously returned <code>Reader</code>, and it must not use it anymore. That is, this method is not - required to support multiple concurrent readers for the same source <code>templateSource</code> object. - - <p> - Typically, this method is called if the template is missing from the cache, or if after calling - <a href="../../freemarker/cache/TemplateLoader.html#findTemplateSource-java.lang.String-"><code>TemplateLoader.findTemplateSource(String)</code></a> and <a href="../../freemarker/cache/TemplateLoader.html#getLastModified-java.lang.Object-"><code>TemplateLoader.getLastModified(Object)</code></a> it was determined that the cached copy - of the template is stale. Then, if it turns out that the <code>encoding</code> parameter used doesn't match the actual - template content (based on the <code>#ftl encoding=...</code> header), this method will be called for a second time - with the correct <code>encoding</code> parameter value. - - <p> - Unlike <a href="../../freemarker/cache/TemplateLoader.html#findTemplateSource-java.lang.String-"><code>TemplateLoader.findTemplateSource(String)</code></a>, this method must not tolerate if the template is not found, and - must throw <code>IOException</code> in that case.</div> -<dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../freemarker/cache/TemplateLoader.html#getReader-java.lang.Object-java.lang.String-">getReader</a></code> in interface <code><a href="../../freemarker/cache/TemplateLoader.html" title="interface in freemarker.cache">TemplateLoader</a></code></dd> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>templateSource</code> - an object representing a template source, obtained through a prior call to - <a href="../../freemarker/cache/TemplateLoader.html#findTemplateSource-java.lang.String-"><code>TemplateLoader.findTemplateSource(String)</code></a>. This must be an object on which - <a href="../../freemarker/cache/TemplateLoader.html#closeTemplateSource-java.lang.Object-"><code>TemplateLoader.closeTemplateSource(Object)</code></a> wasn't applied yet.</dd> -<dd><code>encoding</code> - the character encoding used to translate source bytes to characters. Some loaders may not have access - to the byte representation of the template stream, and instead directly obtain a character stream. - These loaders should ignore the encoding parameter.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>A <code>Reader</code> representing the template character stream; not <code>null</code>. It's the responsibility of - the caller (which is <a href="../../freemarker/cache/TemplateCache.html" title="class in freemarker.cache"><code>TemplateCache</code></a> usually) to <code>close()</code> it. The <code>Reader</code> is not - required to work after the <code>templateSource</code> was closed (<a href="../../freemarker/cache/TemplateLoader.html#closeTemplateSource-java.lang.Object-"><code>TemplateLoader.closeTemplateSource(Object)</code></a>).</dd> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code>java.io.UnsupportedEncodingException</code></dd> -</dl> -</li> -</ul> -<a name="toString--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>toString</h4> -<pre>public java.lang.String toString()</pre> -<div class="block">Show class name and some details that are useful in template-not-found errors.</div> -<dl> -<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> -<dd><code>toString</code> in class <code>java.lang.Object</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/ByteArrayTemplateLoader.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/AndMatcher.html" title="class in freemarker.cache"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../freemarker/cache/CacheStorage.html" title="interface in freemarker.cache"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../index.html?freemarker/cache/ByteArrayTemplateLoader.html" target="_top">Frames</a></li> -<li><a href="ByteArrayTemplateLoader.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/CacheStorage.html ---------------------------------------------------------------------- diff --git a/builds/2.3.28-voting/documentation/api/freemarker/cache/CacheStorage.html b/builds/2.3.28-voting/documentation/api/freemarker/cache/CacheStorage.html deleted file mode 100644 index ab0c428..0000000 --- a/builds/2.3.28-voting/documentation/api/freemarker/cache/CacheStorage.html +++ /dev/null @@ -1,281 +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>CacheStorage (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="CacheStorage (FreeMarker 2.3.28 API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":6,"i1":6,"i2":6,"i3":6}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/CacheStorage.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/ByteArrayTemplateLoader.html" title="class in freemarker.cache"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../freemarker/cache/CacheStorageWithGetSize.html" title="interface in freemarker.cache"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../index.html?freemarker/cache/CacheStorage.html" target="_top">Frames</a></li> -<li><a href="CacheStorage.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">freemarker.cache</div> -<h2 title="Interface CacheStorage" class="title">Interface CacheStorage</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>All Known Subinterfaces:</dt> -<dd><a href="../../freemarker/cache/CacheStorageWithGetSize.html" title="interface in freemarker.cache">CacheStorageWithGetSize</a>, <a href="../../freemarker/cache/ConcurrentCacheStorage.html" title="interface in freemarker.cache">ConcurrentCacheStorage</a></dd> -</dl> -<dl> -<dt>All Known Implementing Classes:</dt> -<dd><a href="../../freemarker/cache/MruCacheStorage.html" title="class in freemarker.cache">MruCacheStorage</a>, <a href="../../freemarker/cache/NullCacheStorage.html" title="class in freemarker.cache">NullCacheStorage</a>, <a href="../../freemarker/cache/SoftCacheStorage.html" title="class in freemarker.cache">SoftCacheStorage</a>, <a href="../../freemarker/cache/StrongCacheStorage.html" title="class in freemarker.cache">StrongCacheStorage</a></dd> -</dl> -<hr> -<br> -<pre>public interface <span class="typeNameLabel">CacheStorage</span></pre> -<div class="block">Cache storage abstracts away the storage aspects of a cache - associating - an object with a key, retrieval and removal via the key. It is actually a - small subset of the <code>Map</code> interface. - The implementations can be coded in a non-threadsafe manner as the natural - user of the cache storage, <a href="../../freemarker/cache/TemplateCache.html" title="class in freemarker.cache"><code>TemplateCache</code></a> does the necessary - synchronization.</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"> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr id="i0" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/CacheStorage.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/CacheStorage.html#get-java.lang.Object-">get</a></span>(java.lang.Object key)</code> </td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/CacheStorage.html#put-java.lang.Object-java.lang.Object-">put</a></span>(java.lang.Object key, - java.lang.Object value)</code> </td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/CacheStorage.html#remove-java.lang.Object-">remove</a></span>(java.lang.Object key)</code> </td> -</tr> -</table> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="get-java.lang.Object-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>get</h4> -<pre>java.lang.Object get(java.lang.Object key)</pre> -</li> -</ul> -<a name="put-java.lang.Object-java.lang.Object-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>put</h4> -<pre>void put(java.lang.Object key, - java.lang.Object value)</pre> -</li> -</ul> -<a name="remove-java.lang.Object-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>remove</h4> -<pre>void remove(java.lang.Object key)</pre> -</li> -</ul> -<a name="clear--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>clear</h4> -<pre>void clear()</pre> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/CacheStorage.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/ByteArrayTemplateLoader.html" title="class in freemarker.cache"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../freemarker/cache/CacheStorageWithGetSize.html" title="interface in freemarker.cache"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../index.html?freemarker/cache/CacheStorage.html" target="_top">Frames</a></li> -<li><a href="CacheStorage.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/freemarker-site/blob/a4a53cb9/builds/2.3.28-voting/documentation/api/freemarker/cache/CacheStorageWithGetSize.html ---------------------------------------------------------------------- diff --git a/builds/2.3.28-voting/documentation/api/freemarker/cache/CacheStorageWithGetSize.html b/builds/2.3.28-voting/documentation/api/freemarker/cache/CacheStorageWithGetSize.html deleted file mode 100644 index 7ea6f93..0000000 --- a/builds/2.3.28-voting/documentation/api/freemarker/cache/CacheStorageWithGetSize.html +++ /dev/null @@ -1,248 +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>CacheStorageWithGetSize (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="CacheStorageWithGetSize (FreeMarker 2.3.28 API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":6}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/CacheStorageWithGetSize.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/CacheStorage.html" title="interface in freemarker.cache"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../freemarker/cache/ClassTemplateLoader.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/CacheStorageWithGetSize.html" target="_top">Frames</a></li> -<li><a href="CacheStorageWithGetSize.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">freemarker.cache</div> -<h2 title="Interface CacheStorageWithGetSize" class="title">Interface CacheStorageWithGetSize</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>All Superinterfaces:</dt> -<dd><a href="../../freemarker/cache/CacheStorage.html" title="interface in freemarker.cache">CacheStorage</a></dd> -</dl> -<dl> -<dt>All Known Implementing Classes:</dt> -<dd><a href="../../freemarker/cache/MruCacheStorage.html" title="class in freemarker.cache">MruCacheStorage</a>, <a href="../../freemarker/cache/NullCacheStorage.html" title="class in freemarker.cache">NullCacheStorage</a>, <a href="../../freemarker/cache/SoftCacheStorage.html" title="class in freemarker.cache">SoftCacheStorage</a>, <a href="../../freemarker/cache/StrongCacheStorage.html" title="class in freemarker.cache">StrongCacheStorage</a></dd> -</dl> -<hr> -<br> -<pre>public interface <span class="typeNameLabel">CacheStorageWithGetSize</span> -extends <a href="../../freemarker/cache/CacheStorage.html" title="interface in freemarker.cache">CacheStorage</a></pre> -<div class="block">A cache storage that has a <code>getSize()</code> method for returning the current number of cache entries.</div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>2.3.21</dd> -</dl> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr id="i0" class="altColor"> -<td class="colFirst"><code>int</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/CacheStorageWithGetSize.html#getSize--">getSize</a></span>()</code> -<div class="block">Returns the current number of cache entries.</div> -</td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.freemarker.cache.CacheStorage"> -<!-- --> -</a> -<h3>Methods inherited from interface freemarker.cache.<a href="../../freemarker/cache/CacheStorage.html" title="interface in freemarker.cache">CacheStorage</a></h3> -<code><a href="../../freemarker/cache/CacheStorage.html#clear--">clear</a>, <a href="../../freemarker/cache/CacheStorage.html#get-java.lang.Object-">get</a>, <a href="../../freemarker/cache/CacheStorage.html#put-java.lang.Object-java.lang.Object-">put</a>, <a href="../../freemarker/cache/CacheStorage.html#remove-java.lang.Object-">remove</a></code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="getSize--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>getSize</h4> -<pre>int getSize()</pre> -<div class="block">Returns the current number of cache entries. This is intended to be used for monitoring. Note that depending on - the implementation, the cost of this operation is not necessary trivial, although calling it a few times per - minute should not be a problem.</div> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/CacheStorageWithGetSize.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/CacheStorage.html" title="interface in freemarker.cache"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../freemarker/cache/ClassTemplateLoader.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/CacheStorageWithGetSize.html" target="_top">Frames</a></li> -<li><a href="CacheStorageWithGetSize.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html> http://git-wip-us.apache.org/repos/asf/freemarker-site/blob/a4a53cb9/builds/2.3.28-voting/documentation/api/freemarker/cache/ClassTemplateLoader.html ---------------------------------------------------------------------- diff --git a/builds/2.3.28-voting/documentation/api/freemarker/cache/ClassTemplateLoader.html b/builds/2.3.28-voting/documentation/api/freemarker/cache/ClassTemplateLoader.html deleted file mode 100644 index 4ca86a7..0000000 --- a/builds/2.3.28-voting/documentation/api/freemarker/cache/ClassTemplateLoader.html +++ /dev/null @@ -1,504 +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>ClassTemplateLoader (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="ClassTemplateLoader (FreeMarker 2.3.28 API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":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/ClassTemplateLoader.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/CacheStorageWithGetSize.html" title="interface in freemarker.cache"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../freemarker/cache/ConcurrentCacheStorage.html" title="interface in freemarker.cache"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../index.html?freemarker/cache/ClassTemplateLoader.html" target="_top">Frames</a></li> -<li><a href="ClassTemplateLoader.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 ClassTemplateLoader" class="title">Class ClassTemplateLoader</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li><a href="../../freemarker/cache/URLTemplateLoader.html" title="class in freemarker.cache">freemarker.cache.URLTemplateLoader</a></li> -<li> -<ul class="inheritance"> -<li>freemarker.cache.ClassTemplateLoader</li> -</ul> -</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>All Implemented Interfaces:</dt> -<dd><a href="../../freemarker/cache/TemplateLoader.html" title="interface in freemarker.cache">TemplateLoader</a></dd> -</dl> -<hr> -<br> -<pre>public class <span class="typeNameLabel">ClassTemplateLoader</span> -extends <a href="../../freemarker/cache/URLTemplateLoader.html" title="class in freemarker.cache">URLTemplateLoader</a></pre> -<div class="block">A <a href="../../freemarker/cache/TemplateLoader.html" title="interface in freemarker.cache"><code>TemplateLoader</code></a> that can load templates from the "classpath". Naturally, it can load from jar files, or from - anywhere where Java can load classes from. Internally, it uses <code>Class.getResource(String)</code> or - <code>ClassLoader.getResource(String)</code> to load templates.</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/ClassTemplateLoader.html#ClassTemplateLoader--">ClassTemplateLoader</a></span>()</code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">It's a confusing constructor, and seldom useful; use <a href="../../freemarker/cache/ClassTemplateLoader.html#ClassTemplateLoader-java.lang.Class-java.lang.String-"><code>ClassTemplateLoader(Class, String)</code></a> - instead.</span></div> -</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/cache/ClassTemplateLoader.html#ClassTemplateLoader-java.lang.Class-">ClassTemplateLoader</a></span>(java.lang.Class<?> resourceLoaderClass)</code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">It's confusing that the base path is <code>""</code>; use <a href="../../freemarker/cache/ClassTemplateLoader.html#ClassTemplateLoader-java.lang.Class-java.lang.String-"><code>ClassTemplateLoader(Class, String)</code></a> - instead.</span></div> -</div> -</td> -</tr> -<tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/cache/ClassTemplateLoader.html#ClassTemplateLoader-java.lang.Class-java.lang.String-">ClassTemplateLoader</a></span>(java.lang.Class<?> resourceLoaderClass, - java.lang.String basePackagePath)</code> -<div class="block">Creates a template loader that will use the <code>Class.getResource(String)</code> method of the specified class to - load the resources, and the specified base package path (absolute or relative).</div> -</td> -</tr> -<tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/cache/ClassTemplateLoader.html#ClassTemplateLoader-java.lang.ClassLoader-java.lang.String-">ClassTemplateLoader</a></span>(java.lang.ClassLoader classLoader, - java.lang.String basePackagePath)</code> -<div class="block">Similar to <a href="../../freemarker/cache/ClassTemplateLoader.html#ClassTemplateLoader-java.lang.Class-java.lang.String-"><code>ClassTemplateLoader(Class, String)</code></a>, but instead of <code>Class.getResource(String)</code> it uses - <code>ClassLoader.getResource(String)</code>.</div> -</td> -</tr> -</table> -</li> -</ul> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="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>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/ClassTemplateLoader.html#getBasePackagePath--">getBasePackagePath</a></span>()</code> -<div class="block">See the similar parameter of <a href="../../freemarker/cache/ClassTemplateLoader.html#ClassTemplateLoader-java.lang.ClassLoader-java.lang.String-"><code>ClassTemplateLoader(ClassLoader, String)</code></a>; note that this is a normalized - version of what was actually passed to the constructor.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code>java.lang.ClassLoader</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/ClassTemplateLoader.html#getClassLoader--">getClassLoader</a></span>()</code> -<div class="block">See the similar parameter of <a href="../../freemarker/cache/ClassTemplateLoader.html#ClassTemplateLoader-java.lang.ClassLoader-java.lang.String-"><code>ClassTemplateLoader(ClassLoader, String)</code></a>; <code>null</code> when other mechanism - is used to load the resources.</div> -</td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>java.lang.Class</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/ClassTemplateLoader.html#getResourceLoaderClass--">getResourceLoaderClass</a></span>()</code> -<div class="block">See the similar parameter of <a href="../../freemarker/cache/ClassTemplateLoader.html#ClassTemplateLoader-java.lang.Class-java.lang.String-"><code>ClassTemplateLoader(Class, String)</code></a>; <code>null</code> when other mechanism is - used to load the resources.</div> -</td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code>protected java.net.URL</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/ClassTemplateLoader.html#getURL-java.lang.String-">getURL</a></span>(java.lang.String name)</code> -<div class="block">Given a template name (plus potential locale decorations) retrieves - an URL that points the template source.</div> -</td> -</tr> -<tr id="i4" class="altColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/ClassTemplateLoader.html#toString--">toString</a></span>()</code> -<div class="block">Show class name and some details that are useful in template-not-found errors.</div> -</td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.freemarker.cache.URLTemplateLoader"> -<!-- --> -</a> -<h3>Methods inherited from class freemarker.cache.<a href="../../freemarker/cache/URLTemplateLoader.html" title="class in freemarker.cache">URLTemplateLoader</a></h3> -<code><a href="../../freemarker/cache/URLTemplateLoader.html#canonicalizePrefix-java.lang.String-">canonicalizePrefix</a>, <a href="../../freemarker/cache/URLTemplateLoader.html#closeTemplateSource-java.lang.Object-">closeTemplateSource</a>, <a href="../../freemarker/cache/URLTemplateLoader.html#findTemplateSource-java.lang.String-">findTemplateSource</a>, <a href="../../freemarker/cache/URLTemplateLoader.html#getLastModified-java.lang.Object-">getLastModified</a>, <a href="../../freemarker/cache/URLTemplateLoader.html#getReader-java.lang.Object-java.lang.String-">getReader</a>, <a href="../../freemarker/cache/URLTemplateLoader.html#getURLConnectionUsesCaches--">getURLConnectionUsesCaches</a>, <a href="../../freemarker/cache/URLTemplateLoader.html#setURLConnectionUsesCaches-java.lang.Boolean-">setURLConnectionUsesCaches</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, 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="ClassTemplateLoader--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>ClassTemplateLoader</h4> -<pre>@Deprecated -public ClassTemplateLoader()</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">It's a confusing constructor, and seldom useful; use <a href="../../freemarker/cache/ClassTemplateLoader.html#ClassTemplateLoader-java.lang.Class-java.lang.String-"><code>ClassTemplateLoader(Class, String)</code></a> - instead.</span></div> -<div class="block">Creates a template loader that will use the <code>Class.getResource(String)</code> method of its own class to load the - resources, and <code>"/"</code> as base package path. This means that that template paths will be resolved relatively - the root package of the class hierarchy, so you hardly ever should use this constructor, rather do something like - this:<br> - <a href="../../freemarker/cache/ClassTemplateLoader.html#ClassTemplateLoader-java.lang.Class-java.lang.String-"><code>new ClassTemplateLoader(com.example.myapplication.SomeClass.class, - "templates")</code></a> - - <p> - If you extend this class, then the extending class will be used to load the resources.</div> -</li> -</ul> -<a name="ClassTemplateLoader-java.lang.Class-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>ClassTemplateLoader</h4> -<pre>@Deprecated -public ClassTemplateLoader(java.lang.Class<?> resourceLoaderClass)</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">It's confusing that the base path is <code>""</code>; use <a href="../../freemarker/cache/ClassTemplateLoader.html#ClassTemplateLoader-java.lang.Class-java.lang.String-"><code>ClassTemplateLoader(Class, String)</code></a> - instead.</span></div> -<div class="block">Creates a template loader that will use the <code>Class.getResource(String)</code> method of the specified class to - load the resources, and <code>""</code> as base package path. This means that template paths will be resolved - relatively to the class location, that is, relatively to the directory (package) of the class.</div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>resourceLoaderClass</code> - the class whose <code>Class.getResource(String)</code> will be used to load the templates.</dd> -</dl> -</li> -</ul> -<a name="ClassTemplateLoader-java.lang.Class-java.lang.String-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>ClassTemplateLoader</h4> -<pre>public ClassTemplateLoader(java.lang.Class<?> resourceLoaderClass, - java.lang.String basePackagePath)</pre> -<div class="block">Creates a template loader that will use the <code>Class.getResource(String)</code> method of the specified class to - load the resources, and the specified base package path (absolute or relative). - - <p> - Examples: - <ul> - <li>Relative base path (will load from the <code>com.example.myapplication.templates</code> package):<br> - <code>new ClassTemplateLoader(com.example.myapplication.SomeClass.class, "templates")</code> - <li>Absolute base path:<br> - <code>new ClassTemplateLoader(somepackage.SomeClass.class, "/com/example/myapplication/templates")</code> - </ul></div> -<dl> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>resourceLoaderClass</code> - The class whose <code>Class.getResource(String)</code> method will be used to load the templates. Be sure - that you chose a class whose defining class-loader sees the templates. This parameter can't be - <code>null</code>.</dd> -<dd><code>basePackagePath</code> - The package that contains the templates, in path (<code>/</code>-separated) format. If it doesn't start - with a <code>/</code> then it's relative to the path (package) of the <code>resourceLoaderClass</code> class. If - it starts with <code>/</code> then it's relative to the root of the package hierarchy. Note that path - components should be separated by forward slashes independently of the separator character used by the - underlying operating system. This parameter can't be <code>null</code>.</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../freemarker/cache/ClassTemplateLoader.html#ClassTemplateLoader-java.lang.ClassLoader-java.lang.String-"><code>ClassTemplateLoader(ClassLoader, String)</code></a></dd> -</dl> -</li> -</ul> -<a name="ClassTemplateLoader-java.lang.ClassLoader-java.lang.String-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>ClassTemplateLoader</h4> -<pre>public ClassTemplateLoader(java.lang.ClassLoader classLoader, - java.lang.String basePackagePath)</pre> -<div class="block">Similar to <a href="../../freemarker/cache/ClassTemplateLoader.html#ClassTemplateLoader-java.lang.Class-java.lang.String-"><code>ClassTemplateLoader(Class, String)</code></a>, but instead of <code>Class.getResource(String)</code> it uses - <code>ClassLoader.getResource(String)</code>. Because a <code>ClassLoader</code> isn't bound to any Java package, it - doesn't mater if the <code>basePackagePath</code> starts with <code>/</code> or not, it will be always relative to the root - of the package hierarchy</div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>2.3.22</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="getURL-java.lang.String-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getURL</h4> -<pre>protected java.net.URL getURL(java.lang.String name)</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/cache/URLTemplateLoader.html#getURL-java.lang.String-">URLTemplateLoader</a></code></span></div> -<div class="block">Given a template name (plus potential locale decorations) retrieves - an URL that points the template source.</div> -<dl> -<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> -<dd><code><a href="../../freemarker/cache/URLTemplateLoader.html#getURL-java.lang.String-">getURL</a></code> in class <code><a href="../../freemarker/cache/URLTemplateLoader.html" title="class in freemarker.cache">URLTemplateLoader</a></code></dd> -<dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>name</code> - the name of the sought template, including the locale - decorations.</dd> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>an URL that points to the template source, or <code>null</code> if the template does not exist.</dd> -</dl> -</li> -</ul> -<a name="toString--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>toString</h4> -<pre>public java.lang.String toString()</pre> -<div class="block">Show class name and some details that are useful in template-not-found errors.</div> -<dl> -<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> -<dd><code>toString</code> in class <code>java.lang.Object</code></dd> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>2.3.21</dd> -</dl> -</li> -</ul> -<a name="getResourceLoaderClass--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getResourceLoaderClass</h4> -<pre>public java.lang.Class getResourceLoaderClass()</pre> -<div class="block">See the similar parameter of <a href="../../freemarker/cache/ClassTemplateLoader.html#ClassTemplateLoader-java.lang.Class-java.lang.String-"><code>ClassTemplateLoader(Class, String)</code></a>; <code>null</code> when other mechanism is - used to load the resources.</div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>2.3.22</dd> -</dl> -</li> -</ul> -<a name="getClassLoader--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getClassLoader</h4> -<pre>public java.lang.ClassLoader getClassLoader()</pre> -<div class="block">See the similar parameter of <a href="../../freemarker/cache/ClassTemplateLoader.html#ClassTemplateLoader-java.lang.ClassLoader-java.lang.String-"><code>ClassTemplateLoader(ClassLoader, String)</code></a>; <code>null</code> when other mechanism - is used to load the resources.</div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>2.3.22</dd> -</dl> -</li> -</ul> -<a name="getBasePackagePath--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>getBasePackagePath</h4> -<pre>public java.lang.String getBasePackagePath()</pre> -<div class="block">See the similar parameter of <a href="../../freemarker/cache/ClassTemplateLoader.html#ClassTemplateLoader-java.lang.ClassLoader-java.lang.String-"><code>ClassTemplateLoader(ClassLoader, String)</code></a>; note that this is a normalized - version of what was actually passed to the constructor.</div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>2.3.22</dd> -</dl> -</li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -</div> -<!-- ========= END OF CLASS DATA ========= --> -<!-- ======= START OF BOTTOM NAVBAR ====== --> -<div class="bottomNav"><a name="navbar.bottom"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.bottom.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/ClassTemplateLoader.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/CacheStorageWithGetSize.html" title="interface in freemarker.cache"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../freemarker/cache/ConcurrentCacheStorage.html" title="interface in freemarker.cache"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../index.html?freemarker/cache/ClassTemplateLoader.html" target="_top">Frames</a></li> -<li><a href="ClassTemplateLoader.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/ConcurrentCacheStorage.html ---------------------------------------------------------------------- diff --git a/builds/2.3.28-voting/documentation/api/freemarker/cache/ConcurrentCacheStorage.html b/builds/2.3.28-voting/documentation/api/freemarker/cache/ConcurrentCacheStorage.html deleted file mode 100644 index ae6b460..0000000 --- a/builds/2.3.28-voting/documentation/api/freemarker/cache/ConcurrentCacheStorage.html +++ /dev/null @@ -1,250 +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>ConcurrentCacheStorage (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="ConcurrentCacheStorage (FreeMarker 2.3.28 API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":6}; -var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; -var altColor = "altColor"; -var rowColor = "rowColor"; -var tableTab = "tableTab"; -var activeTableTab = "activeTableTab"; -</script> -<noscript> -<div>JavaScript is disabled on your browser.</div> -</noscript> -<!-- ========= START OF TOP NAVBAR ======= --> -<div class="topNav"><a name="navbar.top"> -<!-- --> -</a> -<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> -<a name="navbar.top.firstrow"> -<!-- --> -</a> -<ul class="navList" title="Navigation"> -<li><a href="../../overview-summary.html">Overview</a></li> -<li><a href="package-summary.html">Package</a></li> -<li class="navBarCell1Rev">Class</li> -<li><a href="class-use/ConcurrentCacheStorage.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/ClassTemplateLoader.html" title="class in freemarker.cache"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../freemarker/cache/ConditionalTemplateConfigurationFactory.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/ConcurrentCacheStorage.html" target="_top">Frames</a></li> -<li><a href="ConcurrentCacheStorage.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_top"> -<li><a href="../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_top"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">freemarker.cache</div> -<h2 title="Interface ConcurrentCacheStorage" class="title">Interface ConcurrentCacheStorage</h2> -</div> -<div class="contentContainer"> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<dl> -<dt>All Superinterfaces:</dt> -<dd><a href="../../freemarker/cache/CacheStorage.html" title="interface in freemarker.cache">CacheStorage</a></dd> -</dl> -<dl> -<dt>All Known Implementing Classes:</dt> -<dd><a href="../../freemarker/cache/NullCacheStorage.html" title="class in freemarker.cache">NullCacheStorage</a>, <a href="../../freemarker/cache/SoftCacheStorage.html" title="class in freemarker.cache">SoftCacheStorage</a>, <a href="../../freemarker/cache/StrongCacheStorage.html" title="class in freemarker.cache">StrongCacheStorage</a></dd> -</dl> -<hr> -<br> -<pre>public interface <span class="typeNameLabel">ConcurrentCacheStorage</span> -extends <a href="../../freemarker/cache/CacheStorage.html" title="interface in freemarker.cache">CacheStorage</a></pre> -<div class="block">An optional interface for cache storage that knows whether it can be - concurrently accessible without synchronization.</div> -</li> -</ul> -</div> -<div class="summary"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr id="i0" class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/ConcurrentCacheStorage.html#isConcurrent--">isConcurrent</a></span>()</code> -<div class="block">Returns true if this instance of cache storage is concurrently - accessible from multiple threads without synchronization.</div> -</td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.freemarker.cache.CacheStorage"> -<!-- --> -</a> -<h3>Methods inherited from interface freemarker.cache.<a href="../../freemarker/cache/CacheStorage.html" title="interface in freemarker.cache">CacheStorage</a></h3> -<code><a href="../../freemarker/cache/CacheStorage.html#clear--">clear</a>, <a href="../../freemarker/cache/CacheStorage.html#get-java.lang.Object-">get</a>, <a href="../../freemarker/cache/CacheStorage.html#put-java.lang.Object-java.lang.Object-">put</a>, <a href="../../freemarker/cache/CacheStorage.html#remove-java.lang.Object-">remove</a></code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="isConcurrent--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>isConcurrent</h4> -<pre>boolean isConcurrent()</pre> -<div class="block">Returns true if this instance of cache storage is concurrently - accessible from multiple threads without synchronization.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>true if this instance of cache storage is concurrently - accessible from multiple threads without synchronization.</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/ConcurrentCacheStorage.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/ClassTemplateLoader.html" title="class in freemarker.cache"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../freemarker/cache/ConditionalTemplateConfigurationFactory.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/ConcurrentCacheStorage.html" target="_top">Frames</a></li> -<li><a href="ConcurrentCacheStorage.html" target="_top">No Frames</a></li> -</ul> -<ul class="navList" id="allclasses_navbar_bottom"> -<li><a href="../../allclasses-noframe.html">All Classes</a></li> -</ul> -<div> -<script type="text/javascript"><!-- - allClassesLink = document.getElementById("allclasses_navbar_bottom"); - if(window==top) { - allClassesLink.style.display = "block"; - } - else { - allClassesLink.style.display = "none"; - } - //--> -</script> -</div> -<div> -<ul class="subNavList"> -<li>Summary: </li> -<li>Nested | </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method.summary">Method</a></li> -</ul> -<ul class="subNavList"> -<li>Detail: </li> -<li>Field | </li> -<li>Constr | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.bottom"> -<!-- --> -</a></div> -<!-- ======== END OF BOTTOM NAVBAR ======= --> -</body> -</html>
