http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/cache/TemplateConfigurationFactoryException.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/cache/TemplateConfigurationFactoryException.html b/docs/api/freemarker/cache/TemplateConfigurationFactoryException.html index 5024bdf..1df19d5 100644 --- a/docs/api/freemarker/cache/TemplateConfigurationFactoryException.html +++ b/docs/api/freemarker/cache/TemplateConfigurationFactoryException.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>TemplateConfigurationFactoryException (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> @@ -92,13 +92,13 @@ </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="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">java.lang.Throwable</a></li> +<li>java.lang.Throwable</li> <li> <ul class="inheritance"> -<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">java.lang.Exception</a></li> +<li>java.lang.Exception</li> <li> <ul class="inheritance"> <li>freemarker.cache.TemplateConfigurationFactoryException</li> @@ -114,12 +114,12 @@ <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> -<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> +<dd>java.io.Serializable</dd> </dl> <hr> <br> <pre>public class <span class="typeNameLabel">TemplateConfigurationFactoryException</span> -extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +extends java.lang.Exception</pre> <div class="block">Non-I/O exception thrown by <a href="../../freemarker/cache/TemplateConfigurationFactory.html" title="class in freemarker.cache"><code>TemplateConfigurationFactory</code></a>-s.</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> @@ -145,11 +145,11 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.ht <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/cache/TemplateConfigurationFactoryException.html#TemplateConfigurationFactoryException-java.lang.String-">TemplateConfigurationFactoryException</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> +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/cache/TemplateConfigurationFactoryException.html#TemplateConfigurationFactoryException-java.lang.String-">TemplateConfigurationFactoryException</a></span>(java.lang.String message)</code> </td> </tr> <tr class="rowColor"> -<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/cache/TemplateConfigurationFactoryException.html#TemplateConfigurationFactoryException-java.lang.String-java.lang.Throwable-">TemplateConfigurationFactoryException</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, - <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> cause)</code> </td> +<td class="colOne"><code><span class="memberNameLink"><a href="../../freemarker/cache/TemplateConfigurationFactoryException.html#TemplateConfigurationFactoryException-java.lang.String-java.lang.Throwable-">TemplateConfigurationFactoryException</a></span>(java.lang.String message, + java.lang.Throwable cause)</code> </td> </tr> </table> </li> @@ -164,15 +164,15 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.ht <li class="blockList"><a name="methods.inherited.from.class.java.lang.Throwable"> <!-- --> </a> -<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a></h3> -<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#addSuppressed-java.lang.Throwable-" title="class or interface in java.lang">addSuppressed</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#fillInStackTrace--" title="class or interface in java.lang">fillInStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getCause--" title="class or interface in java.lang">getCause</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getLocalizedMessage--" title="class or interface in java.lang">getLocalizedMessage</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getMessage--" title="class or interface in java.lang">getMessage</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getStackTrace--" title="class or inter face in java.lang">getStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#getSuppressed--" title="class or interface in java.lang">getSuppressed</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#initCause-java.lang.Throwable-" title="class or interface in java.lang">initCause</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace--" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintStream-" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#printStackTrace-java.io.PrintWriter-" title="class or interface in java.lang">printStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lan g/Throwable.html?is-external=true#setStackTrace-java.lang.StackTraceElement:A-" title="class or interface in java.lang">setStackTrace</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code></li> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</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> +<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> @@ -194,7 +194,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.ht <ul class="blockList"> <li class="blockList"> <h4>TemplateConfigurationFactoryException</h4> -<pre>public TemplateConfigurationFactoryException(<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 TemplateConfigurationFactoryException(java.lang.String message)</pre> </li> </ul> <a name="TemplateConfigurationFactoryException-java.lang.String-java.lang.Throwable-"> @@ -203,8 +203,8 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.ht <ul class="blockListLast"> <li class="blockList"> <h4>TemplateConfigurationFactoryException</h4> -<pre>public TemplateConfigurationFactoryException(<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, - <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a> cause)</pre> +<pre>public TemplateConfigurationFactoryException(java.lang.String message, + java.lang.Throwable cause)</pre> </li> </ul> </li>
http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/cache/TemplateLoader.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/cache/TemplateLoader.html b/docs/api/freemarker/cache/TemplateLoader.html index 24138bd..40597e5 100644 --- a/docs/api/freemarker/cache/TemplateLoader.html +++ b/docs/api/freemarker/cache/TemplateLoader.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>TemplateLoader (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> @@ -122,7 +122,7 @@ var activeTableTab = "activeTableTab"; <p>Implementations of this interface should be thread-safe. - <p>Implementations should override <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"><code>Object.toString()</code></a> to show information about from where the + <p>Implementations should override <code>Object.toString()</code> to show information about from where the <a href="../../freemarker/cache/TemplateLoader.html" title="interface in freemarker.cache"><code>TemplateLoader</code></a> loads the templates. For example, for a template loader that loads template from database table <code>toString</code> could return something like <code>"MyDatabaseTemplateLoader(user=\"cms\", table=\"mail_templates\")"</code>. This string will be shown in @@ -151,28 +151,28 @@ var activeTableTab = "activeTableTab"; </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/TemplateLoader.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/TemplateLoader.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/TemplateLoader.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/TemplateLoader.html#findTemplateSource-java.lang.String-">findTemplateSource</a></span>(java.lang.String name)</code> <div class="block">Finds the template in the backing storage and returns an object that identifies the storage location where the template can be loaded from.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>long</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/TemplateLoader.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/TemplateLoader.html#getLastModified-java.lang.Object-">getLastModified</a></span>(java.lang.Object templateSource)</code> <div class="block">Returns the time of last modification of the specified template source.</div> </td> </tr> <tr id="i3" class="rowColor"> -<td class="colFirst"><code><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/TemplateLoader.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/TemplateLoader.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> @@ -197,8 +197,8 @@ var activeTableTab = "activeTableTab"; <ul class="blockList"> <li class="blockList"> <h4>findTemplateSource</h4> -<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> 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>java.lang.Object findTemplateSource(java.lang.String name) + throws java.io.IOException</pre> <div class="block">Finds the template in the backing storage and returns an object that identifies the storage location where the template can be loaded from. See the return value for more information.</div> <dl> @@ -225,14 +225,14 @@ var activeTableTab = "activeTableTab"; 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>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> @@ -244,7 +244,7 @@ var activeTableTab = "activeTableTab"; <ul class="blockList"> <li class="blockList"> <h4>getLastModified</h4> -<pre>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>long getLastModified(java.lang.Object templateSource)</pre> <div class="block">Returns the time of last modification of the specified template source. This method is called after <code>findTemplateSource()</code>.</div> <dl> @@ -263,13 +263,13 @@ var activeTableTab = "activeTableTab"; <ul class="blockList"> <li class="blockList"> <h4>getReader</h4> -<pre><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>java.io.Reader getReader(java.lang.Object templateSource, + java.lang.String encoding) + throws java.io.IOException</pre> <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> @@ -287,11 +287,11 @@ var activeTableTab = "activeTableTab"; 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>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> @@ -301,17 +301,17 @@ var activeTableTab = "activeTableTab"; <ul class="blockListLast"> <li class="blockList"> <h4>closeTemplateSource</h4> -<pre>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) - 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>void closeTemplateSource(java.lang.Object templateSource) + throws java.io.IOException</pre> <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>findTemplateSource(String)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>templateSource</code> - the template source that should be closed.</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> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/cache/TemplateLookupContext.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/cache/TemplateLookupContext.html b/docs/api/freemarker/cache/TemplateLookupContext.html index 445dea6..d015581 100644 --- a/docs/api/freemarker/cache/TemplateLookupContext.html +++ b/docs/api/freemarker/cache/TemplateLookupContext.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>TemplateLookupContext (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.TemplateLookupContext</li> @@ -111,7 +111,7 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre>public abstract class <span class="typeNameLabel">TemplateLookupContext</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></pre> +extends java.lang.Object</pre> <div class="block">Used as the parameter of <a href="../../freemarker/cache/TemplateLookupStrategy.html#lookup-freemarker.cache.TemplateLookupContext-"><code>TemplateLookupStrategy.lookup(TemplateLookupContext)</code></a>. You can't create instances of this, only receive them from FreeMarker.</div> <dl> @@ -144,37 +144,37 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? </td> </tr> <tr id="i1" class="rowColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> +<td class="colFirst"><code>java.lang.Object</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/TemplateLookupContext.html#getCustomLookupCondition--">getCustomLookupCondition</a></span>()</code> <div class="block">Returns the value of the <code>customLookupCondition</code> parameter of <a href="../../freemarker/template/Configuration.html#getTemplate-java.lang.String-java.util.Locale-java.lang.Object-java.lang.String-boolean-boolean-"><code>Configuration.getTemplate(String, Locale, Object, String, boolean, boolean)</code></a>; see requirements there, such - as having 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> method.</div> + as having a proper <code>Object.equals(Object)</code> and <code>Object.hashCode()</code> method.</div> </td> </tr> <tr id="i2" class="altColor"> -<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a></code></td> +<td class="colFirst"><code>java.util.Locale</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/TemplateLookupContext.html#getTemplateLocale--">getTemplateLocale</a></span>()</code> <div class="block"><code>null</code> if localized lookup is disabled (see <a href="../../freemarker/template/Configuration.html#getLocalizedLookup--"><code>Configuration.getLocalizedLookup()</code></a>), otherwise the locale requested.</div> </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/TemplateLookupContext.html#getTemplateName--">getTemplateName</a></span>()</code> <div class="block">The normalized name (path) of the template (relatively to the <a href="../../freemarker/cache/TemplateLoader.html" title="interface in freemarker.cache"><code>TemplateLoader</code></a>).</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>abstract <a href="../../freemarker/cache/TemplateLookupResult.html" title="class in freemarker.cache">TemplateLookupResult</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/TemplateLookupContext.html#lookupWithAcquisitionStrategy-java.lang.String-">lookupWithAcquisitionStrategy</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> templateName)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/TemplateLookupContext.html#lookupWithAcquisitionStrategy-java.lang.String-">lookupWithAcquisitionStrategy</a></span>(java.lang.String templateName)</code> <div class="block">Finds the template source based on its <em>normalized</em> name; handles <code>*</code> steps (so called acquisition), otherwise it just calls <a href="../../freemarker/cache/TemplateLoader.html#findTemplateSource-java.lang.String-"><code>TemplateLoader.findTemplateSource(String)</code></a>.</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>abstract <a href="../../freemarker/cache/TemplateLookupResult.html" title="class in freemarker.cache">TemplateLookupResult</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/TemplateLookupContext.html#lookupWithLocalizedThenAcquisitionStrategy-java.lang.String-java.util.Locale-">lookupWithLocalizedThenAcquisitionStrategy</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> templateName, - <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> templateLocale)</code> +<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/TemplateLookupContext.html#lookupWithLocalizedThenAcquisitionStrategy-java.lang.String-java.util.Locale-">lookupWithLocalizedThenAcquisitionStrategy</a></span>(java.lang.String templateName, + java.util.Locale templateLocale)</code> <div class="block">Finds the template source based on its <em>normalized</em> name; tries localized variations going from most specific to less specific, and for each variation it delegates to <a href="../../freemarker/cache/TemplateLookupContext.html#lookupWithAcquisitionStrategy-java.lang.String-"><code>lookupWithAcquisitionStrategy(String)</code></a>.</div> </td> @@ -184,8 +184,8 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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> @@ -207,8 +207,8 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>lookupWithAcquisitionStrategy</h4> -<pre>public abstract <a href="../../freemarker/cache/TemplateLookupResult.html" title="class in freemarker.cache">TemplateLookupResult</a> lookupWithAcquisitionStrategy(<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> templateName) - 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 abstract <a href="../../freemarker/cache/TemplateLookupResult.html" title="class in freemarker.cache">TemplateLookupResult</a> lookupWithAcquisitionStrategy(java.lang.String templateName) + throws java.io.IOException</pre> <div class="block">Finds the template source based on its <em>normalized</em> name; handles <code>*</code> steps (so called acquisition), otherwise it just calls <a href="../../freemarker/cache/TemplateLoader.html#findTemplateSource-java.lang.String-"><code>TemplateLoader.findTemplateSource(String)</code></a>.</div> <dl> @@ -221,7 +221,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <dd>The result of the lookup. Not <code>null</code>; check <a href="../../freemarker/cache/TemplateLookupResult.html#isPositive--"><code>TemplateLookupResult.isPositive()</code></a> to see if the lookup has found anything.</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> @@ -231,9 +231,9 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>lookupWithLocalizedThenAcquisitionStrategy</h4> -<pre>public abstract <a href="../../freemarker/cache/TemplateLookupResult.html" title="class in freemarker.cache">TemplateLookupResult</a> lookupWithLocalizedThenAcquisitionStrategy(<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> templateName, - <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> templateLocale) - 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 abstract <a href="../../freemarker/cache/TemplateLookupResult.html" title="class in freemarker.cache">TemplateLookupResult</a> lookupWithLocalizedThenAcquisitionStrategy(java.lang.String templateName, + java.util.Locale templateLocale) + throws java.io.IOException</pre> <div class="block">Finds the template source based on its <em>normalized</em> name; tries localized variations going from most specific to less specific, and for each variation it delegates to <a href="../../freemarker/cache/TemplateLookupContext.html#lookupWithAcquisitionStrategy-java.lang.String-"><code>lookupWithAcquisitionStrategy(String)</code></a>. If <code>templateLocale</code> is <code>null</code> (typically, because <a href="../../freemarker/template/Configuration.html#getLocalizedLookup--"><code>Configuration.getLocalizedLookup()</code></a> is @@ -242,7 +242,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <a href="../../freemarker/cache/TemplateLookupStrategy.html#DEFAULT_2_3_0"><code>TemplateLookupStrategy.DEFAULT_2_3_0</code></a>.</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> @@ -252,7 +252,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getTemplateName</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> getTemplateName()</pre> +<pre>public java.lang.String getTemplateName()</pre> <div class="block">The normalized name (path) of the template (relatively to the <a href="../../freemarker/cache/TemplateLoader.html" title="interface in freemarker.cache"><code>TemplateLoader</code></a>). Not <code>null</code>.</div> </li> </ul> @@ -262,7 +262,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getTemplateLocale</h4> -<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> getTemplateLocale()</pre> +<pre>public java.util.Locale getTemplateLocale()</pre> <div class="block"><code>null</code> if localized lookup is disabled (see <a href="../../freemarker/template/Configuration.html#getLocalizedLookup--"><code>Configuration.getLocalizedLookup()</code></a>), otherwise the locale requested.</div> </li> @@ -273,10 +273,10 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getCustomLookupCondition</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> getCustomLookupCondition()</pre> +<pre>public java.lang.Object getCustomLookupCondition()</pre> <div class="block">Returns the value of the <code>customLookupCondition</code> parameter of <a href="../../freemarker/template/Configuration.html#getTemplate-java.lang.String-java.util.Locale-java.lang.Object-java.lang.String-boolean-boolean-"><code>Configuration.getTemplate(String, Locale, Object, String, boolean, boolean)</code></a>; see requirements there, such - as having 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> method. The interpretation of this + as having a proper <code>Object.equals(Object)</code> and <code>Object.hashCode()</code> method. The interpretation of this value is up to the custom <a href="../../freemarker/cache/TemplateLookupStrategy.html" title="class in freemarker.cache"><code>TemplateLookupStrategy</code></a>. Usually, it's used similarly to as the default lookup strategy uses <a href="../../freemarker/cache/TemplateLookupContext.html#getTemplateLocale--"><code>getTemplateLocale()</code></a>, that is, to look for a template variation that satisfies the condition, and then maybe fall back to more generic template if that's missing.</div> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/cache/TemplateLookupResult.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/cache/TemplateLookupResult.html b/docs/api/freemarker/cache/TemplateLookupResult.html index 3f27661..63fa60b 100644 --- a/docs/api/freemarker/cache/TemplateLookupResult.html +++ b/docs/api/freemarker/cache/TemplateLookupResult.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>TemplateLookupResult (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.TemplateLookupResult</li> @@ -111,7 +111,7 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre>public abstract class <span class="typeNameLabel">TemplateLookupResult</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></pre> +extends java.lang.Object</pre> <div class="block">The return value of <a href="../../freemarker/cache/TemplateLookupStrategy.html#lookup-freemarker.cache.TemplateLookupContext-"><code>TemplateLookupStrategy.lookup(TemplateLookupContext)</code></a> and similar lookup methods. You usually get one from <a href="../../freemarker/cache/TemplateLookupContext.html#lookupWithAcquisitionStrategy-java.lang.String-"><code>TemplateLookupContext.lookupWithAcquisitionStrategy(String)</code></a> or <a href="../../freemarker/cache/TemplateLookupContext.html#createNegativeLookupResult--"><code>TemplateLookupContext.createNegativeLookupResult()</code></a>; you can't create instances of this directly.</div> @@ -138,7 +138,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> -<td class="colFirst"><code>abstract <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>abstract java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/cache/TemplateLookupResult.html#getTemplateSourceName--">getTemplateSourceName</a></span>()</code> <div class="block">The source name of the template found (see <a href="../../freemarker/template/Template.html#getSourceName--"><code>Template.getSourceName()</code></a>), or <code>null</code> if <a href="../../freemarker/cache/TemplateLookupResult.html#isPositive--"><code>isPositive()</code></a> is <code>false</code>.</div> @@ -155,8 +155,8 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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> @@ -178,7 +178,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getTemplateSourceName</h4> -<pre>public abstract <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> getTemplateSourceName()</pre> +<pre>public abstract java.lang.String getTemplateSourceName()</pre> <div class="block">The source name of the template found (see <a href="../../freemarker/template/Template.html#getSourceName--"><code>Template.getSourceName()</code></a>), or <code>null</code> if <a href="../../freemarker/cache/TemplateLookupResult.html#isPositive--"><code>isPositive()</code></a> is <code>false</code>.</div> </li> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/cache/TemplateLookupStrategy.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/cache/TemplateLookupStrategy.html b/docs/api/freemarker/cache/TemplateLookupStrategy.html index 9b96d71..64a58d7 100644 --- a/docs/api/freemarker/cache/TemplateLookupStrategy.html +++ b/docs/api/freemarker/cache/TemplateLookupStrategy.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>TemplateLookupStrategy (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.TemplateLookupStrategy</li> @@ -111,7 +111,7 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre>public abstract class <span class="typeNameLabel">TemplateLookupStrategy</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></pre> +extends java.lang.Object</pre> <div class="block">Finds the <a href="../../freemarker/cache/TemplateLoader.html" title="interface in freemarker.cache"><code>TemplateLoader</code></a>-level (storage-level) template source for the template name with which the template was requested (as in <a href="../../freemarker/template/Configuration.html#getTemplate-java.lang.String-"><code>Configuration.getTemplate(String)</code></a>). This usually means trying various <a href="../../freemarker/cache/TemplateLoader.html" title="interface in freemarker.cache"><code>TemplateLoader</code></a>-level template names (so called source names; see also <a href="../../freemarker/template/Template.html#getSourceName--"><code>Template.getSourceName()</code></a>) that @@ -211,8 +211,8 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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> @@ -249,7 +249,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <p> The generation of the localized name variation with the default lookup strategy, happens like this: It removes - the file extension (the part starting with the <em>last</em> dot), then appends <a href="http://docs.oracle.com/javase/8/docs/api/java/util/Locale.html?is-external=true#toString--" title="class or interface in java.util"><code>Locale.toString()</code></a> after + the file extension (the part starting with the <em>last</em> dot), then appends <code>Locale.toString()</code> after it, and puts back the extension. Then it starts to remove the parts from the end of the locale, considering <code>"_"</code> as the separator between the parts. It won't remove parts that are not part of the locale string (like if the requested template name is <code>foo_bar.ftl</code>, it won't remove the <code>"_bar"</code>).</div> @@ -287,7 +287,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <li class="blockList"> <h4>lookup</h4> <pre>public abstract <a href="../../freemarker/cache/TemplateLookupResult.html" title="class in freemarker.cache">TemplateLookupResult</a> lookup(<a href="../../freemarker/cache/TemplateLookupContext.html" title="class in freemarker.cache">TemplateLookupContext</a> ctx) - 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">Finds the template source that matches the template name, locale (if not <code>null</code>) and other parameters specified in the <a href="../../freemarker/cache/TemplateLookupContext.html" title="class in freemarker.cache"><code>TemplateLookupContext</code></a>. See also the class-level <a href="../../freemarker/cache/TemplateLookupStrategy.html" title="class in freemarker.cache"><code>TemplateLookupStrategy</code></a> documentation to understand lookup strategies more.</div> @@ -304,7 +304,7 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <code>TemplateLookupContext#createNegativeLookupResult()</code> if no matching template exists. Can't be <code>null</code>.</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> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/cache/TemplateNameFormat.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/cache/TemplateNameFormat.html b/docs/api/freemarker/cache/TemplateNameFormat.html index c8ff07d..eb3f11e 100644 --- a/docs/api/freemarker/cache/TemplateNameFormat.html +++ b/docs/api/freemarker/cache/TemplateNameFormat.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>TemplateNameFormat (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> @@ -92,7 +92,7 @@ </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.TemplateNameFormat</li> @@ -105,7 +105,7 @@ <hr> <br> <pre>public abstract class <span class="typeNameLabel">TemplateNameFormat</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></pre> +extends java.lang.Object</pre> <div class="block">Symbolizes a template name format, which defines the basic syntax of names through algorithms such as normalization. The API of this class isn't exposed as it's too immature, so custom template name formats aren't possible yet.</div> <dl> @@ -157,8 +157,8 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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> http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/51c3b7e5/docs/api/freemarker/cache/TemplateSourceMatcher.html ---------------------------------------------------------------------- diff --git a/docs/api/freemarker/cache/TemplateSourceMatcher.html b/docs/api/freemarker/cache/TemplateSourceMatcher.html index 1add296..467447e 100644 --- a/docs/api/freemarker/cache/TemplateSourceMatcher.html +++ b/docs/api/freemarker/cache/TemplateSourceMatcher.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>TemplateSourceMatcher (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> @@ -92,7 +92,7 @@ </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.TemplateSourceMatcher</li> @@ -109,7 +109,7 @@ <hr> <br> <pre>public abstract class <span class="typeNameLabel">TemplateSourceMatcher</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></pre> +extends java.lang.Object</pre> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>2.3.24</dd> @@ -147,8 +147,8 @@ extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html? <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>