Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.0 / log4j-core / apidocs / src-html / org / apache / logging / log4j / core / time / MutableInstant.html
blob: c031bc9921fa86ec5bc3b9288fe83b54d62d184e [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.logging.log4j.core.time;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.apache.logging.log4j.core.util.Clock;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.apache.logging.log4j.util.PerformanceSensitive;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.Serializable;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>/**<a name="line.24"></a>
<span class="sourceLineNo">025</span> * An instantaneous point on the time line, used for high-precision log event timestamps.<a name="line.25"></a>
<span class="sourceLineNo">026</span> * Modeled on &lt;a href="https://docs.oracle.com/javase/9/docs/api/index.html?java/time/class-use/Instant.html"&gt;java.time.Instant&lt;/a&gt;,<a name="line.26"></a>
<span class="sourceLineNo">027</span> * except that this version is mutable to prevent allocating temporary objects that need to be garbage-collected later.<a name="line.27"></a>
<span class="sourceLineNo">028</span> * &lt;p&gt;<a name="line.28"></a>
<span class="sourceLineNo">029</span> * Instances of this class are &lt;em&gt;not&lt;/em&gt; thread-safe and should not be shared between threads.<a name="line.29"></a>
<span class="sourceLineNo">030</span> * &lt;/p&gt;<a name="line.30"></a>
<span class="sourceLineNo">031</span> *<a name="line.31"></a>
<span class="sourceLineNo">032</span> * @since 2.11<a name="line.32"></a>
<span class="sourceLineNo">033</span> */<a name="line.33"></a>
<span class="sourceLineNo">034</span>@PerformanceSensitive("allocation")<a name="line.34"></a>
<span class="sourceLineNo">035</span>public class MutableInstant implements Instant, Serializable {<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span> private static final int MILLIS_PER_SECOND = 1000;<a name="line.37"></a>
<span class="sourceLineNo">038</span> private static final int NANOS_PER_MILLI = 1000_000;<a name="line.38"></a>
<span class="sourceLineNo">039</span> private static final int NANOS_PER_SECOND = MILLIS_PER_SECOND * NANOS_PER_MILLI;<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span> private long epochSecond;<a name="line.41"></a>
<span class="sourceLineNo">042</span> private int nanoOfSecond;<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> @Override<a name="line.44"></a>
<span class="sourceLineNo">045</span> public long getEpochSecond() {<a name="line.45"></a>
<span class="sourceLineNo">046</span> return epochSecond;<a name="line.46"></a>
<span class="sourceLineNo">047</span> }<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> @Override<a name="line.49"></a>
<span class="sourceLineNo">050</span> public int getNanoOfSecond() {<a name="line.50"></a>
<span class="sourceLineNo">051</span> return nanoOfSecond;<a name="line.51"></a>
<span class="sourceLineNo">052</span> }<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>
<span class="sourceLineNo">054</span> @Override<a name="line.54"></a>
<span class="sourceLineNo">055</span> public long getEpochMillisecond() {<a name="line.55"></a>
<span class="sourceLineNo">056</span> final int millis = nanoOfSecond / NANOS_PER_MILLI;<a name="line.56"></a>
<span class="sourceLineNo">057</span> final long epochMillisecond = epochSecond * MILLIS_PER_SECOND + millis;<a name="line.57"></a>
<span class="sourceLineNo">058</span> return epochMillisecond;<a name="line.58"></a>
<span class="sourceLineNo">059</span> }<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> @Override<a name="line.61"></a>
<span class="sourceLineNo">062</span> public int getNanoOfMillisecond() {<a name="line.62"></a>
<span class="sourceLineNo">063</span> final int millis = nanoOfSecond / NANOS_PER_MILLI;<a name="line.63"></a>
<span class="sourceLineNo">064</span> final int nanoOfMillisecond = nanoOfSecond - (millis * NANOS_PER_MILLI); // cheaper than nanoOfSecond % NANOS_PER_MILLI<a name="line.64"></a>
<span class="sourceLineNo">065</span> return nanoOfMillisecond;<a name="line.65"></a>
<span class="sourceLineNo">066</span> }<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span> public void initFrom(final Instant other) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> this.epochSecond = other.getEpochSecond();<a name="line.69"></a>
<span class="sourceLineNo">070</span> this.nanoOfSecond = other.getNanoOfSecond();<a name="line.70"></a>
<span class="sourceLineNo">071</span> }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span> /**<a name="line.73"></a>
<span class="sourceLineNo">074</span> * Updates the fields of this {@code MutableInstant} from the specified epoch millis.<a name="line.74"></a>
<span class="sourceLineNo">075</span> * @param epochMilli the number of milliseconds from the Java epoch of 1970-01-01T00:00:00Z<a name="line.75"></a>
<span class="sourceLineNo">076</span> * @param nanoOfMillisecond the number of nanoseconds, later along the time-line, from the start of the millisecond<a name="line.76"></a>
<span class="sourceLineNo">077</span> */<a name="line.77"></a>
<span class="sourceLineNo">078</span> public void initFromEpochMilli(final long epochMilli, final int nanoOfMillisecond) {<a name="line.78"></a>
<span class="sourceLineNo">079</span> validateNanoOfMillisecond(nanoOfMillisecond);<a name="line.79"></a>
<span class="sourceLineNo">080</span> this.epochSecond = epochMilli / MILLIS_PER_SECOND;<a name="line.80"></a>
<span class="sourceLineNo">081</span> this.nanoOfSecond = (int) (epochMilli - (epochSecond * MILLIS_PER_SECOND)) * NANOS_PER_MILLI + nanoOfMillisecond;<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> private void validateNanoOfMillisecond(final int nanoOfMillisecond) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> if (nanoOfMillisecond &lt; 0 || nanoOfMillisecond &gt;= NANOS_PER_MILLI) {<a name="line.85"></a>
<span class="sourceLineNo">086</span> throw new IllegalArgumentException("Invalid nanoOfMillisecond " + nanoOfMillisecond);<a name="line.86"></a>
<span class="sourceLineNo">087</span> }<a name="line.87"></a>
<span class="sourceLineNo">088</span> }<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> public void initFrom(final Clock clock) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> if (clock instanceof PreciseClock) {<a name="line.91"></a>
<span class="sourceLineNo">092</span> ((PreciseClock) clock).init(this);<a name="line.92"></a>
<span class="sourceLineNo">093</span> } else {<a name="line.93"></a>
<span class="sourceLineNo">094</span> initFromEpochMilli(clock.currentTimeMillis(), 0);<a name="line.94"></a>
<span class="sourceLineNo">095</span> }<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> /**<a name="line.98"></a>
<span class="sourceLineNo">099</span> * Updates the fields of this {@code MutableInstant} from the specified instant components.<a name="line.99"></a>
<span class="sourceLineNo">100</span> * @param epochSecond the number of seconds from the Java epoch of 1970-01-01T00:00:00Z<a name="line.100"></a>
<span class="sourceLineNo">101</span> * @param nano the number of nanoseconds, later along the time-line, from the start of the second<a name="line.101"></a>
<span class="sourceLineNo">102</span> */<a name="line.102"></a>
<span class="sourceLineNo">103</span> public void initFromEpochSecond(final long epochSecond, final int nano) {<a name="line.103"></a>
<span class="sourceLineNo">104</span> validateNanoOfSecond(nano);<a name="line.104"></a>
<span class="sourceLineNo">105</span> this.epochSecond = epochSecond;<a name="line.105"></a>
<span class="sourceLineNo">106</span> this.nanoOfSecond = nano;<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span> private void validateNanoOfSecond(final int nano) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> if (nano &lt; 0 || nano &gt;= NANOS_PER_SECOND) {<a name="line.110"></a>
<span class="sourceLineNo">111</span> throw new IllegalArgumentException("Invalid nanoOfSecond " + nano);<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span> }<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span> /**<a name="line.115"></a>
<span class="sourceLineNo">116</span> * Updates the elements of the specified {@code long[]} result array from the specified instant components.<a name="line.116"></a>
<span class="sourceLineNo">117</span> * @param epochSecond (input) the number of seconds from the Java epoch of 1970-01-01T00:00:00Z<a name="line.117"></a>
<span class="sourceLineNo">118</span> * @param nano (input) the number of nanoseconds, later along the time-line, from the start of the second<a name="line.118"></a>
<span class="sourceLineNo">119</span> * @param result (output) a two-element array to store the result: the first element is the number of milliseconds<a name="line.119"></a>
<span class="sourceLineNo">120</span> * from the Java epoch of 1970-01-01T00:00:00Z,<a name="line.120"></a>
<span class="sourceLineNo">121</span> * the second element is the number of nanoseconds, later along the time-line, from the start of the millisecond<a name="line.121"></a>
<span class="sourceLineNo">122</span> */<a name="line.122"></a>
<span class="sourceLineNo">123</span> public static void instantToMillisAndNanos(final long epochSecond, final int nano, final long[] result) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> final int millis = nano / NANOS_PER_MILLI;<a name="line.124"></a>
<span class="sourceLineNo">125</span> result[0] = epochSecond * MILLIS_PER_SECOND + millis;<a name="line.125"></a>
<span class="sourceLineNo">126</span> result[1] = nano - (millis * NANOS_PER_MILLI); // cheaper than nanoOfSecond % NANOS_PER_MILLI<a name="line.126"></a>
<span class="sourceLineNo">127</span> }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> @Override<a name="line.129"></a>
<span class="sourceLineNo">130</span> public boolean equals(final Object object) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> if (object == this) {<a name="line.131"></a>
<span class="sourceLineNo">132</span> return true;<a name="line.132"></a>
<span class="sourceLineNo">133</span> }<a name="line.133"></a>
<span class="sourceLineNo">134</span> if (!(object instanceof MutableInstant)) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> return false;<a name="line.135"></a>
<span class="sourceLineNo">136</span> }<a name="line.136"></a>
<span class="sourceLineNo">137</span> final MutableInstant other = (MutableInstant) object;<a name="line.137"></a>
<span class="sourceLineNo">138</span> return epochSecond == other.epochSecond &amp;&amp; nanoOfSecond == other.nanoOfSecond;<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> @Override<a name="line.141"></a>
<span class="sourceLineNo">142</span> public int hashCode() {<a name="line.142"></a>
<span class="sourceLineNo">143</span> int result = 17;<a name="line.143"></a>
<span class="sourceLineNo">144</span> result = 31 * result + (int) (epochSecond ^ (epochSecond &gt;&gt;&gt; 32));<a name="line.144"></a>
<span class="sourceLineNo">145</span> result = 31 * result + nanoOfSecond;<a name="line.145"></a>
<span class="sourceLineNo">146</span> return result;<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span><a name="line.148"></a>
<span class="sourceLineNo">149</span> @Override<a name="line.149"></a>
<span class="sourceLineNo">150</span> public String toString() {<a name="line.150"></a>
<span class="sourceLineNo">151</span> final StringBuilder sb = new StringBuilder(64);<a name="line.151"></a>
<span class="sourceLineNo">152</span> formatTo(sb);<a name="line.152"></a>
<span class="sourceLineNo">153</span> return sb.toString();<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span> @Override<a name="line.156"></a>
<span class="sourceLineNo">157</span> public void formatTo(final StringBuilder buffer) {<a name="line.157"></a>
<span class="sourceLineNo">158</span> buffer.append("MutableInstant[epochSecond=").append(epochSecond).append(", nano=").append(nanoOfSecond).append("]");<a name="line.158"></a>
<span class="sourceLineNo">159</span> }<a name="line.159"></a>
<span class="sourceLineNo">160</span>}<a name="line.160"></a>
</pre>
</div>
</body>
</html>