http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/cache/FileNameGlobMatcher.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/cache/FileNameGlobMatcher.html b/docs/api/freemarker/cache/FileNameGlobMatcher.html index bbc5a61..dd3287e 100644 --- a/docs/api/freemarker/cache/FileNameGlobMatcher.html +++ b/docs/api/freemarker/cache/FileNameGlobMatcher.html @@ -2,10 +2,10 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_144) on Sun Oct 15 21:19:44 EDT 2017 --> +<!-- Generated by javadoc (1.8.0_144) on Sat Nov 11 19:25:47 CET 2017 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>FileNameGlobMatcher (FreeMarker 2.3.27-incubating API)</title> -<meta name="date" content="2017-10-15"> +<meta name="date" content="2017-11-11"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> </head> @@ -98,7 +98,7 @@ var activeTableTab = "activeTableTab"; </div> <div class="contentContainer"> <ul class="inheritance"> -<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li>java.lang.Object</li> <li> <ul class="inheritance"> <li><a href="../../freemarker/cache/TemplateSourceMatcher.html" title="class in freemarker.cache">freemarker.cache.TemplateSourceMatcher</a></li> @@ -143,7 +143,7 @@ extends <a href="../../freemarker/cache/TemplateSourceMatcher.html" title="class <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileNameGlobMatcher.html#FileNameGlobMatcher-java.lang.String-">FileNameGlobMatcher</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> glob)</code> </td> +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileNameGlobMatcher.html#FileNameGlobMatcher-java.lang.String-">FileNameGlobMatcher</a></span>(java.lang.String glob)</code> </td> </tr> </table> </li> @@ -172,8 +172,8 @@ extends <a href="../../freemarker/cache/TemplateSourceMatcher.html" title="class </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileNameGlobMatcher.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> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileNameGlobMatcher.html#matches-java.lang.String-java.lang.Object-">matches</a></span>(java.lang.String sourceName, + java.lang.Object templateSource)</code> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>void</code></td> @@ -186,8 +186,8 @@ extends <a href="../../freemarker/cache/TemplateSourceMatcher.html" title="class <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> -<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> -<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> @@ -209,7 +209,7 @@ extends <a href="../../freemarker/cache/TemplateSourceMatcher.html" title="class <ul class="blockListLast"> <li class="blockList"> <h4>FileNameGlobMatcher</h4> -<pre>public FileNameGlobMatcher(<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> glob)</pre> +<pre>public FileNameGlobMatcher(java.lang.String glob)</pre> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>glob</code> - Glob with the syntax defined by <a href="../../freemarker/template/utility/StringUtil.html#globToRegularExpression-java.lang.String-boolean-"><code>StringUtil.globToRegularExpression(String, boolean)</code></a>. Must not @@ -231,12 +231,12 @@ extends <a href="../../freemarker/cache/TemplateSourceMatcher.html" title="class <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> +<pre>public boolean matches(java.lang.String sourceName, + java.lang.Object templateSource) + throws java.io.IOException</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> +<dd><code>java.io.IOException</code></dd> </dl> </li> </ul>
http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/cache/FileTemplateLoader.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/cache/FileTemplateLoader.html b/docs/api/freemarker/cache/FileTemplateLoader.html index aa15802..115a378 100644 --- a/docs/api/freemarker/cache/FileTemplateLoader.html +++ b/docs/api/freemarker/cache/FileTemplateLoader.html @@ -2,10 +2,10 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_144) on Sun Oct 15 21:19:44 EDT 2017 --> +<!-- Generated by javadoc (1.8.0_144) on Sat Nov 11 19:25:47 CET 2017 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>FileTemplateLoader (FreeMarker 2.3.27-incubating API)</title> -<meta name="date" content="2017-10-15"> +<meta name="date" content="2017-11-11"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> </head> @@ -98,7 +98,7 @@ var activeTableTab = "activeTableTab"; </div> <div class="contentContainer"> <ul class="inheritance"> -<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li>java.lang.Object</li> <li> <ul class="inheritance"> <li>freemarker.cache.FileTemplateLoader</li> @@ -115,7 +115,7 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre>public class <span class="typeNameLabel">FileTemplateLoader</span> -extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +extends java.lang.Object implements <a href="../../freemarker/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 files inside a specified directory as the source of templates. By default it does security checks on the <em>canonical</em> path that will prevent it serving templates outside that specified @@ -141,11 +141,11 @@ implements <a href="../../freemarker/cache/TemplateLoader.html" title="interface <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a></code></td> +<td class="colFirst"><code>java.io.File</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileTemplateLoader.html#baseDir">baseDir</a></span></code> </td> </tr> <tr class="rowColor"> -<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colFirst"><code>static java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileTemplateLoader.html#SYSTEM_PROPERTY_NAME_EMULATE_CASE_SENSITIVE_FILE_SYSTEM">SYSTEM_PROPERTY_NAME_EMULATE_CASE_SENSITIVE_FILE_SYSTEM</a></span></code> <div class="block">By setting this Java system property to <code>true</code>, you can change the default of <code>#getEmulateCaseSensitiveFileSystem()</code>.</div> @@ -174,13 +174,13 @@ implements <a href="../../freemarker/cache/TemplateLoader.html" title="interface </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileTemplateLoader.html#FileTemplateLoader-java.io.File-">FileTemplateLoader</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> baseDir)</code> +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileTemplateLoader.html#FileTemplateLoader-java.io.File-">FileTemplateLoader</a></span>(java.io.File baseDir)</code> <div class="block">Creates a new file template loader that will use the specified directory as the base directory for loading templates.</div> </td> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileTemplateLoader.html#FileTemplateLoader-java.io.File-boolean-">FileTemplateLoader</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> baseDir, +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileTemplateLoader.html#FileTemplateLoader-java.io.File-boolean-">FileTemplateLoader</a></span>(java.io.File baseDir, boolean disableCanonicalPathCheck)</code> <div class="block">Creates a new file template loader that will use the specified directory as the base directory for loading templates.</div> @@ -203,20 +203,20 @@ implements <a href="../../freemarker/cache/TemplateLoader.html" title="interface </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileTemplateLoader.html#closeTemplateSource-java.lang.Object-">closeTemplateSource</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> templateSource)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileTemplateLoader.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><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileTemplateLoader.html#findTemplateSource-java.lang.String-">findTemplateSource</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> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileTemplateLoader.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><a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a></code></td> +<td class="colFirst"><code>java.io.File</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileTemplateLoader.html#getBaseDirectory--">getBaseDirectory</a></span>()</code> <div class="block">Returns the base directory in which the templates are searched.</div> </td> @@ -235,14 +235,14 @@ implements <a href="../../freemarker/cache/TemplateLoader.html" title="interface </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>long</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileTemplateLoader.html#getLastModified-java.lang.Object-">getLastModified</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> templateSource)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileTemplateLoader.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="i6" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true"; title="class or interface in java.io">Reader</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileTemplateLoader.html#getReader-java.lang.Object-java.lang.String-">getReader</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> templateSource, - <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> encoding)</code> +<td class="colFirst"><code>java.io.Reader</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileTemplateLoader.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> @@ -254,7 +254,7 @@ implements <a href="../../freemarker/cache/TemplateLoader.html" title="interface </td> </tr> <tr id="i8" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FileTemplateLoader.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> @@ -264,8 +264,8 @@ implements <a href="../../freemarker/cache/TemplateLoader.html" title="interface <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> -<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> -<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li> </ul> </li> </ul> @@ -287,7 +287,7 @@ implements <a href="../../freemarker/cache/TemplateLoader.html" title="interface <ul class="blockList"> <li class="blockList"> <h4>SYSTEM_PROPERTY_NAME_EMULATE_CASE_SENSITIVE_FILE_SYSTEM</h4> -<pre>public static <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> SYSTEM_PROPERTY_NAME_EMULATE_CASE_SENSITIVE_FILE_SYSTEM</pre> +<pre>public static java.lang.String SYSTEM_PROPERTY_NAME_EMULATE_CASE_SENSITIVE_FILE_SYSTEM</pre> <div class="block">By setting this Java system property to <code>true</code>, you can change the default of <code>#getEmulateCaseSensitiveFileSystem()</code>.</div> </li> @@ -298,7 +298,7 @@ implements <a href="../../freemarker/cache/TemplateLoader.html" title="interface <ul class="blockListLast"> <li class="blockList"> <h4>baseDir</h4> -<pre>public final <a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> baseDir</pre> +<pre>public final java.io.File baseDir</pre> </li> </ul> </li> @@ -315,9 +315,9 @@ implements <a href="../../freemarker/cache/TemplateLoader.html" title="interface <ul class="blockList"> <li class="blockList"> <h4>FileTemplateLoader</h4> -<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +<pre>@Deprecated public FileTemplateLoader() - 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> + throws java.io.IOException</pre> <div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Relying on what the current directory is is a bad practice; use <a href="../../freemarker/cache/FileTemplateLoader.html#FileTemplateLoader-java.io.File-"><code>FileTemplateLoader(File)</code></a> instead.</span></div> <div class="block">Creates a new file template cache that will use the current directory (the value of the system property @@ -325,7 +325,7 @@ public FileTemplateLoader() that are accessible through symlinks that point outside the base directory.</div> <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> +<dd><code>java.io.IOException</code></dd> </dl> </li> </ul> @@ -335,8 +335,8 @@ public FileTemplateLoader() <ul class="blockList"> <li class="blockList"> <h4>FileTemplateLoader</h4> -<pre>public FileTemplateLoader(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> baseDir) - 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> +<pre>public FileTemplateLoader(java.io.File baseDir) + throws java.io.IOException</pre> <div class="block">Creates a new file template loader that will use the specified directory as the base directory for loading templates. It will not allow access to template files that are accessible through symlinks that point outside @@ -345,7 +345,7 @@ public FileTemplateLoader() <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>baseDir</code> - the base directory for loading templates</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></dd> +<dd><code>java.io.IOException</code></dd> </dl> </li> </ul> @@ -355,9 +355,9 @@ public FileTemplateLoader() <ul class="blockListLast"> <li class="blockList"> <h4>FileTemplateLoader</h4> -<pre>public FileTemplateLoader(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> baseDir, +<pre>public FileTemplateLoader(java.io.File baseDir, boolean disableCanonicalPathCheck) - 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> + throws java.io.IOException</pre> <div class="block">Creates a new file template loader that will use the specified directory as the base directory for loading templates. See the parameters for allowing symlinks that point outside the base directory.</div> <dl> @@ -371,7 +371,7 @@ public FileTemplateLoader() outside the <code>baseDir</code>, set this parameter to <code>true</code>, but then be very careful with template paths that are supplied by the visitor or an external system.</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></dd> +<dd><code>java.io.IOException</code></dd> </dl> </li> </ul> @@ -389,8 +389,8 @@ public FileTemplateLoader() <ul class="blockList"> <li class="blockList"> <h4>findTemplateSource</h4> -<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> findTemplateSource(<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) - 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> +<pre>public java.lang.Object findTemplateSource(java.lang.String name) + throws java.io.IOException</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> @@ -420,14 +420,14 @@ public FileTemplateLoader() 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 <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"><code>Object.equals(Object)</code></a> and - <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"><code>Object.hashCode()</code></a>) implementation</b>. Especially, template sources that refer to the same + 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 <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"><code>Object.equals(Object)</code></a> when the compared template sources came from the same + 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> <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> - When an error occurs that makes it impossible to find out if the template exists, or to access the +<dd><code>java.io.IOException</code> - When an error occurs that makes it impossible to find out if the template exists, or to access the existing template. Don't throw exception if the template doesn't exist, instead return with <code>null</code> then!</dd> </dl> @@ -439,7 +439,7 @@ public FileTemplateLoader() <ul class="blockList"> <li class="blockList"> <h4>getLastModified</h4> -<pre>public long getLastModified(<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)</pre> +<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> @@ -461,14 +461,14 @@ public FileTemplateLoader() <ul class="blockList"> <li class="blockList"> <h4>getReader</h4> -<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true"; title="class or interface in java.io">Reader</a> getReader(<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, - <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> encoding) - 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> +<pre>public java.io.Reader getReader(java.lang.Object templateSource, + java.lang.String encoding) + throws java.io.IOException</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 <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true"; title="class or interface in java.io"><code>Reader</code></a> that + 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 <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true"; title="class or interface in java.io"><code>Reader</code></a>, and it must not use it anymore. That is, this method is not + 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> @@ -488,11 +488,11 @@ public FileTemplateLoader() 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 <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true"; title="class or interface in java.io"><code>Reader</code></a> representing the template character stream. 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 <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Reader.html?is-external=true"; title="class or interface in java.io"><code>Reader</code></a> is not required to work after +<dd>A <code>Reader</code> representing the template character stream. 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><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> - if an I/O error occurs while accessing the stream.</dd> +<dd><code>java.io.IOException</code> - if an I/O error occurs while accessing the stream.</dd> </dl> </li> </ul> @@ -502,11 +502,11 @@ public FileTemplateLoader() <ul class="blockList"> <li class="blockList"> <h4>closeTemplateSource</h4> -<pre>public void closeTemplateSource(<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)</pre> +<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 <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"><code>Object.equals(Object)</code></a> 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 + 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> @@ -522,7 +522,7 @@ public FileTemplateLoader() <ul class="blockList"> <li class="blockList"> <h4>getBaseDirectory</h4> -<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true"; title="class or interface in java.io">File</a> getBaseDirectory()</pre> +<pre>public java.io.File getBaseDirectory()</pre> <div class="block">Returns the base directory in which the templates are searched. This comes from the constructor argument, but it's possibly a canonicalized version of that.</div> <dl> @@ -590,11 +590,11 @@ public FileTemplateLoader() <ul class="blockListLast"> <li class="blockList"> <h4>toString</h4> -<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> toString()</pre> +<pre>public java.lang.String toString()</pre> <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> +<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> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/cache/FirstMatchTemplateConfigurationFactory.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/cache/FirstMatchTemplateConfigurationFactory.html b/docs/api/freemarker/cache/FirstMatchTemplateConfigurationFactory.html index 45c32d4..4a19141 100644 --- a/docs/api/freemarker/cache/FirstMatchTemplateConfigurationFactory.html +++ b/docs/api/freemarker/cache/FirstMatchTemplateConfigurationFactory.html @@ -2,10 +2,10 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_144) on Sun Oct 15 21:19:44 EDT 2017 --> +<!-- Generated by javadoc (1.8.0_144) on Sat Nov 11 19:25:48 CET 2017 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>FirstMatchTemplateConfigurationFactory (FreeMarker 2.3.27-incubating API)</title> -<meta name="date" content="2017-10-15"> +<meta name="date" content="2017-11-11"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> </head> @@ -98,7 +98,7 @@ var activeTableTab = "activeTableTab"; </div> <div class="contentContainer"> <ul class="inheritance"> -<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li>java.lang.Object</li> <li> <ul class="inheritance"> <li><a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache">freemarker.cache.TemplateConfigurationFactory</a></li> @@ -162,8 +162,8 @@ extends <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core">TemplateConfiguration</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#get-java.lang.String-java.lang.Object-">get</a></span>(<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 class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#get-java.lang.String-java.lang.Object-">get</a></span>(java.lang.String sourceName, + java.lang.Object templateSource)</code> <div class="block">Returns (maybe creates) the <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core"><code>TemplateConfiguration</code></a> for the given template source.</div> </td> </tr> @@ -174,14 +174,14 @@ extends <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title </td> </tr> <tr id="i3" class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#getNoMatchErrorDetails--">getNoMatchErrorDetails</a></span>()</code> <div class="block">Use this to specify the text added to the exception error message when there was no matching choice.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html" title="class in freemarker.cache">FirstMatchTemplateConfigurationFactory</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#noMatchErrorDetails-java.lang.String-">noMatchErrorDetails</a></span>(<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> message)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#noMatchErrorDetails-java.lang.String-">noMatchErrorDetails</a></span>(java.lang.String message)</code> <div class="block">Same as <a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#setNoMatchErrorDetails-java.lang.String-"><code>setNoMatchErrorDetails(String)</code></a>, but return this object to support "fluent API" style.</div> </td> </tr> @@ -201,7 +201,7 @@ extends <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#setNoMatchErrorDetails-java.lang.String-">setNoMatchErrorDetails</a></span>(<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> noMatchErrorDetails)</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#setNoMatchErrorDetails-java.lang.String-">setNoMatchErrorDetails</a></span>(java.lang.String noMatchErrorDetails)</code> </td> </tr> </table> <ul class="blockList"> @@ -215,8 +215,8 @@ extends <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> -<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> -<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> @@ -255,9 +255,9 @@ extends <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title <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>, +<pre>public <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core">TemplateConfiguration</a> get(java.lang.String sourceName, + java.lang.Object templateSource) + throws java.io.IOException, <a href="../../freemarker/cache/TemplateConfigurationFactoryException.html" title="class in freemarker.cache">TemplateConfigurationFactoryException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/cache/TemplateConfigurationFactory.html#get-java.lang.String-java.lang.Object-">TemplateConfigurationFactory</a></code></span></div> <div class="block">Returns (maybe creates) the <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core"><code>TemplateConfiguration</code></a> for the given template source.</div> @@ -272,7 +272,7 @@ extends <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title <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 +<dd><code>java.io.IOException</code> - Typically, if there factory needs further I/O to find out more about the template source, but that fails.</dd> <dd><code><a href="../../freemarker/cache/TemplateConfigurationFactoryException.html" title="class in freemarker.cache">TemplateConfigurationFactoryException</a></code> - If there's a problem that's specific to the factory logic.</dd> </dl> @@ -309,7 +309,7 @@ extends <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title <ul class="blockList"> <li class="blockList"> <h4>getNoMatchErrorDetails</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> getNoMatchErrorDetails()</pre> +<pre>public java.lang.String getNoMatchErrorDetails()</pre> <div class="block">Use this to specify the text added to the exception error message when there was no matching choice. The default is <code>null</code> (no error details).</div> <dl> @@ -324,7 +324,7 @@ extends <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title <ul class="blockList"> <li class="blockList"> <h4>setNoMatchErrorDetails</h4> -<pre>public void setNoMatchErrorDetails(<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> noMatchErrorDetails)</pre> +<pre>public void setNoMatchErrorDetails(java.lang.String noMatchErrorDetails)</pre> </li> </ul> <a name="allowNoMatch-boolean-"> @@ -343,7 +343,7 @@ extends <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title <ul class="blockList"> <li class="blockList"> <h4>noMatchErrorDetails</h4> -<pre>public <a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html" title="class in freemarker.cache">FirstMatchTemplateConfigurationFactory</a> noMatchErrorDetails(<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> message)</pre> +<pre>public <a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html" title="class in freemarker.cache">FirstMatchTemplateConfigurationFactory</a> noMatchErrorDetails(java.lang.String message)</pre> <div class="block">Same as <a href="../../freemarker/cache/FirstMatchTemplateConfigurationFactory.html#setNoMatchErrorDetails-java.lang.String-"><code>setNoMatchErrorDetails(String)</code></a>, but return this object to support "fluent API" style.</div> </li> </ul> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/cache/MergingTemplateConfigurationFactory.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/cache/MergingTemplateConfigurationFactory.html b/docs/api/freemarker/cache/MergingTemplateConfigurationFactory.html index 8632424..1d5d419 100644 --- a/docs/api/freemarker/cache/MergingTemplateConfigurationFactory.html +++ b/docs/api/freemarker/cache/MergingTemplateConfigurationFactory.html @@ -2,10 +2,10 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_144) on Sun Oct 15 21:19:44 EDT 2017 --> +<!-- Generated by javadoc (1.8.0_144) on Sat Nov 11 19:25:48 CET 2017 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>MergingTemplateConfigurationFactory (FreeMarker 2.3.27-incubating API)</title> -<meta name="date" content="2017-10-15"> +<meta name="date" content="2017-11-11"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> </head> @@ -98,7 +98,7 @@ var activeTableTab = "activeTableTab"; </div> <div class="contentContainer"> <ul class="inheritance"> -<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li>java.lang.Object</li> <li> <ul class="inheritance"> <li><a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache">freemarker.cache.TemplateConfigurationFactory</a></li> @@ -161,8 +161,8 @@ extends <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code><a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core">TemplateConfiguration</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/MergingTemplateConfigurationFactory.html#get-java.lang.String-java.lang.Object-">get</a></span>(<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 class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/MergingTemplateConfigurationFactory.html#get-java.lang.String-java.lang.Object-">get</a></span>(java.lang.String sourceName, + java.lang.Object templateSource)</code> <div class="block">Returns (maybe creates) the <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core"><code>TemplateConfiguration</code></a> for the given template source.</div> </td> </tr> @@ -186,8 +186,8 @@ extends <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> -<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> -<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> @@ -226,9 +226,9 @@ extends <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title <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>, +<pre>public <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core">TemplateConfiguration</a> get(java.lang.String sourceName, + java.lang.Object templateSource) + throws java.io.IOException, <a href="../../freemarker/cache/TemplateConfigurationFactoryException.html" title="class in freemarker.cache">TemplateConfigurationFactoryException</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/cache/TemplateConfigurationFactory.html#get-java.lang.String-java.lang.Object-">TemplateConfigurationFactory</a></code></span></div> <div class="block">Returns (maybe creates) the <a href="../../freemarker/core/TemplateConfiguration.html" title="class in freemarker.core"><code>TemplateConfiguration</code></a> for the given template source.</div> @@ -243,7 +243,7 @@ extends <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title <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 +<dd><code>java.io.IOException</code> - Typically, if there factory needs further I/O to find out more about the template source, but that fails.</dd> <dd><code><a href="../../freemarker/cache/TemplateConfigurationFactoryException.html" title="class in freemarker.cache">TemplateConfigurationFactoryException</a></code> - If there's a problem that's specific to the factory logic.</dd> </dl> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/cache/MruCacheStorage.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/cache/MruCacheStorage.html b/docs/api/freemarker/cache/MruCacheStorage.html index 5ca772d..843c240 100644 --- a/docs/api/freemarker/cache/MruCacheStorage.html +++ b/docs/api/freemarker/cache/MruCacheStorage.html @@ -2,10 +2,10 @@ <!-- NewPage --> <html lang="en"> <head> -<!-- Generated by javadoc (1.8.0_144) on Sun Oct 15 21:19:44 EDT 2017 --> +<!-- Generated by javadoc (1.8.0_144) on Sat Nov 11 19:25:48 CET 2017 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>MruCacheStorage (FreeMarker 2.3.27-incubating API)</title> -<meta name="date" content="2017-10-15"> +<meta name="date" content="2017-11-11"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> </head> @@ -98,7 +98,7 @@ var activeTableTab = "activeTableTab"; </div> <div class="contentContainer"> <ul class="inheritance"> -<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li>java.lang.Object</li> <li> <ul class="inheritance"> <li>freemarker.cache.MruCacheStorage</li> @@ -115,7 +115,7 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre>public class <span class="typeNameLabel">MruCacheStorage</span> -extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +extends java.lang.Object implements <a href="../../freemarker/cache/CacheStorageWithGetSize.html" title="interface in freemarker.cache">CacheStorageWithGetSize</a></pre> <div class="block">A cache storage that implements a two-level Most Recently Used cache. In the first level, items are strongly referenced up to the specified maximum. When @@ -190,8 +190,8 @@ implements <a href="../../freemarker/cache/CacheStorageWithGetSize.html" title=" <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/MruCacheStorage.html#clear--">clear</a></span>()</code> </td> </tr> <tr id="i1" class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/MruCacheStorage.html#get-java.lang.Object-">get</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> key)</code> </td> +<td class="colFirst"><code>java.lang.Object</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/MruCacheStorage.html#get-java.lang.Object-">get</a></span>(java.lang.Object key)</code> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>int</code></td> @@ -225,20 +225,20 @@ implements <a href="../../freemarker/cache/CacheStorageWithGetSize.html" title=" </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/MruCacheStorage.html#put-java.lang.Object-java.lang.Object-">put</a></span>(<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> key, - <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/MruCacheStorage.html#put-java.lang.Object-java.lang.Object-">put</a></span>(java.lang.Object key, + java.lang.Object value)</code> </td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/MruCacheStorage.html#remove-java.lang.Object-">remove</a></span>(<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> key)</code> </td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/MruCacheStorage.html#remove-java.lang.Object-">remove</a></span>(java.lang.Object key)</code> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> -<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> -<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> </li> </ul> @@ -263,7 +263,7 @@ implements <a href="../../freemarker/cache/CacheStorageWithGetSize.html" title=" <pre>public MruCacheStorage(int strongSizeLimit, int softSizeLimit)</pre> <div class="block">Creates a new MRU cache storage with specified maximum cache sizes. Each - cache size can vary between 0 and <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html?is-external=true#MAX_VALUE"; title="class or interface in java.lang"><code>Integer.MAX_VALUE</code></a>.</div> + cache size can vary between 0 and <code>Integer.MAX_VALUE</code>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>strongSizeLimit</code> - the maximum number of strongly referenced templates; when exceeded, the entry used @@ -287,7 +287,7 @@ implements <a href="../../freemarker/cache/CacheStorageWithGetSize.html" title=" <ul class="blockList"> <li class="blockList"> <h4>get</h4> -<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> get(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> key)</pre> +<pre>public java.lang.Object get(java.lang.Object key)</pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../freemarker/cache/CacheStorage.html#get-java.lang.Object-">get</a></code> in interface <code><a href="../../freemarker/cache/CacheStorage.html" title="interface in freemarker.cache">CacheStorage</a></code></dd> @@ -300,8 +300,8 @@ implements <a href="../../freemarker/cache/CacheStorageWithGetSize.html" title=" <ul class="blockList"> <li class="blockList"> <h4>put</h4> -<pre>public void put(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> key, - <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> value)</pre> +<pre>public void put(java.lang.Object key, + java.lang.Object value)</pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../freemarker/cache/CacheStorage.html#put-java.lang.Object-java.lang.Object-">put</a></code> in interface <code><a href="../../freemarker/cache/CacheStorage.html" title="interface in freemarker.cache">CacheStorage</a></code></dd> @@ -314,7 +314,7 @@ implements <a href="../../freemarker/cache/CacheStorageWithGetSize.html" title=" <ul class="blockList"> <li class="blockList"> <h4>remove</h4> -<pre>public void remove(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> key)</pre> +<pre>public void remove(java.lang.Object key)</pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../freemarker/cache/CacheStorage.html#remove-java.lang.Object-">remove</a></code> in interface <code><a href="../../freemarker/cache/CacheStorage.html" title="interface in freemarker.cache">CacheStorage</a></code></dd>
