http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/beee6d6b/builds/fm2.3.27/api/freemarker/cache/ClassTemplateLoader.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.27/api/freemarker/cache/ClassTemplateLoader.html b/builds/fm2.3.27/api/freemarker/cache/ClassTemplateLoader.html new file mode 100644 index 0000000..f504e95 --- /dev/null +++ b/builds/fm2.3.27/api/freemarker/cache/ClassTemplateLoader.html @@ -0,0 +1,504 @@ +<!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 Wed Sep 20 18:42:00 CEST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ClassTemplateLoader (FreeMarker 2.3.27-nightly_20170920T164139Z-incubating API)</title> +<meta name="date" content="2017-09-20"> +<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.27-nightly_20170920T164139Z-incubating 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><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../freemarker/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 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getResource-java.lang.String-"; title="class or interface in java.lang"><code>Class.getResource(String)</code></a> or + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true#getResource-java.lang.String-"; title="class or interface in java.lang"><code>ClassLoader.getResource(String)</code></a> 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>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> 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>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> resourceLoaderClass, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> basePackagePath)</code> +<div class="block">Creates a template loader that will use the <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getResource-java.lang.String-"; title="class or interface in java.lang"><code>Class.getResource(String)</code></a> 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>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true"; title="class or interface in java.lang">ClassLoader</a> classLoader, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> 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 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getResource-java.lang.String-"; title="class or interface in java.lang"><code>Class.getResource(String)</code></a> it uses + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true#getResource-java.lang.String-"; title="class or interface in java.lang"><code>ClassLoader.getResource(String)</code></a>.</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><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/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><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true"; title="class or interface in java.lang">ClassLoader</a></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><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a></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 <a href="http://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net">URL</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/ClassTemplateLoader.html#getURL-java.lang.String-">getURL</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> 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><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/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.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= 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><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public 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 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getResource-java.lang.String-"; title="class or interface in java.lang"><code>Class.getResource(String)</code></a> 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><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public ClassTemplateLoader(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> 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 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getResource-java.lang.String-"; title="class or interface in java.lang"><code>Class.getResource(String)</code></a> 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 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getResource-java.lang.String-"; title="class or interface in java.lang"><code>Class.getResource(String)</code></a> 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(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> resourceLoaderClass, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> basePackagePath)</pre> +<div class="block">Creates a template loader that will use the <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getResource-java.lang.String-"; title="class or interface in java.lang"><code>Class.getResource(String)</code></a> 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 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getResource-java.lang.String-"; title="class or interface in java.lang"><code>Class.getResource(String)</code></a> 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(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true"; title="class or interface in java.lang">ClassLoader</a> classLoader, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> 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 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getResource-java.lang.String-"; title="class or interface in java.lang"><code>Class.getResource(String)</code></a> it uses + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true#getResource-java.lang.String-"; title="class or interface in java.lang"><code>ClassLoader.getResource(String)</code></a>. Because a <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true"; title="class or interface in java.lang"><code>ClassLoader</code></a> 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 <a href="http://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net">URL</a> getURL(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> 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 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> toString()</pre> +<div class="block">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><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> +<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 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a> 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 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true"; title="class or interface in java.lang">ClassLoader</a> 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 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> 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/incubator-freemarker-site/blob/beee6d6b/builds/fm2.3.27/api/freemarker/cache/ConcurrentCacheStorage.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.27/api/freemarker/cache/ConcurrentCacheStorage.html b/builds/fm2.3.27/api/freemarker/cache/ConcurrentCacheStorage.html new file mode 100644 index 0000000..55fce42 --- /dev/null +++ b/builds/fm2.3.27/api/freemarker/cache/ConcurrentCacheStorage.html @@ -0,0 +1,250 @@ +<!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 Wed Sep 20 18:42:00 CEST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ConcurrentCacheStorage (FreeMarker 2.3.27-nightly_20170920T164139Z-incubating API)</title> +<meta name="date" content="2017-09-20"> +<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.27-nightly_20170920T164139Z-incubating 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> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/beee6d6b/builds/fm2.3.27/api/freemarker/cache/ConditionalTemplateConfigurationFactory.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.27/api/freemarker/cache/ConditionalTemplateConfigurationFactory.html b/builds/fm2.3.27/api/freemarker/cache/ConditionalTemplateConfigurationFactory.html new file mode 100644 index 0000000..61b4d60 --- /dev/null +++ b/builds/fm2.3.27/api/freemarker/cache/ConditionalTemplateConfigurationFactory.html @@ -0,0 +1,355 @@ +<!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 Wed Sep 20 18:42:00 CEST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ConditionalTemplateConfigurationFactory (FreeMarker 2.3.27-nightly_20170920T164139Z-incubating API)</title> +<meta name="date" content="2017-09-20"> +<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="ConditionalTemplateConfigurationFactory (FreeMarker 2.3.27-nightly_20170920T164139Z-incubating 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/ConditionalTemplateConfigurationFactory.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/ConcurrentCacheStorage.html" title="interface in freemarker.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/cache/FileExtensionMatcher.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/ConditionalTemplateConfigurationFactory.html" target="_top">Frames</a></li> +<li><a href="ConditionalTemplateConfigurationFactory.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 ConditionalTemplateConfigurationFactory" class="title">Class ConditionalTemplateConfigurationFactory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache">freemarker.cache.TemplateConfigurationFactory</a></li> +<li> +<ul class="inheritance"> +<li>freemarker.cache.ConditionalTemplateConfigurationFactory</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">ConditionalTemplateConfigurationFactory</span> +extends <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache">TemplateConfigurationFactory</a></pre> +<div class="block">Returns the given <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core"><code>TemplateConfiguration</code></a> directly, or another <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache"><code>TemplateConfigurationFactory</code></a>'s result, when + the specified matcher matches the template source.</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/ConditionalTemplateConfigurationFactory.html#ConditionalTemplateConfigurationFactory-freemarker.cache.TemplateSourceMatcher-freemarker.core.TemplateConfiguration-">ConditionalTemplateConfigurationFactory</a></span>(<a href="../../freemarker/cache/TemplateSourceMatcher.html" title="class in freemarker.cache">TemplateSourceMatcher</a> matcher, + <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core">TemplateConfiguration</a> templateConfiguration)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/cache/ConditionalTemplateConfigurationFactory.html#ConditionalTemplateConfigurationFactory-freemarker.cache.TemplateSourceMatcher-freemarker.cache.TemplateConfigurationFactory-">ConditionalTemplateConfigurationFactory</a></span>(<a href="../../freemarker/cache/TemplateSourceMatcher.html" title="class in freemarker.cache">TemplateSourceMatcher</a> matcher, + <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache">TemplateConfigurationFactory</a> templateConfigurationFactory)</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/ConditionalTemplateConfigurationFactory.html#get-java.lang.String-java.lang.Object-">get</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> sourceName, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> 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/ConditionalTemplateConfigurationFactory.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.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ConditionalTemplateConfigurationFactory-freemarker.cache.TemplateSourceMatcher-freemarker.cache.TemplateConfigurationFactory-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ConditionalTemplateConfigurationFactory</h4> +<pre>public ConditionalTemplateConfigurationFactory(<a href="../../freemarker/cache/TemplateSourceMatcher.html" title="class in freemarker.cache">TemplateSourceMatcher</a> matcher, + <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache">TemplateConfigurationFactory</a> templateConfigurationFactory)</pre> +</li> +</ul> +<a name="ConditionalTemplateConfigurationFactory-freemarker.cache.TemplateSourceMatcher-freemarker.core.TemplateConfiguration-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ConditionalTemplateConfigurationFactory</h4> +<pre>public ConditionalTemplateConfigurationFactory(<a href="../../freemarker/cache/TemplateSourceMatcher.html" title="class in freemarker.cache">TemplateSourceMatcher</a> matcher, + <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core">TemplateConfiguration</a> templateConfiguration)</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(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> sourceName, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> templateSource) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a>, + <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><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></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/ConditionalTemplateConfigurationFactory.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/ConcurrentCacheStorage.html" title="interface in freemarker.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/cache/FileExtensionMatcher.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/ConditionalTemplateConfigurationFactory.html" target="_top">Frames</a></li> +<li><a href="ConditionalTemplateConfigurationFactory.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/incubator-freemarker-site/blob/beee6d6b/builds/fm2.3.27/api/freemarker/cache/FileExtensionMatcher.html ---------------------------------------------------------------------- diff --git a/builds/fm2.3.27/api/freemarker/cache/FileExtensionMatcher.html b/builds/fm2.3.27/api/freemarker/cache/FileExtensionMatcher.html new file mode 100644 index 0000000..f68895f --- /dev/null +++ b/builds/fm2.3.27/api/freemarker/cache/FileExtensionMatcher.html @@ -0,0 +1,340 @@ +<!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 Wed Sep 20 18:42:00 CEST 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>FileExtensionMatcher (FreeMarker 2.3.27-nightly_20170920T164139Z-incubating API)</title> +<meta name="date" content="2017-09-20"> +<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="FileExtensionMatcher (FreeMarker 2.3.27-nightly_20170920T164139Z-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":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/FileExtensionMatcher.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/ConditionalTemplateConfigurationFactory.html" title="class in freemarker.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/cache/FileNameGlobMatcher.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/FileExtensionMatcher.html" target="_top">Frames</a></li> +<li><a href="FileExtensionMatcher.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 FileExtensionMatcher" class="title">Class FileExtensionMatcher</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../freemarker/cache/TemplateSourceMatcher.html" title="class in freemarker.cache">freemarker.cache.TemplateSourceMatcher</a></li> +<li> +<ul class="inheritance"> +<li>freemarker.cache.FileExtensionMatcher</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">FileExtensionMatcher</span> +extends <a href="../../freemarker/cache/TemplateSourceMatcher.html" title="class in freemarker.cache">TemplateSourceMatcher</a></pre> +<div class="block">Matches the file extension; unlike other matchers, by default case <em>insensitive</em>. A name (a path) is + considered to have the given extension exactly if it ends with a dot plus the extension.</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/FileExtensionMatcher.html#FileExtensionMatcher-java.lang.String-">FileExtensionMatcher</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> extension)</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/FileExtensionMatcher.html" title="class in freemarker.cache">FileExtensionMatcher</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileExtensionMatcher.html#caseInsensitive-boolean-">caseInsensitive</a></span>(boolean caseInsensitive)</code> +<div class="block">Fluid API variation of <a href="../../freemarker/cache/FileExtensionMatcher.html#setCaseInsensitive-boolean-"><code>setCaseInsensitive(boolean)</code></a></div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileExtensionMatcher.html#isCaseInsensitive--">isCaseInsensitive</a></span>()</code> </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/FileExtensionMatcher.html#matches-java.lang.String-java.lang.Object-">matches</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> sourceName, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> templateSource)</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/FileExtensionMatcher.html#setCaseInsensitive-boolean-">setCaseInsensitive</a></span>(boolean caseInsensitive)</code> +<div class="block">Sets if the matching will be case insensitive (UNICODE compliant); default is <code>true</code>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="FileExtensionMatcher-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FileExtensionMatcher</h4> +<pre>public FileExtensionMatcher(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> extension)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>extension</code> - The file extension (without the initial dot). Can't contain there characters: + <code>'/'</code>, <code>'*'</code>, <code>'?'</code>. May contains <code>'.'</code>, but can't start with it.</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="matches-java.lang.String-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>matches</h4> +<pre>public boolean matches(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> sourceName, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> templateSource) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></dd> +</dl> +</li> +</ul> +<a name="isCaseInsensitive--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isCaseInsensitive</h4> +<pre>public boolean isCaseInsensitive()</pre> +</li> +</ul> +<a name="setCaseInsensitive-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCaseInsensitive</h4> +<pre>public void setCaseInsensitive(boolean caseInsensitive)</pre> +<div class="block">Sets if the matching will be case insensitive (UNICODE compliant); default is <code>true</code>.</div> +</li> +</ul> +<a name="caseInsensitive-boolean-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>caseInsensitive</h4> +<pre>public <a href="../../freemarker/cache/FileExtensionMatcher.html" title="class in freemarker.cache">FileExtensionMatcher</a> caseInsensitive(boolean caseInsensitive)</pre> +<div class="block">Fluid API variation of <a href="../../freemarker/cache/FileExtensionMatcher.html#setCaseInsensitive-boolean-"><code>setCaseInsensitive(boolean)</code></a></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/FileExtensionMatcher.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/ConditionalTemplateConfigurationFactory.html" title="class in freemarker.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../freemarker/cache/FileNameGlobMatcher.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/FileExtensionMatcher.html" target="_top">Frames</a></li> +<li><a href="FileExtensionMatcher.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>
