blob: 49b7e2acea58525bb1e3b16f8fc122b99d738323 [file] [log] [blame]
<!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_281) on Sun Jan 15 15:58:37 CET 2023 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Uses of Package freemarker.template.utility (FreeMarker 2.3.32 API)</title>
<meta name="date" content="2023-01-15">
<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="Uses of Package freemarker.template.utility (FreeMarker 2.3.32 API)";
}
}
catch(err) {
}
//-->
</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</li>
<li class="navBarCell1Rev">Use</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?freemarker/template/utility/package-use.html" target="_top">Frames</a></li>
<li><a href="package-use.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Uses of Package freemarker.template.utility" class="title">Uses of Package<br>freemarker.template.utility</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
<caption><span>Packages that use <a href="../../../freemarker/template/utility/package-summary.html">freemarker.template.utility</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="#freemarker.core">freemarker.core</a></td>
<td class="colLast">
<div class="block">The seldom used or advanced parts of the fundamental FreeMarker API, compared to <a href="../../../freemarker/template/package-summary.html"><code>freemarker.template</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="#freemarker.ext.beans">freemarker.ext.beans</a></td>
<td class="colLast">
<div class="block">The <a href="../../../freemarker/template/DefaultObjectWrapper.html" title="class in freemarker.template">default object wrapper</a> of FreeMarker uses
this to expose Java Beans and POJO-s to templates.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="#freemarker.ext.rhino">freemarker.ext.rhino</a></td>
<td class="colLast">
<div class="block">Exposes Rhino (ECMAScript) objects to templates.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="#freemarker.template">freemarker.template</a></td>
<td class="colLast">
<div class="block"><b>The fundamental, most commonly used API-s of FreeMarker;</b>
start with <a href="../../../freemarker/template/Configuration.html" title="class in freemarker.template"><code>Configuration</code></a> (see also the
<a href="https://freemarker.apache.org/docs/pgui_quickstart.html" target="_blank">Getting Started</a> in the Manual.)</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="#freemarker.template.utility">freemarker.template.utility</a></td>
<td class="colLast">
<div class="block">Various classes used by core FreeMarker code but might be useful outside of it too.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="freemarker.core">
<!-- -->
</a>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../freemarker/template/utility/package-summary.html">freemarker.template.utility</a> used by <a href="../../../freemarker/core/package-summary.html">freemarker.core</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="../../../freemarker/template/utility/class-use/ObjectFactory.html#freemarker.core">ObjectFactory</a>
<div class="block">Used for the trivial cases of the factory pattern.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="freemarker.ext.beans">
<!-- -->
</a>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../freemarker/template/utility/package-summary.html">freemarker.template.utility</a> used by <a href="../../../freemarker/ext/beans/package-summary.html">freemarker.ext.beans</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="../../../freemarker/template/utility/class-use/ObjectWrapperWithAPISupport.html#freemarker.ext.beans">ObjectWrapperWithAPISupport</a>
<div class="block"><b>Experimental - subject to change:</b> Implemented by <a href="../../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template"><code>ObjectWrapper</code></a>-s to help <a href="../../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a>-s to
implement the <code>someValue?api</code> operation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../freemarker/template/utility/class-use/RichObjectWrapper.html#freemarker.ext.beans">RichObjectWrapper</a>
<div class="block"><b>Experimental - subject to change:</b> Union of the interfaces that a typical feature rich <a href="../../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template"><code>ObjectWrapper</code></a> is
expected to implement.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../freemarker/template/utility/class-use/WriteProtectable.html#freemarker.ext.beans">WriteProtectable</a>
<div class="block">Implemented by objects that can be made <em>permanently</em> read-only.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="freemarker.ext.rhino">
<!-- -->
</a>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../freemarker/template/utility/package-summary.html">freemarker.template.utility</a> used by <a href="../../../freemarker/ext/rhino/package-summary.html">freemarker.ext.rhino</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="../../../freemarker/template/utility/class-use/ObjectWrapperWithAPISupport.html#freemarker.ext.rhino">ObjectWrapperWithAPISupport</a>
<div class="block"><b>Experimental - subject to change:</b> Implemented by <a href="../../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template"><code>ObjectWrapper</code></a>-s to help <a href="../../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a>-s to
implement the <code>someValue?api</code> operation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../freemarker/template/utility/class-use/RichObjectWrapper.html#freemarker.ext.rhino">RichObjectWrapper</a>
<div class="block"><b>Experimental - subject to change:</b> Union of the interfaces that a typical feature rich <a href="../../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template"><code>ObjectWrapper</code></a> is
expected to implement.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../freemarker/template/utility/class-use/WriteProtectable.html#freemarker.ext.rhino">WriteProtectable</a>
<div class="block">Implemented by objects that can be made <em>permanently</em> read-only.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="freemarker.template">
<!-- -->
</a>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../freemarker/template/utility/package-summary.html">freemarker.template.utility</a> used by <a href="../../../freemarker/template/package-summary.html">freemarker.template</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="../../../freemarker/template/utility/class-use/ObjectWrapperWithAPISupport.html#freemarker.template">ObjectWrapperWithAPISupport</a>
<div class="block"><b>Experimental - subject to change:</b> Implemented by <a href="../../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template"><code>ObjectWrapper</code></a>-s to help <a href="../../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a>-s to
implement the <code>someValue?api</code> operation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../freemarker/template/utility/class-use/RichObjectWrapper.html#freemarker.template">RichObjectWrapper</a>
<div class="block"><b>Experimental - subject to change:</b> Union of the interfaces that a typical feature rich <a href="../../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template"><code>ObjectWrapper</code></a> is
expected to implement.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../freemarker/template/utility/class-use/WriteProtectable.html#freemarker.template">WriteProtectable</a>
<div class="block">Implemented by objects that can be made <em>permanently</em> read-only.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="freemarker.template.utility">
<!-- -->
</a>
<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
<caption><span>Classes in <a href="../../../freemarker/template/utility/package-summary.html">freemarker.template.utility</a> used by <a href="../../../freemarker/template/utility/package-summary.html">freemarker.template.utility</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Class and Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colOne"><a href="../../../freemarker/template/utility/class-use/DateUtil.CalendarFieldsToDateConverter.html#freemarker.template.utility">DateUtil.CalendarFieldsToDateConverter</a>
<div class="block">Used internally by <a href="../../../freemarker/template/utility/DateUtil.html" title="class in freemarker.template.utility"><code>DateUtil</code></a>; don't use its implementations for anything else.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../freemarker/template/utility/class-use/DateUtil.DateParseException.html#freemarker.template.utility">DateUtil.DateParseException</a>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../freemarker/template/utility/class-use/DateUtil.DateToISO8601CalendarFactory.html#freemarker.template.utility">DateUtil.DateToISO8601CalendarFactory</a>
<div class="block">Used internally by <a href="../../../freemarker/template/utility/DateUtil.html" title="class in freemarker.template.utility"><code>DateUtil</code></a>; don't use its implementations for
anything else.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../freemarker/template/utility/class-use/NullWriter.html#freemarker.template.utility">NullWriter</a>
<div class="block">A <code>Writer</code> that simply drops what it gets.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../freemarker/template/utility/class-use/ObjectWrapperWithAPISupport.html#freemarker.template.utility">ObjectWrapperWithAPISupport</a>
<div class="block"><b>Experimental - subject to change:</b> Implemented by <a href="../../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template"><code>ObjectWrapper</code></a>-s to help <a href="../../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a>-s to
implement the <code>someValue?api</code> operation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../freemarker/template/utility/class-use/StandardCompress.html#freemarker.template.utility">StandardCompress</a>
<div class="block">A filter that compresses each sequence of consecutive whitespace
to a single line break (if the sequence contains a line break) or a
single space.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../freemarker/template/utility/class-use/StringUtil.JsStringEncCompatibility.html#freemarker.template.utility">StringUtil.JsStringEncCompatibility</a>
<div class="block">Used as the argument of <a href="../../../freemarker/template/utility/StringUtil.html#jsStringEnc-java.lang.String-freemarker.template.utility.StringUtil.JsStringEncCompatibility-freemarker.template.utility.StringUtil.JsStringEncQuotation-"><code>StringUtil.jsStringEnc(String, JsStringEncCompatibility, JsStringEncQuotation)</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../freemarker/template/utility/class-use/StringUtil.JsStringEncQuotation.html#freemarker.template.utility">StringUtil.JsStringEncQuotation</a>
<div class="block">Used as the argument of <a href="../../../freemarker/template/utility/StringUtil.html#jsStringEnc-java.lang.String-freemarker.template.utility.StringUtil.JsStringEncCompatibility-freemarker.template.utility.StringUtil.JsStringEncQuotation-"><code>StringUtil.jsStringEnc(String, JsStringEncCompatibility, JsStringEncQuotation)</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../freemarker/template/utility/class-use/UnrecognizedTimeZoneException.html#freemarker.template.utility">UnrecognizedTimeZoneException</a>
<div class="block">Indicates that the time zone name is not recognized.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li>Class</li>
<li class="navBarCell1Rev">Use</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>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?freemarker/template/utility/package-use.html" target="_top">Frames</a></li>
<li><a href="package-use.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>