http://git-wip-us.apache.org/repos/asf/freemarker-site/blob/a4a53cb9/builds/2.3.28-voting/documentation/api/freemarker/core/Environment.html ---------------------------------------------------------------------- diff --git a/builds/2.3.28-voting/documentation/api/freemarker/core/Environment.html b/builds/2.3.28-voting/documentation/api/freemarker/core/Environment.html deleted file mode 100644 index 6c6f9c7..0000000 --- a/builds/2.3.28-voting/documentation/api/freemarker/core/Environment.html +++ /dev/null @@ -1,2309 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> -<!-- NewPage --> -<html lang="en"> -<head> -<!-- Generated by javadoc (1.8.0_144) on Fri Mar 30 23:10:43 CEST 2018 --> -<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>Environment (FreeMarker 2.3.28 API)</title> -<meta name="date" content="2018-03-30"> -<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> -<script type="text/javascript" src="../../script.js"></script> -</head> -<body> -<script type="text/javascript"><!-- - try { - if (location.href.indexOf('is-external=true') == -1) { - parent.document.title="Environment (FreeMarker 2.3.28 API)"; - } - } - catch(err) { - } -//--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":9,"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,"i26":10,"i27":10,"i28":10,"i29":42,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":10,"i50":10,"i51":10,"i52":10,"i53":10,"i54":10,"i55":10,"i56":10,"i57":10,"i58":10,"i59":10,"i60":10,"i61":10,"i62":10,"i63":10,"i64":10,"i65":10,"i66":10,"i67":10,"i68":42}; -var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/Environment.html">Use</a></li> -<li><a href="package-tree.html">Tree</a></li> -<li><a href="../../deprecated-list.html">Deprecated</a></li> -<li><a href="../../index-all.html">Index</a></li> -<li><a href="../../help-doc.html">Help</a></li> -</ul> -</div> -<div class="subNav"> -<ul class="navList"> -<li><a href="../../freemarker/core/DirectiveCallPlace.html" title="interface in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> -<li><a href="../../freemarker/core/Environment.Namespace.html" title="class in freemarker.core"><span class="typeNameLink">Next Class</span></a></li> -</ul> -<ul class="navList"> -<li><a href="../../index.html?freemarker/core/Environment.html" target="_top">Frames</a></li> -<li><a href="Environment.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="#fields.inherited.from.class.freemarker.core.Configurable">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>Field | </li> -<li><a href="#constructor.detail">Constr</a> | </li> -<li><a href="#method.detail">Method</a></li> -</ul> -</div> -<a name="skip.navbar.top"> -<!-- --> -</a></div> -<!-- ========= END OF TOP NAVBAR ========= --> -<!-- ======== START OF CLASS DATA ======== --> -<div class="header"> -<div class="subTitle">freemarker.core</div> -<h2 title="Class Environment" class="title">Class Environment</h2> -</div> -<div class="contentContainer"> -<ul class="inheritance"> -<li>java.lang.Object</li> -<li> -<ul class="inheritance"> -<li><a href="../../freemarker/core/Configurable.html" title="class in freemarker.core">freemarker.core.Configurable</a></li> -<li> -<ul class="inheritance"> -<li>freemarker.core.Environment</li> -</ul> -</li> -</ul> -</li> -</ul> -<div class="description"> -<ul class="blockList"> -<li class="blockList"> -<hr> -<br> -<pre>public final class <span class="typeNameLabel">Environment</span> -extends <a href="../../freemarker/core/Configurable.html" title="class in freemarker.core">Configurable</a></pre> -<div class="block">Object that represents the runtime environment during template processing. For every invocation of a - <tt>Template.process()</tt> method, a new instance of this object is created, and then discarded when - <tt>process()</tt> returns. This object stores the set of temporary variables created by the template, the value of - settings set by the template, the reference to the data model root, etc. Everything that is needed to fulfill the - template processing job. - - <p> - Data models that need to access the <tt>Environment</tt> object that represents the template processing on the - current thread can use the <a href="../../freemarker/core/Environment.html#getCurrentEnvironment--"><code>getCurrentEnvironment()</code></a> method. - - <p> - If you need to modify or read this object before or after the <tt>process</tt> call, use - <a href="../../freemarker/template/Template.html#createProcessingEnvironment-java.lang.Object-java.io.Writer-freemarker.template.ObjectWrapper-"><code>Template.createProcessingEnvironment(Object rootMap, Writer out, ObjectWrapper wrapper)</code></a></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>class </code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.Namespace.html" title="class in freemarker.core">Environment.Namespace</a></span></code> </td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="nested.classes.inherited.from.class.freemarker.core.Configurable"> -<!-- --> -</a> -<h3>Nested classes/interfaces inherited from class freemarker.core.<a href="../../freemarker/core/Configurable.html" title="class in freemarker.core">Configurable</a></h3> -<code><a href="../../freemarker/core/Configurable.SettingValueAssignmentException.html" title="class in freemarker.core">Configurable.SettingValueAssignmentException</a>, <a href="../../freemarker/core/Configurable.UnknownSettingException.html" title="class in freemarker.core">Configurable.UnknownSettingException</a></code></li> -</ul> -</li> -</ul> -<!-- =========== FIELD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="field.summary"> -<!-- --> -</a> -<h3>Field Summary</h3> -<ul class="blockList"> -<li class="blockList"><a name="fields.inherited.from.class.freemarker.core.Configurable"> -<!-- --> -</a> -<h3>Fields inherited from class freemarker.core.<a href="../../freemarker/core/Configurable.html" title="class in freemarker.core">Configurable</a></h3> -<code><a href="../../freemarker/core/Configurable.html#API_BUILTIN_ENABLED_KEY">API_BUILTIN_ENABLED_KEY</a>, <a href="../../freemarker/core/Configurable.html#API_BUILTIN_ENABLED_KEY_CAMEL_CASE">API_BUILTIN_ENABLED_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#API_BUILTIN_ENABLED_KEY_SNAKE_CASE">API_BUILTIN_ENABLED_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#ARITHMETIC_ENGINE_KEY">ARITHMETIC_ENGINE_KEY</a>, <a href="../../freemarker/core/Configurable.html#ARITHMETIC_ENGINE_KEY_CAMEL_CASE">ARITHMETIC_ENGINE_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#ARITHMETIC_ENGINE_KEY_SNAKE_CASE">ARITHMETIC_ENGINE_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#ATTEMPT_EXCEPTION_REPORTER_KEY">ATTEMPT_EXCEPTION_REPORTER_KEY</a>, <a href="../../freemarker/core/Configurable.html#ATTEMPT_EXCEPTION_REPORTER_KEY_CAMEL_CASE">ATTEMPT_EXCEPTION_REPORTER_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurab le.html#ATTEMPT_EXCEPTION_REPORTER_KEY_SNAKE_CASE">ATTEMPT_EXCEPTION_REPORTER_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#AUTO_FLUSH_KEY">AUTO_FLUSH_KEY</a>, <a href="../../freemarker/core/Configurable.html#AUTO_FLUSH_KEY_CAMEL_CASE">AUTO_FLUSH_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#AUTO_FLUSH_KEY_SNAKE_CASE">AUTO_FLUSH_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#AUTO_IMPORT_KEY">AUTO_IMPORT_KEY</a>, <a href="../../freemarker/core/Configurable.html#AUTO_IMPORT_KEY_CAMEL_CASE">AUTO_IMPORT_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#AUTO_IMPORT_KEY_SNAKE_CASE">AUTO_IMPORT_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#AUTO_INCLUDE_KEY">AUTO_INCLUDE_KEY</a>, <a href="../../freemarker/core/Configurable.html#AUTO_INCLUDE_KEY_CAMEL_CASE">AUTO_INCLUDE_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#AUTO_INCLUDE_KEY_SNAKE_CASE">AUTO_INCLUDE_KEY_ SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#BOOLEAN_FORMAT_KEY">BOOLEAN_FORMAT_KEY</a>, <a href="../../freemarker/core/Configurable.html#BOOLEAN_FORMAT_KEY_CAMEL_CASE">BOOLEAN_FORMAT_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#BOOLEAN_FORMAT_KEY_SNAKE_CASE">BOOLEAN_FORMAT_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#CLASSIC_COMPATIBLE_KEY">CLASSIC_COMPATIBLE_KEY</a>, <a href="../../freemarker/core/Configurable.html#CLASSIC_COMPATIBLE_KEY_CAMEL_CASE">CLASSIC_COMPATIBLE_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#CLASSIC_COMPATIBLE_KEY_SNAKE_CASE">CLASSIC_COMPATIBLE_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#CUSTOM_DATE_FORMATS_KEY">CUSTOM_DATE_FORMATS_KEY</a>, <a href="../../freemarker/core/Configurable.html#CUSTOM_DATE_FORMATS_KEY_CAMEL_CASE">CUSTOM_DATE_FORMATS_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#CUSTOM_DATE_FORMATS_KEY_SNAKE_CASE ">CUSTOM_DATE_FORMATS_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#CUSTOM_NUMBER_FORMATS_KEY">CUSTOM_NUMBER_FORMATS_KEY</a>, <a href="../../freemarker/core/Configurable.html#CUSTOM_NUMBER_FORMATS_KEY_CAMEL_CASE">CUSTOM_NUMBER_FORMATS_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#CUSTOM_NUMBER_FORMATS_KEY_SNAKE_CASE">CUSTOM_NUMBER_FORMATS_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#DATE_FORMAT_KEY">DATE_FORMAT_KEY</a>, <a href="../../freemarker/core/Configurable.html#DATE_FORMAT_KEY_CAMEL_CASE">DATE_FORMAT_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#DATE_FORMAT_KEY_SNAKE_CASE">DATE_FORMAT_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#DATETIME_FORMAT_KEY">DATETIME_FORMAT_KEY</a>, <a href="../../freemarker/core/Configurable.html#DATETIME_FORMAT_KEY_CAMEL_CASE">DATETIME_FORMAT_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#DATETIME_FORMAT_KEY_SNAK E_CASE">DATETIME_FORMAT_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#LAZY_AUTO_IMPORTS_KEY">LAZY_AUTO_IMPORTS_KEY</a>, <a href="../../freemarker/core/Configurable.html#LAZY_AUTO_IMPORTS_KEY_CAMEL_CASE">LAZY_AUTO_IMPORTS_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#LAZY_AUTO_IMPORTS_KEY_SNAKE_CASE">LAZY_AUTO_IMPORTS_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#LAZY_IMPORTS_KEY">LAZY_IMPORTS_KEY</a>, <a href="../../freemarker/core/Configurable.html#LAZY_IMPORTS_KEY_CAMEL_CASE">LAZY_IMPORTS_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#LAZY_IMPORTS_KEY_SNAKE_CASE">LAZY_IMPORTS_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#LOCALE_KEY">LOCALE_KEY</a>, <a href="../../freemarker/core/Configurable.html#LOCALE_KEY_CAMEL_CASE">LOCALE_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#LOCALE_KEY_SNAKE_CASE">LOCALE_KEY_SNAKE_CASE</a>, <a href="../../freemarker/ core/Configurable.html#LOG_TEMPLATE_EXCEPTIONS_KEY">LOG_TEMPLATE_EXCEPTIONS_KEY</a>, <a href="../../freemarker/core/Configurable.html#LOG_TEMPLATE_EXCEPTIONS_KEY_CAMEL_CASE">LOG_TEMPLATE_EXCEPTIONS_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#LOG_TEMPLATE_EXCEPTIONS_KEY_SNAKE_CASE">LOG_TEMPLATE_EXCEPTIONS_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#NEW_BUILTIN_CLASS_RESOLVER_KEY">NEW_BUILTIN_CLASS_RESOLVER_KEY</a>, <a href="../../freemarker/core/Configurable.html#NEW_BUILTIN_CLASS_RESOLVER_KEY_CAMEL_CASE">NEW_BUILTIN_CLASS_RESOLVER_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#NEW_BUILTIN_CLASS_RESOLVER_KEY_SNAKE_CASE">NEW_BUILTIN_CLASS_RESOLVER_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#NUMBER_FORMAT_KEY">NUMBER_FORMAT_KEY</a>, <a href="../../freemarker/core/Configurable.html#NUMBER_FORMAT_KEY_CAMEL_CASE">NUMBER_FORMAT_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.htm l#NUMBER_FORMAT_KEY_SNAKE_CASE">NUMBER_FORMAT_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#OBJECT_WRAPPER_KEY">OBJECT_WRAPPER_KEY</a>, <a href="../../freemarker/core/Configurable.html#OBJECT_WRAPPER_KEY_CAMEL_CASE">OBJECT_WRAPPER_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#OBJECT_WRAPPER_KEY_SNAKE_CASE">OBJECT_WRAPPER_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#OUTPUT_ENCODING_KEY">OUTPUT_ENCODING_KEY</a>, <a href="../../freemarker/core/Configurable.html#OUTPUT_ENCODING_KEY_CAMEL_CASE">OUTPUT_ENCODING_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#OUTPUT_ENCODING_KEY_SNAKE_CASE">OUTPUT_ENCODING_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#SHOW_ERROR_TIPS_KEY">SHOW_ERROR_TIPS_KEY</a>, <a href="../../freemarker/core/Configurable.html#SHOW_ERROR_TIPS_KEY_CAMEL_CASE">SHOW_ERROR_TIPS_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#SHOW_ERROR_TIPS_KE Y_SNAKE_CASE">SHOW_ERROR_TIPS_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#SQL_DATE_AND_TIME_TIME_ZONE_KEY">SQL_DATE_AND_TIME_TIME_ZONE_KEY</a>, <a href="../../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="../../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="../../freemarker/core/Configurable.html#STRICT_BEAN_MODELS">STRICT_BEAN_MODELS</a>, <a href="../../freemarker/core/Configurable.html#STRICT_BEAN_MODELS_KEY">STRICT_BEAN_MODELS_KEY</a>, <a href="../../freemarker/core/Configurable.html#STRICT_BEAN_MODELS_KEY_CAMEL_CASE">STRICT_BEAN_MODELS_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#STRICT_BEAN_MODELS_KEY_SNAKE_CASE">STRICT_BEAN_MODELS_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#TEMPLATE_EXCEPTION_HANDLER_KEY">TEMPLATE_EXCEPTION_HANDLE R_KEY</a>, <a href="../../freemarker/core/Configurable.html#TEMPLATE_EXCEPTION_HANDLER_KEY_CAMEL_CASE">TEMPLATE_EXCEPTION_HANDLER_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#TEMPLATE_EXCEPTION_HANDLER_KEY_SNAKE_CASE">TEMPLATE_EXCEPTION_HANDLER_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#TIME_FORMAT_KEY">TIME_FORMAT_KEY</a>, <a href="../../freemarker/core/Configurable.html#TIME_FORMAT_KEY_CAMEL_CASE">TIME_FORMAT_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#TIME_FORMAT_KEY_SNAKE_CASE">TIME_FORMAT_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#TIME_ZONE_KEY">TIME_ZONE_KEY</a>, <a href="../../freemarker/core/Configurable.html#TIME_ZONE_KEY_CAMEL_CASE">TIME_ZONE_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#TIME_ZONE_KEY_SNAKE_CASE">TIME_ZONE_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#URL_ESCAPING_CHARSET_KEY">URL_ESCAPING_CHARSET_KEY</a>, <a hr ef="../../freemarker/core/Configurable.html#URL_ESCAPING_CHARSET_KEY_CAMEL_CASE">URL_ESCAPING_CHARSET_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#URL_ESCAPING_CHARSET_KEY_SNAKE_CASE">URL_ESCAPING_CHARSET_KEY_SNAKE_CASE</a>, <a href="../../freemarker/core/Configurable.html#WRAP_UNCHECKED_EXCEPTIONS_KEY">WRAP_UNCHECKED_EXCEPTIONS_KEY</a>, <a href="../../freemarker/core/Configurable.html#WRAP_UNCHECKED_EXCEPTIONS_KEY_CAMEL_CASE">WRAP_UNCHECKED_EXCEPTIONS_KEY_CAMEL_CASE</a>, <a href="../../freemarker/core/Configurable.html#WRAP_UNCHECKED_EXCEPTIONS_KEY_SNAKE_CASE">WRAP_UNCHECKED_EXCEPTIONS_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="../../freemarker/core/Environment.html#Environment-freemarker.template.Template-freemarker.template.TemplateHashModel-java.io.Writer-">Environment</a></span>(<a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a> template, - <a href="../../freemarker/template/TemplateHashModel.html" title="interface in freemarker.template">TemplateHashModel</a> rootDataModel, - java.io.Writer out)</code> </td> -</tr> -</table> -</li> -</ul> -<!-- ========== METHOD SUMMARY =========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.summary"> -<!-- --> -</a> -<h3>Method Summary</h3> -<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> -<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> -<tr> -<th class="colFirst" scope="col">Modifier and Type</th> -<th class="colLast" scope="col">Method and Description</th> -</tr> -<tr id="i0" class="altColor"> -<td class="colFirst"><code>java.lang.Object</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#Z:Z__getitem__-java.lang.String-">__getitem__</a></span>(java.lang.String key)</code> -<div class="block">A hook that Jython uses.</div> -</td> -</tr> -<tr id="i1" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#Z:Z__setitem__-java.lang.String-java.lang.Object-">__setitem__</a></span>(java.lang.String key, - java.lang.Object o)</code> -<div class="block">A hook that Jython uses.</div> -</td> -</tr> -<tr id="i2" class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#applyEqualsOperator-freemarker.template.TemplateModel-freemarker.template.TemplateModel-">applyEqualsOperator</a></span>(<a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> leftValue, - <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> rightValue)</code> -<div class="block">Compares two <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a>-s according the rules of the FTL "==" operator.</div> -</td> -</tr> -<tr id="i3" class="rowColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#applyEqualsOperatorLenient-freemarker.template.TemplateModel-freemarker.template.TemplateModel-">applyEqualsOperatorLenient</a></span>(<a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> leftValue, - <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> rightValue)</code> -<div class="block">Compares two <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a>-s according the rules of the FTL "==" operator, except that if the two types - are incompatible, they are treated as non-equal instead of throwing an exception.</div> -</td> -</tr> -<tr id="i4" class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#applyGreaterThanOperator-freemarker.template.TemplateModel-freemarker.template.TemplateModel-">applyGreaterThanOperator</a></span>(<a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> leftValue, - <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> rightValue)</code> -<div class="block">Compares two <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a>-s according the rules of the FTL ">" operator.</div> -</td> -</tr> -<tr id="i5" class="rowColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#applyLessThanOperator-freemarker.template.TemplateModel-freemarker.template.TemplateModel-">applyLessThanOperator</a></span>(<a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> leftValue, - <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> rightValue)</code> -<div class="block">Compares two <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a>-s according the rules of the FTL "<" operator.</div> -</td> -</tr> -<tr id="i6" class="altColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#applyLessThanOrEqualsOperator-freemarker.template.TemplateModel-freemarker.template.TemplateModel-">applyLessThanOrEqualsOperator</a></span>(<a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> leftValue, - <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> rightValue)</code> -<div class="block">Compares two <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a>-s according the rules of the FTL "<" operator.</div> -</td> -</tr> -<tr id="i7" class="rowColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#applyWithGreaterThanOrEqualsOperator-freemarker.template.TemplateModel-freemarker.template.TemplateModel-">applyWithGreaterThanOrEqualsOperator</a></span>(<a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> leftValue, - <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> rightValue)</code> -<div class="block">Compares two <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a>-s according the rules of the FTL ">=" operator.</div> -</td> -</tr> -<tr id="i8" class="altColor"> -<td class="colFirst"><code>java.text.NumberFormat</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getCNumberFormat--">getCNumberFormat</a></span>()</code> -<div class="block">Returns the <code>NumberFormat</code> used for the <tt>c</tt> built-in.</div> -</td> -</tr> -<tr id="i9" class="rowColor"> -<td class="colFirst"><code><a href="../../freemarker/template/Configuration.html" title="class in freemarker.template">Configuration</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getConfiguration--">getConfiguration</a></span>()</code> </td> -</tr> -<tr id="i10" class="altColor"> -<td class="colFirst"><code><a href="../../freemarker/core/DirectiveCallPlace.html" title="interface in freemarker.core">DirectiveCallPlace</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getCurrentDirectiveCallPlace--">getCurrentDirectiveCallPlace</a></span>()</code> -<div class="block">Gets the currently executing <em>custom</em> directive's call place information, or <code>null</code> if there's no - executing custom directive.</div> -</td> -</tr> -<tr id="i11" class="rowColor"> -<td class="colFirst"><code>static <a href="../../freemarker/core/Environment.html" title="class in freemarker.core">Environment</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getCurrentEnvironment--">getCurrentEnvironment</a></span>()</code> -<div class="block">Retrieves the environment object associated with the current thread, or <code>null</code> if there's no template - processing going on in this thread.</div> -</td> -</tr> -<tr id="i12" class="altColor"> -<td class="colFirst"><code><a href="../../freemarker/core/Environment.Namespace.html" title="class in freemarker.core">Environment.Namespace</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getCurrentNamespace--">getCurrentNamespace</a></span>()</code> -<div class="block">Returns the current namespace.</div> -</td> -</tr> -<tr id="i13" class="rowColor"> -<td class="colFirst"><code><a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getCurrentTemplate--">getCurrentTemplate</a></span>()</code> -<div class="block">Returns the <a href="../../freemarker/template/Template.html" title="class in freemarker.template"><code>Template</code></a> that we are "lexically" inside at the moment.</div> -</td> -</tr> -<tr id="i14" class="altColor"> -<td class="colFirst"><code><a href="../../freemarker/template/TemplateNodeModel.html" title="interface in freemarker.template">TemplateNodeModel</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getCurrentVisitorNode--">getCurrentVisitorNode</a></span>()</code> </td> -</tr> -<tr id="i15" class="rowColor"> -<td class="colFirst"><code>java.lang.Object</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getCustomState-java.lang.Object-">getCustomState</a></span>(java.lang.Object identityKey)</code> -<div class="block">Returns the value of a custom state variable, or <code>null</code> if it's missing; see - <a href="../../freemarker/core/Environment.html#setCustomState-java.lang.Object-java.lang.Object-"><code>setCustomState(Object, Object)</code></a> for more.</div> -</td> -</tr> -<tr id="i16" class="altColor"> -<td class="colFirst"><code><a href="../../freemarker/template/TemplateHashModel.html" title="interface in freemarker.template">TemplateHashModel</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getDataModel--">getDataModel</a></span>()</code> -<div class="block">Returns a view of the data-model (also known as the template context in some other template engines) - that falls back to <a href="../../freemarker/template/Configuration.html#setSharedVariable-java.lang.String-freemarker.template.TemplateModel-">shared variables</a>.</div> -</td> -</tr> -<tr id="i17" class="rowColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getDefaultNS--">getDefaultNS</a></span>()</code> </td> -</tr> -<tr id="i18" class="altColor"> -<td class="colFirst"><code><a href="../../freemarker/core/Environment.Namespace.html" title="class in freemarker.core">Environment.Namespace</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getGlobalNamespace--">getGlobalNamespace</a></span>()</code> -<div class="block">Returns the name-space that contains the globally visible non-data-model variables (usually created with - <code>&lt;#global ...&gt;</code>).</div> -</td> -</tr> -<tr id="i19" class="rowColor"> -<td class="colFirst"><code><a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getGlobalVariable-java.lang.String-">getGlobalVariable</a></span>(java.lang.String name)</code> -<div class="block">Returns the globally visible variable of the given name (or null).</div> -</td> -</tr> -<tr id="i20" class="altColor"> -<td class="colFirst"><code><a href="../../freemarker/template/TemplateHashModel.html" title="interface in freemarker.template">TemplateHashModel</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getGlobalVariables--">getGlobalVariables</a></span>()</code> -<div class="block">Returns the read-only hash of globally visible variables.</div> -</td> -</tr> -<tr id="i21" class="rowColor"> -<td class="colFirst"><code>java.util.Set</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getKnownVariableNames--">getKnownVariableNames</a></span>()</code> -<div class="block">Returns a set of variable names that are known at the time of call.</div> -</td> -</tr> -<tr id="i22" class="altColor"> -<td class="colFirst"><code><a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getLocalVariable-java.lang.String-">getLocalVariable</a></span>(java.lang.String name)</code> -<div class="block">Returns the loop or macro local variable corresponding to this variable name.</div> -</td> -</tr> -<tr id="i23" class="rowColor"> -<td class="colFirst"><code><a href="../../freemarker/core/Environment.Namespace.html" title="class in freemarker.core">Environment.Namespace</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getMainNamespace--">getMainNamespace</a></span>()</code> -<div class="block">Returns the main namespace.</div> -</td> -</tr> -<tr id="i24" class="altColor"> -<td class="colFirst"><code><a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getMainTemplate--">getMainTemplate</a></span>()</code> -<div class="block">Returns the topmost <a href="../../freemarker/template/Template.html" title="class in freemarker.template"><code>Template</code></a>, with other words, the one for which this <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a> was created.</div> -</td> -</tr> -<tr id="i25" class="rowColor"> -<td class="colFirst"><code><a href="../../freemarker/core/Environment.Namespace.html" title="class in freemarker.core">Environment.Namespace</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getNamespace-java.lang.String-">getNamespace</a></span>(java.lang.String name)</code> -<div class="block">Returns the name-space for the name if exists, or null.</div> -</td> -</tr> -<tr id="i26" class="altColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getNamespaceForPrefix-java.lang.String-">getNamespaceForPrefix</a></span>(java.lang.String prefix)</code> </td> -</tr> -<tr id="i27" class="rowColor"> -<td class="colFirst"><code>java.io.Writer</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getOut--">getOut</a></span>()</code> </td> -</tr> -<tr id="i28" class="altColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getPrefixForNamespace-java.lang.String-">getPrefixForNamespace</a></span>(java.lang.String nsURI)</code> </td> -</tr> -<tr id="i29" class="rowColor"> -<td class="colFirst"><code><a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getTemplate--">getTemplate</a></span>()</code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">Use <a href="../../freemarker/core/Environment.html#getMainTemplate--"><code>getMainTemplate()</code></a> instead (or <a href="../../freemarker/core/Environment.html#getCurrentNamespace--"><code>getCurrentNamespace()</code></a> and then - <a href="../../freemarker/core/Environment.Namespace.html#getTemplate--"><code>Environment.Namespace.getTemplate()</code></a>); the value returned by this method is often not what you expect when - it comes to macro/function invocations.</span></div> -</div> -</td> -</tr> -<tr id="i30" class="altColor"> -<td class="colFirst"><code><a href="../../freemarker/core/TemplateDateFormat.html" title="class in freemarker.core">TemplateDateFormat</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getTemplateDateFormat-int-java.lang.Class-">getTemplateDateFormat</a></span>(int dateType, - java.lang.Class<? extends java.util.Date> dateClass)</code> -<div class="block">Gets a <a href="../../freemarker/core/TemplateDateFormat.html" title="class in freemarker.core"><code>TemplateDateFormat</code></a> using the date/time/datetime format settings and the current locale and time - zone.</div> -</td> -</tr> -<tr id="i31" class="rowColor"> -<td class="colFirst"><code><a href="../../freemarker/core/TemplateDateFormat.html" title="class in freemarker.core">TemplateDateFormat</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getTemplateDateFormat-java.lang.String-int-java.lang.Class-">getTemplateDateFormat</a></span>(java.lang.String formatString, - int dateType, - java.lang.Class<? extends java.util.Date> dateClass)</code> -<div class="block">Gets a <a href="../../freemarker/core/TemplateDateFormat.html" title="class in freemarker.core"><code>TemplateDateFormat</code></a> for the specified format string and the current locale and time zone.</div> -</td> -</tr> -<tr id="i32" class="altColor"> -<td class="colFirst"><code><a href="../../freemarker/core/TemplateDateFormat.html" title="class in freemarker.core">TemplateDateFormat</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getTemplateDateFormat-java.lang.String-int-java.lang.Class-java.util.Locale-">getTemplateDateFormat</a></span>(java.lang.String formatString, - int dateType, - java.lang.Class<? extends java.util.Date> dateClass, - java.util.Locale locale)</code> -<div class="block">Like <a href="../../freemarker/core/Environment.html#getTemplateDateFormat-java.lang.String-int-java.lang.Class-"><code>getTemplateDateFormat(String, int, Class)</code></a>, but allows you to use a different locale than the - current one.</div> -</td> -</tr> -<tr id="i33" class="rowColor"> -<td class="colFirst"><code><a href="../../freemarker/core/TemplateDateFormat.html" title="class in freemarker.core">TemplateDateFormat</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getTemplateDateFormat-java.lang.String-int-java.lang.Class-java.util.Locale-java.util.TimeZone-java.util.TimeZone-">getTemplateDateFormat</a></span>(java.lang.String formatString, - int dateType, - java.lang.Class<? extends java.util.Date> dateClass, - java.util.Locale locale, - java.util.TimeZone timeZone, - java.util.TimeZone sqlDateAndTimeTimeZone)</code> -<div class="block">Like <a href="../../freemarker/core/Environment.html#getTemplateDateFormat-java.lang.String-int-java.lang.Class-"><code>getTemplateDateFormat(String, int, Class)</code></a>, but allows you to use a different locale and time zone - than the current one.</div> -</td> -</tr> -<tr id="i34" class="altColor"> -<td class="colFirst"><code><a href="../../freemarker/core/TemplateDateFormat.html" title="class in freemarker.core">TemplateDateFormat</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getTemplateDateFormat-java.lang.String-int-java.util.Locale-java.util.TimeZone-boolean-">getTemplateDateFormat</a></span>(java.lang.String formatString, - int dateType, - java.util.Locale locale, - java.util.TimeZone timeZone, - boolean zonelessInput)</code> -<div class="block">Gets a <a href="../../freemarker/core/TemplateDateFormat.html" title="class in freemarker.core"><code>TemplateDateFormat</code></a> for the specified parameters.</div> -</td> -</tr> -<tr id="i35" class="rowColor"> -<td class="colFirst"><code><a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getTemplateForImporting-java.lang.String-">getTemplateForImporting</a></span>(java.lang.String name)</code> -<div class="block">Gets a template for importing; used with <a href="../../freemarker/core/Environment.html#importLib-freemarker.template.Template-java.lang.String-"><code>importLib(Template importedTemplate, String namespace)</code></a>.</div> -</td> -</tr> -<tr id="i36" class="altColor"> -<td class="colFirst"><code><a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getTemplateForInclusion-java.lang.String-java.lang.String-boolean-">getTemplateForInclusion</a></span>(java.lang.String name, - java.lang.String encoding, - boolean parse)</code> -<div class="block">Same as <a href="../../freemarker/core/Environment.html#getTemplateForInclusion-java.lang.String-java.lang.String-boolean-boolean-"><code>getTemplateForInclusion(String, String, boolean, boolean)</code></a> with <code>false</code> - <code>ignoreMissing</code> argument.</div> -</td> -</tr> -<tr id="i37" class="rowColor"> -<td class="colFirst"><code><a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getTemplateForInclusion-java.lang.String-java.lang.String-boolean-boolean-">getTemplateForInclusion</a></span>(java.lang.String name, - java.lang.String encoding, - boolean parseAsFTL, - boolean ignoreMissing)</code> -<div class="block">Gets a template for inclusion; used for implementing <a href="../../freemarker/core/Environment.html#include-freemarker.template.Template-"><code>include(Template includedTemplate)</code></a>.</div> -</td> -</tr> -<tr id="i38" class="altColor"> -<td class="colFirst"><code><a href="../../freemarker/core/TemplateNumberFormat.html" title="class in freemarker.core">TemplateNumberFormat</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getTemplateNumberFormat--">getTemplateNumberFormat</a></span>()</code> -<div class="block">Returns the current number format (<a href="../../freemarker/core/Configurable.html#getNumberFormat--"><code>Configurable.getNumberFormat()</code></a>) as <a href="../../freemarker/core/TemplateNumberFormat.html" title="class in freemarker.core"><code>TemplateNumberFormat</code></a>.</div> -</td> -</tr> -<tr id="i39" class="rowColor"> -<td class="colFirst"><code><a href="../../freemarker/core/TemplateNumberFormat.html" title="class in freemarker.core">TemplateNumberFormat</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getTemplateNumberFormat-java.lang.String-">getTemplateNumberFormat</a></span>(java.lang.String formatString)</code> -<div class="block">Returns the number format as <a href="../../freemarker/core/TemplateNumberFormat.html" title="class in freemarker.core"><code>TemplateNumberFormat</code></a> for the given format string and the current locale.</div> -</td> -</tr> -<tr id="i40" class="altColor"> -<td class="colFirst"><code><a href="../../freemarker/core/TemplateNumberFormat.html" title="class in freemarker.core">TemplateNumberFormat</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getTemplateNumberFormat-java.lang.String-java.util.Locale-">getTemplateNumberFormat</a></span>(java.lang.String formatString, - java.util.Locale locale)</code> -<div class="block">Returns the number format as <a href="../../freemarker/core/TemplateNumberFormat.html" title="class in freemarker.core"><code>TemplateNumberFormat</code></a>, for the given format string and locale.</div> -</td> -</tr> -<tr id="i41" class="rowColor"> -<td class="colFirst"><code><a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#getVariable-java.lang.String-">getVariable</a></span>(java.lang.String name)</code> -<div class="block">Returns the variable that is visible in this context, or <code>null</code> if the variable is not found.</div> -</td> -</tr> -<tr id="i42" class="altColor"> -<td class="colFirst"><code><a href="../../freemarker/core/Environment.Namespace.html" title="class in freemarker.core">Environment.Namespace</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#importLib-java.lang.String-java.lang.String-">importLib</a></span>(java.lang.String templateName, - java.lang.String targetNsVarName)</code> -<div class="block">Emulates <code>import</code> directive, except that <code>templateName</code> must be template root relative.</div> -</td> -</tr> -<tr id="i43" class="rowColor"> -<td class="colFirst"><code><a href="../../freemarker/core/Environment.Namespace.html" title="class in freemarker.core">Environment.Namespace</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#importLib-java.lang.String-java.lang.String-boolean-">importLib</a></span>(java.lang.String templateName, - java.lang.String targetNsVarName, - boolean lazy)</code> -<div class="block">Like <a href="../../freemarker/core/Environment.html#importLib-java.lang.String-java.lang.String-"><code>importLib(String, String)</code></a>, but you can specify if you want a - <a href="../../freemarker/core/Configurable.html#setLazyImports-boolean-">lazy import</a> or not.</div> -</td> -</tr> -<tr id="i44" class="altColor"> -<td class="colFirst"><code><a href="../../freemarker/core/Environment.Namespace.html" title="class in freemarker.core">Environment.Namespace</a></code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#importLib-freemarker.template.Template-java.lang.String-">importLib</a></span>(<a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a> loadedTemplate, - java.lang.String targetNsVarName)</code> -<div class="block">Does what the <code>#import</code> directive does, but with an already loaded template.</div> -</td> -</tr> -<tr id="i45" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#include-java.lang.String-java.lang.String-boolean-">include</a></span>(java.lang.String name, - java.lang.String encoding, - boolean parse)</code> -<div class="block">Emulates <code>include</code> directive, except that <code>name</code> must be template root relative.</div> -</td> -</tr> -<tr id="i46" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#include-freemarker.template.Template-">include</a></span>(<a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a> includedTemplate)</code> -<div class="block">Processes a Template in the context of this <code>Environment</code>, including its output in the - <code>Environment</code>'s Writer.</div> -</td> -</tr> -<tr id="i47" class="rowColor"> -<td class="colFirst"><code>boolean</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#isInAttemptBlock--">isInAttemptBlock</a></span>()</code> -<div class="block">Tells if we are inside an <tt>#attempt</tt> block (but before <tt>#recover</tt>).</div> -</td> -</tr> -<tr id="i48" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#outputInstructionStack-java.io.PrintWriter-">outputInstructionStack</a></span>(java.io.PrintWriter pw)</code> -<div class="block">Prints the current FTL stack trace.</div> -</td> -</tr> -<tr id="i49" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#process--">process</a></span>()</code> -<div class="block">Processes the template to which this environment belongs to.</div> -</td> -</tr> -<tr id="i50" class="altColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#rootBasedToAbsoluteTemplateName-java.lang.String-">rootBasedToAbsoluteTemplateName</a></span>(java.lang.String rootBasedName)</code> -<div class="block">Converts a root based name (a name that's either relative to the root, or is absolute), which are typically used - by the API (such as for <a href="../../freemarker/template/Configuration.html#getTemplate-java.lang.String-"><code>Configuration.getTemplate(String)</code></a>), to an absolute name, which can be safely - passed to <code><#include path></code> and such, as it won't be misinterpreted to be relative to the directory of the - template.</div> -</td> -</tr> -<tr id="i51" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#setCurrentVisitorNode-freemarker.template.TemplateNodeModel-">setCurrentVisitorNode</a></span>(<a href="../../freemarker/template/TemplateNodeModel.html" title="interface in freemarker.template">TemplateNodeModel</a> node)</code> -<div class="block">sets TemplateNodeModel as the current visitor node.</div> -</td> -</tr> -<tr id="i52" class="altColor"> -<td class="colFirst"><code>java.lang.Object</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#setCustomState-java.lang.Object-java.lang.Object-">setCustomState</a></span>(java.lang.Object identityKey, - java.lang.Object value)</code> -<div class="block">Sets the value of a custom state variable.</div> -</td> -</tr> -<tr id="i53" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#setDateFormat-java.lang.String-">setDateFormat</a></span>(java.lang.String dateFormat)</code> -<div class="block">Sets the format used to convert <code>Date</code>-s that are date-only (no time part) values to string-s, - also the format that <code>someString?date</code> will use to parse strings.</div> -</td> -</tr> -<tr id="i54" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#setDateTimeFormat-java.lang.String-">setDateTimeFormat</a></span>(java.lang.String dateTimeFormat)</code> -<div class="block">Sets the format used to convert <code>Date</code>-s that are date-time (timestamp) values to string-s, - also the format that <code>someString?datetime</code> will use to parse strings.</div> -</td> -</tr> -<tr id="i55" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#setGlobalVariable-java.lang.String-freemarker.template.TemplateModel-">setGlobalVariable</a></span>(java.lang.String name, - <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> model)</code> -<div class="block">Sets a variable that is visible globally.</div> -</td> -</tr> -<tr id="i56" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#setLocale-java.util.Locale-">setLocale</a></span>(java.util.Locale locale)</code> -<div class="block">Sets the locale used for number and date formatting (among others), also the locale used for searching - localized template variations when no locale was explicitly requested.</div> -</td> -</tr> -<tr id="i57" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#setLocalVariable-java.lang.String-freemarker.template.TemplateModel-">setLocalVariable</a></span>(java.lang.String name, - <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> model)</code> -<div class="block">Sets a local variable (one effective only during a macro invocation).</div> -</td> -</tr> -<tr id="i58" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#setNumberFormat-java.lang.String-">setNumberFormat</a></span>(java.lang.String formatName)</code> -<div class="block">Sets the default number format used to convert numbers to strings.</div> -</td> -</tr> -<tr id="i59" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#setOut-java.io.Writer-">setOut</a></span>(java.io.Writer out)</code> </td> -</tr> -<tr id="i60" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#setOutputEncoding-java.lang.String-">setOutputEncoding</a></span>(java.lang.String outputEncoding)</code> -<div class="block">Informs FreeMarker about the charset used for the output.</div> -</td> -</tr> -<tr id="i61" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#setSQLDateAndTimeTimeZone-java.util.TimeZone-">setSQLDateAndTimeTimeZone</a></span>(java.util.TimeZone timeZone)</code> -<div class="block">Sets the time zone used when dealing with <code>java.sql.Date</code> and - <code>java.sql.Time</code> values.</div> -</td> -</tr> -<tr id="i62" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#setTemplateExceptionHandler-freemarker.template.TemplateExceptionHandler-">setTemplateExceptionHandler</a></span>(<a href="../../freemarker/template/TemplateExceptionHandler.html" title="interface in freemarker.template">TemplateExceptionHandler</a> templateExceptionHandler)</code> -<div class="block">Sets the exception handler used to handle exceptions occurring inside templates.</div> -</td> -</tr> -<tr id="i63" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#setTimeFormat-java.lang.String-">setTimeFormat</a></span>(java.lang.String timeFormat)</code> -<div class="block">Sets the format used to convert <code>Date</code>-s that are time (no date part) values to string-s, also - the format that <code>someString?time</code> will use to parse strings.</div> -</td> -</tr> -<tr id="i64" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#setTimeZone-java.util.TimeZone-">setTimeZone</a></span>(java.util.TimeZone timeZone)</code> -<div class="block">Sets the time zone to use when formatting date/time values.</div> -</td> -</tr> -<tr id="i65" class="rowColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#setURLEscapingCharset-java.lang.String-">setURLEscapingCharset</a></span>(java.lang.String urlEscapingCharset)</code> -<div class="block">Sets the URL escaping (URL encoding, percentage encoding) charset.</div> -</td> -</tr> -<tr id="i66" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#setVariable-java.lang.String-freemarker.template.TemplateModel-">setVariable</a></span>(java.lang.String name, - <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a> model)</code> -<div class="block">Sets a variable in the current namespace.</div> -</td> -</tr> -<tr id="i67" class="rowColor"> -<td class="colFirst"><code>java.lang.String</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#toFullTemplateName-java.lang.String-java.lang.String-">toFullTemplateName</a></span>(java.lang.String baseName, - java.lang.String targetName)</code> -<div class="block">Resolves a reference to a template (like the one used in <code>#include</code> or <code>#import</code>), assuming a base - name.</div> -</td> -</tr> -<tr id="i68" class="altColor"> -<td class="colFirst"><code>void</code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../freemarker/core/Environment.html#visit-freemarker.core.TemplateElement-freemarker.template.TemplateDirectiveModel-java.util.Map-java.util.List-">visit</a></span>(freemarker.core.TemplateElement element, - <a href="../../freemarker/template/TemplateDirectiveModel.html" title="interface in freemarker.template">TemplateDirectiveModel</a> directiveModel, - java.util.Map args, - java.util.List bodyParameterNames)</code> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> -<div class="block"><span class="deprecationComment">Should be internal API</span></div> -</div> -</td> -</tr> -</table> -<ul class="blockList"> -<li class="blockList"><a name="methods.inherited.from.class.freemarker.core.Configurable"> -<!-- --> -</a> -<h3>Methods inherited from class freemarker.core.<a href="../../freemarker/core/Configurable.html" title="class in freemarker.core">Configurable</a></h3> -<code><a href="../../freemarker/core/Configurable.html#addAutoImport-java.lang.String-java.lang.String-">addAutoImport</a>, <a href="../../freemarker/core/Configurable.html#addAutoInclude-java.lang.String-">addAutoInclude</a>, <a href="../../freemarker/core/Configurable.html#clone--">clone</a>, <a href="../../freemarker/core/Configurable.html#doAutoImportsAndIncludes-freemarker.core.Environment-">doAutoImportsAndIncludes</a>, <a href="../../freemarker/core/Configurable.html#getArithmeticEngine--">getArithmeticEngine</a>, <a href="../../freemarker/core/Configurable.html#getAttemptExceptionReporter--">getAttemptExceptionReporter</a>, <a href="../../freemarker/core/Configurable.html#getAutoFlush--">getAutoFlush</a>, <a href="../../freemarker/core/Configurable.html#getAutoImports--">getAutoImports</a>, <a href="../../freemarker/core/Configurable.html#getAutoImportsWithoutFallback--">getAutoImportsWithoutFallback</a>, <a href="../../freemarker/core/Configurable.html#getAutoIncludes--">ge tAutoIncludes</a>, <a href="../../freemarker/core/Configurable.html#getAutoIncludesWithoutFallback--">getAutoIncludesWithoutFallback</a>, <a href="../../freemarker/core/Configurable.html#getBooleanFormat--">getBooleanFormat</a>, <a href="../../freemarker/core/Configurable.html#getClassicCompatibleAsInt--">getClassicCompatibleAsInt</a>, <a href="../../freemarker/core/Configurable.html#getCorrectedNameForUnknownSetting-java.lang.String-">getCorrectedNameForUnknownSetting</a>, <a href="../../freemarker/core/Configurable.html#getCustomAttribute-java.lang.String-">getCustomAttribute</a>, <a href="../../freemarker/core/Configurable.html#getCustomAttributeNames--">getCustomAttributeNames</a>, <a href="../../freemarker/core/Configurable.html#getCustomDateFormat-java.lang.String-">getCustomDateFormat</a>, <a href="../../freemarker/core/Configurable.html#getCustomDateFormats--">getCustomDateFormats</a>, <a href="../../freemarker/core/Configurable.html#getCustomDateFormatsWithoutFallback--">ge tCustomDateFormatsWithoutFallback</a>, <a href="../../freemarker/core/Configurable.html#getCustomNumberFormat-java.lang.String-">getCustomNumberFormat</a>, <a href="../../freemarker/core/Configurable.html#getCustomNumberFormats--">getCustomNumberFormats</a>, <a href="../../freemarker/core/Configurable.html#getCustomNumberFormatsWithoutFallback--">getCustomNumberFormatsWithoutFallback</a>, <a href="../../freemarker/core/Configurable.html#getDateFormat--">getDateFormat</a>, <a href="../../freemarker/core/Configurable.html#getDateTimeFormat--">getDateTimeFormat</a>, <a href="../../freemarker/core/Configurable.html#getEnvironment--">getEnvironment</a>, <a href="../../freemarker/core/Configurable.html#getLazyAutoImports--">getLazyAutoImports</a>, <a href="../../freemarker/core/Configurable.html#getLazyImports--">getLazyImports</a>, <a href="../../freemarker/core/Configurable.html#getLocale--">getLocale</a>, <a href="../../freemarker/core/Configurable.html#getLogTemplateExceptions--">getL ogTemplateExceptions</a>, <a href="../../freemarker/core/Configurable.html#getNewBuiltinClassResolver--">getNewBuiltinClassResolver</a>, <a href="../../freemarker/core/Configurable.html#getNumberFormat--">getNumberFormat</a>, <a href="../../freemarker/core/Configurable.html#getObjectWrapper--">getObjectWrapper</a>, <a href="../../freemarker/core/Configurable.html#getOutputEncoding--">getOutputEncoding</a>, <a href="../../freemarker/core/Configurable.html#getParent--">getParent</a>, <a href="../../freemarker/core/Configurable.html#getSetting-java.lang.String-">getSetting</a>, <a href="../../freemarker/core/Configurable.html#getSettingNames-boolean-">getSettingNames</a>, <a href="../../freemarker/core/Configurable.html#getSettings--">getSettings</a>, <a href="../../freemarker/core/Configurable.html#getShowErrorTips--">getShowErrorTips</a>, <a href="../../freemarker/core/Configurable.html#getSQLDateAndTimeTimeZone--">getSQLDateAndTimeTimeZone</a>, <a href="../../freemarker/core/Configu rable.html#getTemplateExceptionHandler--">getTemplateExceptionHandler</a>, <a href="../../freemarker/core/Configurable.html#getTimeFormat--">getTimeFormat</a>, <a href="../../freemarker/core/Configurable.html#getTimeZone--">getTimeZone</a>, <a href="../../freemarker/core/Configurable.html#getURLEscapingCharset--">getURLEscapingCharset</a>, <a href="../../freemarker/core/Configurable.html#getWrapUncheckedExceptions--">getWrapUncheckedExceptions</a>, <a href="../../freemarker/core/Configurable.html#hasCustomFormats--">hasCustomFormats</a>, <a href="../../freemarker/core/Configurable.html#invalidSettingValueException-java.lang.String-java.lang.String-">invalidSettingValueException</a>, <a href="../../freemarker/core/Configurable.html#isAPIBuiltinEnabled--">isAPIBuiltinEnabled</a>, <a href="../../freemarker/core/Configurable.html#isAPIBuiltinEnabledSet--">isAPIBuiltinEnabledSet</a>, <a href="../../freemarker/core/Configurable.html#isArithmeticEngineSet--">isArithmeticEngineSet</a>, <a h ref="../../freemarker/core/Configurable.html#isAttemptExceptionReporterSet--">isAttemptExceptionReporterSet</a>, <a href="../../freemarker/core/Configurable.html#isAutoFlushSet--">isAutoFlushSet</a>, <a href="../../freemarker/core/Configurable.html#isAutoImportsSet--">isAutoImportsSet</a>, <a href="../../freemarker/core/Configurable.html#isAutoIncludesSet--">isAutoIncludesSet</a>, <a href="../../freemarker/core/Configurable.html#isBooleanFormatSet--">isBooleanFormatSet</a>, <a href="../../freemarker/core/Configurable.html#isClassicCompatible--">isClassicCompatible</a>, <a href="../../freemarker/core/Configurable.html#isClassicCompatibleSet--">isClassicCompatibleSet</a>, <a href="../../freemarker/core/Configurable.html#isCustomDateFormatsSet--">isCustomDateFormatsSet</a>, <a href="../../freemarker/core/Configurable.html#isCustomNumberFormatsSet--">isCustomNumberFormatsSet</a>, <a href="../../freemarker/core/Configurable.html#isDateFormatSet--">isDateFormatSet</a>, <a href="../../free marker/core/Configurable.html#isDateTimeFormatSet--">isDateTimeFormatSet</a>, <a href="../../freemarker/core/Configurable.html#isLazyAutoImportsSet--">isLazyAutoImportsSet</a>, <a href="../../freemarker/core/Configurable.html#isLazyImportsSet--">isLazyImportsSet</a>, <a href="../../freemarker/core/Configurable.html#isLocaleSet--">isLocaleSet</a>, <a href="../../freemarker/core/Configurable.html#isLogTemplateExceptionsSet--">isLogTemplateExceptionsSet</a>, <a href="../../freemarker/core/Configurable.html#isNewBuiltinClassResolverSet--">isNewBuiltinClassResolverSet</a>, <a href="../../freemarker/core/Configurable.html#isNumberFormatSet--">isNumberFormatSet</a>, <a href="../../freemarker/core/Configurable.html#isObjectWrapperSet--">isObjectWrapperSet</a>, <a href="../../freemarker/core/Configurable.html#isOutputEncodingSet--">isOutputEncodingSet</a>, <a href="../../freemarker/core/Configurable.html#isShowErrorTipsSet--">isShowErrorTipsSet</a>, <a href="../../freemarker/core/Configurabl e.html#isSQLDateAndTimeTimeZoneSet--">isSQLDateAndTimeTimeZoneSet</a>, <a href="../../freemarker/core/Configurable.html#isTemplateExceptionHandlerSet--">isTemplateExceptionHandlerSet</a>, <a href="../../freemarker/core/Configurable.html#isTimeFormatSet--">isTimeFormatSet</a>, <a href="../../freemarker/core/Configurable.html#isTimeZoneSet--">isTimeZoneSet</a>, <a href="../../freemarker/core/Configurable.html#isURLEscapingCharsetSet--">isURLEscapingCharsetSet</a>, <a href="../../freemarker/core/Configurable.html#isWrapUncheckedExceptionsSet--">isWrapUncheckedExceptionsSet</a>, <a href="../../freemarker/core/Configurable.html#parseAsImportList-java.lang.String-">parseAsImportList</a>, <a href="../../freemarker/core/Configurable.html#parseAsList-java.lang.String-">parseAsList</a>, <a href="../../freemarker/core/Configurable.html#parseAsSegmentedList-java.lang.String-">parseAsSegmentedList</a>, <a href="../../freemarker/core/Configurable.html#removeAutoImport-java.lang.String-">removeAut oImport</a>, <a href="../../freemarker/core/Configurable.html#removeAutoInclude-java.lang.String-">removeAutoInclude</a>, <a href="../../freemarker/core/Configurable.html#removeCustomAttribute-java.lang.String-">removeCustomAttribute</a>, <a href="../../freemarker/core/Configurable.html#setAPIBuiltinEnabled-boolean-">setAPIBuiltinEnabled</a>, <a href="../../freemarker/core/Configurable.html#setArithmeticEngine-freemarker.core.ArithmeticEngine-">setArithmeticEngine</a>, <a href="../../freemarker/core/Configurable.html#setAttemptExceptionReporter-freemarker.template.AttemptExceptionReporter-">setAttemptExceptionReporter</a>, <a href="../../freemarker/core/Configurable.html#setAutoFlush-boolean-">setAutoFlush</a>, <a href="../../freemarker/core/Configurable.html#setAutoImports-java.util.Map-">setAutoImports</a>, <a href="../../freemarker/core/Configurable.html#setAutoIncludes-java.util.List-">setAutoIncludes</a>, <a href="../../freemarker/core/Configurable.html#setBooleanFormat-java.la ng.String-">setBooleanFormat</a>, <a href="../../freemarker/core/Configurable.html#setClassicCompatible-boolean-">setClassicCompatible</a>, <a href="../../freemarker/core/Configurable.html#setClassicCompatibleAsInt-int-">setClassicCompatibleAsInt</a>, <a href="../../freemarker/core/Configurable.html#setCustomAttribute-java.lang.String-java.lang.Object-">setCustomAttribute</a>, <a href="../../freemarker/core/Configurable.html#setCustomDateFormats-java.util.Map-">setCustomDateFormats</a>, <a href="../../freemarker/core/Configurable.html#setCustomNumberFormats-java.util.Map-">setCustomNumberFormats</a>, <a href="../../freemarker/core/Configurable.html#setLazyAutoImports-java.lang.Boolean-">setLazyAutoImports</a>, <a href="../../freemarker/core/Configurable.html#setLazyImports-boolean-">setLazyImports</a>, <a href="../../freemarker/core/Configurable.html#setLogTemplateExceptions-boolean-">setLogTemplateExceptions</a>, <a href="../../freemarker/core/Configurable.html#setNewBuiltinClassRe solver-freemarker.core.TemplateClassResolver-">setNewBuiltinClassResolver</a>, <a href="../../freemarker/core/Configurable.html#setObjectWrapper-freemarker.template.ObjectWrapper-">setObjectWrapper</a>, <a href="../../freemarker/core/Configurable.html#setSetting-java.lang.String-java.lang.String-">setSetting</a>, <a href="../../freemarker/core/Configurable.html#setSettings-java.io.InputStream-">setSettings</a>, <a href="../../freemarker/core/Configurable.html#setSettings-java.util.Properties-">setSettings</a>, <a href="../../freemarker/core/Configurable.html#setShowErrorTips-boolean-">setShowErrorTips</a>, <a href="../../freemarker/core/Configurable.html#setStrictBeanModels-boolean-">setStrictBeanModels</a>, <a href="../../freemarker/core/Configurable.html#settingValueAssignmentException-java.lang.String-java.lang.String-java.lang.Throwable-">settingValueAssignmentException</a>, <a href="../../freemarker/core/Configurable.html#setWrapUncheckedExceptions-boolean-">setWrapUncheckedExc eptions</a>, <a href="../../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.Object</h3> -<code>equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> -</ul> -</li> -</ul> -</li> -</ul> -</div> -<div class="details"> -<ul class="blockList"> -<li class="blockList"> -<!-- ========= CONSTRUCTOR DETAIL ======== --> -<ul class="blockList"> -<li class="blockList"><a name="constructor.detail"> -<!-- --> -</a> -<h3>Constructor Detail</h3> -<a name="Environment-freemarker.template.Template-freemarker.template.TemplateHashModel-java.io.Writer-"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>Environment</h4> -<pre>public Environment(<a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a> template, - <a href="../../freemarker/template/TemplateHashModel.html" title="interface in freemarker.template">TemplateHashModel</a> rootDataModel, - java.io.Writer out)</pre> -</li> -</ul> -</li> -</ul> -<!-- ============ METHOD DETAIL ========== --> -<ul class="blockList"> -<li class="blockList"><a name="method.detail"> -<!-- --> -</a> -<h3>Method Detail</h3> -<a name="getCurrentEnvironment--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getCurrentEnvironment</h4> -<pre>public static <a href="../../freemarker/core/Environment.html" title="class in freemarker.core">Environment</a> getCurrentEnvironment()</pre> -<div class="block">Retrieves the environment object associated with the current thread, or <code>null</code> if there's no template - processing going on in this thread. Data model implementations that need access to the environment can call this - method to obtain the environment object that represents the template processing that is currently running on the - current thread.</div> -</li> -</ul> -<a name="getTemplate--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getTemplate</h4> -<pre>@Deprecated -public <a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a> getTemplate()</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Use <a href="../../freemarker/core/Environment.html#getMainTemplate--"><code>getMainTemplate()</code></a> instead (or <a href="../../freemarker/core/Environment.html#getCurrentNamespace--"><code>getCurrentNamespace()</code></a> and then - <a href="../../freemarker/core/Environment.Namespace.html#getTemplate--"><code>Environment.Namespace.getTemplate()</code></a>); the value returned by this method is often not what you expect when - it comes to macro/function invocations.</span></div> -<div class="block">Despite its name it just returns <a href="../../freemarker/core/Configurable.html#getParent--"><code>Configurable.getParent()</code></a>. If <a href="../../freemarker/template/Configuration.html#getIncompatibleImprovements--"><code>Configuration.getIncompatibleImprovements()</code></a> is - at least 2.3.22, then that will be the same as <a href="../../freemarker/core/Environment.html#getMainTemplate--"><code>getMainTemplate()</code></a>. Otherwise the returned value follows - the <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a> parent switchings that occur at <code>#include</code>/<code>#import</code> and <code>#nested</code> - directive calls, that is, it's not very meaningful outside FreeMarker internals.</div> -</li> -</ul> -<a name="getMainTemplate--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getMainTemplate</h4> -<pre>public <a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a> getMainTemplate()</pre> -<div class="block">Returns the topmost <a href="../../freemarker/template/Template.html" title="class in freemarker.template"><code>Template</code></a>, with other words, the one for which this <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a> was created. - That template will never change, like <code>#include</code> or macro calls don't change it. This method never returns - <code>null</code>.</div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>2.3.22</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../freemarker/core/Environment.html#getCurrentNamespace--"><code>getCurrentNamespace()</code></a></dd> -</dl> -</li> -</ul> -<a name="getCurrentTemplate--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getCurrentTemplate</h4> -<pre>public <a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a> getCurrentTemplate()</pre> -<div class="block">Returns the <a href="../../freemarker/template/Template.html" title="class in freemarker.template"><code>Template</code></a> that we are "lexically" inside at the moment. This template will change when - entering an <code>#include</code> or calling a macro or function in another template, or returning to yet another - template with <code>#nested</code>. When you are calling a directive that's implemented in Java or a Java method - from a template, the current template will be the last current template, not <code>null</code>. This method never - returns <code>null</code>.</div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>2.3.23</dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../freemarker/core/Environment.html#getMainTemplate--"><code>getMainTemplate()</code></a>, -<a href="../../freemarker/core/Environment.html#getCurrentNamespace--"><code>getCurrentNamespace()</code></a></dd> -</dl> -</li> -</ul> -<a name="getCurrentDirectiveCallPlace--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>getCurrentDirectiveCallPlace</h4> -<pre>public <a href="../../freemarker/core/DirectiveCallPlace.html" title="interface in freemarker.core">DirectiveCallPlace</a> getCurrentDirectiveCallPlace()</pre> -<div class="block">Gets the currently executing <em>custom</em> directive's call place information, or <code>null</code> if there's no - executing custom directive. This currently only works for calls made from templates with the <code><@...></code> - syntax. This should only be called from the <a href="../../freemarker/template/TemplateDirectiveModel.html" title="interface in freemarker.template"><code>TemplateDirectiveModel</code></a> that was invoked with <code><@...></code>, - otherwise its return value is not defined by this API (it's usually <code>null</code>).</div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>2.3.22</dd> -</dl> -</li> -</ul> -<a name="process--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>process</h4> -<pre>public void process() - throws <a href="../../freemarker/template/TemplateException.html" title="class in freemarker.template">TemplateException</a>, - java.io.IOException</pre> -<div class="block">Processes the template to which this environment belongs to.</div> -<dl> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../freemarker/template/TemplateException.html" title="class in freemarker.template">TemplateException</a></code></dd> -<dd><code>java.io.IOException</code></dd> -</dl> -</li> -</ul> -<a name="visit-freemarker.core.TemplateElement-freemarker.template.TemplateDirectiveModel-java.util.Map-java.util.List-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>visit</h4> -<pre>@Deprecated -public void visit(freemarker.core.TemplateElement element, - <a href="../../freemarker/template/TemplateDirectiveModel.html" title="interface in freemarker.template">TemplateDirectiveModel</a> directiveModel, - java.util.Map args, - java.util.List bodyParameterNames) - throws <a href="../../freemarker/template/TemplateException.html" title="class in freemarker.template">TemplateException</a>, - java.io.IOException</pre> -<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Should be internal API</span></div> -<dl> -<dt><span class="throwsLabel">Throws:</span></dt> -<dd><code><a href="../../freemarker/template/TemplateException.html" title="class in freemarker.template">TemplateException</a></code></dd> -<dd><code>java.io.IOException</code></dd> -</dl> -</li> -</ul> -<a name="isInAttemptBlock--"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>isInAttemptBlock</h4> -<pre>public boolean isInAttemptBlock()</pre> -<div class="block">Tells if we are inside an <tt>#attempt</tt> block (but before <tt>#recover</tt>). This can be useful for - <a href="../../freemarker/template/TemplateExceptionHandler.html" title="interface in freemarker.template"><code>TemplateExceptionHandler</code></a>-s, as then they may don't want to print the error to the output, as - <tt>#attempt</tt> will roll it back anyway.</div> -<dl> -<dt><span class="simpleTagLabel">Since:</span></dt> -<dd>2.3.20</dd> -</dl> -</li> -</ul> -<a name="setTemplateExceptionHandler-freemarker.template.TemplateExceptionHandler-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setTemplateExceptionHandler</h4> -<pre>public void setTemplateExceptionHandler(<a href="../../freemarker/template/TemplateExceptionHandler.html" title="interface in freemarker.template">TemplateExceptionHandler</a> templateExceptionHandler)</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/Configurable.html#setTemplateExceptionHandler-freemarker.template.TemplateExceptionHandler-">Configurable</a></code></span></div> -<div class="block">Sets the exception handler used to handle exceptions occurring inside templates. - The default is <a href="../../freemarker/template/TemplateExceptionHandler.html#DEBUG_HANDLER"><code>TemplateExceptionHandler.DEBUG_HANDLER</code></a>. The recommended values are: - - <ul> - <li>In production systems: <a href="../../freemarker/template/TemplateExceptionHandler.html#RETHROW_HANDLER"><code>TemplateExceptionHandler.RETHROW_HANDLER</code></a> - <li>During development of HTML templates: <a href="../../freemarker/template/TemplateExceptionHandler.html#HTML_DEBUG_HANDLER"><code>TemplateExceptionHandler.HTML_DEBUG_HANDLER</code></a> - <li>During development of non-HTML templates: <a href="../../freemarker/template/TemplateExceptionHandler.html#DEBUG_HANDLER"><code>TemplateExceptionHandler.DEBUG_HANDLER</code></a> - </ul> - - <p>All of these will let the exception propagate further, so that you can catch it around - <a href="../../freemarker/template/Template.html#process-java.lang.Object-java.io.Writer-"><code>Template.process(Object, Writer)</code></a> for example. The difference is in what they print on the output before - they do that. - - <p>Note that the <a href="../../freemarker/template/TemplateExceptionHandler.html" title="interface in freemarker.template"><code>TemplateExceptionHandler</code></a> is not meant to be used for generating HTTP error pages. - Neither is it meant to be used to roll back the printed output. These should be solved outside template - processing when the exception raises from <a href="../../freemarker/template/Template.html#process-java.lang.Object-java.io.Writer-"><code>Template.process</code></a>. - <a href="../../freemarker/template/TemplateExceptionHandler.html" title="interface in freemarker.template"><code>TemplateExceptionHandler</code></a> meant to be used if you want to include special content <em>in</em> the template - output, or if you want to suppress certain exceptions. If you suppress an exception, and the - <a href="../../freemarker/core/Configurable.html#getLogTemplateExceptions--"><code>Configurable.getLogTemplateExceptions()</code></a> returns <code>false</code>, then it's the responsibility of the - <a href="../../freemarker/template/TemplateExceptionHandler.html" title="interface in freemarker.template"><code>TemplateExceptionHandler</code></a> to log the exception (if you want it to be logged).</div> -<dl> -<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> -<dd><code><a href="../../freemarker/core/Configurable.html#setTemplateExceptionHandler-freemarker.template.TemplateExceptionHandler-">setTemplateExceptionHandler</a></code> in class <code><a href="../../freemarker/core/Configurable.html" title="class in freemarker.core">Configurable</a></code></dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../freemarker/core/Configurable.html#setLogTemplateExceptions-boolean-"><code>Configurable.setLogTemplateExceptions(boolean)</code></a>, -<a href="../../freemarker/core/Configurable.html#setAttemptExceptionReporter-freemarker.template.AttemptExceptionReporter-"><code>Configurable.setAttemptExceptionReporter(AttemptExceptionReporter)</code></a></dd> -</dl> -</li> -</ul> -<a name="setLocale-java.util.Locale-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setLocale</h4> -<pre>public void setLocale(java.util.Locale locale)</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/Configurable.html#setLocale-java.util.Locale-">Configurable</a></code></span></div> -<div class="block">Sets the locale used for number and date formatting (among others), also the locale used for searching - localized template variations when no locale was explicitly requested. On the <a href="../../freemarker/template/Configuration.html" title="class in freemarker.template"><code>Configuration</code></a> level it - defaults to the default locale of system (of the JVM), for server-side application usually you should set it - explicitly in the <a href="../../freemarker/template/Configuration.html" title="class in freemarker.template"><code>Configuration</code></a> to use the preferred locale of your application instead.</div> -<dl> -<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> -<dd><code><a href="../../freemarker/core/Configurable.html#setLocale-java.util.Locale-">setLocale</a></code> in class <code><a href="../../freemarker/core/Configurable.html" title="class in freemarker.core">Configurable</a></code></dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../freemarker/template/Configuration.html#getTemplate-java.lang.String-java.util.Locale-"><code>Configuration.getTemplate(String, Locale)</code></a></dd> -</dl> -</li> -</ul> -<a name="setTimeZone-java.util.TimeZone-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setTimeZone</h4> -<pre>public void setTimeZone(java.util.TimeZone timeZone)</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/Configurable.html#setTimeZone-java.util.TimeZone-">Configurable</a></code></span></div> -<div class="block">Sets the time zone to use when formatting date/time values. - Defaults to the system time zone (<code>TimeZone.getDefault()</code>), regardless of the "locale" FreeMarker setting, - so in a server application you probably want to set it explicitly in the <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a> to match the - preferred time zone of target audience (like the Web page visitor). - - <p>If you or the templates set the time zone, you should probably also set - <a href="../../freemarker/core/Configurable.html#setSQLDateAndTimeTimeZone-java.util.TimeZone-"><code>Configurable.setSQLDateAndTimeTimeZone(TimeZone)</code></a>!</div> -<dl> -<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> -<dd><code><a href="../../freemarker/core/Configurable.html#setTimeZone-java.util.TimeZone-">setTimeZone</a></code> in class <code><a href="../../freemarker/core/Configurable.html" title="class in freemarker.core">Configurable</a></code></dd> -<dt><span class="seeLabel">See Also:</span></dt> -<dd><a href="../../freemarker/core/Configurable.html#setSQLDateAndTimeTimeZone-java.util.TimeZone-"><code>Configurable.setSQLDateAndTimeTimeZone(TimeZone)</code></a></dd> -</dl> -</li> -</ul> -<a name="setSQLDateAndTimeTimeZone-java.util.TimeZone-"> -<!-- --> -</a> -<ul class="blockList"> -<li class="blockList"> -<h4>setSQLDateAndTimeTimeZone</h4> -<pre>public void setSQLDateAndTimeTimeZone(java.util.TimeZone timeZone)</pre> -<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../freemarker/core/Configurable.html#setSQLDateAndTimeTimeZone-java.util.TimeZone-">Configurable</a></code></span></div> -<div class="block">Sets the time zone used when dealing with <code>java.sql.Date</code> and - <code>java.sql.Time</code> values. It defaults to <code>null</code> for backward compatibility, but in most - applications this should be set to the JVM default time zone (server default time zone), because that's what - most JDBC drivers will use when constructing the <code>java.sql.Date</code> and - <code>java.sql.Time</code> values. If this setting is <code>null</code>, FreeMarker will use the value of - (<a href="../../freemarker/core/Configurable.html#getTimeZone--"><code>Configurable.getTimeZone()</code></a>) for <code>java.sql.Date</code> and <code>java.sql.Time</code> values, - which often gives bad results. - - <p>This setting doesn't influence the formatting of other kind of values (like of - <code>java.sql.Timestamp</code> or plain <
<TRUNCATED>
