http://git-wip-us.apache.org/repos/asf/incubator-freemarker-site/blob/55a5c314/builds/fm3/api/org/apache/freemarker/core/Template.html ---------------------------------------------------------------------- diff --git a/builds/fm3/api/org/apache/freemarker/core/Template.html b/builds/fm3/api/org/apache/freemarker/core/Template.html new file mode 100644 index 0000000..e183308 --- /dev/null +++ b/builds/fm3/api/org/apache/freemarker/core/Template.html @@ -0,0 +1,1302 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_66) on Wed Mar 01 19:40:22 CET 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Template (FreeMarker 3.0.0-nightly-incubating API)</title> +<meta name="date" content="2017-03-01"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="Template (FreeMarker 3.0.0-nightly-incubating API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<a name="navbar.top.firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/Template.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../../index-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../org/apache/freemarker/core/StopException.html" title="class in org.apache.freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/freemarker/core/Template.WrongEncodingException.html" title="class in org.apache.freemarker.core"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/freemarker/core/Template.html" target="_top">Frames</a></li> +<li><a href="Template.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li><a href="#nested.class.summary">Nested</a> | </li> +<li><a href="#field.summary">Field</a> | </li> +<li><a href="#constructor.summary">Constr</a> | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field.detail">Field</a> | </li> +<li><a href="#constructor.detail">Constr</a> | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.freemarker.core</div> +<h2 title="Class Template" class="title">Class Template</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li><a href="../../../../org/apache/freemarker/core/Configurable.html" title="class in org.apache.freemarker.core">org.apache.freemarker.core.Configurable</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.freemarker.core.Template</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">Template</span> +extends <a href="../../../../org/apache/freemarker/core/Configurable.html" title="class in org.apache.freemarker.core">Configurable</a></pre> +<div class="block"><p> + Stores an already parsed template, ready to be processed (rendered) for unlimited times, possibly from multiple + threads. + + <p> + Typically, you will use <a href="../../../../org/apache/freemarker/core/Configuration.html#getTemplate-java.lang.String-"><code>Configuration.getTemplate(String)</code></a> to create/get <a href="../../../../org/apache/freemarker/core/Template.html" title="class in org.apache.freemarker.core"><code>Template</code></a> objects, so you + don't construct them directly. But you can also construct a template from 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> or a <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang"><code>String</code></a> that + contains the template source code. But then it's important to know that while the resulting <a href="../../../../org/apache/freemarker/core/Template.html" title="class in org.apache.freemarker.core"><code>Template</code></a> is + efficient for later processing, creating a new <a href="../../../../org/apache/freemarker/core/Template.html" title="class in org.apache.freemarker.core"><code>Template</code></a> itself is relatively expensive. So try to re-use + <a href="../../../../org/apache/freemarker/core/Template.html" title="class in org.apache.freemarker.core"><code>Template</code></a> objects if possible. <a href="../../../../org/apache/freemarker/core/Configuration.html#getTemplate-java.lang.String-"><code>Configuration.getTemplate(String)</code></a> (and its overloads) does that + (caching <a href="../../../../org/apache/freemarker/core/Template.html" title="class in org.apache.freemarker.core"><code>Template</code></a>-s) for you, but the constructor of course doesn't, so it's up to you to solve then. + + <p> + Objects of this class meant to be handled as immutable and thus thread-safe. However, it has some setter methods for + changing FreeMarker settings. Those must not be used while the template is being processed, or if the template object + is already accessible from multiple threads. If some templates need different settings that those coming from the + shared <a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core"><code>Configuration</code></a>, and you are using <a href="../../../../org/apache/freemarker/core/Configuration.html#getTemplate-java.lang.String-"><code>Configuration.getTemplate(String)</code></a> (or its overloads), then + use <a href="../../../../org/apache/freemarker/core/Configuration.html#setTemplateConfigurations-org.apache.freemarker.core.templateresolver.TemplateConfigurationFactory-"><code>Configuration.setTemplateConfigurations(org.apache.freemarker.core.templateresolver.TemplateConfigurationFactory)</code></a> to achieve that.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.WrongEncodingException.html" title="class in org.apache.freemarker.core">Template.WrongEncodingException</a></span></code> +<div class="block">Thrown by the <a href="../../../../org/apache/freemarker/core/Template.html" title="class in org.apache.freemarker.core"><code>Template</code></a> constructors that specify a non-<code>null</code> encoding whoch doesn't match the + encoding specified in the <code>#ftl</code> header of the template.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<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="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#DEFAULT_NAMESPACE_PREFIX">DEFAULT_NAMESPACE_PREFIX</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="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#NO_NS_PREFIX">NO_NS_PREFIX</a></span></code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields.inherited.from.class.org.apache.freemarker.core.Configurable"> +<!-- --> +</a> +<h3>Fields inherited from class org.apache.freemarker.core.<a href="../../../../org/apache/freemarker/core/Configurable.html" title="class in org.apache.freemarker.core">Configurable</a></h3> +<code><a href="../../../../org/apache/freemarker/core/Configurable.html#API_BUILTIN_ENABLED_KEY">API_BUILTIN_ENABLED_KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#API_BUILTIN_ENABLED_KEY_CAMEL_CASE">API_BUILTIN_ENABLED_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#API_BUILTIN_ENABLED_KEY_SNAKE_CASE">API_BUILTIN_ENABLED_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#ARITHMETIC_ENGINE_KEY">ARITHMETIC_ENGINE_KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#ARITHMETIC_ENGINE_KEY_CAMEL_CASE">ARITHMETIC_ENGINE_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#ARITHMETIC_ENGINE_KEY_SNAKE_CASE">ARITHMETIC_ENGINE_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#AUTO_FLUSH_KEY">AUTO_FLUSH_KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#AUTO_FLUSH_KEY_CAMEL_CASE"> AUTO_FLUSH_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#AUTO_FLUSH_KEY_SNAKE_CASE">AUTO_FLUSH_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#AUTO_IMPORT_KEY">AUTO_IMPORT_KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#AUTO_IMPORT_KEY_CAMEL_CASE">AUTO_IMPORT_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#AUTO_IMPORT_KEY_SNAKE_CASE">AUTO_IMPORT_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#AUTO_INCLUDE_KEY">AUTO_INCLUDE_KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#AUTO_INCLUDE_KEY_CAMEL_CASE">AUTO_INCLUDE_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#AUTO_INCLUDE_KEY_SNAKE_CASE">AUTO_INCLUDE_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#BOOLEAN_FORMAT_KEY">BOOLEAN_FORMAT_KEY</a>, <a href="../.. /../../org/apache/freemarker/core/Configurable.html#BOOLEAN_FORMAT_KEY_CAMEL_CASE">BOOLEAN_FORMAT_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#BOOLEAN_FORMAT_KEY_SNAKE_CASE">BOOLEAN_FORMAT_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#CUSTOM_DATE_FORMATS_KEY">CUSTOM_DATE_FORMATS_KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#CUSTOM_DATE_FORMATS_KEY_CAMEL_CASE">CUSTOM_DATE_FORMATS_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#CUSTOM_DATE_FORMATS_KEY_SNAKE_CASE">CUSTOM_DATE_FORMATS_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#CUSTOM_NUMBER_FORMATS_KEY">CUSTOM_NUMBER_FORMATS_KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#CUSTOM_NUMBER_FORMATS_KEY_CAMEL_CASE">CUSTOM_NUMBER_FORMATS_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#CUSTOM_ NUMBER_FORMATS_KEY_SNAKE_CASE">CUSTOM_NUMBER_FORMATS_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#DATE_FORMAT_KEY">DATE_FORMAT_KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#DATE_FORMAT_KEY_CAMEL_CASE">DATE_FORMAT_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#DATE_FORMAT_KEY_SNAKE_CASE">DATE_FORMAT_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#DATETIME_FORMAT_KEY">DATETIME_FORMAT_KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#DATETIME_FORMAT_KEY_CAMEL_CASE">DATETIME_FORMAT_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#DATETIME_FORMAT_KEY_SNAKE_CASE">DATETIME_FORMAT_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#LAZY_AUTO_IMPORTS_KEY">LAZY_AUTO_IMPORTS_KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#LAZY_A UTO_IMPORTS_KEY_CAMEL_CASE">LAZY_AUTO_IMPORTS_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#LAZY_AUTO_IMPORTS_KEY_SNAKE_CASE">LAZY_AUTO_IMPORTS_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#LAZY_IMPORTS_KEY">LAZY_IMPORTS_KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#LAZY_IMPORTS_KEY_CAMEL_CASE">LAZY_IMPORTS_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#LAZY_IMPORTS_KEY_SNAKE_CASE">LAZY_IMPORTS_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#LOCALE_KEY">LOCALE_KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#LOCALE_KEY_CAMEL_CASE">LOCALE_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#LOCALE_KEY_SNAKE_CASE">LOCALE_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#LOG_TEMPLATE_EXCEPTIONS_KEY">LOG_TEMPLA TE_EXCEPTIONS_KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#LOG_TEMPLATE_EXCEPTIONS_KEY_CAMEL_CASE">LOG_TEMPLATE_EXCEPTIONS_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#LOG_TEMPLATE_EXCEPTIONS_KEY_SNAKE_CASE">LOG_TEMPLATE_EXCEPTIONS_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#NEW_BUILTIN_CLASS_RESOLVER_KEY">NEW_BUILTIN_CLASS_RESOLVER_KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#NEW_BUILTIN_CLASS_RESOLVER_KEY_CAMEL_CASE">NEW_BUILTIN_CLASS_RESOLVER_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#NEW_BUILTIN_CLASS_RESOLVER_KEY_SNAKE_CASE">NEW_BUILTIN_CLASS_RESOLVER_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#NUMBER_FORMAT_KEY">NUMBER_FORMAT_KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#NUMBER_FORMAT_KEY_CAMEL_CASE">NUMBER_FORMAT_KEY_CAMEL_ CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#NUMBER_FORMAT_KEY_SNAKE_CASE">NUMBER_FORMAT_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#OBJECT_WRAPPER_KEY">OBJECT_WRAPPER_KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#OBJECT_WRAPPER_KEY_CAMEL_CASE">OBJECT_WRAPPER_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#OBJECT_WRAPPER_KEY_SNAKE_CASE">OBJECT_WRAPPER_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#OUTPUT_ENCODING_KEY">OUTPUT_ENCODING_KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#OUTPUT_ENCODING_KEY_CAMEL_CASE">OUTPUT_ENCODING_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#OUTPUT_ENCODING_KEY_SNAKE_CASE">OUTPUT_ENCODING_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#SHOW_ERROR_TIPS_KEY">SHOW_ERROR_TIPS_ KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#SHOW_ERROR_TIPS_KEY_CAMEL_CASE">SHOW_ERROR_TIPS_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#SHOW_ERROR_TIPS_KEY_SNAKE_CASE">SHOW_ERROR_TIPS_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#SQL_DATE_AND_TIME_TIME_ZONE_KEY">SQL_DATE_AND_TIME_TIME_ZONE_KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#SQL_DATE_AND_TIME_TIME_ZONE_KEY_CAMEL_CASE">SQL_DATE_AND_TIME_TIME_ZONE_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#SQL_DATE_AND_TIME_TIME_ZONE_KEY_SNAKE_CASE">SQL_DATE_AND_TIME_TIME_ZONE_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#TEMPLATE_EXCEPTION_HANDLER_KEY">TEMPLATE_EXCEPTION_HANDLER_KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#TEMPLATE_EXCEPTION_HANDLER_KEY_CAMEL_CASE">TEMPLATE_EXCEPTION_HANDLE R_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#TEMPLATE_EXCEPTION_HANDLER_KEY_SNAKE_CASE">TEMPLATE_EXCEPTION_HANDLER_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#TIME_FORMAT_KEY">TIME_FORMAT_KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#TIME_FORMAT_KEY_CAMEL_CASE">TIME_FORMAT_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#TIME_FORMAT_KEY_SNAKE_CASE">TIME_FORMAT_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#TIME_ZONE_KEY">TIME_ZONE_KEY</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#TIME_ZONE_KEY_CAMEL_CASE">TIME_ZONE_KEY_CAMEL_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#TIME_ZONE_KEY_SNAKE_CASE">TIME_ZONE_KEY_SNAKE_CASE</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#URL_ESCAPING_CHARSET_KEY">URL_ESCAPING_CHARSET_KEY</a >, <a >href="../../../../org/apache/freemarker/core/Configurable.html#URL_ESCAPING_CHARSET_KEY_CAMEL_CASE">URL_ESCAPING_CHARSET_KEY_CAMEL_CASE</a>, > <a >href="../../../../org/apache/freemarker/core/Configurable.html#URL_ESCAPING_CHARSET_KEY_SNAKE_CASE">URL_ESCAPING_CHARSET_KEY_SNAKE_CASE</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#Template-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-">Template</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, + <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> reader, + <a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core">Configuration</a> cfg)</code> +<div class="block">Same as <a href="../../../../org/apache/freemarker/core/Template.html#Template-java.lang.String-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-"><code>Template(String, String, Reader, Configuration)</code></a> with <code>null</code> <code>sourceName</code> parameter.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#Template-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-java.lang.String-">Template</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, + <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> reader, + <a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core">Configuration</a> cfg, + <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> +<div class="block">Convenience constructor for <a href="../../../../org/apache/freemarker/core/Template.html#Template-java.lang.String-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-java.lang.String-"><code>Template(name, null, + reader, cfg, encoding)</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#Template-java.lang.String-java.lang.String-org.apache.freemarker.core.Configuration-">Template</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, + <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> sourceCode, + <a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core">Configuration</a> cfg)</code> +<div class="block">Convenience constructor for <a href="../../../../org/apache/freemarker/core/Template.html#Template-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-"><code>Template(name, new StringReader(reader), cfg)</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#Template-java.lang.String-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-">Template</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, + <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/io/Reader.html?is-external=true"; title="class or interface in java.io">Reader</a> reader, + <a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core">Configuration</a> cfg)</code> +<div class="block">Constructs a template from a character stream.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#Template-java.lang.String-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-org.apache.freemarker.core.ParserConfiguration-java.lang.String-">Template</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, + <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/io/Reader.html?is-external=true"; title="class or interface in java.io">Reader</a> reader, + <a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core">Configuration</a> cfg, + <a href="../../../../org/apache/freemarker/core/ParserConfiguration.html" title="interface in org.apache.freemarker.core">ParserConfiguration</a> customParserConfiguration, + <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> +<div class="block">Same as <a href="../../../../org/apache/freemarker/core/Template.html#Template-java.lang.String-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-java.lang.String-"><code>Template(String, String, Reader, Configuration, String)</code></a>, but also specifies a + <a href="../../../../org/apache/freemarker/core/TemplateConfiguration.html" title="class in org.apache.freemarker.core"><code>TemplateConfiguration</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#Template-java.lang.String-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-org.apache.freemarker.core.ParserConfiguration-java.lang.String-java.io.InputStream-">Template</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, + <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/io/Reader.html?is-external=true"; title="class or interface in java.io">Reader</a> reader, + <a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core">Configuration</a> cfg, + <a href="../../../../org/apache/freemarker/core/ParserConfiguration.html" title="interface in org.apache.freemarker.core">ParserConfiguration</a> customParserConfiguration, + <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, + <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a> streamToUnmarkWhenEncEstabd)</code> +<div class="block">Same as <a href="../../../../org/apache/freemarker/core/Template.html#Template-java.lang.String-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-org.apache.freemarker.core.ParserConfiguration-java.lang.String-"><code>Template(String, String, Reader, Configuration, ParserConfiguration, String)</code></a>, but allows + specifying the <code>streamToUnmarkWhenEncEstabd</code> <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io"><code>InputStream</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#Template-java.lang.String-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-java.lang.String-">Template</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, + <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/io/Reader.html?is-external=true"; title="class or interface in java.io">Reader</a> reader, + <a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core">Configuration</a> cfg, + <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> +<div class="block">Same as <a href="../../../../org/apache/freemarker/core/Template.html#Template-java.lang.String-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-"><code>Template(String, String, Reader, Configuration)</code></a>, but also specifies the template's encoding (not + recommended).</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/freemarker/core/Template.html" title="class in org.apache.freemarker.core">Template</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#createPlainTextTemplate-java.lang.String-java.lang.String-org.apache.freemarker.core.Configuration-">createPlainTextTemplate</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, + <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> content, + <a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core">Configuration</a> config)</code> +<div class="block">Same as <a href="../../../../org/apache/freemarker/core/Template.html#createPlainTextTemplate-java.lang.String-java.lang.String-java.lang.String-org.apache.freemarker.core.Configuration-java.lang.String-"><code>createPlainTextTemplate(String, String, String, Configuration, String)</code></a> with <code>null</code> + <code>sourceName</code> argument.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/freemarker/core/Template.html" title="class in org.apache.freemarker.core">Template</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#createPlainTextTemplate-java.lang.String-java.lang.String-java.lang.String-org.apache.freemarker.core.Configuration-java.lang.String-">createPlainTextTemplate</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, + <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/String.html?is-external=true"; title="class or interface in java.lang">String</a> content, + <a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core">Configuration</a> config, + <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> +<div class="block">Creates a <a href="../../../../org/apache/freemarker/core/Template.html" title="class in org.apache.freemarker.core"><code>Template</code></a> that only contains a single block of static text, no dynamic content.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core">Environment</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#createProcessingEnvironment-java.lang.Object-java.io.Writer-">createProcessingEnvironment</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> dataModel, + <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> out)</code> +<div class="block">Same as <a href="../../../../org/apache/freemarker/core/Template.html#createProcessingEnvironment-java.lang.Object-java.io.Writer-org.apache.freemarker.core.model.ObjectWrapper-"><code>createProcessingEnvironment(dataModel, out, null)</code></a>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core">Environment</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#createProcessingEnvironment-java.lang.Object-java.io.Writer-org.apache.freemarker.core.model.ObjectWrapper-">createProcessingEnvironment</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> dataModel, + <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> out, + <a href="../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapper</a> wrapper)</code> +<div class="block">Creates a <a href="../../../../org/apache/freemarker/core/Environment.html" title="class in org.apache.freemarker.core"><code>Environment</code></a> object, using this template, the data-model provided as + parameter.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#dump-java.io.PrintStream-">dump</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true"; title="class or interface in java.io">PrintStream</a> ps)</code> +<div class="block">Dump the raw template in canonical form.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#dump-java.io.Writer-">dump</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> out)</code> +<div class="block">Dump the raw template in canonical form.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#getActualNamingConvention--">getActualNamingConvention</a></span>()</code> +<div class="block">Returns the naming convention the parser has chosen for this template.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#getActualTagSyntax--">getActualTagSyntax</a></span>()</code> +<div class="block">Returns the tag syntax the parser has chosen for this template.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#getAutoEscaping--">getAutoEscaping</a></span>()</code> +<div class="block">Returns if the template actually uses auto-escaping (see <a href="../../../../org/apache/freemarker/core/Configuration.html#setAutoEscapingPolicy-int-"><code>Configuration.setAutoEscapingPolicy(int)</code></a>).</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core">Configuration</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#getConfiguration--">getConfiguration</a></span>()</code> +<div class="block">Returns the Configuration object associated with this template.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<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="../../../../org/apache/freemarker/core/Template.html#getCustomLookupCondition--">getCustomLookupCondition</a></span>()</code> +<div class="block">Gets the custom lookup condition with which this template was found.</div> +</td> +</tr> +<tr id="i11" 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="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#getDefaultNS--">getDefaultNS</a></span>()</code> </td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#getEncoding--">getEncoding</a></span>()</code> +<div class="block">Returns the default character encoding used for reading included/imported files; if <code>null</code>, then + the encoding returned by <a href="../../../../org/apache/freemarker/core/Configuration.html#getEncoding-java.util.Locale-"><code>Configuration.getEncoding(java.util.Locale)</code></a> should be used instead.</div> +</td> +</tr> +<tr id="i13" 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="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#getName--">getName</a></span>()</code> +<div class="block">The usually path-like (or URL-like) identifier of the template, or possibly <code>null</code> for non-stored + templates.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#getNamespaceForPrefix-java.lang.String-">getNamespaceForPrefix</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> prefix)</code> </td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/freemarker/core/outputformat/OutputFormat.html" title="class in org.apache.freemarker.core.outputformat">OutputFormat</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#getOutputFormat--">getOutputFormat</a></span>()</code> +<div class="block">Returns the output format (see <a href="../../../../org/apache/freemarker/core/Configuration.html#setOutputFormat-org.apache.freemarker.core.outputformat.OutputFormat-"><code>Configuration.setOutputFormat(OutputFormat)</code></a>) used for this template.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/freemarker/core/ParserConfiguration.html" title="interface in org.apache.freemarker.core">ParserConfiguration</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#getParserConfiguration--">getParserConfiguration</a></span>()</code> +<div class="block">Returns the <a href="../../../../org/apache/freemarker/core/ParserConfiguration.html" title="interface in org.apache.freemarker.core"><code>ParserConfiguration</code></a> that was used for parsing this template.</div> +</td> +</tr> +<tr id="i17" 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="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#getPrefixedName-java.lang.String-java.lang.String-">getPrefixedName</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> localName, + <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> nsURI)</code> </td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#getPrefixForNamespace-java.lang.String-">getPrefixForNamespace</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> nsURI)</code> </td> +</tr> +<tr id="i19" 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="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#getSource-int-int-int-int-">getSource</a></span>(int beginColumn, + int beginLine, + int endColumn, + int endLine)</code> +<div class="block">Returns the template source at the location specified by the coordinates given, or <code>null</code> if unavailable.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#getSourceName--">getSourceName</a></span>()</code> +<div class="block">The name that was actually used to load this template from the <a href="../../../../org/apache/freemarker/core/templateresolver/TemplateLoader.html" title="interface in org.apache.freemarker.core.templateresolver"><code>TemplateLoader</code></a> (or from other custom + storage mechanism).</div> +</td> +</tr> +<tr id="i21" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#process-java.lang.Object-java.io.Writer-">process</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> dataModel, + <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> out)</code> +<div class="block">Executes template, using the data-model provided, writing the generated output to the supplied <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io"><code>Writer</code></a>.</div> +</td> +</tr> +<tr id="i22" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#process-java.lang.Object-java.io.Writer-org.apache.freemarker.core.model.ObjectWrapper-">process</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> dataModel, + <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> out, + <a href="../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapper</a> wrapper)</code> +<div class="block">Like <a href="../../../../org/apache/freemarker/core/Template.html#process-java.lang.Object-java.io.Writer-"><code>process(Object, Writer)</code></a>, but overrides the <a href="../../../../org/apache/freemarker/core/Configurable.html#getObjectWrapper--"><code>Configurable.getObjectWrapper()</code></a>.</div> +</td> +</tr> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#process-java.lang.Object-java.io.Writer-org.apache.freemarker.core.model.ObjectWrapper-org.apache.freemarker.core.model.TemplateNodeModel-">process</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> dataModel, + <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> out, + <a href="../../../../org/apache/freemarker/core/model/ObjectWrapper.html" title="interface in org.apache.freemarker.core.model">ObjectWrapper</a> wrapper, + <a href="../../../../org/apache/freemarker/core/model/TemplateNodeModel.html" title="interface in org.apache.freemarker.core.model">TemplateNodeModel</a> rootNode)</code> +<div class="block">Like <a href="../../../../org/apache/freemarker/core/Template.html#process-java.lang.Object-java.io.Writer-"><code>process(Object, Writer)</code></a>, but also sets a (XML-)node to be recursively processed by the template.</div> +</td> +</tr> +<tr id="i24" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#setCustomLookupCondition-java.lang.Object-">setCustomLookupCondition</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> customLookupCondition)</code> +<div class="block">Mostly only used internally; setter pair of <a href="../../../../org/apache/freemarker/core/Template.html#getCustomLookupCondition--"><code>getCustomLookupCondition()</code></a>.</div> +</td> +</tr> +<tr id="i25" 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="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/freemarker/core/Template.html#toString--">toString</a></span>()</code> +<div class="block">Returns a string representing the raw template + text in canonical form.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.org.apache.freemarker.core.Configurable"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.freemarker.core.<a href="../../../../org/apache/freemarker/core/Configurable.html" title="class in org.apache.freemarker.core">Configurable</a></h3> +<code><a href="../../../../org/apache/freemarker/core/Configurable.html#addAutoImport-java.lang.String-java.lang.String-">addAutoImport</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#addAutoInclude-java.lang.String-">addAutoInclude</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#doAutoImportsAndIncludes-org.apache.freemarker.core.Environment-">doAutoImportsAndIncludes</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getArithmeticEngine--">getArithmeticEngine</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getAutoFlush--">getAutoFlush</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getAutoImports--">getAutoImports</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getAutoImportsWithoutFallback--">getAutoImportsWithoutFallback</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getAutoIncludes--">getAutoIncludes</a>, <a href="../../. ./../org/apache/freemarker/core/Configurable.html#getAutoIncludesWithoutFallback--">getAutoIncludesWithoutFallback</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getBooleanFormat--">getBooleanFormat</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getCorrectedNameForUnknownSetting-java.lang.String-">getCorrectedNameForUnknownSetting</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getCustomAttribute-java.lang.String-">getCustomAttribute</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getCustomAttributeNames--">getCustomAttributeNames</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getCustomDateFormat-java.lang.String-">getCustomDateFormat</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getCustomDateFormats--">getCustomDateFormats</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getCustomDateFormatsWithoutFallback--">getCustomD ateFormatsWithoutFallback</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getCustomNumberFormat-java.lang.String-">getCustomNumberFormat</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getCustomNumberFormats--">getCustomNumberFormats</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getCustomNumberFormatsWithoutFallback--">getCustomNumberFormatsWithoutFallback</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getDateFormat--">getDateFormat</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getDateTimeFormat--">getDateTimeFormat</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getEnvironment--">getEnvironment</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getLazyAutoImports--">getLazyAutoImports</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getLazyImports--">getLazyImports</a>, <a href="../../../../org/apach e/freemarker/core/Configurable.html#getLocale--">getLocale</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getLogTemplateExceptions--">getLogTemplateExceptions</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getNewBuiltinClassResolver--">getNewBuiltinClassResolver</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getNumberFormat--">getNumberFormat</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getObjectWrapper--">getObjectWrapper</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getOutputEncoding--">getOutputEncoding</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getParent--">getParent</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getRemovalVersionForUnknownSetting-java.lang.String-">getRemovalVersionForUnknownSetting</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getSettingNames-boolean-">getSettingN ames</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getShowErrorTips--">getShowErrorTips</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getSQLDateAndTimeTimeZone--">getSQLDateAndTimeTimeZone</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getTemplateExceptionHandler--">getTemplateExceptionHandler</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getTimeFormat--">getTimeFormat</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getTimeZone--">getTimeZone</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#getURLEscapingCharset--">getURLEscapingCharset</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#hasCustomFormats--">hasCustomFormats</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#invalidSettingValueException-java.lang.String-java.lang.String-">invalidSettingValueException</a>, <a href="../../../../org/apache/ freemarker/core/Configurable.html#invalidSettingValueException-java.lang.String-java.lang.String-java.lang.String-">invalidSettingValueException</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isAPIBuiltinEnabled--">isAPIBuiltinEnabled</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isAPIBuiltinEnabledSet--">isAPIBuiltinEnabledSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isArithmeticEngineSet--">isArithmeticEngineSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isAutoFlushSet--">isAutoFlushSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isAutoImportsSet--">isAutoImportsSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isAutoIncludesSet--">isAutoIncludesSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isBooleanFormatSet--">isBooleanFormatSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable. html#isCustomDateFormatsSet--">isCustomDateFormatsSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isCustomNumberFormatsSet--">isCustomNumberFormatsSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isDateFormatSet--">isDateFormatSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isDateTimeFormatSet--">isDateTimeFormatSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isLazyAutoImportsSet--">isLazyAutoImportsSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isLazyImportsSet--">isLazyImportsSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isLocaleSet--">isLocaleSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isLogTemplateExceptionsSet--">isLogTemplateExceptionsSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isNewBuiltinClassResolverSet--">isNewBuiltinClassResolverSet</a>, <a href="../ ../../../org/apache/freemarker/core/Configurable.html#isNumberFormatSet--">isNumberFormatSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isObjectWrapperSet--">isObjectWrapperSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isOutputEncodingSet--">isOutputEncodingSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isShowErrorTipsSet--">isShowErrorTipsSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isSQLDateAndTimeTimeZoneSet--">isSQLDateAndTimeTimeZoneSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isTemplateExceptionHandlerSet--">isTemplateExceptionHandlerSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isTimeFormatSet--">isTimeFormatSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isTimeZoneSet--">isTimeZoneSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#isURLEscapingCharsetSet --">isURLEscapingCharsetSet</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#parseAsImportList-java.lang.String-">parseAsImportList</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#parseAsList-java.lang.String-">parseAsList</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#parseAsSegmentedList-java.lang.String-">parseAsSegmentedList</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#removeAutoImport-java.lang.String-">removeAutoImport</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#removeAutoInclude-java.lang.String-">removeAutoInclude</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#removeCustomAttribute-java.lang.String-">removeCustomAttribute</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setAPIBuiltinEnabled-boolean-">setAPIBuiltinEnabled</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setArithmeticEngine -org.apache.freemarker.core.arithmetic.ArithmeticEngine-">setArithmeticEngine</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setAutoFlush-boolean-">setAutoFlush</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setAutoImports-java.util.Map-">setAutoImports</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setAutoIncludes-java.util.List-">setAutoIncludes</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setBooleanFormat-java.lang.String-">setBooleanFormat</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setCustomAttribute-java.lang.String-java.lang.Object-">setCustomAttribute</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setCustomDateFormats-java.util.Map-">setCustomDateFormats</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setCustomNumberFormats-java.util.Map-">setCustomNumberFormats</a>, <a href="../../../../org/apache/freemar ker/core/Configurable.html#setDateFormat-java.lang.String-">setDateFormat</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setDateTimeFormat-java.lang.String-">setDateTimeFormat</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setLazyAutoImports-java.lang.Boolean-">setLazyAutoImports</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setLazyImports-boolean-">setLazyImports</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setLocale-java.util.Locale-">setLocale</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setLogTemplateExceptions-boolean-">setLogTemplateExceptions</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setNewBuiltinClassResolver-org.apache.freemarker.core.TemplateClassResolver-">setNewBuiltinClassResolver</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setNumberFormat-java.lang.String-">setNumberFormat</a>, <a href="../. ./../../org/apache/freemarker/core/Configurable.html#setObjectWrapper-org.apache.freemarker.core.model.ObjectWrapper-">setObjectWrapper</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setOutputEncoding-java.lang.String-">setOutputEncoding</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setSetting-java.lang.String-java.lang.String-">setSetting</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setSettings-java.util.Properties-">setSettings</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setShowErrorTips-boolean-">setShowErrorTips</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setSQLDateAndTimeTimeZone-java.util.TimeZone-">setSQLDateAndTimeTimeZone</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setTemplateExceptionHandler-org.apache.freemarker.core.TemplateExceptionHandler-">setTemplateExceptionHandler</a>, <a href="../../../../org/apache/freemarker/ core/Configurable.html#setTimeFormat-java.lang.String-">setTimeFormat</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setTimeZone-java.util.TimeZone-">setTimeZone</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#settingValueAssignmentException-java.lang.String-java.lang.String-java.lang.Throwable-">settingValueAssignmentException</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#setURLEscapingCharset-java.lang.String-">setURLEscapingCharset</a>, <a href="../../../../org/apache/freemarker/core/Configurable.html#unknownSettingException-java.lang.String-">unknownSettingException</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-"; title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="DEFAULT_NAMESPACE_PREFIX"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_NAMESPACE_PREFIX</h4> +<pre>public static final <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> DEFAULT_NAMESPACE_PREFIX</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.freemarker.core.Template.DEFAULT_NAMESPACE_PREFIX">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="NO_NS_PREFIX"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>NO_NS_PREFIX</h4> +<pre>public static final <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> NO_NS_PREFIX</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.freemarker.core.Template.NO_NS_PREFIX">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="Template-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Template</h4> +<pre>public Template(<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, + <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> reader, + <a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core">Configuration</a> cfg) + 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> +<div class="block">Same as <a href="../../../../org/apache/freemarker/core/Template.html#Template-java.lang.String-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-"><code>Template(String, String, Reader, Configuration)</code></a> with <code>null</code> <code>sourceName</code> parameter.</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> +</dl> +</li> +</ul> +<a name="Template-java.lang.String-java.lang.String-org.apache.freemarker.core.Configuration-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Template</h4> +<pre>public Template(<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, + <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> sourceCode, + <a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core">Configuration</a> cfg) + 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> +<div class="block">Convenience constructor for <a href="../../../../org/apache/freemarker/core/Template.html#Template-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-"><code>Template(name, new StringReader(reader), cfg)</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> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.20</dd> +</dl> +</li> +</ul> +<a name="Template-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Template</h4> +<pre>public Template(<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, + <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> reader, + <a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core">Configuration</a> cfg, + <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> +<div class="block">Convenience constructor for <a href="../../../../org/apache/freemarker/core/Template.html#Template-java.lang.String-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-java.lang.String-"><code>Template(name, null, + reader, cfg, encoding)</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> +</dl> +</li> +</ul> +<a name="Template-java.lang.String-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Template</h4> +<pre>public Template(<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, + <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/io/Reader.html?is-external=true"; title="class or interface in java.io">Reader</a> reader, + <a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core">Configuration</a> cfg) + 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> +<div class="block">Constructs a template from a character stream. Note that this is a relatively expensive operation; where higher + performance matters, you should re-use (cache) <a href="../../../../org/apache/freemarker/core/Template.html" title="class in org.apache.freemarker.core"><code>Template</code></a> instances instead of re-creating them from the + same source again and again. (<a href="../../../../org/apache/freemarker/core/Configuration.html#getTemplate-java.lang.String-"><code>and its overloads already do such reuse.</code></a>)</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The path of the template file relatively to the (virtual) directory that you use to store the + templates (except if <a href="../../../../org/apache/freemarker/core/Template.html#Template-java.lang.String-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-java.lang.String-"><code>sourceName</code></a> + differs from it). Shouldn't start with <code>'/'</code>. Should use <code>'/'</code>, not <code>'\'</code>. Check + <a href="../../../../org/apache/freemarker/core/Template.html#getName--"><code>getName()</code></a> to see how the name will be used. The name should be independent of the actual + storage mechanism and physical location as far as possible. Even when the templates are stored + straightforwardly in real files (they often aren't; see <a href="../../../../org/apache/freemarker/core/templateresolver/TemplateLoader.html" title="interface in org.apache.freemarker.core.templateresolver"><code>TemplateLoader</code></a>), the name shouldn't be + an absolute file path. Like if the template is stored in <code>"/www/templates/forum/main.ftl"</code>, and + you are using <code>"/www/templates/"</code> as the template root directory via + <a href="../../../../org/apache/freemarker/core/Configuration.html#setDirectoryForTemplateLoading-java.io.File-"><code>Configuration.setDirectoryForTemplateLoading(java.io.File)</code></a>, then the template name will be + <code>"forum/main.ftl"</code>. The name can be <code>null</code> (should be used for template made on-the-fly + instead of being loaded from somewhere), in which case relative paths in it will be relative to + the template root directory (and here again, it's the <a href="../../../../org/apache/freemarker/core/templateresolver/TemplateLoader.html" title="interface in org.apache.freemarker.core.templateresolver"><code>TemplateLoader</code></a> that knows what that + "physically" means).</dd> +<dd><code>sourceName</code> - See <a href="../../../../org/apache/freemarker/core/Template.html#getSourceName--"><code>getSourceName()</code></a> for the meaning. Can be <code>null</code>, in which case + <a href="../../../../org/apache/freemarker/core/Template.html#getSourceName--"><code>getSourceName()</code></a> will return the same as <a href="../../../../org/apache/freemarker/core/Template.html#getName--"><code>getName()</code></a>.</dd> +<dd><code>reader</code> - The character stream to read from. 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 <em>not</em> closed by this method (unlike + in FreeMarker 2.x.x), so be sure that it's closed somewhere. (Except of course, readers like + <a href="http://docs.oracle.com/javase/8/docs/api/java/io/StringReader.html?is-external=true"; title="class or interface in java.io"><code>StringReader</code></a> need not be closed.) 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> need not be buffered, because this + method ensures that it will be read in few kilobyte chunks, not byte by byte.</dd> +<dd><code>cfg</code> - The Configuration object that this Template is associated with. 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> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.22</dd> +</dl> +</li> +</ul> +<a name="Template-java.lang.String-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Template</h4> +<pre>public Template(<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, + <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/io/Reader.html?is-external=true"; title="class or interface in java.io">Reader</a> reader, + <a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core">Configuration</a> cfg, + <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> +<div class="block">Same as <a href="../../../../org/apache/freemarker/core/Template.html#Template-java.lang.String-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-"><code>Template(String, String, Reader, Configuration)</code></a>, but also specifies the template's encoding (not + recommended).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>encoding</code> - This is the encoding that we are supposed to be using. At the first glance it's unnecessary because we + already have 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> (so decoding with the charset has already happened), however, if this is + non-<code>null</code> and there's an <code>#ftl</code> header with <code>encoding</code> parameter, they must match, + or else a <a href="../../../../org/apache/freemarker/core/Template.WrongEncodingException.html" title="class in org.apache.freemarker.core"><code>Template.WrongEncodingException</code></a> is thrown. Thus, it should be set if to decode the template, + we were using an encoding (a charset), otherwise it should be <code>null</code>. It's also kept as + meta-info (returned by <a href="../../../../org/apache/freemarker/core/Template.html#getEncoding--"><code>getEncoding()</code></a>). It also has an impact when <code>#include</code>-ing or + <code>#import</code>-ing another template from this template, as its default encoding will be this. But + this behavior of said directives is considered to be harmful, and will be probably phased out.</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> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.22</dd> +</dl> +</li> +</ul> +<a name="Template-java.lang.String-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-org.apache.freemarker.core.ParserConfiguration-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>Template</h4> +<pre>public Template(<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, + <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/io/Reader.html?is-external=true"; title="class or interface in java.io">Reader</a> reader, + <a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core">Configuration</a> cfg, + <a href="../../../../org/apache/freemarker/core/ParserConfiguration.html" title="interface in org.apache.freemarker.core">ParserConfiguration</a> customParserConfiguration, + <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> +<div class="block">Same as <a href="../../../../org/apache/freemarker/core/Template.html#Template-java.lang.String-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-java.lang.String-"><code>Template(String, String, Reader, Configuration, String)</code></a>, but also specifies a + <a href="../../../../org/apache/freemarker/core/TemplateConfiguration.html" title="class in org.apache.freemarker.core"><code>TemplateConfiguration</code></a>. This is mostly meant to be used by FreeMarker internally, but advanced users might + still find this useful.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>customParserConfiguration</code> - Overrides the parsing related configuration settings of the <a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core"><code>Configuration</code></a> parameter; can be + <code>null</code>. This is useful as the <a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core"><code>Configuration</code></a> is normally a singleton shared by all + templates, and so it's not good for specifying template-specific settings. (While <a href="../../../../org/apache/freemarker/core/Template.html" title="class in org.apache.freemarker.core"><code>Template</code></a> + itself has methods to specify settings just for that template, those don't influence the parsing, and + you only have opportunity to call them after the parsing anyway.) This objects is often a + <a href="../../../../org/apache/freemarker/core/TemplateConfiguration.html" title="class in org.apache.freemarker.core"><code>TemplateConfiguration</code></a> whose parent is the <a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core"><code>Configuration</code></a> parameter, and then it + practically just overrides some of the parser settings, as the others are inherited from the + <a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core"><code>Configuration</code></a>. Note that if this is a <a href="../../../../org/apache/freemarker/core/TemplateConfiguration.html" title="class in org.apache.freemarker.core"><code>TemplateConfiguration</code></a>, you will also want to + call <a href="../../../../org/apache/freemarker/core/TemplateConfiguration.html#apply-org.apache.freemarker.core.Template-"><code>TemplateConfiguration.apply(Template)</code></a> on the resulting <a href="../../../../org/apache/freemarker/core/Template.html" title="class in org.apache.freemarker.core"><code>Template</code></a> so that + <a href="../../../../org/apache/freemarker/core/Configurable.html" title="class in org.apache.freemarker.core"><code>Configurable</code></a> settings will be set too, because this constructor only uses it as a + <a href="../../../../org/apache/freemarker/core/ParserConfiguration.html" title="interface in org.apache.freemarker.core"><code>ParserConfiguration</code></a>.</dd> +<dd><code>encoding</code> - Same as in <a href="../../../../org/apache/freemarker/core/Template.html#Template-java.lang.String-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-java.lang.String-"><code>Template(String, String, Reader, Configuration, String)</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></dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2.3.24</dd> +</dl> +</li> +</ul> +<a name="Template-java.lang.String-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-org.apache.freemarker.core.ParserConfiguration-java.lang.String-java.io.InputStream-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Template</h4> +<pre>public Template(<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, + <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/io/Reader.html?is-external=true"; title="class or interface in java.io">Reader</a> reader, + <a href="../../../../org/apache/freemarker/core/Configuration.html" title="class in org.apache.freemarker.core">Configuration</a> cfg, + <a href="../../../../org/apache/freemarker/core/ParserConfiguration.html" title="interface in org.apache.freemarker.core">ParserConfiguration</a> customParserConfiguration, + <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, + <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a> streamToUnmarkWhenEncEstabd) + 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> +<div class="block">Same as <a href="../../../../org/apache/freemarker/core/Template.html#Template-java.lang.String-java.lang.String-java.io.Reader-org.apache.freemarker.core.Configuration-org.apache.freemarker.core.ParserConfiguration-java.lang.String-"><code>Template(String, String, Reader, Configuration, ParserConfiguration, String)</code></a>, but allows + specifying the <code>streamToUnmarkWhenEncEstabd</code> <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io"><code>InputStream</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>streamToUnmarkWhenEncEstabd</code> - If not <code>null</code>, when during the parsing we reach a point where we know that no <a href="../../../../org/apache/freemarker/core/Template.WrongEncodingException.html" title="class in org.apache.freemarker.core"><code>Template.WrongEncodingException</code></a> will be thrown, <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true#mark-int-"; title="class or interface in java.io"><code>mark(0)</code></a> will be called on this. + This is meant to be used when the reader parameter is a <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStreamReader.html?is-external=true"; title="class or interface in java.io"><code>InputStreamReader</code></a>, and this parameter is + the underlying <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io"><code>InputStream</code></a>, and you have a mark at the beginning of the <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io"><code>InputStream</code></a> so + that you can retry if a <a href="../../../../org/apache/freemarker/core/Template.WrongEncodingException.html" title="class in org.apache.freemarker.core"><code>Template.WrongEncodingException</code></a> is thrown without extra I/O. As keeping that + mark consumes some resources, so you may want to release it as soon as possible.</dd> +<dt><span class="throwsLabel">Throws:</
<TRUNCATED>
