| <!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.StringBuilderFormattable;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>/**<a name="line.22"></a> |
| <span class="sourceLineNo">023</span> * Models a point in time, suitable for event timestamps.<a name="line.23"></a> |
| <span class="sourceLineNo">024</span> * <p><a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * Provides methods for obtaining high precision time information similar to the<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * <a href="https://docs.oracle.com/javase/9/docs/api/java/time/Instant.html">Instant</a> class introduced in Java 8,<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * while also supporting the legacy millisecond precision API.<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * </p><p><a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * Depending on the platform, time sources ({@link Clock} implementations) may produce high precision or millisecond<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * precision time values. At the same time, some time value consumers (for example timestamp formatters) may only be<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * able to consume time values of millisecond precision, while some others may require a high precision time value.<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * </p><p><a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * This class bridges these two time APIs.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * </p><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * @since 2.11<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> */<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>public interface Instant extends StringBuilderFormattable {<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> /**<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * Gets the number of seconds from the Java epoch of 1970-01-01T00:00:00Z.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <p><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * The epoch second count is a simple incrementing count of seconds where second 0 is 1970-01-01T00:00:00Z.<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * The nanosecond part of the day is returned by {@link #getNanoOfSecond()}.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * </p><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * @return the seconds from the epoch of 1970-01-01T00:00:00Z<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> */<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> long getEpochSecond();<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> * Gets the number of nanoseconds, later along the time-line, from the start of the second.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <p><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * The nanosecond-of-second value measures the total number of nanoseconds from the second returned by {@link #getEpochSecond()}.<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * </p><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * @return the nanoseconds within the second, always positive, never exceeds {@code 999,999,999}<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> */<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> int getNanoOfSecond();<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> /**<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * Gets the number of milliseconds from the Java epoch of 1970-01-01T00:00:00Z.<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * <p><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * The epoch millisecond count is a simple incrementing count of milliseconds where millisecond 0 is 1970-01-01T00:00:00Z.<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * The nanosecond part of the day is returned by {@link #getNanoOfMillisecond()}.<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * </p><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * @return the milliseconds from the epoch of 1970-01-01T00:00:00Z<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> */<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> long getEpochMillisecond();<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> * Gets the number of nanoseconds, later along the time-line, from the start of the millisecond.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> * <p><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * The nanosecond-of-millisecond value measures the total number of nanoseconds from the millisecond returned by {@link #getEpochMillisecond()}.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * </p><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * @return the nanoseconds within the millisecond, always positive, never exceeds {@code 999,999}<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> */<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> int getNanoOfMillisecond();<a name="line.74"></a> |
| <span class="sourceLineNo">075</span>}<a name="line.75"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
