| <!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:34 CET 2023 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>TemplateDateFormatFactory (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="TemplateDateFormatFactory (FreeMarker 2.3.32 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/TemplateDateFormatFactory.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/TemplateDateFormat.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../freemarker/core/TemplateFormatUtil.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/TemplateDateFormatFactory.html" target="_top">Frames</a></li> |
| <li><a href="TemplateDateFormatFactory.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>Nested | </li> |
| <li>Field | </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 TemplateDateFormatFactory" class="title">Class TemplateDateFormatFactory</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../freemarker/core/TemplateValueFormatFactory.html" title="class in freemarker.core">freemarker.core.TemplateValueFormatFactory</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>freemarker.core.TemplateDateFormatFactory</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../freemarker/core/AliasTemplateDateFormatFactory.html" title="class in freemarker.core">AliasTemplateDateFormatFactory</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">TemplateDateFormatFactory</span> |
| extends <a href="../../freemarker/core/TemplateValueFormatFactory.html" title="class in freemarker.core">TemplateValueFormatFactory</a></pre> |
| <div class="block">Factory for a certain kind of date/time/dateTime formatting (<a href="../../freemarker/core/TemplateDateFormat.html" title="class in freemarker.core"><code>TemplateDateFormat</code></a>). Usually a singleton |
| (one-per-VM or one-per-<a href="../../freemarker/template/Configuration.html" title="class in freemarker.template"><code>Configuration</code></a>), and so must be thread-safe.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>2.3.24</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../freemarker/core/Configurable.html#setCustomDateFormats-java.util.Map-"><code>Configurable.setCustomDateFormats(java.util.Map)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== 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/TemplateDateFormatFactory.html#TemplateDateFormatFactory--">TemplateDateFormatFactory</a></span>()</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>abstract <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/TemplateDateFormatFactory.html#get-java.lang.String-int-java.util.Locale-java.util.TimeZone-boolean-freemarker.core.Environment-">get</a></span>(java.lang.String params, |
| int dateType, |
| java.util.Locale locale, |
| java.util.TimeZone timeZone, |
| boolean zonelessInput, |
| <a href="../../freemarker/core/Environment.html" title="class in freemarker.core">Environment</a> env)</code> |
| <div class="block">Returns a formatter for the given parameters.</div> |
| </td> |
| </tr> |
| </table> |
| <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>clone, 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="TemplateDateFormatFactory--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>TemplateDateFormatFactory</h4> |
| <pre>public TemplateDateFormatFactory()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="get-java.lang.String-int-java.util.Locale-java.util.TimeZone-boolean-freemarker.core.Environment-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public abstract <a href="../../freemarker/core/TemplateDateFormat.html" title="class in freemarker.core">TemplateDateFormat</a> get(java.lang.String params, |
| int dateType, |
| java.util.Locale locale, |
| java.util.TimeZone timeZone, |
| boolean zonelessInput, |
| <a href="../../freemarker/core/Environment.html" title="class in freemarker.core">Environment</a> env) |
| throws <a href="../../freemarker/core/TemplateValueFormatException.html" title="class in freemarker.core">TemplateValueFormatException</a></pre> |
| <div class="block">Returns a formatter for the given parameters. |
| |
| <p> |
| The returned formatter can be a new instance or a reused (cached) instance. Note that <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a> itself |
| caches the returned instances, though that cache is lost with the <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a> (i.e., when the top-level |
| template execution ends), also it might flushes lot of entries if the locale or time zone is changed during |
| template execution. So caching on the factory level is still useful, unless creating the formatters is |
| sufficiently cheap.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>params</code> - The string that further describes how the format should look. For example, when the |
| <a href="../../freemarker/core/Configurable.html#getDateFormat--"><code>dateFormat</code></a> is <code>"@fooBar 1, 2"</code>, then it will be |
| <code>"1, 2"</code> (and <code>"@fooBar"</code> selects the factory). The format of this string is up to the |
| <a href="../../freemarker/core/TemplateDateFormatFactory.html" title="class in freemarker.core"><code>TemplateDateFormatFactory</code></a> implementation. Not <code>null</code>, often an empty string.</dd> |
| <dd><code>dateType</code> - <a href="../../freemarker/template/TemplateDateModel.html#DATE"><code>TemplateDateModel.DATE</code></a>, <a href="../../freemarker/template/TemplateDateModel.html#TIME"><code>TemplateDateModel.TIME</code></a>, <a href="../../freemarker/template/TemplateDateModel.html#DATETIME"><code>TemplateDateModel.DATETIME</code></a> or |
| <a href="../../freemarker/template/TemplateDateModel.html#UNKNOWN"><code>TemplateDateModel.UNKNOWN</code></a>. Supporting <a href="../../freemarker/template/TemplateDateModel.html#UNKNOWN"><code>TemplateDateModel.UNKNOWN</code></a> is not necessary, in |
| which case the method should throw an <a href="../../freemarker/core/UnknownDateTypeFormattingUnsupportedException.html" title="class in freemarker.core"><code>UnknownDateTypeFormattingUnsupportedException</code></a> exception.</dd> |
| <dd><code>locale</code> - The locale to format for. Not <code>null</code>. The resulting format should be bound to this locale |
| forever (i.e. locale changes in the <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a> must not be followed).</dd> |
| <dd><code>timeZone</code> - The time zone to format for. Not <code>null</code>. The resulting format must be bound to this time zone |
| forever (i.e. time zone changes in the <a href="../../freemarker/core/Environment.html" title="class in freemarker.core"><code>Environment</code></a> must not be followed).</dd> |
| <dd><code>zonelessInput</code> - Indicates that the input Java <code>Date</code> is not from a time zone aware source. When this is |
| <code>true</code>, the formatters shouldn't override the time zone provided to its constructor (most |
| formatters don't do that anyway), and it shouldn't show the time zone, if it can hide it (like a |
| <code>SimpleDateFormat</code> pattern-based formatter may can't do that, as the pattern prescribes what to |
| show). |
| <p> |
| As of FreeMarker 2.3.21, this is <code>true</code> exactly when the date is an SQL "date without time of |
| the day" (i.e., a <code>java.sql.Date</code>) or an SQL "time of the day" value (i.e., a |
| <code>java.sql.Time</code>, although this rule can change in future, depending on |
| configuration settings and such, so you shouldn't rely on this rule, just accept what this parameter |
| says.</dd> |
| <dd><code>env</code> - The runtime environment from which the formatting was called. This is mostly meant to be used for |
| <a href="../../freemarker/core/Environment.html#setCustomState-java.lang.Object-java.lang.Object-"><code>Environment.setCustomState(Object, Object)</code></a>/<a href="../../freemarker/core/Environment.html#getCustomState-java.lang.Object-"><code>Environment.getCustomState(Object)</code></a>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../freemarker/core/TemplateValueFormatException.html" title="class in freemarker.core">TemplateValueFormatException</a></code> - If any problem occurs while parsing/getting the format. Notable subclasses: |
| <a href="../../freemarker/core/InvalidFormatParametersException.html" title="class in freemarker.core"><code>InvalidFormatParametersException</code></a> if <code>params</code> is malformed; |
| <a href="../../freemarker/core/UnknownDateTypeFormattingUnsupportedException.html" title="class in freemarker.core"><code>UnknownDateTypeFormattingUnsupportedException</code></a> if <code>dateType</code> is |
| <a href="../../freemarker/template/TemplateDateModel.html#UNKNOWN"><code>TemplateDateModel.UNKNOWN</code></a> and that's unsupported by this factory.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= 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="navBarCell1Rev">Class</li> |
| <li><a href="class-use/TemplateDateFormatFactory.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/TemplateDateFormat.html" title="class in freemarker.core"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../freemarker/core/TemplateFormatUtil.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/TemplateDateFormatFactory.html" target="_top">Frames</a></li> |
| <li><a href="TemplateDateFormatFactory.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </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.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
