| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>MutableInstant (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.time, class: MutableInstant"> |
| <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/MutableInstant.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>Field | </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>Field | </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.time</a></div> |
| <h1 title="Class MutableInstant" class="title">Class MutableInstant</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">org.apache.logging.log4j.core.time.MutableInstant</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalAccessor.html" title="class or interface in java.time.temporal" class="external-link">TemporalAccessor</a></code>, <code><a href="Instant.html" title="interface in org.apache.logging.log4j.core.time">Instant</a></code>, <code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/util/StringBuilderFormattable.html" title="class or interface in org.apache.logging.log4j.util" class="external-link">StringBuilderFormattable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">MutableInstant</span> |
| <span class="extends-implements">extends <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> |
| implements <a href="Instant.html" title="interface in org.apache.logging.log4j.core.time">Instant</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html" title="class or interface in java.io" class="external-link">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalAccessor.html" title="class or interface in java.time.temporal" class="external-link">TemporalAccessor</a></span></div> |
| <div class="block">An instantaneous point on the time line, used for high-precision log event timestamps. |
| Modeled on <a href="https://docs.oracle.com/javase/9/docs/api/index.html?java/time/class-use/Instant.html">java.time.Instant</a>, |
| except that this version is mutable to prevent allocating temporary objects that need to be garbage-collected later. |
| <p> |
| Instances of this class are <em>not</em> thread-safe and should not be shared between threads. |
| </p></div> |
| <dl class="notes"> |
| <dt>Since:</dt> |
| <dd>2.11</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../../serialized-form.html#org.apache.logging.log4j.core.time.MutableInstant">Serialized Form</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== 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 two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">MutableInstant</a>()</code></div> |
| <div class="col-last even-row-color"> </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> object)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#formatTo(java.lang.StringBuilder)" class="member-name-link">formatTo</a><wbr>(<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> buffer)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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="#get(java.time.temporal.TemporalField)" class="member-name-link">get</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalField.html" title="class or interface in java.time.temporal" class="external-link">TemporalField</a> field)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEpochMillisecond()" class="member-name-link">getEpochMillisecond</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 number of milliseconds from the Java epoch of 1970-01-01T00:00:00Z.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getEpochSecond()" class="member-name-link">getEpochSecond</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 number of seconds from the Java epoch of 1970-01-01T00:00:00Z.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLong(java.time.temporal.TemporalField)" class="member-name-link">getLong</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalField.html" title="class or interface in java.time.temporal" class="external-link">TemporalField</a> field)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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="#getNanoOfMillisecond()" class="member-name-link">getNanoOfMillisecond</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 number of nanoseconds, later along the time-line, from the start of the millisecond.</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="#getNanoOfSecond()" class="member-name-link">getNanoOfSecond</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 number of nanoseconds, later along the time-line, from the start of the second.</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="#hashCode()" class="member-name-link">hashCode</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initFrom(org.apache.logging.log4j.core.time.Instant)" class="member-name-link">initFrom</a><wbr>(<a href="Instant.html" title="interface in org.apache.logging.log4j.core.time">Instant</a> other)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initFrom(org.apache.logging.log4j.core.util.Clock)" class="member-name-link">initFrom</a><wbr>(<a href="../util/Clock.html" title="interface in org.apache.logging.log4j.core.util">Clock</a> clock)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initFromEpochMilli(long,int)" class="member-name-link">initFromEpochMilli</a><wbr>(long epochMilli, |
| int nanoOfMillisecond)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Updates the fields of this <code>MutableInstant</code> from the specified epoch millis.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initFromEpochSecond(long,int)" class="member-name-link">initFromEpochSecond</a><wbr>(long epochSecond, |
| int nano)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Updates the fields of this <code>MutableInstant</code> from the specified instant components.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#instantToMillisAndNanos(long,int,long%5B%5D)" class="member-name-link">instantToMillisAndNanos</a><wbr>(long epochSecond, |
| int nano, |
| long[] result)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Updates the elements of the specified <code>long[]</code> result array from the specified instant components.</div> |
| </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="#isSupported(java.time.temporal.TemporalField)" class="member-name-link">isSupported</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalField.html" title="class or interface in java.time.temporal" class="external-link">TemporalField</a> field)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><R> R</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#query(java.time.temporal.TemporalQuery)" class="member-name-link">query</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalQuery.html" title="class or interface in java.time.temporal" class="external-link">TemporalQuery</a><R> query)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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/time/temporal/ValueRange.html" title="class or interface in java.time.temporal" class="external-link">ValueRange</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#range(java.time.temporal.TemporalField)" class="member-name-link">range</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalField.html" title="class or interface in java.time.temporal" class="external-link">TemporalField</a> field)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>MutableInstant</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">MutableInstant</span>()</div> |
| </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="getEpochSecond()"> |
| <h3>getEpochSecond</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getEpochSecond</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Instant.html#getEpochSecond()">Instant</a></code></span></div> |
| <div class="block">Gets the number of seconds from the Java epoch of 1970-01-01T00:00:00Z. |
| <p> |
| The epoch second count is a simple incrementing count of seconds where second 0 is 1970-01-01T00:00:00Z. |
| The nanosecond part of the day is returned by <a href="Instant.html#getNanoOfSecond()"><code>Instant.getNanoOfSecond()</code></a>. |
| </p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Instant.html#getEpochSecond()">getEpochSecond</a></code> in interface <code><a href="Instant.html" title="interface in org.apache.logging.log4j.core.time">Instant</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the seconds from the epoch of 1970-01-01T00:00:00Z</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNanoOfSecond()"> |
| <h3>getNanoOfSecond</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNanoOfSecond</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Instant.html#getNanoOfSecond()">Instant</a></code></span></div> |
| <div class="block">Gets the number of nanoseconds, later along the time-line, from the start of the second. |
| <p> |
| The nanosecond-of-second value measures the total number of nanoseconds from the second returned by <a href="Instant.html#getEpochSecond()"><code>Instant.getEpochSecond()</code></a>. |
| </p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Instant.html#getNanoOfSecond()">getNanoOfSecond</a></code> in interface <code><a href="Instant.html" title="interface in org.apache.logging.log4j.core.time">Instant</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the nanoseconds within the second, always positive, never exceeds <code>999,999,999</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getEpochMillisecond()"> |
| <h3>getEpochMillisecond</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getEpochMillisecond</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Instant.html#getEpochMillisecond()">Instant</a></code></span></div> |
| <div class="block">Gets the number of milliseconds from the Java epoch of 1970-01-01T00:00:00Z. |
| <p> |
| The epoch millisecond count is a simple incrementing count of milliseconds where millisecond 0 is 1970-01-01T00:00:00Z. |
| The nanosecond part of the day is returned by <a href="Instant.html#getNanoOfMillisecond()"><code>Instant.getNanoOfMillisecond()</code></a>. |
| </p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Instant.html#getEpochMillisecond()">getEpochMillisecond</a></code> in interface <code><a href="Instant.html" title="interface in org.apache.logging.log4j.core.time">Instant</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the milliseconds from the epoch of 1970-01-01T00:00:00Z</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNanoOfMillisecond()"> |
| <h3>getNanoOfMillisecond</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getNanoOfMillisecond</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="Instant.html#getNanoOfMillisecond()">Instant</a></code></span></div> |
| <div class="block">Gets the number of nanoseconds, later along the time-line, from the start of the millisecond. |
| <p> |
| The nanosecond-of-millisecond value measures the total number of nanoseconds from the millisecond returned by <a href="Instant.html#getEpochMillisecond()"><code>Instant.getEpochMillisecond()</code></a>. |
| </p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="Instant.html#getNanoOfMillisecond()">getNanoOfMillisecond</a></code> in interface <code><a href="Instant.html" title="interface in org.apache.logging.log4j.core.time">Instant</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>the nanoseconds within the millisecond, always positive, never exceeds <code>999,999</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="initFrom(org.apache.logging.log4j.core.time.Instant)"> |
| <h3>initFrom</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">initFrom</span><wbr><span class="parameters">(<a href="Instant.html" title="interface in org.apache.logging.log4j.core.time">Instant</a> other)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="initFromEpochMilli(long,int)"> |
| <h3>initFromEpochMilli</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">initFromEpochMilli</span><wbr><span class="parameters">(long epochMilli, |
| int nanoOfMillisecond)</span></div> |
| <div class="block">Updates the fields of this <code>MutableInstant</code> from the specified epoch millis.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>epochMilli</code> - the number of milliseconds from the Java epoch of 1970-01-01T00:00:00Z</dd> |
| <dd><code>nanoOfMillisecond</code> - the number of nanoseconds, later along the time-line, from the start of the millisecond</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="initFrom(org.apache.logging.log4j.core.util.Clock)"> |
| <h3>initFrom</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">initFrom</span><wbr><span class="parameters">(<a href="../util/Clock.html" title="interface in org.apache.logging.log4j.core.util">Clock</a> clock)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="initFromEpochSecond(long,int)"> |
| <h3>initFromEpochSecond</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">initFromEpochSecond</span><wbr><span class="parameters">(long epochSecond, |
| int nano)</span></div> |
| <div class="block">Updates the fields of this <code>MutableInstant</code> from the specified instant components.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>epochSecond</code> - the number of seconds from the Java epoch of 1970-01-01T00:00:00Z</dd> |
| <dd><code>nano</code> - the number of nanoseconds, later along the time-line, from the start of the second</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="instantToMillisAndNanos(long,int,long[])"> |
| <h3>instantToMillisAndNanos</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">instantToMillisAndNanos</span><wbr><span class="parameters">(long epochSecond, |
| int nano, |
| long[] result)</span></div> |
| <div class="block">Updates the elements of the specified <code>long[]</code> result array from the specified instant components.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>epochSecond</code> - (input) the number of seconds from the Java epoch of 1970-01-01T00:00:00Z</dd> |
| <dd><code>nano</code> - (input) the number of nanoseconds, later along the time-line, from the start of the second</dd> |
| <dd><code>result</code> - (output) a two-element array to store the result: the first element is the number of milliseconds |
| from the Java epoch of 1970-01-01T00:00:00Z, |
| the second element is the number of nanoseconds, later along the time-line, from the start of the millisecond</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSupported(java.time.temporal.TemporalField)"> |
| <h3>isSupported</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isSupported</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalField.html" title="class or interface in java.time.temporal" class="external-link">TemporalField</a> field)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalAccessor.html#isSupported-java.time.temporal.TemporalField-" title="class or interface in java.time.temporal" class="external-link">isSupported</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalAccessor.html" title="class or interface in java.time.temporal" class="external-link">TemporalAccessor</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLong(java.time.temporal.TemporalField)"> |
| <h3>getLong</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getLong</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalField.html" title="class or interface in java.time.temporal" class="external-link">TemporalField</a> field)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalAccessor.html#getLong-java.time.temporal.TemporalField-" title="class or interface in java.time.temporal" class="external-link">getLong</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalAccessor.html" title="class or interface in java.time.temporal" class="external-link">TemporalAccessor</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="range(java.time.temporal.TemporalField)"> |
| <h3>range</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/time/temporal/ValueRange.html" title="class or interface in java.time.temporal" class="external-link">ValueRange</a></span> <span class="element-name">range</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalField.html" title="class or interface in java.time.temporal" class="external-link">TemporalField</a> field)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalAccessor.html#range-java.time.temporal.TemporalField-" title="class or interface in java.time.temporal" class="external-link">range</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalAccessor.html" title="class or interface in java.time.temporal" class="external-link">TemporalAccessor</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="get(java.time.temporal.TemporalField)"> |
| <h3>get</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">get</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalField.html" title="class or interface in java.time.temporal" class="external-link">TemporalField</a> field)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalAccessor.html#get-java.time.temporal.TemporalField-" title="class or interface in java.time.temporal" class="external-link">get</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalAccessor.html" title="class or interface in java.time.temporal" class="external-link">TemporalAccessor</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="query(java.time.temporal.TemporalQuery)"> |
| <h3>query</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="type-parameters"><R></span> <span class="return-type">R</span> <span class="element-name">query</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalQuery.html" title="class or interface in java.time.temporal" class="external-link">TemporalQuery</a><R> query)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalAccessor.html#query-java.time.temporal.TemporalQuery-" title="class or interface in java.time.temporal" class="external-link">query</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/time/temporal/TemporalAccessor.html" title="class or interface in java.time.temporal" class="external-link">TemporalAccessor</a></code></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> object)</span></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> |
| </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> |
| <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> |
| </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> |
| <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> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="formatTo(java.lang.StringBuilder)"> |
| <h3>formatTo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">formatTo</span><wbr><span class="parameters">(<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> buffer)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/util/StringBuilderFormattable.html#formatTo(java.lang.StringBuilder)" title="class or interface in org.apache.logging.log4j.util" class="external-link">formatTo</a></code> in interface <code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/util/StringBuilderFormattable.html" title="class or interface in org.apache.logging.log4j.util" class="external-link">StringBuilderFormattable</a></code></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> |
