| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>FastDateFormat (Apache Log4j Core 2.23.1 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.logging.log4j.core.util.datetime, class: FastDateFormat"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/FastDateFormat.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.logging.log4j.core.util.datetime</a></div> |
| <h1 title="Class FastDateFormat" class="title">Class FastDateFormat</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="Format.html" title="class in org.apache.logging.log4j.core.util.datetime">org.apache.logging.log4j.core.util.datetime.Format</a> |
| <div class="inheritance">org.apache.logging.log4j.core.util.datetime.FastDateFormat</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="DatePrinter.html" title="interface in org.apache.logging.log4j.core.util.datetime">DatePrinter</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">FastDateFormat</span> |
| <span class="extends-implements">extends <a href="Format.html" title="class in org.apache.logging.log4j.core.util.datetime">Format</a> |
| implements <a href="DatePrinter.html" title="interface in org.apache.logging.log4j.core.util.datetime">DatePrinter</a></span></div> |
| <div class="block"><p>FastDateFormat is a fast and thread-safe version of |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html" title="class or interface in java.text" class="external-link"><code>SimpleDateFormat</code></a>.</p> |
| |
| <p>To obtain an instance of FastDateFormat, use one of the static factory methods: |
| <a href="#getInstance(java.lang.String,java.util.TimeZone,java.util.Locale)"><code>getInstance(String, TimeZone, Locale)</code></a>, <a href="#getDateInstance(int,java.util.TimeZone,java.util.Locale)"><code>getDateInstance(int, TimeZone, Locale)</code></a>, |
| <a href="#getTimeInstance(int,java.util.TimeZone,java.util.Locale)"><code>getTimeInstance(int, TimeZone, Locale)</code></a>, or <a href="#getDateTimeInstance(int,int,java.util.TimeZone,java.util.Locale)"><code>getDateTimeInstance(int, int, TimeZone, Locale)</code></a> |
| </p> |
| |
| <p>Since FastDateFormat is thread safe, you can use a static member instance:</p> |
| <code> |
| private static final FastDateFormat DATE_FORMATTER = FastDateFormat.getDateTimeInstance(FastDateFormat.LONG, FastDateFormat.SHORT); |
| </code> |
| |
| <p>This class can be used as a direct replacement to |
| <code>SimpleDateFormat</code> in most formatting and parsing situations. |
| This class is especially useful in multi-threaded server environments. |
| <code>SimpleDateFormat</code> is not thread-safe in any JDK version, |
| nor will it be as Sun have closed the bug/RFE. |
| </p> |
| |
| <p>All patterns are compatible with |
| SimpleDateFormat (except time zones and some year patterns - see below).</p> |
| |
| <p>Since 3.2, FastDateFormat supports parsing as well as printing.</p> |
| |
| <p>Java 1.4 introduced a new pattern letter, <code>'Z'</code>, to represent |
| time zones in RFC822 format (eg. <code>+0800</code> or <code>-1100</code>). |
| This pattern letter can be used here (on all JDK versions).</p> |
| |
| <p>In addition, the pattern <code>'ZZ'</code> has been made to represent |
| ISO 8601 extended format time zones (eg. <code>+08:00</code> or <code>-11:00</code>). |
| This introduces a minor incompatibility with Java 1.4, but at a gain of |
| useful functionality.</p> |
| |
| <p>Javadoc cites for the year pattern: <i>For formatting, if the number of |
| pattern letters is 2, the year is truncated to 2 digits; otherwise it is |
| interpreted as a number.</i> Starting with Java 1.7 a pattern of 'Y' or |
| 'YYY' will be formatted as '2003', while it was '03' in former Java |
| versions. FastDateFormat implements the behavior of Java 7.</p> |
| |
| <p> |
| Copied and modified from <a href="https://commons.apache.org/proper/commons-lang/">Apache Commons Lang</a>. |
| </p></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>Apache Commons Lang 2.0</dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#FULL" class="member-name-link">FULL</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">FULL locale dependent date or time style.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#LONG" class="member-name-link">LONG</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">LONG locale dependent date or time style.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#MEDIUM" class="member-name-link">MEDIUM</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">MEDIUM locale dependent date or time style.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#SHORT" class="member-name-link">SHORT</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">SHORT locale dependent date or time style.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>protected </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.util.TimeZone,java.util.Locale)" class="member-name-link">FastDateFormat</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constructs a new FastDateFormat.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected </code></div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.util.TimeZone,java.util.Locale,java.util.Date)" class="member-name-link">FastDateFormat</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html" title="class or interface in java.util" class="external-link">Date</a> centuryStart)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Constructs a new FastDateFormat.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> obj)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Compares two objects for equality.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#format(long)" class="member-name-link">format</a><wbr>(long millis)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Formats a millisecond <code>long</code> value.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><B extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a>><br>B</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#format(long,B)" class="member-name-link">format</a><wbr>(long millis, |
| B buf)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Formats a millisecond <code>long</code> value into the |
| supplied <code>StringBuffer</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#format(java.lang.Object,java.lang.StringBuilder,java.text.FieldPosition)" class="member-name-link">format</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> obj, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> toAppendTo, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/text/FieldPosition.html" title="class or interface in java.text" class="external-link">FieldPosition</a> pos)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Formats a <code>Date</code>, <code>Calendar</code> or |
| <code>Long</code> (milliseconds) object.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#format(java.util.Calendar)" class="member-name-link">format</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html" title="class or interface in java.util" class="external-link">Calendar</a> calendar)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Formats a <code>Calendar</code> object.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><B extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a>><br>B</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#format(java.util.Calendar,B)" class="member-name-link">format</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html" title="class or interface in java.util" class="external-link">Calendar</a> calendar, |
| B buf)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Formats a <code>Calendar</code> object into the |
| supplied <code>StringBuffer</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#format(java.util.Date)" class="member-name-link">format</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html" title="class or interface in java.util" class="external-link">Date</a> date)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Formats a <code>Date</code> object using a <code>GregorianCalendar</code>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><B extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a>><br>B</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#format(java.util.Date,B)" class="member-name-link">format</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html" title="class or interface in java.util" class="external-link">Date</a> date, |
| B buf)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Formats a <code>Date</code> object into the |
| supplied <code>StringBuffer</code> using a <code>GregorianCalendar</code>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDateInstance(int)" class="member-name-link">getDateInstance</a><wbr>(int style)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets a date formatter instance using the specified style in the |
| default time zone and locale.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDateInstance(int,java.util.Locale)" class="member-name-link">getDateInstance</a><wbr>(int style, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets a date formatter instance using the specified style and |
| locale in the default time zone.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDateInstance(int,java.util.TimeZone)" class="member-name-link">getDateInstance</a><wbr>(int style, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets a date formatter instance using the specified style and |
| time zone in the default locale.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDateInstance(int,java.util.TimeZone,java.util.Locale)" class="member-name-link">getDateInstance</a><wbr>(int style, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets a date formatter instance using the specified style, time |
| zone and locale.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDateTimeInstance(int,int)" class="member-name-link">getDateTimeInstance</a><wbr>(int dateStyle, |
| int timeStyle)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets a date/time formatter instance using the specified style |
| in the default time zone and locale.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDateTimeInstance(int,int,java.util.Locale)" class="member-name-link">getDateTimeInstance</a><wbr>(int dateStyle, |
| int timeStyle, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets a date/time formatter instance using the specified style and |
| locale in the default time zone.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDateTimeInstance(int,int,java.util.TimeZone)" class="member-name-link">getDateTimeInstance</a><wbr>(int dateStyle, |
| int timeStyle, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets a date/time formatter instance using the specified style and |
| time zone in the default locale.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getDateTimeInstance(int,int,java.util.TimeZone,java.util.Locale)" class="member-name-link">getDateTimeInstance</a><wbr>(int dateStyle, |
| int timeStyle, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets a date/time formatter instance using the specified style, |
| time zone and locale.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInstance()" class="member-name-link">getInstance</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets a formatter instance using the default pattern in the |
| default locale.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInstance(java.lang.String)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pattern)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets a formatter instance using the specified pattern in the |
| default locale.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInstance(java.lang.String,java.util.Locale)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets a formatter instance using the specified pattern and |
| locale.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInstance(java.lang.String,java.util.TimeZone)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets a formatter instance using the specified pattern and |
| time zone.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getInstance(java.lang.String,java.util.TimeZone,java.util.Locale)" class="member-name-link">getInstance</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets a formatter instance using the specified pattern, time zone |
| and locale.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLocale()" class="member-name-link">getLocale</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the locale used by this formatter.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMaxLengthEstimate()" class="member-name-link">getMaxLengthEstimate</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets an estimate for the maximum string length that the |
| formatter will produce.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPattern()" class="member-name-link">getPattern</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the pattern used by this formatter.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getTimeInstance(int)" class="member-name-link">getTimeInstance</a><wbr>(int style)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets a time formatter instance using the specified style in the |
| default time zone and locale.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getTimeInstance(int,java.util.Locale)" class="member-name-link">getTimeInstance</a><wbr>(int style, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets a time formatter instance using the specified style and |
| locale in the default time zone.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getTimeInstance(int,java.util.TimeZone)" class="member-name-link">getTimeInstance</a><wbr>(int style, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets a time formatter instance using the specified style and |
| time zone in the default locale.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getTimeInstance(int,java.util.TimeZone,java.util.Locale)" class="member-name-link">getTimeInstance</a><wbr>(int style, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets a time formatter instance using the specified style, time |
| zone and locale.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTimeZone()" class="member-name-link">getTimeZone</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets the time zone used by this formatter.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns a hash code compatible with equals.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Gets a debugging string version of this formatter.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.logging.log4j.core.util.datetime.Format">Methods inherited from class org.apache.logging.log4j.core.util.datetime.<a href="Format.html" title="class in org.apache.logging.log4j.core.util.datetime">Format</a></h3> |
| <code><a href="Format.html#format(java.lang.Object)">format</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="FULL"> |
| <h3>FULL</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">FULL</span></div> |
| <div class="block">FULL locale dependent date or time style.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../../constant-values.html#org.apache.logging.log4j.core.util.datetime.FastDateFormat.FULL">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="LONG"> |
| <h3>LONG</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">LONG</span></div> |
| <div class="block">LONG locale dependent date or time style.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../../constant-values.html#org.apache.logging.log4j.core.util.datetime.FastDateFormat.LONG">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="MEDIUM"> |
| <h3>MEDIUM</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">MEDIUM</span></div> |
| <div class="block">MEDIUM locale dependent date or time style.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../../constant-values.html#org.apache.logging.log4j.core.util.datetime.FastDateFormat.MEDIUM">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SHORT"> |
| <h3>SHORT</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name">SHORT</span></div> |
| <div class="block">SHORT locale dependent date or time style.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../../constant-values.html#org.apache.logging.log4j.core.util.datetime.FastDateFormat.SHORT">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.util.TimeZone,java.util.Locale)"> |
| <h3>FastDateFormat</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">FastDateFormat</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</span></div> |
| <div class="block"><p>Constructs a new FastDateFormat.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>pattern</code> - <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html" title="class or interface in java.text" class="external-link"><code>SimpleDateFormat</code></a> compatible pattern</dd> |
| <dd><code>timeZone</code> - non-null time zone to use</dd> |
| <dd><code>locale</code> - non-null locale to use</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if pattern, timeZone, or locale is null.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(java.lang.String,java.util.TimeZone,java.util.Locale,java.util.Date)"> |
| <h3>FastDateFormat</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="element-name">FastDateFormat</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html" title="class or interface in java.util" class="external-link">Date</a> centuryStart)</span></div> |
| <div class="block"><p>Constructs a new FastDateFormat.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>pattern</code> - <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html" title="class or interface in java.text" class="external-link"><code>SimpleDateFormat</code></a> compatible pattern</dd> |
| <dd><code>timeZone</code> - non-null time zone to use</dd> |
| <dd><code>locale</code> - non-null locale to use</dd> |
| <dd><code>centuryStart</code> - The start of the 100 year period to use as the "default century" for 2 digit year parsing. If centuryStart is null, defaults to now - 80 years</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if pattern, timeZone, or locale is null.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getInstance()"> |
| <h3>getInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></span> <span class="element-name">getInstance</span>()</div> |
| <div class="block"><p>Gets a formatter instance using the default pattern in the |
| default locale.</p></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a date/time formatter</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInstance(java.lang.String)"> |
| <h3>getInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></span> <span class="element-name">getInstance</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pattern)</span></div> |
| <div class="block"><p>Gets a formatter instance using the specified pattern in the |
| default locale.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>pattern</code> - <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html" title="class or interface in java.text" class="external-link"><code>SimpleDateFormat</code></a> compatible |
| pattern</dd> |
| <dt>Returns:</dt> |
| <dd>a pattern based date/time formatter</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if pattern is invalid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInstance(java.lang.String,java.util.TimeZone)"> |
| <h3>getInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></span> <span class="element-name">getInstance</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone)</span></div> |
| <div class="block"><p>Gets a formatter instance using the specified pattern and |
| time zone.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>pattern</code> - <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html" title="class or interface in java.text" class="external-link"><code>SimpleDateFormat</code></a> compatible |
| pattern</dd> |
| <dd><code>timeZone</code> - optional time zone, overrides time zone of |
| formatted date</dd> |
| <dt>Returns:</dt> |
| <dd>a pattern based date/time formatter</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if pattern is invalid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInstance(java.lang.String,java.util.Locale)"> |
| <h3>getInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></span> <span class="element-name">getInstance</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</span></div> |
| <div class="block"><p>Gets a formatter instance using the specified pattern and |
| locale.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>pattern</code> - <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html" title="class or interface in java.text" class="external-link"><code>SimpleDateFormat</code></a> compatible |
| pattern</dd> |
| <dd><code>locale</code> - optional locale, overrides system locale</dd> |
| <dt>Returns:</dt> |
| <dd>a pattern based date/time formatter</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if pattern is invalid</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getInstance(java.lang.String,java.util.TimeZone,java.util.Locale)"> |
| <h3>getInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></span> <span class="element-name">getInstance</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> pattern, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</span></div> |
| <div class="block"><p>Gets a formatter instance using the specified pattern, time zone |
| and locale.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>pattern</code> - <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html" title="class or interface in java.text" class="external-link"><code>SimpleDateFormat</code></a> compatible |
| pattern</dd> |
| <dd><code>timeZone</code> - optional time zone, overrides time zone of |
| formatted date</dd> |
| <dd><code>locale</code> - optional locale, overrides system locale</dd> |
| <dt>Returns:</dt> |
| <dd>a pattern based date/time formatter</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if pattern is invalid |
| or <code>null</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDateInstance(int)"> |
| <h3>getDateInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></span> <span class="element-name">getDateInstance</span><wbr><span class="parameters">(int style)</span></div> |
| <div class="block"><p>Gets a date formatter instance using the specified style in the |
| default time zone and locale.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>style</code> - date style: FULL, LONG, MEDIUM, or SHORT</dd> |
| <dt>Returns:</dt> |
| <dd>a localized standard date formatter</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the Locale has no date |
| pattern defined</dd> |
| <dt>Since:</dt> |
| <dd>2.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDateInstance(int,java.util.Locale)"> |
| <h3>getDateInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></span> <span class="element-name">getDateInstance</span><wbr><span class="parameters">(int style, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</span></div> |
| <div class="block"><p>Gets a date formatter instance using the specified style and |
| locale in the default time zone.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>style</code> - date style: FULL, LONG, MEDIUM, or SHORT</dd> |
| <dd><code>locale</code> - optional locale, overrides system locale</dd> |
| <dt>Returns:</dt> |
| <dd>a localized standard date formatter</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the Locale has no date |
| pattern defined</dd> |
| <dt>Since:</dt> |
| <dd>2.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDateInstance(int,java.util.TimeZone)"> |
| <h3>getDateInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></span> <span class="element-name">getDateInstance</span><wbr><span class="parameters">(int style, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone)</span></div> |
| <div class="block"><p>Gets a date formatter instance using the specified style and |
| time zone in the default locale.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>style</code> - date style: FULL, LONG, MEDIUM, or SHORT</dd> |
| <dd><code>timeZone</code> - optional time zone, overrides time zone of |
| formatted date</dd> |
| <dt>Returns:</dt> |
| <dd>a localized standard date formatter</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the Locale has no date |
| pattern defined</dd> |
| <dt>Since:</dt> |
| <dd>2.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDateInstance(int,java.util.TimeZone,java.util.Locale)"> |
| <h3>getDateInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></span> <span class="element-name">getDateInstance</span><wbr><span class="parameters">(int style, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</span></div> |
| <div class="block"><p>Gets a date formatter instance using the specified style, time |
| zone and locale.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>style</code> - date style: FULL, LONG, MEDIUM, or SHORT</dd> |
| <dd><code>timeZone</code> - optional time zone, overrides time zone of |
| formatted date</dd> |
| <dd><code>locale</code> - optional locale, overrides system locale</dd> |
| <dt>Returns:</dt> |
| <dd>a localized standard date formatter</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the Locale has no date |
| pattern defined</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTimeInstance(int)"> |
| <h3>getTimeInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></span> <span class="element-name">getTimeInstance</span><wbr><span class="parameters">(int style)</span></div> |
| <div class="block"><p>Gets a time formatter instance using the specified style in the |
| default time zone and locale.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>style</code> - time style: FULL, LONG, MEDIUM, or SHORT</dd> |
| <dt>Returns:</dt> |
| <dd>a localized standard time formatter</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the Locale has no time |
| pattern defined</dd> |
| <dt>Since:</dt> |
| <dd>2.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTimeInstance(int,java.util.Locale)"> |
| <h3>getTimeInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></span> <span class="element-name">getTimeInstance</span><wbr><span class="parameters">(int style, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</span></div> |
| <div class="block"><p>Gets a time formatter instance using the specified style and |
| locale in the default time zone.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>style</code> - time style: FULL, LONG, MEDIUM, or SHORT</dd> |
| <dd><code>locale</code> - optional locale, overrides system locale</dd> |
| <dt>Returns:</dt> |
| <dd>a localized standard time formatter</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the Locale has no time |
| pattern defined</dd> |
| <dt>Since:</dt> |
| <dd>2.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTimeInstance(int,java.util.TimeZone)"> |
| <h3>getTimeInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></span> <span class="element-name">getTimeInstance</span><wbr><span class="parameters">(int style, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone)</span></div> |
| <div class="block"><p>Gets a time formatter instance using the specified style and |
| time zone in the default locale.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>style</code> - time style: FULL, LONG, MEDIUM, or SHORT</dd> |
| <dd><code>timeZone</code> - optional time zone, overrides time zone of |
| formatted time</dd> |
| <dt>Returns:</dt> |
| <dd>a localized standard time formatter</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the Locale has no time |
| pattern defined</dd> |
| <dt>Since:</dt> |
| <dd>2.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTimeInstance(int,java.util.TimeZone,java.util.Locale)"> |
| <h3>getTimeInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></span> <span class="element-name">getTimeInstance</span><wbr><span class="parameters">(int style, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</span></div> |
| <div class="block"><p>Gets a time formatter instance using the specified style, time |
| zone and locale.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>style</code> - time style: FULL, LONG, MEDIUM, or SHORT</dd> |
| <dd><code>timeZone</code> - optional time zone, overrides time zone of |
| formatted time</dd> |
| <dd><code>locale</code> - optional locale, overrides system locale</dd> |
| <dt>Returns:</dt> |
| <dd>a localized standard time formatter</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the Locale has no time |
| pattern defined</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDateTimeInstance(int,int)"> |
| <h3>getDateTimeInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></span> <span class="element-name">getDateTimeInstance</span><wbr><span class="parameters">(int dateStyle, |
| int timeStyle)</span></div> |
| <div class="block"><p>Gets a date/time formatter instance using the specified style |
| in the default time zone and locale.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>dateStyle</code> - date style: FULL, LONG, MEDIUM, or SHORT</dd> |
| <dd><code>timeStyle</code> - time style: FULL, LONG, MEDIUM, or SHORT</dd> |
| <dt>Returns:</dt> |
| <dd>a localized standard date/time formatter</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the Locale has no date/time |
| pattern defined</dd> |
| <dt>Since:</dt> |
| <dd>2.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDateTimeInstance(int,int,java.util.Locale)"> |
| <h3>getDateTimeInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></span> <span class="element-name">getDateTimeInstance</span><wbr><span class="parameters">(int dateStyle, |
| int timeStyle, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</span></div> |
| <div class="block"><p>Gets a date/time formatter instance using the specified style and |
| locale in the default time zone.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>dateStyle</code> - date style: FULL, LONG, MEDIUM, or SHORT</dd> |
| <dd><code>timeStyle</code> - time style: FULL, LONG, MEDIUM, or SHORT</dd> |
| <dd><code>locale</code> - optional locale, overrides system locale</dd> |
| <dt>Returns:</dt> |
| <dd>a localized standard date/time formatter</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the Locale has no date/time |
| pattern defined</dd> |
| <dt>Since:</dt> |
| <dd>2.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDateTimeInstance(int,int,java.util.TimeZone)"> |
| <h3>getDateTimeInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></span> <span class="element-name">getDateTimeInstance</span><wbr><span class="parameters">(int dateStyle, |
| int timeStyle, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone)</span></div> |
| <div class="block"><p>Gets a date/time formatter instance using the specified style and |
| time zone in the default locale.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>dateStyle</code> - date style: FULL, LONG, MEDIUM, or SHORT</dd> |
| <dd><code>timeStyle</code> - time style: FULL, LONG, MEDIUM, or SHORT</dd> |
| <dd><code>timeZone</code> - optional time zone, overrides time zone of |
| formatted date</dd> |
| <dt>Returns:</dt> |
| <dd>a localized standard date/time formatter</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the Locale has no date/time |
| pattern defined</dd> |
| <dt>Since:</dt> |
| <dd>2.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getDateTimeInstance(int,int,java.util.TimeZone,java.util.Locale)"> |
| <h3>getDateTimeInstance</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="FastDateFormat.html" title="class in org.apache.logging.log4j.core.util.datetime">FastDateFormat</a></span> <span class="element-name">getDateTimeInstance</span><wbr><span class="parameters">(int dateStyle, |
| int timeStyle, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a> timeZone, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a> locale)</span></div> |
| <div class="block"><p>Gets a date/time formatter instance using the specified style, |
| time zone and locale.</p></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>dateStyle</code> - date style: FULL, LONG, MEDIUM, or SHORT</dd> |
| <dd><code>timeStyle</code> - time style: FULL, LONG, MEDIUM, or SHORT</dd> |
| <dd><code>timeZone</code> - optional time zone, overrides time zone of |
| formatted date</dd> |
| <dd><code>locale</code> - optional locale, overrides system locale</dd> |
| <dt>Returns:</dt> |
| <dd>a localized standard date/time formatter</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if the Locale has no date/time |
| pattern defined</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="format(java.lang.Object,java.lang.StringBuilder,java.text.FieldPosition)"> |
| <h3>format</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a></span> <span class="element-name">format</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> obj, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a> toAppendTo, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/text/FieldPosition.html" title="class or interface in java.text" class="external-link">FieldPosition</a> pos)</span></div> |
| <div class="block"><p>Formats a <code>Date</code>, <code>Calendar</code> or |
| <code>Long</code> (milliseconds) object.</p> |
| This method is an implementation of <a href="Format.html#format(java.lang.Object,java.lang.StringBuilder,java.text.FieldPosition)"><code>Format.format(Object, StringBuilder, FieldPosition)</code></a></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DatePrinter.html#format(java.lang.Object,java.lang.StringBuilder,java.text.FieldPosition)">format</a></code> in interface <code><a href="DatePrinter.html" title="interface in org.apache.logging.log4j.core.util.datetime">DatePrinter</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Format.html#format(java.lang.Object,java.lang.StringBuilder,java.text.FieldPosition)">format</a></code> in class <code><a href="Format.html" title="class in org.apache.logging.log4j.core.util.datetime">Format</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>obj</code> - the object to format</dd> |
| <dd><code>toAppendTo</code> - the buffer to append to</dd> |
| <dd><code>pos</code> - the position - ignored</dd> |
| <dt>Returns:</dt> |
| <dd>the buffer passed in</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/text/DateFormat.html#format-java.lang.Object-java.lang.StringBuffer-java.text.FieldPosition-" title="class or interface in java.text" class="external-link"><code>DateFormat.format(Object, StringBuffer, FieldPosition)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="format(long)"> |
| <h3>format</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">format</span><wbr><span class="parameters">(long millis)</span></div> |
| <div class="block"><p>Formats a millisecond <code>long</code> value.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DatePrinter.html#format(long)">format</a></code> in interface <code><a href="DatePrinter.html" title="interface in org.apache.logging.log4j.core.util.datetime">DatePrinter</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>millis</code> - the millisecond value to format</dd> |
| <dt>Returns:</dt> |
| <dd>the formatted string</dd> |
| <dt>Since:</dt> |
| <dd>2.1</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="format(java.util.Date)"> |
| <h3>format</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">format</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html" title="class or interface in java.util" class="external-link">Date</a> date)</span></div> |
| <div class="block"><p>Formats a <code>Date</code> object using a <code>GregorianCalendar</code>.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DatePrinter.html#format(java.util.Date)">format</a></code> in interface <code><a href="DatePrinter.html" title="interface in org.apache.logging.log4j.core.util.datetime">DatePrinter</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>date</code> - the date to format</dd> |
| <dt>Returns:</dt> |
| <dd>the formatted string</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="format(java.util.Calendar)"> |
| <h3>format</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">format</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html" title="class or interface in java.util" class="external-link">Calendar</a> calendar)</span></div> |
| <div class="block"><p>Formats a <code>Calendar</code> object.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DatePrinter.html#format(java.util.Calendar)">format</a></code> in interface <code><a href="DatePrinter.html" title="interface in org.apache.logging.log4j.core.util.datetime">DatePrinter</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>calendar</code> - the calendar to format</dd> |
| <dt>Returns:</dt> |
| <dd>the formatted string</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="format(long,B)"> |
| <h3 id="format(long,java.lang.Appendable)">format</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><B extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a>></span> <span class="return-type">B</span> <span class="element-name">format</span><wbr><span class="parameters">(long millis, |
| B buf)</span></div> |
| <div class="block"><p>Formats a millisecond <code>long</code> value into the |
| supplied <code>StringBuffer</code>.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DatePrinter.html#format(long,B)">format</a></code> in interface <code><a href="DatePrinter.html" title="interface in org.apache.logging.log4j.core.util.datetime">DatePrinter</a></code></dd> |
| <dt>Type Parameters:</dt> |
| <dd><code>B</code> - the Appendable class type, usually StringBuilder or StringBuffer.</dd> |
| <dt>Parameters:</dt> |
| <dd><code>millis</code> - the millisecond value to format</dd> |
| <dd><code>buf</code> - the buffer to format into</dd> |
| <dt>Returns:</dt> |
| <dd>the specified string buffer</dd> |
| <dt>Since:</dt> |
| <dd>3.5</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="format(java.util.Date,B)"> |
| <h3 id="format(java.util.Date,java.lang.Appendable)">format</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><B extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a>></span> <span class="return-type">B</span> <span class="element-name">format</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Date.html" title="class or interface in java.util" class="external-link">Date</a> date, |
| B buf)</span></div> |
| <div class="block"><p>Formats a <code>Date</code> object into the |
| supplied <code>StringBuffer</code> using a <code>GregorianCalendar</code>.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DatePrinter.html#format(java.util.Date,B)">format</a></code> in interface <code><a href="DatePrinter.html" title="interface in org.apache.logging.log4j.core.util.datetime">DatePrinter</a></code></dd> |
| <dt>Type Parameters:</dt> |
| <dd><code>B</code> - the Appendable class type, usually StringBuilder or StringBuffer.</dd> |
| <dt>Parameters:</dt> |
| <dd><code>date</code> - the date to format</dd> |
| <dd><code>buf</code> - the buffer to format into</dd> |
| <dt>Returns:</dt> |
| <dd>the specified string buffer</dd> |
| <dt>Since:</dt> |
| <dd>3.5</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="format(java.util.Calendar,B)"> |
| <h3 id="format(java.util.Calendar,java.lang.Appendable)">format</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><B extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Appendable.html" title="class or interface in java.lang" class="external-link">Appendable</a>></span> <span class="return-type">B</span> <span class="element-name">format</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Calendar.html" title="class or interface in java.util" class="external-link">Calendar</a> calendar, |
| B buf)</span></div> |
| <div class="block"><p>Formats a <code>Calendar</code> object into the |
| supplied <code>StringBuffer</code>.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DatePrinter.html#format(java.util.Calendar,B)">format</a></code> in interface <code><a href="DatePrinter.html" title="interface in org.apache.logging.log4j.core.util.datetime">DatePrinter</a></code></dd> |
| <dt>Type Parameters:</dt> |
| <dd><code>B</code> - the Appendable class type, usually StringBuilder or StringBuffer.</dd> |
| <dt>Parameters:</dt> |
| <dd><code>calendar</code> - the calendar to format</dd> |
| <dd><code>buf</code> - the buffer to format into</dd> |
| <dt>Returns:</dt> |
| <dd>the specified string buffer</dd> |
| <dt>Since:</dt> |
| <dd>3.5</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPattern()"> |
| <h3>getPattern</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getPattern</span>()</div> |
| <div class="block"><p>Gets the pattern used by this formatter.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DatePrinter.html#getPattern()">getPattern</a></code> in interface <code><a href="DatePrinter.html" title="interface in org.apache.logging.log4j.core.util.datetime">DatePrinter</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the pattern, <a href="https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html" title="class or interface in java.text" class="external-link"><code>SimpleDateFormat</code></a> compatible</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTimeZone()"> |
| <h3>getTimeZone</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/TimeZone.html" title="class or interface in java.util" class="external-link">TimeZone</a></span> <span class="element-name">getTimeZone</span>()</div> |
| <div class="block"><p>Gets the time zone used by this formatter.</p> |
| |
| <p>This zone is always used for <code>Date</code> formatting. </p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DatePrinter.html#getTimeZone()">getTimeZone</a></code> in interface <code><a href="DatePrinter.html" title="interface in org.apache.logging.log4j.core.util.datetime">DatePrinter</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the time zone</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLocale()"> |
| <h3>getLocale</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a></span> <span class="element-name">getLocale</span>()</div> |
| <div class="block"><p>Gets the locale used by this formatter.</p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="DatePrinter.html#getLocale()">getLocale</a></code> in interface <code><a href="DatePrinter.html" title="interface in org.apache.logging.log4j.core.util.datetime">DatePrinter</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the locale</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMaxLengthEstimate()"> |
| <h3>getMaxLengthEstimate</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getMaxLengthEstimate</span>()</div> |
| <div class="block"><p>Gets an estimate for the maximum string length that the |
| formatter will produce.</p> |
| |
| <p>The actual formatted length will almost always be less than or |
| equal to this amount.</p></div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the maximum formatted length</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="equals(java.lang.Object)"> |
| <h3>equals</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">equals</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> obj)</span></div> |
| <div class="block"><p>Compares two objects for equality.</p></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>obj</code> - the object to compare to</dd> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if equal</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hashCode()"> |
| <h3>hashCode</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">hashCode</span>()</div> |
| <div class="block"><p>Returns a hash code compatible with equals.</p></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>a hash code compatible with equals</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">toString</span>()</div> |
| <div class="block"><p>Gets a debugging string version of this formatter.</p></div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>a debugging string</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><p align="center"> Copyright © 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation. </p></small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
