| <!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:36 CET 2023 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>freemarker.template (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="freemarker.template (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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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/log/package-summary.html">Prev Package</a></li> |
| <li><a href="../../freemarker/template/utility/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?freemarker/template/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package freemarker.template</h1> |
| <div class="docSummary"> |
| <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> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/AdapterTemplateModel.html" title="interface in freemarker.template">AdapterTemplateModel</a></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> that can be unwrapped and then it considers a provided desired (hint) class.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/AttemptExceptionReporter.html" title="interface in freemarker.template">AttemptExceptionReporter</a></td> |
| <td class="colLast"> |
| <div class="block">Used for the <a href="../../freemarker/core/Configurable.html#setAttemptExceptionReporter-freemarker.template.AttemptExceptionReporter-"><code>attempt_exception_reported</code></a> |
| configuration setting.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template">ObjectWrapper</a></td> |
| <td class="colLast"> |
| <div class="block">Maps Java objects to the type-system of FreeMarker Template Language (see the <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> |
| interfaces).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/ObjectWrapperAndUnwrapper.html" title="interface in freemarker.template">ObjectWrapperAndUnwrapper</a></td> |
| <td class="colLast"> |
| <div class="block"><b>Experimental - subject to change:</b> Adds functionality to <a href="../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template"><code>ObjectWrapper</code></a> that creates a plain Java object |
| from a <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateBooleanModel.html" title="interface in freemarker.template">TemplateBooleanModel</a></td> |
| <td class="colLast"> |
| <div class="block">"boolean" template language data type; same as in Java; either <code>true</code> or <code>false</code>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateCollectionModel.html" title="interface in freemarker.template">TemplateCollectionModel</a></td> |
| <td class="colLast"> |
| <div class="block">"collection" template language data type: a collection of values that can be enumerated, but can't be or not meant to |
| be accessed by index or key, nor the number of elements in it is known.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateCollectionModelEx.html" title="interface in freemarker.template">TemplateCollectionModelEx</a></td> |
| <td class="colLast"> |
| <div class="block">"collection" template language data type: Adds size/emptiness querybility to |
| <a href="../../freemarker/template/TemplateCollectionModel.html" title="interface in freemarker.template"><code>TemplateCollectionModel</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateDateModel.html" title="interface in freemarker.template">TemplateDateModel</a></td> |
| <td class="colLast"> |
| <div class="block">"date", "time" and "date-time" template language data types: corresponds to <code>Date</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateDirectiveBody.html" title="interface in freemarker.template">TemplateDirectiveBody</a></td> |
| <td class="colLast"> |
| <div class="block">Represents the nested content of a directive (<a href="../../freemarker/template/TemplateDirectiveModel.html" title="interface in freemarker.template"><code>TemplateDirectiveModel</code></a>) invocation.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateDirectiveModel.html" title="interface in freemarker.template">TemplateDirectiveModel</a></td> |
| <td class="colLast"> |
| <div class="block">"directive" template language data type: used as user-defined directives |
| (much like macros) in templates.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateExceptionHandler.html" title="interface in freemarker.template">TemplateExceptionHandler</a></td> |
| <td class="colLast"> |
| <div class="block">Used for the <a href="../../freemarker/core/Configurable.html#setTemplateExceptionHandler-freemarker.template.TemplateExceptionHandler-"><code>template_exception_handler</code></a> |
| configuration setting.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateHashModel.html" title="interface in freemarker.template">TemplateHashModel</a></td> |
| <td class="colLast"> |
| <div class="block">"hash" template language data type: an object that contains other objects accessible through string keys |
| (sub-variable names).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateHashModelEx.html" title="interface in freemarker.template">TemplateHashModelEx</a></td> |
| <td class="colLast"> |
| <div class="block">"extended hash" template language data type; extends <a href="../../freemarker/template/TemplateHashModel.html" title="interface in freemarker.template"><code>TemplateHashModel</code></a> by allowing |
| iterating through its keys and values.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateHashModelEx2.html" title="interface in freemarker.template">TemplateHashModelEx2</a></td> |
| <td class="colLast"> |
| <div class="block">Adds key-value pair listing capability to <a href="../../freemarker/template/TemplateHashModelEx.html" title="interface in freemarker.template"><code>TemplateHashModelEx</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateHashModelEx2.KeyValuePair.html" title="interface in freemarker.template">TemplateHashModelEx2.KeyValuePair</a></td> |
| <td class="colLast"> |
| <div class="block">A key-value pair in a hash; used for <a href="../../freemarker/template/TemplateHashModelEx2.KeyValuePairIterator.html" title="interface in freemarker.template"><code>TemplateHashModelEx2.KeyValuePairIterator</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateHashModelEx2.KeyValuePairIterator.html" title="interface in freemarker.template">TemplateHashModelEx2.KeyValuePairIterator</a></td> |
| <td class="colLast"> |
| <div class="block">Iterates over the key-value pairs in a hash.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateMethodModel.html" title="interface in freemarker.template">TemplateMethodModel</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">Use <a href="../../freemarker/template/TemplateMethodModelEx.html" title="interface in freemarker.template"><code>TemplateMethodModelEx</code></a> instead.</span></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateMethodModelEx.html" title="interface in freemarker.template">TemplateMethodModelEx</a></td> |
| <td class="colLast"> |
| <div class="block">"extended method" template language data type: Objects that act like functions.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template">TemplateModel</a></td> |
| <td class="colLast"> |
| <div class="block">The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateModelAdapter.html" title="interface in freemarker.template">TemplateModelAdapter</a></td> |
| <td class="colLast"> |
| <div class="block">Implemented by classes that serve as adapters for template model objects in |
| some other object model.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateModelIterator.html" title="interface in freemarker.template">TemplateModelIterator</a></td> |
| <td class="colLast"> |
| <div class="block">Used to iterate over a set of template models <em>once</em>; usually returned from |
| <a href="../../freemarker/template/TemplateCollectionModel.html#iterator--"><code>TemplateCollectionModel.iterator()</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateModelWithAPISupport.html" title="interface in freemarker.template">TemplateModelWithAPISupport</a></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> on which the <code>?api</code> operation can be applied.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateNodeModel.html" title="interface in freemarker.template">TemplateNodeModel</a></td> |
| <td class="colLast"> |
| <div class="block">"node" template language data type: an object that is a node in a tree.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateNodeModelEx.html" title="interface in freemarker.template">TemplateNodeModelEx</a></td> |
| <td class="colLast"> |
| <div class="block">A <a href="../../freemarker/template/TemplateNodeModel.html" title="interface in freemarker.template"><code>TemplateNodeModel</code></a> that supports navigating to the previous and next sibling nodes.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateNumberModel.html" title="interface in freemarker.template">TemplateNumberModel</a></td> |
| <td class="colLast"> |
| <div class="block">"number" template language data type; an object that stores a number.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateScalarModel.html" title="interface in freemarker.template">TemplateScalarModel</a></td> |
| <td class="colLast"> |
| <div class="block">"string" template language data-type; like in Java, an unmodifiable UNICODE character sequence.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateSequenceModel.html" title="interface in freemarker.template">TemplateSequenceModel</a></td> |
| <td class="colLast"> |
| <div class="block">"sequence" template language data type; an object that contains other objects accessible through an integer 0-based |
| index.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateTransformModel.html" title="interface in freemarker.template">TemplateTransformModel</a></td> |
| <td class="colLast"> |
| <div class="block">"transform" template language data type: user-defined directives |
| (much like macros) specialized on filtering output; you should rather use the newer <a href="../../freemarker/template/TemplateDirectiveModel.html" title="interface in freemarker.template"><code>TemplateDirectiveModel</code></a> |
| instead.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TransformControl.html" title="interface in freemarker.template">TransformControl</a></td> |
| <td class="colLast"> |
| <div class="block">An interface that can be implemented by writers returned from |
| <a href="../../freemarker/template/TemplateTransformModel.html#getWriter-java.io.Writer-java.util.Map-"><code>TemplateTransformModel.getWriter(java.io.Writer, java.util.Map)</code></a>.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/Configuration.html" title="class in freemarker.template">Configuration</a></td> |
| <td class="colLast"> |
| <div class="block"><b>The main entry point into the FreeMarker API</b>; encapsulates the configuration settings of FreeMarker, |
| also serves as a central template-loading and caching service.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/DefaultArrayAdapter.html" title="class in freemarker.template">DefaultArrayAdapter</a></td> |
| <td class="colLast"> |
| <div class="block">Adapts an <code>array</code> of a non-primitive elements to the corresponding <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> interface(s), most |
| importantly to <a href="../../freemarker/template/TemplateHashModelEx.html" title="interface in freemarker.template"><code>TemplateHashModelEx</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/DefaultEnumerationAdapter.html" title="class in freemarker.template">DefaultEnumerationAdapter</a></td> |
| <td class="colLast"> |
| <div class="block">Adapts an <code>Enumeration</code> to the corresponding <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> interface(s), most importantly to |
| <a href="../../freemarker/template/TemplateCollectionModel.html" title="interface in freemarker.template"><code>TemplateCollectionModel</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/DefaultIterableAdapter.html" title="class in freemarker.template">DefaultIterableAdapter</a></td> |
| <td class="colLast"> |
| <div class="block">Adapts an <code>Iterable</code> to the corresponding <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> interface(s), most importantly to |
| <a href="../../freemarker/template/TemplateCollectionModel.html" title="interface in freemarker.template"><code>TemplateCollectionModel</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/DefaultIteratorAdapter.html" title="class in freemarker.template">DefaultIteratorAdapter</a></td> |
| <td class="colLast"> |
| <div class="block">Adapts an <code>Iterator</code> to the corresponding <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> interface(s), most importantly to |
| <a href="../../freemarker/template/TemplateCollectionModel.html" title="interface in freemarker.template"><code>TemplateCollectionModel</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/DefaultListAdapter.html" title="class in freemarker.template">DefaultListAdapter</a></td> |
| <td class="colLast"> |
| <div class="block">Adapts a <code>List</code> to the corresponding <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> interface(s), most importantly to |
| <a href="../../freemarker/template/TemplateSequenceModel.html" title="interface in freemarker.template"><code>TemplateSequenceModel</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/DefaultMapAdapter.html" title="class in freemarker.template">DefaultMapAdapter</a></td> |
| <td class="colLast"> |
| <div class="block">Adapts a <code>Map</code> to the corresponding <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> interface(s), most importantly to |
| <a href="../../freemarker/template/TemplateHashModelEx.html" title="interface in freemarker.template"><code>TemplateHashModelEx</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/DefaultNonListCollectionAdapter.html" title="class in freemarker.template">DefaultNonListCollectionAdapter</a></td> |
| <td class="colLast"> |
| <div class="block">Adapts a non-<code>List</code> Java <code>Collection</code> to the corresponding <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> interface(s), most |
| importantly to <a href="../../freemarker/template/TemplateCollectionModelEx.html" title="interface in freemarker.template"><code>TemplateCollectionModelEx</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/DefaultObjectWrapper.html" title="class in freemarker.template">DefaultObjectWrapper</a></td> |
| <td class="colLast"> |
| <div class="block">The default implementation of the <a href="../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template"><code>ObjectWrapper</code></a> interface.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/DefaultObjectWrapperBuilder.html" title="class in freemarker.template">DefaultObjectWrapperBuilder</a></td> |
| <td class="colLast"> |
| <div class="block">Gets/creates a <a href="../../freemarker/template/DefaultObjectWrapper.html" title="class in freemarker.template"><code>DefaultObjectWrapper</code></a> singleton instance that's already configured as specified in the |
| properties of this object; this is recommended over using the <a href="../../freemarker/template/DefaultObjectWrapper.html" title="class in freemarker.template"><code>DefaultObjectWrapper</code></a> constructors.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/DefaultObjectWrapperConfiguration.html" title="class in freemarker.template">DefaultObjectWrapperConfiguration</a></td> |
| <td class="colLast"> |
| <div class="block">Holds <a href="../../freemarker/template/DefaultObjectWrapper.html" title="class in freemarker.template"><code>DefaultObjectWrapper</code></a> configuration settings and defines their defaults.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/LocalizedString.html" title="class in freemarker.template">LocalizedString</a></td> |
| <td class="colLast"> |
| <div class="block">An abstract base class for scalars that vary by locale.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/MapKeyValuePairIterator.html" title="class in freemarker.template">MapKeyValuePairIterator</a></td> |
| <td class="colLast"> |
| <div class="block">Implementation of <a href="../../freemarker/template/TemplateHashModelEx2.KeyValuePairIterator.html" title="interface in freemarker.template"><code>TemplateHashModelEx2.KeyValuePairIterator</code></a> for a <a href="../../freemarker/template/TemplateHashModelEx2.html" title="interface in freemarker.template"><code>TemplateHashModelEx2</code></a> that wraps or otherwise uses a |
| <code>Map</code> internally.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/ResourceBundleLocalizedString.html" title="class in freemarker.template">ResourceBundleLocalizedString</a></td> |
| <td class="colLast"> |
| <div class="block">A concrete implementation of <a href="../../freemarker/template/LocalizedString.html" title="class in freemarker.template"><code>LocalizedString</code></a> that gets |
| a localized string from a <code>ResourceBundle</code></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/SimpleCollection.html" title="class in freemarker.template">SimpleCollection</a></td> |
| <td class="colLast"> |
| <div class="block">A simple implementation of <a href="../../freemarker/template/TemplateCollectionModel.html" title="interface in freemarker.template"><code>TemplateCollectionModel</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/SimpleDate.html" title="class in freemarker.template">SimpleDate</a></td> |
| <td class="colLast"> |
| <div class="block">A simple implementation of the <tt>TemplateDateModel</tt> |
| interface.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/SimpleHash.html" title="class in freemarker.template">SimpleHash</a></td> |
| <td class="colLast"> |
| <div class="block">A simple implementation of the <a href="../../freemarker/template/TemplateHashModelEx.html" title="interface in freemarker.template"><code>TemplateHashModelEx</code></a> interface, using its own underlying <code>Map</code> or |
| <code>SortedMap</code> for storing the hash entries.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/SimpleList.html" title="class in freemarker.template">SimpleList</a></td> |
| <td class="colLast">Deprecated |
| <div class="block"><span class="deprecationComment">Use <a href="../../freemarker/template/SimpleSequence.html" title="class in freemarker.template"><code>SimpleSequence</code></a> instead.</span></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/SimpleNumber.html" title="class in freemarker.template">SimpleNumber</a></td> |
| <td class="colLast"> |
| <div class="block">A simple implementation of the <tt>TemplateNumberModel</tt> |
| interface.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/SimpleObjectWrapper.html" title="class in freemarker.template">SimpleObjectWrapper</a></td> |
| <td class="colLast"> |
| <div class="block">A restricted object wrapper that will not expose arbitrary object, just those that directly correspond to the |
| <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> sub-interfaces (<code>String</code>, <code>Map</code> and such).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/SimpleScalar.html" title="class in freemarker.template">SimpleScalar</a></td> |
| <td class="colLast"> |
| <div class="block">A simple implementation of the <tt>TemplateScalarModel</tt> |
| interface, using a <tt>String</tt>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/SimpleSequence.html" title="class in freemarker.template">SimpleSequence</a></td> |
| <td class="colLast"> |
| <div class="block">A simple implementation of the <a href="../../freemarker/template/TemplateSequenceModel.html" title="interface in freemarker.template"><code>TemplateSequenceModel</code></a> interface, using its own underlying <code>List</code> for |
| storing the list items.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/Template.html" title="class in freemarker.template">Template</a></td> |
| <td class="colLast"> |
| <div class="block">Stores an already parsed template, ready to be processed (rendered) for unlimited times, possibly from multiple |
| threads.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateModelListSequence.html" title="class in freemarker.template">TemplateModelListSequence</a></td> |
| <td class="colLast"> |
| <div class="block">A sequence that wraps a <code>List</code> of <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a>-s.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/Version.html" title="class in freemarker.template">Version</a></td> |
| <td class="colLast"> |
| <div class="block">Represents a version number plus the further qualifiers and build info.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/WrappingTemplateModel.html" title="class in freemarker.template">WrappingTemplateModel</a></td> |
| <td class="colLast"> |
| <div class="block">Convenience base-class for containers that wrap their contained arbitrary Java objects into <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> |
| instances.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/MalformedTemplateNameException.html" title="class in freemarker.template">MalformedTemplateNameException</a></td> |
| <td class="colLast"> |
| <div class="block">Indicates that the template name given was malformed according the <a href="../../freemarker/cache/TemplateNameFormat.html" title="class in freemarker.cache"><code>TemplateNameFormat</code></a> in use.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/Template.WrongEncodingException.html" title="class in freemarker.template">Template.WrongEncodingException</a></td> |
| <td class="colLast"> |
| <div class="block">Thrown by the <a href="../../freemarker/template/Template.html" title="class in freemarker.template"><code>Template</code></a> constructors that specify a non-<code>null</code> encoding whoch doesn't match the |
| encoding specified in the <code>#ftl</code> header of the template.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateException.html" title="class in freemarker.template">TemplateException</a></td> |
| <td class="colLast"> |
| <div class="block">Runtime exception in a template (as opposed to a parsing-time exception: <a href="../../freemarker/core/ParseException.html" title="class in freemarker.core"><code>ParseException</code></a>).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateModelException.html" title="class in freemarker.template">TemplateModelException</a></td> |
| <td class="colLast"> |
| <div class="block"><a href="../../freemarker/template/ObjectWrapper.html" title="interface in freemarker.template"><code>ObjectWrapper</code></a>-s may throw this when wrapping/unwrapping fails, or <a href="../../freemarker/template/TemplateModel.html" title="interface in freemarker.template"><code>TemplateModel</code></a> methods throw this |
| if the requested data can't be retrieved.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../freemarker/template/TemplateNotFoundException.html" title="class in freemarker.template">TemplateNotFoundException</a></td> |
| <td class="colLast"> |
| <div class="block">Thrown when <a href="../../freemarker/template/Configuration.html#getTemplate-java.lang.String-"><code>Configuration.getTemplate(String)</code></a> (or similar) doesn't find a template.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package freemarker.template Description">Package freemarker.template Description</h2> |
| <div class="block"><p><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.)</p></div> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.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/log/package-summary.html">Prev Package</a></li> |
| <li><a href="../../freemarker/template/utility/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?freemarker/template/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../allclasses-noframe.html">All 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> |
