blob: a609e6006fbe203bdbf3c77a6d305bc1bf2a1048 [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><a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.logging.log4j.core.util.datetime;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.apache.logging.log4j.core.time.Instant;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Arrays;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.Calendar;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Objects;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.TimeZone;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.concurrent.TimeUnit;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>/**<a name="line.28"></a>
<span class="sourceLineNo">029</span> * Custom time formatter that trades flexibility for performance. This formatter only supports the date patterns defined<a name="line.29"></a>
<span class="sourceLineNo">030</span> * in {@link FixedFormat}. For any other date patterns use {@link FastDateFormat}.<a name="line.30"></a>
<span class="sourceLineNo">031</span> * &lt;p&gt;<a name="line.31"></a>
<span class="sourceLineNo">032</span> * Related benchmarks: /log4j-perf/src/main/java/org/apache/logging/log4j/perf/jmh/TimeFormatBenchmark.java and<a name="line.32"></a>
<span class="sourceLineNo">033</span> * /log4j-perf/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadsafeDateFormatBenchmark.java<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;/p&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> */<a name="line.35"></a>
<span class="sourceLineNo">036</span>public class FixedDateFormat {<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span> /**<a name="line.38"></a>
<span class="sourceLineNo">039</span> * Enumeration over the supported date/time format patterns.<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;p&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> * Package protected for unit tests.<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;/p&gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> */<a name="line.43"></a>
<span class="sourceLineNo">044</span> public enum FixedFormat {<a name="line.44"></a>
<span class="sourceLineNo">045</span> <a name="line.45"></a>
<span class="sourceLineNo">046</span> /**<a name="line.46"></a>
<span class="sourceLineNo">047</span> * ABSOLUTE time format: {@code "HH:mm:ss,SSS"}.<a name="line.47"></a>
<span class="sourceLineNo">048</span> */<a name="line.48"></a>
<span class="sourceLineNo">049</span> ABSOLUTE("HH:mm:ss,SSS", null, 0, ':', 1, ',', 1, 3, null),<a name="line.49"></a>
<span class="sourceLineNo">050</span> /**<a name="line.50"></a>
<span class="sourceLineNo">051</span> * ABSOLUTE time format with microsecond precision: {@code "HH:mm:ss,nnnnnn"}.<a name="line.51"></a>
<span class="sourceLineNo">052</span> */<a name="line.52"></a>
<span class="sourceLineNo">053</span> ABSOLUTE_MICROS("HH:mm:ss,nnnnnn", null, 0, ':', 1, ',', 1, 6, null),<a name="line.53"></a>
<span class="sourceLineNo">054</span> /**<a name="line.54"></a>
<span class="sourceLineNo">055</span> * ABSOLUTE time format with nanosecond precision: {@code "HH:mm:ss,nnnnnnnnn"}.<a name="line.55"></a>
<span class="sourceLineNo">056</span> */<a name="line.56"></a>
<span class="sourceLineNo">057</span> ABSOLUTE_NANOS("HH:mm:ss,nnnnnnnnn", null, 0, ':', 1, ',', 1, 9, null),<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> /**<a name="line.59"></a>
<span class="sourceLineNo">060</span> * ABSOLUTE time format variation with period separator: {@code "HH:mm:ss.SSS"}.<a name="line.60"></a>
<span class="sourceLineNo">061</span> */<a name="line.61"></a>
<span class="sourceLineNo">062</span> ABSOLUTE_PERIOD("HH:mm:ss.SSS", null, 0, ':', 1, '.', 1, 3, null),<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> /**<a name="line.64"></a>
<span class="sourceLineNo">065</span> * COMPACT time format: {@code "yyyyMMddHHmmssSSS"}.<a name="line.65"></a>
<span class="sourceLineNo">066</span> */<a name="line.66"></a>
<span class="sourceLineNo">067</span> COMPACT("yyyyMMddHHmmssSSS", "yyyyMMdd", 0, ' ', 0, ' ', 0, 3, null),<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> /**<a name="line.69"></a>
<span class="sourceLineNo">070</span> * DATE_AND_TIME time format: {@code "dd MMM yyyy HH:mm:ss,SSS"}.<a name="line.70"></a>
<span class="sourceLineNo">071</span> */<a name="line.71"></a>
<span class="sourceLineNo">072</span> DATE("dd MMM yyyy HH:mm:ss,SSS", "dd MMM yyyy ", 0, ':', 1, ',', 1, 3, null),<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> /**<a name="line.74"></a>
<span class="sourceLineNo">075</span> * DATE_AND_TIME time format variation with period separator: {@code "dd MMM yyyy HH:mm:ss.SSS"}.<a name="line.75"></a>
<span class="sourceLineNo">076</span> */<a name="line.76"></a>
<span class="sourceLineNo">077</span> DATE_PERIOD("dd MMM yyyy HH:mm:ss.SSS", "dd MMM yyyy ", 0, ':', 1, '.', 1, 3, null),<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> /**<a name="line.79"></a>
<span class="sourceLineNo">080</span> * DEFAULT time format: {@code "yyyy-MM-dd HH:mm:ss,SSS"}.<a name="line.80"></a>
<span class="sourceLineNo">081</span> */<a name="line.81"></a>
<span class="sourceLineNo">082</span> DEFAULT("yyyy-MM-dd HH:mm:ss,SSS", "yyyy-MM-dd ", 0, ':', 1, ',', 1, 3, null),<a name="line.82"></a>
<span class="sourceLineNo">083</span> /**<a name="line.83"></a>
<span class="sourceLineNo">084</span> * DEFAULT time format with microsecond precision: {@code "yyyy-MM-dd HH:mm:ss,nnnnnn"}.<a name="line.84"></a>
<span class="sourceLineNo">085</span> */<a name="line.85"></a>
<span class="sourceLineNo">086</span> DEFAULT_MICROS("yyyy-MM-dd HH:mm:ss,nnnnnn", "yyyy-MM-dd ", 0, ':', 1, ',', 1, 6, null),<a name="line.86"></a>
<span class="sourceLineNo">087</span> /**<a name="line.87"></a>
<span class="sourceLineNo">088</span> * DEFAULT time format with nanosecond precision: {@code "yyyy-MM-dd HH:mm:ss,nnnnnnnnn"}.<a name="line.88"></a>
<span class="sourceLineNo">089</span> */<a name="line.89"></a>
<span class="sourceLineNo">090</span> DEFAULT_NANOS("yyyy-MM-dd HH:mm:ss,nnnnnnnnn", "yyyy-MM-dd ", 0, ':', 1, ',', 1, 9, null),<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> /**<a name="line.92"></a>
<span class="sourceLineNo">093</span> * DEFAULT time format variation with period separator: {@code "yyyy-MM-dd HH:mm:ss.SSS"}.<a name="line.93"></a>
<span class="sourceLineNo">094</span> */<a name="line.94"></a>
<span class="sourceLineNo">095</span> DEFAULT_PERIOD("yyyy-MM-dd HH:mm:ss.SSS", "yyyy-MM-dd ", 0, ':', 1, '.', 1, 3, null),<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> * ISO8601_BASIC time format: {@code "yyyyMMdd'T'HHmmss,SSS"}.<a name="line.98"></a>
<span class="sourceLineNo">099</span> */<a name="line.99"></a>
<span class="sourceLineNo">100</span> ISO8601_BASIC("yyyyMMdd'T'HHmmss,SSS", "yyyyMMdd'T'", 2, ' ', 0, ',', 1, 3, null),<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> /**<a name="line.102"></a>
<span class="sourceLineNo">103</span> * ISO8601_BASIC time format: {@code "yyyyMMdd'T'HHmmss.SSS"}.<a name="line.103"></a>
<span class="sourceLineNo">104</span> */<a name="line.104"></a>
<span class="sourceLineNo">105</span> ISO8601_BASIC_PERIOD("yyyyMMdd'T'HHmmss.SSS", "yyyyMMdd'T'", 2, ' ', 0, '.', 1, 3, null),<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span> /**<a name="line.107"></a>
<span class="sourceLineNo">108</span> * ISO8601 time format: {@code "yyyy-MM-dd'T'HH:mm:ss,SSS"}.<a name="line.108"></a>
<span class="sourceLineNo">109</span> */<a name="line.109"></a>
<span class="sourceLineNo">110</span> ISO8601("yyyy-MM-dd'T'HH:mm:ss,SSS", "yyyy-MM-dd'T'", 2, ':', 1, ',', 1, 3, null),<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span>// TODO Do we even want a format without seconds?<a name="line.112"></a>
<span class="sourceLineNo">113</span>// /**<a name="line.113"></a>
<span class="sourceLineNo">114</span>// * ISO8601_OFFSET_DATE_TIME time format: {@code "yyyy-MM-dd'T'HH:mmXXX"}.<a name="line.114"></a>
<span class="sourceLineNo">115</span>// */<a name="line.115"></a>
<span class="sourceLineNo">116</span>// // Would need work in org.apache.logging.log4j.core.util.datetime.FixedDateFormat.writeTime(int, char[], int)<a name="line.116"></a>
<span class="sourceLineNo">117</span>// ISO8601_OFFSET_DATE_TIME("yyyy-MM-dd'T'HH:mmXXX", "yyyy-MM-dd'T'", 2, ':', 1, ' ', 0, 0, FixedTimeZoneFormat.XXX),<a name="line.117"></a>
<span class="sourceLineNo">118</span><a name="line.118"></a>
<span class="sourceLineNo">119</span> /**<a name="line.119"></a>
<span class="sourceLineNo">120</span> * ISO8601 time format: {@code "yyyy-MM-dd'T'HH:mm:ss,SSSX"} with a time zone like {@code -07}.<a name="line.120"></a>
<span class="sourceLineNo">121</span> */<a name="line.121"></a>
<span class="sourceLineNo">122</span> ISO8601_OFFSET_DATE_TIME_HH("yyyy-MM-dd'T'HH:mm:ss,SSSX", "yyyy-MM-dd'T'", 2, ':', 1, ',', 1, 3, FixedTimeZoneFormat.HH),<a name="line.122"></a>
<span class="sourceLineNo">123</span><a name="line.123"></a>
<span class="sourceLineNo">124</span> /**<a name="line.124"></a>
<span class="sourceLineNo">125</span> * ISO8601 time format: {@code "yyyy-MM-dd'T'HH:mm:ss,SSSXX"} with a time zone like {@code -0700}.<a name="line.125"></a>
<span class="sourceLineNo">126</span> */<a name="line.126"></a>
<span class="sourceLineNo">127</span> ISO8601_OFFSET_DATE_TIME_HHMM("yyyy-MM-dd'T'HH:mm:ss,SSSXX", "yyyy-MM-dd'T'", 2, ':', 1, ',', 1, 3, FixedTimeZoneFormat.HHMM),<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span> /**<a name="line.129"></a>
<span class="sourceLineNo">130</span> * ISO8601 time format: {@code "yyyy-MM-dd'T'HH:mm:ss,SSSXXX"} with a time zone like {@code -07:00}.<a name="line.130"></a>
<span class="sourceLineNo">131</span> */<a name="line.131"></a>
<span class="sourceLineNo">132</span> ISO8601_OFFSET_DATE_TIME_HHCMM("yyyy-MM-dd'T'HH:mm:ss,SSSXXX", "yyyy-MM-dd'T'", 2, ':', 1, ',', 1, 3, FixedTimeZoneFormat.HHCMM),<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span> /**<a name="line.134"></a>
<span class="sourceLineNo">135</span> * ISO8601 time format: {@code "yyyy-MM-dd'T'HH:mm:ss.SSS"}.<a name="line.135"></a>
<span class="sourceLineNo">136</span> */<a name="line.136"></a>
<span class="sourceLineNo">137</span> ISO8601_PERIOD("yyyy-MM-dd'T'HH:mm:ss.SSS", "yyyy-MM-dd'T'", 2, ':', 1, '.', 1, 3, null),<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span> /**<a name="line.139"></a>
<span class="sourceLineNo">140</span> * ISO8601 time format with support for microsecond precision: {@code "yyyy-MM-dd'T'HH:mm:ss.nnnnnn"}.<a name="line.140"></a>
<span class="sourceLineNo">141</span> */<a name="line.141"></a>
<span class="sourceLineNo">142</span> ISO8601_PERIOD_MICROS("yyyy-MM-dd'T'HH:mm:ss.nnnnnn", "yyyy-MM-dd'T'", 2, ':', 1, '.', 1, 6, null);<a name="line.142"></a>
<span class="sourceLineNo">143</span><a name="line.143"></a>
<span class="sourceLineNo">144</span> private static final String DEFAULT_SECOND_FRACTION_PATTERN = "SSS";<a name="line.144"></a>
<span class="sourceLineNo">145</span> private static final int MILLI_FRACTION_DIGITS = DEFAULT_SECOND_FRACTION_PATTERN.length();<a name="line.145"></a>
<span class="sourceLineNo">146</span> private static final char SECOND_FRACTION_PATTERN = 'n';<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> private final String pattern;<a name="line.148"></a>
<span class="sourceLineNo">149</span> private final String datePattern;<a name="line.149"></a>
<span class="sourceLineNo">150</span> private final int escapeCount;<a name="line.150"></a>
<span class="sourceLineNo">151</span> private final char timeSeparatorChar;<a name="line.151"></a>
<span class="sourceLineNo">152</span> private final int timeSeparatorLength;<a name="line.152"></a>
<span class="sourceLineNo">153</span> private final char millisSeparatorChar;<a name="line.153"></a>
<span class="sourceLineNo">154</span> private final int millisSeparatorLength;<a name="line.154"></a>
<span class="sourceLineNo">155</span> private final int secondFractionDigits;<a name="line.155"></a>
<span class="sourceLineNo">156</span> private final FixedTimeZoneFormat fixedTimeZoneFormat;<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span> FixedFormat(final String pattern, final String datePattern, final int escapeCount, final char timeSeparator,<a name="line.158"></a>
<span class="sourceLineNo">159</span> final int timeSepLength, final char millisSeparator, final int millisSepLength,<a name="line.159"></a>
<span class="sourceLineNo">160</span> final int secondFractionDigits, final FixedTimeZoneFormat timeZoneFormat) {<a name="line.160"></a>
<span class="sourceLineNo">161</span> this.timeSeparatorChar = timeSeparator;<a name="line.161"></a>
<span class="sourceLineNo">162</span> this.timeSeparatorLength = timeSepLength;<a name="line.162"></a>
<span class="sourceLineNo">163</span> this.millisSeparatorChar = millisSeparator;<a name="line.163"></a>
<span class="sourceLineNo">164</span> this.millisSeparatorLength = millisSepLength;<a name="line.164"></a>
<span class="sourceLineNo">165</span> this.pattern = Objects.requireNonNull(pattern);<a name="line.165"></a>
<span class="sourceLineNo">166</span> this.datePattern = datePattern; // may be null<a name="line.166"></a>
<span class="sourceLineNo">167</span> this.escapeCount = escapeCount;<a name="line.167"></a>
<span class="sourceLineNo">168</span> this.secondFractionDigits = secondFractionDigits;<a name="line.168"></a>
<span class="sourceLineNo">169</span> this.fixedTimeZoneFormat = timeZoneFormat;<a name="line.169"></a>
<span class="sourceLineNo">170</span> }<a name="line.170"></a>
<span class="sourceLineNo">171</span><a name="line.171"></a>
<span class="sourceLineNo">172</span> /**<a name="line.172"></a>
<span class="sourceLineNo">173</span> * Returns the full pattern.<a name="line.173"></a>
<span class="sourceLineNo">174</span> *<a name="line.174"></a>
<span class="sourceLineNo">175</span> * @return the full pattern<a name="line.175"></a>
<span class="sourceLineNo">176</span> */<a name="line.176"></a>
<span class="sourceLineNo">177</span> public String getPattern() {<a name="line.177"></a>
<span class="sourceLineNo">178</span> return pattern;<a name="line.178"></a>
<span class="sourceLineNo">179</span> }<a name="line.179"></a>
<span class="sourceLineNo">180</span><a name="line.180"></a>
<span class="sourceLineNo">181</span> /**<a name="line.181"></a>
<span class="sourceLineNo">182</span> * Returns the date part of the pattern.<a name="line.182"></a>
<span class="sourceLineNo">183</span> *<a name="line.183"></a>
<span class="sourceLineNo">184</span> * @return the date part of the pattern<a name="line.184"></a>
<span class="sourceLineNo">185</span> */<a name="line.185"></a>
<span class="sourceLineNo">186</span> public String getDatePattern() {<a name="line.186"></a>
<span class="sourceLineNo">187</span> return datePattern;<a name="line.187"></a>
<span class="sourceLineNo">188</span> }<a name="line.188"></a>
<span class="sourceLineNo">189</span><a name="line.189"></a>
<span class="sourceLineNo">190</span> /**<a name="line.190"></a>
<span class="sourceLineNo">191</span> * Returns the FixedFormat with the name or pattern matching the specified string or {@code null} if not found.<a name="line.191"></a>
<span class="sourceLineNo">192</span> *<a name="line.192"></a>
<span class="sourceLineNo">193</span> * @param nameOrPattern the name or pattern to find a FixedFormat for<a name="line.193"></a>
<span class="sourceLineNo">194</span> * @return the FixedFormat with the name or pattern matching the specified string<a name="line.194"></a>
<span class="sourceLineNo">195</span> */<a name="line.195"></a>
<span class="sourceLineNo">196</span> public static FixedFormat lookup(final String nameOrPattern) {<a name="line.196"></a>
<span class="sourceLineNo">197</span> for (final FixedFormat type : FixedFormat.values()) {<a name="line.197"></a>
<span class="sourceLineNo">198</span> if (type.name().equals(nameOrPattern) || type.getPattern().equals(nameOrPattern)) {<a name="line.198"></a>
<span class="sourceLineNo">199</span> return type;<a name="line.199"></a>
<span class="sourceLineNo">200</span> }<a name="line.200"></a>
<span class="sourceLineNo">201</span> }<a name="line.201"></a>
<span class="sourceLineNo">202</span> return null;<a name="line.202"></a>
<span class="sourceLineNo">203</span> }<a name="line.203"></a>
<span class="sourceLineNo">204</span><a name="line.204"></a>
<span class="sourceLineNo">205</span> static FixedFormat lookupIgnoringNanos(final String pattern) {<a name="line.205"></a>
<span class="sourceLineNo">206</span> final int[] nanoRange = nanoRange(pattern);<a name="line.206"></a>
<span class="sourceLineNo">207</span> final int nanoStart = nanoRange[0];<a name="line.207"></a>
<span class="sourceLineNo">208</span> final int nanoEnd = nanoRange[1];<a name="line.208"></a>
<span class="sourceLineNo">209</span> if (nanoStart &gt; 0) {<a name="line.209"></a>
<span class="sourceLineNo">210</span> final String subPattern = pattern.substring(0, nanoStart) + DEFAULT_SECOND_FRACTION_PATTERN<a name="line.210"></a>
<span class="sourceLineNo">211</span> + pattern.substring(nanoEnd, pattern.length());<a name="line.211"></a>
<span class="sourceLineNo">212</span> for (final FixedFormat type : FixedFormat.values()) {<a name="line.212"></a>
<span class="sourceLineNo">213</span> if (type.getPattern().equals(subPattern)) {<a name="line.213"></a>
<span class="sourceLineNo">214</span> return type;<a name="line.214"></a>
<span class="sourceLineNo">215</span> }<a name="line.215"></a>
<span class="sourceLineNo">216</span> }<a name="line.216"></a>
<span class="sourceLineNo">217</span> }<a name="line.217"></a>
<span class="sourceLineNo">218</span> return null;<a name="line.218"></a>
<span class="sourceLineNo">219</span> }<a name="line.219"></a>
<span class="sourceLineNo">220</span><a name="line.220"></a>
<span class="sourceLineNo">221</span> private final static int[] EMPTY_RANGE = { -1, -1 };<a name="line.221"></a>
<span class="sourceLineNo">222</span> <a name="line.222"></a>
<span class="sourceLineNo">223</span> /**<a name="line.223"></a>
<span class="sourceLineNo">224</span> * @return int[0] start index inclusive; int[1] end index exclusive<a name="line.224"></a>
<span class="sourceLineNo">225</span> */<a name="line.225"></a>
<span class="sourceLineNo">226</span> private static int[] nanoRange(final String pattern) {<a name="line.226"></a>
<span class="sourceLineNo">227</span> final int indexStart = pattern.indexOf(SECOND_FRACTION_PATTERN);<a name="line.227"></a>
<span class="sourceLineNo">228</span> int indexEnd = -1;<a name="line.228"></a>
<span class="sourceLineNo">229</span> if (indexStart &gt;= 0) {<a name="line.229"></a>
<span class="sourceLineNo">230</span> indexEnd = pattern.indexOf('Z', indexStart);<a name="line.230"></a>
<span class="sourceLineNo">231</span> indexEnd = indexEnd &lt; 0 ? pattern.indexOf('X', indexStart) : indexEnd;<a name="line.231"></a>
<span class="sourceLineNo">232</span> indexEnd = indexEnd &lt; 0 ? pattern.length() : indexEnd; <a name="line.232"></a>
<span class="sourceLineNo">233</span> for (int i = indexStart + 1; i &lt; indexEnd; i++) {<a name="line.233"></a>
<span class="sourceLineNo">234</span> if (pattern.charAt(i) != SECOND_FRACTION_PATTERN) {<a name="line.234"></a>
<span class="sourceLineNo">235</span> return EMPTY_RANGE;<a name="line.235"></a>
<span class="sourceLineNo">236</span> }<a name="line.236"></a>
<span class="sourceLineNo">237</span> }<a name="line.237"></a>
<span class="sourceLineNo">238</span> }<a name="line.238"></a>
<span class="sourceLineNo">239</span> return new int [] {indexStart, indexEnd};<a name="line.239"></a>
<span class="sourceLineNo">240</span> }<a name="line.240"></a>
<span class="sourceLineNo">241</span><a name="line.241"></a>
<span class="sourceLineNo">242</span> /**<a name="line.242"></a>
<span class="sourceLineNo">243</span> * Returns the length of the resulting formatted date and time strings.<a name="line.243"></a>
<span class="sourceLineNo">244</span> *<a name="line.244"></a>
<span class="sourceLineNo">245</span> * @return the length of the resulting formatted date and time strings<a name="line.245"></a>
<span class="sourceLineNo">246</span> */<a name="line.246"></a>
<span class="sourceLineNo">247</span> public int getLength() {<a name="line.247"></a>
<span class="sourceLineNo">248</span> return pattern.length() - escapeCount;<a name="line.248"></a>
<span class="sourceLineNo">249</span> }<a name="line.249"></a>
<span class="sourceLineNo">250</span><a name="line.250"></a>
<span class="sourceLineNo">251</span> /**<a name="line.251"></a>
<span class="sourceLineNo">252</span> * Returns the length of the date part of the resulting formatted string.<a name="line.252"></a>
<span class="sourceLineNo">253</span> *<a name="line.253"></a>
<span class="sourceLineNo">254</span> * @return the length of the date part of the resulting formatted string<a name="line.254"></a>
<span class="sourceLineNo">255</span> */<a name="line.255"></a>
<span class="sourceLineNo">256</span> public int getDatePatternLength() {<a name="line.256"></a>
<span class="sourceLineNo">257</span> return getDatePattern() == null ? 0 : getDatePattern().length() - escapeCount;<a name="line.257"></a>
<span class="sourceLineNo">258</span> }<a name="line.258"></a>
<span class="sourceLineNo">259</span><a name="line.259"></a>
<span class="sourceLineNo">260</span> /**<a name="line.260"></a>
<span class="sourceLineNo">261</span> * Returns the {@code FastDateFormat} object for formatting the date part of the pattern or {@code null} if the<a name="line.261"></a>
<span class="sourceLineNo">262</span> * pattern does not have a date part.<a name="line.262"></a>
<span class="sourceLineNo">263</span> *<a name="line.263"></a>
<span class="sourceLineNo">264</span> * @return the {@code FastDateFormat} object for formatting the date part of the pattern or {@code null}<a name="line.264"></a>
<span class="sourceLineNo">265</span> */<a name="line.265"></a>
<span class="sourceLineNo">266</span> public FastDateFormat getFastDateFormat() {<a name="line.266"></a>
<span class="sourceLineNo">267</span> return getFastDateFormat(null);<a name="line.267"></a>
<span class="sourceLineNo">268</span> }<a name="line.268"></a>
<span class="sourceLineNo">269</span><a name="line.269"></a>
<span class="sourceLineNo">270</span> /**<a name="line.270"></a>
<span class="sourceLineNo">271</span> * Returns the {@code FastDateFormat} object for formatting the date part of the pattern or {@code null} if the<a name="line.271"></a>
<span class="sourceLineNo">272</span> * pattern does not have a date part.<a name="line.272"></a>
<span class="sourceLineNo">273</span> *<a name="line.273"></a>
<span class="sourceLineNo">274</span> * @param tz the time zone to use<a name="line.274"></a>
<span class="sourceLineNo">275</span> * @return the {@code FastDateFormat} object for formatting the date part of the pattern or {@code null}<a name="line.275"></a>
<span class="sourceLineNo">276</span> */<a name="line.276"></a>
<span class="sourceLineNo">277</span> public FastDateFormat getFastDateFormat(final TimeZone tz) {<a name="line.277"></a>
<span class="sourceLineNo">278</span> return getDatePattern() == null ? null : FastDateFormat.getInstance(getDatePattern(), tz);<a name="line.278"></a>
<span class="sourceLineNo">279</span> }<a name="line.279"></a>
<span class="sourceLineNo">280</span><a name="line.280"></a>
<span class="sourceLineNo">281</span> /**<a name="line.281"></a>
<span class="sourceLineNo">282</span> * Returns the number of digits specifying the fraction of the second to show<a name="line.282"></a>
<span class="sourceLineNo">283</span> * @return 3 for millisecond precision, 6 for microsecond precision or 9 for nanosecond precision<a name="line.283"></a>
<span class="sourceLineNo">284</span> */<a name="line.284"></a>
<span class="sourceLineNo">285</span> public int getSecondFractionDigits() {<a name="line.285"></a>
<span class="sourceLineNo">286</span> return secondFractionDigits;<a name="line.286"></a>
<span class="sourceLineNo">287</span> }<a name="line.287"></a>
<span class="sourceLineNo">288</span><a name="line.288"></a>
<span class="sourceLineNo">289</span> /**<a name="line.289"></a>
<span class="sourceLineNo">290</span> * Returns the optional time zone format.<a name="line.290"></a>
<span class="sourceLineNo">291</span> * @return the optional time zone format, may be null.<a name="line.291"></a>
<span class="sourceLineNo">292</span> */<a name="line.292"></a>
<span class="sourceLineNo">293</span> public FixedTimeZoneFormat getFixedTimeZoneFormat() {<a name="line.293"></a>
<span class="sourceLineNo">294</span> return fixedTimeZoneFormat;<a name="line.294"></a>
<span class="sourceLineNo">295</span> }<a name="line.295"></a>
<span class="sourceLineNo">296</span> }<a name="line.296"></a>
<span class="sourceLineNo">297</span><a name="line.297"></a>
<span class="sourceLineNo">298</span> private static final char NONE = (char) 0;<a name="line.298"></a>
<span class="sourceLineNo">299</span><a name="line.299"></a>
<span class="sourceLineNo">300</span> /**<a name="line.300"></a>
<span class="sourceLineNo">301</span> * Fixed time zone formats. The enum names are symbols from Java's &lt;a href=<a name="line.301"></a>
<span class="sourceLineNo">302</span> * "https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html"&gt;DateTimeFormatter&lt;/a&gt;.<a name="line.302"></a>
<span class="sourceLineNo">303</span> * <a name="line.303"></a>
<span class="sourceLineNo">304</span> * @see &lt;a href=<a name="line.304"></a>
<span class="sourceLineNo">305</span> * "https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html"&gt;DateTimeFormatter&lt;/a&gt;<a name="line.305"></a>
<span class="sourceLineNo">306</span> */<a name="line.306"></a>
<span class="sourceLineNo">307</span> public enum FixedTimeZoneFormat {<a name="line.307"></a>
<span class="sourceLineNo">308</span><a name="line.308"></a>
<span class="sourceLineNo">309</span> /**<a name="line.309"></a>
<span class="sourceLineNo">310</span> * Offset like {@code -07}.<a name="line.310"></a>
<span class="sourceLineNo">311</span> */<a name="line.311"></a>
<span class="sourceLineNo">312</span> HH(NONE, false, 3),<a name="line.312"></a>
<span class="sourceLineNo">313</span><a name="line.313"></a>
<span class="sourceLineNo">314</span> /**<a name="line.314"></a>
<span class="sourceLineNo">315</span> * Offset like {@code -0700}.<a name="line.315"></a>
<span class="sourceLineNo">316</span> */<a name="line.316"></a>
<span class="sourceLineNo">317</span> HHMM(NONE, true, 5), <a name="line.317"></a>
<span class="sourceLineNo">318</span> <a name="line.318"></a>
<span class="sourceLineNo">319</span> /** <a name="line.319"></a>
<span class="sourceLineNo">320</span> * Offset like {@code -07:00}.<a name="line.320"></a>
<span class="sourceLineNo">321</span> */<a name="line.321"></a>
<span class="sourceLineNo">322</span> HHCMM(':', true, 6);<a name="line.322"></a>
<span class="sourceLineNo">323</span> <a name="line.323"></a>
<span class="sourceLineNo">324</span> private FixedTimeZoneFormat() {<a name="line.324"></a>
<span class="sourceLineNo">325</span> this(NONE, true, 4);<a name="line.325"></a>
<span class="sourceLineNo">326</span> }<a name="line.326"></a>
<span class="sourceLineNo">327</span><a name="line.327"></a>
<span class="sourceLineNo">328</span> private FixedTimeZoneFormat(final char timeSeparatorChar, final boolean minutes, final int length) {<a name="line.328"></a>
<span class="sourceLineNo">329</span> this.timeSeparatorChar = timeSeparatorChar;<a name="line.329"></a>
<span class="sourceLineNo">330</span> this.timeSeparatorCharLen = timeSeparatorChar != NONE ? 1 : 0;<a name="line.330"></a>
<span class="sourceLineNo">331</span> this.useMinutes = minutes;<a name="line.331"></a>
<span class="sourceLineNo">332</span> this.length = length;<a name="line.332"></a>
<span class="sourceLineNo">333</span> }<a name="line.333"></a>
<span class="sourceLineNo">334</span><a name="line.334"></a>
<span class="sourceLineNo">335</span> private final char timeSeparatorChar;<a name="line.335"></a>
<span class="sourceLineNo">336</span> private final int timeSeparatorCharLen;<a name="line.336"></a>
<span class="sourceLineNo">337</span> private final boolean useMinutes;<a name="line.337"></a>
<span class="sourceLineNo">338</span> // The length includes 1 for the leading sign <a name="line.338"></a>
<span class="sourceLineNo">339</span> private final int length;<a name="line.339"></a>
<span class="sourceLineNo">340</span><a name="line.340"></a>
<span class="sourceLineNo">341</span> public int getLength() {<a name="line.341"></a>
<span class="sourceLineNo">342</span> return length;<a name="line.342"></a>
<span class="sourceLineNo">343</span> }<a name="line.343"></a>
<span class="sourceLineNo">344</span><a name="line.344"></a>
<span class="sourceLineNo">345</span> // Profiling showed this method is important to log4j performance. Modify with care!<a name="line.345"></a>
<span class="sourceLineNo">346</span> // 262 bytes (will be inlined when hot enough: &lt;= -XX:FreqInlineSize=325 bytes on Linux)<a name="line.346"></a>
<span class="sourceLineNo">347</span> private int write(final int offset, final char[] buffer, int pos) {<a name="line.347"></a>
<span class="sourceLineNo">348</span> // This method duplicates part of writeTime()<a name="line.348"></a>
<span class="sourceLineNo">349</span><a name="line.349"></a>
<span class="sourceLineNo">350</span> buffer[pos++] = offset &lt; 0 ? '-' : '+';<a name="line.350"></a>
<span class="sourceLineNo">351</span> final int absOffset = Math.abs(offset);<a name="line.351"></a>
<span class="sourceLineNo">352</span> final int hours = absOffset / 3600000;<a name="line.352"></a>
<span class="sourceLineNo">353</span> int ms = absOffset - (3600000 * hours);<a name="line.353"></a>
<span class="sourceLineNo">354</span><a name="line.354"></a>
<span class="sourceLineNo">355</span> // Hour<a name="line.355"></a>
<span class="sourceLineNo">356</span> int temp = hours / 10;<a name="line.356"></a>
<span class="sourceLineNo">357</span> buffer[pos++] = ((char) (temp + '0'));<a name="line.357"></a>
<span class="sourceLineNo">358</span><a name="line.358"></a>
<span class="sourceLineNo">359</span> // Do subtract to get remainder instead of doing % 10<a name="line.359"></a>
<span class="sourceLineNo">360</span> buffer[pos++] = ((char) (hours - 10 * temp + '0'));<a name="line.360"></a>
<span class="sourceLineNo">361</span><a name="line.361"></a>
<span class="sourceLineNo">362</span> // Minute<a name="line.362"></a>
<span class="sourceLineNo">363</span> if (useMinutes) {<a name="line.363"></a>
<span class="sourceLineNo">364</span> buffer[pos] = timeSeparatorChar;<a name="line.364"></a>
<span class="sourceLineNo">365</span> pos += timeSeparatorCharLen;<a name="line.365"></a>
<span class="sourceLineNo">366</span> final int minutes = ms / 60000;<a name="line.366"></a>
<span class="sourceLineNo">367</span> ms -= 60000 * minutes;<a name="line.367"></a>
<span class="sourceLineNo">368</span><a name="line.368"></a>
<span class="sourceLineNo">369</span> temp = minutes / 10;<a name="line.369"></a>
<span class="sourceLineNo">370</span> buffer[pos++] = ((char) (temp + '0'));<a name="line.370"></a>
<span class="sourceLineNo">371</span><a name="line.371"></a>
<span class="sourceLineNo">372</span> // Do subtract to get remainder instead of doing % 10<a name="line.372"></a>
<span class="sourceLineNo">373</span> buffer[pos++] = ((char) (minutes - 10 * temp + '0'));<a name="line.373"></a>
<span class="sourceLineNo">374</span> }<a name="line.374"></a>
<span class="sourceLineNo">375</span> return pos;<a name="line.375"></a>
<span class="sourceLineNo">376</span> }<a name="line.376"></a>
<span class="sourceLineNo">377</span><a name="line.377"></a>
<span class="sourceLineNo">378</span> }<a name="line.378"></a>
<span class="sourceLineNo">379</span><a name="line.379"></a>
<span class="sourceLineNo">380</span> private final FixedFormat fixedFormat;<a name="line.380"></a>
<span class="sourceLineNo">381</span> private final TimeZone timeZone;<a name="line.381"></a>
<span class="sourceLineNo">382</span> private final int length;<a name="line.382"></a>
<span class="sourceLineNo">383</span> private final int secondFractionDigits;<a name="line.383"></a>
<span class="sourceLineNo">384</span> private final FastDateFormat fastDateFormat; // may be null<a name="line.384"></a>
<span class="sourceLineNo">385</span> private final char timeSeparatorChar;<a name="line.385"></a>
<span class="sourceLineNo">386</span> private final char millisSeparatorChar;<a name="line.386"></a>
<span class="sourceLineNo">387</span> private final int timeSeparatorLength;<a name="line.387"></a>
<span class="sourceLineNo">388</span> private final int millisSeparatorLength;<a name="line.388"></a>
<span class="sourceLineNo">389</span> private final FixedTimeZoneFormat fixedTimeZoneFormat;<a name="line.389"></a>
<span class="sourceLineNo">390</span><a name="line.390"></a>
<span class="sourceLineNo">391</span> private volatile long midnightToday = 0;<a name="line.391"></a>
<span class="sourceLineNo">392</span> private volatile long midnightTomorrow = 0;<a name="line.392"></a>
<span class="sourceLineNo">393</span> private final int[] dstOffsets = new int[25];<a name="line.393"></a>
<span class="sourceLineNo">394</span><a name="line.394"></a>
<span class="sourceLineNo">395</span> // cachedDate does not need to be volatile because<a name="line.395"></a>
<span class="sourceLineNo">396</span> // there is a write to a volatile field *after* cachedDate is modified,<a name="line.396"></a>
<span class="sourceLineNo">397</span> // and there is a read from a volatile field *before* cachedDate is read.<a name="line.397"></a>
<span class="sourceLineNo">398</span> // The Java memory model guarantees that because of the above,<a name="line.398"></a>
<span class="sourceLineNo">399</span> // changes to cachedDate in one thread are visible to other threads.<a name="line.399"></a>
<span class="sourceLineNo">400</span> // See http://g.oswego.edu/dl/jmm/cookbook.html<a name="line.400"></a>
<span class="sourceLineNo">401</span> private char[] cachedDate; // may be null<a name="line.401"></a>
<span class="sourceLineNo">402</span> private int dateLength;<a name="line.402"></a>
<span class="sourceLineNo">403</span><a name="line.403"></a>
<span class="sourceLineNo">404</span> /**<a name="line.404"></a>
<span class="sourceLineNo">405</span> * Constructs a FixedDateFormat for the specified fixed format.<a name="line.405"></a>
<span class="sourceLineNo">406</span> * &lt;p&gt;<a name="line.406"></a>
<span class="sourceLineNo">407</span> * Package protected for unit tests.<a name="line.407"></a>
<span class="sourceLineNo">408</span> *<a name="line.408"></a>
<span class="sourceLineNo">409</span> * @param fixedFormat the fixed format<a name="line.409"></a>
<span class="sourceLineNo">410</span> * @param tz time zone<a name="line.410"></a>
<span class="sourceLineNo">411</span> */<a name="line.411"></a>
<span class="sourceLineNo">412</span> FixedDateFormat(final FixedFormat fixedFormat, final TimeZone tz) {<a name="line.412"></a>
<span class="sourceLineNo">413</span> this(fixedFormat, tz, fixedFormat.getSecondFractionDigits());<a name="line.413"></a>
<span class="sourceLineNo">414</span> }<a name="line.414"></a>
<span class="sourceLineNo">415</span><a name="line.415"></a>
<span class="sourceLineNo">416</span> /**<a name="line.416"></a>
<span class="sourceLineNo">417</span> * Constructs a FixedDateFormat for the specified fixed format.<a name="line.417"></a>
<span class="sourceLineNo">418</span> * &lt;p&gt;<a name="line.418"></a>
<span class="sourceLineNo">419</span> * Package protected for unit tests.<a name="line.419"></a>
<span class="sourceLineNo">420</span> * &lt;/p&gt;<a name="line.420"></a>
<span class="sourceLineNo">421</span> *<a name="line.421"></a>
<span class="sourceLineNo">422</span> * @param fixedFormat the fixed format<a name="line.422"></a>
<span class="sourceLineNo">423</span> * @param tz time zone<a name="line.423"></a>
<span class="sourceLineNo">424</span> * @param secondFractionDigits the number of digits specifying the fraction of the second to show<a name="line.424"></a>
<span class="sourceLineNo">425</span> */<a name="line.425"></a>
<span class="sourceLineNo">426</span> FixedDateFormat(final FixedFormat fixedFormat, final TimeZone tz, final int secondFractionDigits) {<a name="line.426"></a>
<span class="sourceLineNo">427</span> this.fixedFormat = Objects.requireNonNull(fixedFormat);<a name="line.427"></a>
<span class="sourceLineNo">428</span> this.timeZone = Objects.requireNonNull(tz);<a name="line.428"></a>
<span class="sourceLineNo">429</span> this.timeSeparatorChar = fixedFormat.timeSeparatorChar;<a name="line.429"></a>
<span class="sourceLineNo">430</span> this.timeSeparatorLength = fixedFormat.timeSeparatorLength;<a name="line.430"></a>
<span class="sourceLineNo">431</span> this.millisSeparatorChar = fixedFormat.millisSeparatorChar;<a name="line.431"></a>
<span class="sourceLineNo">432</span> this.millisSeparatorLength = fixedFormat.millisSeparatorLength;<a name="line.432"></a>
<span class="sourceLineNo">433</span> this.fixedTimeZoneFormat = fixedFormat.fixedTimeZoneFormat; // may be null<a name="line.433"></a>
<span class="sourceLineNo">434</span> this.length = fixedFormat.getLength();<a name="line.434"></a>
<span class="sourceLineNo">435</span> this.secondFractionDigits = Math.max(1, Math.min(9, secondFractionDigits));<a name="line.435"></a>
<span class="sourceLineNo">436</span> this.fastDateFormat = fixedFormat.getFastDateFormat(tz);<a name="line.436"></a>
<span class="sourceLineNo">437</span> }<a name="line.437"></a>
<span class="sourceLineNo">438</span><a name="line.438"></a>
<span class="sourceLineNo">439</span> public static FixedDateFormat createIfSupported(final String... options) {<a name="line.439"></a>
<span class="sourceLineNo">440</span> if (options == null || options.length == 0 || options[0] == null) {<a name="line.440"></a>
<span class="sourceLineNo">441</span> return new FixedDateFormat(FixedFormat.DEFAULT, TimeZone.getDefault());<a name="line.441"></a>
<span class="sourceLineNo">442</span> }<a name="line.442"></a>
<span class="sourceLineNo">443</span> final TimeZone tz;<a name="line.443"></a>
<span class="sourceLineNo">444</span> if (options.length &gt; 1) {<a name="line.444"></a>
<span class="sourceLineNo">445</span> if (options[1] != null) {<a name="line.445"></a>
<span class="sourceLineNo">446</span> tz = TimeZone.getTimeZone(options[1]);<a name="line.446"></a>
<span class="sourceLineNo">447</span> } else {<a name="line.447"></a>
<span class="sourceLineNo">448</span> tz = TimeZone.getDefault();<a name="line.448"></a>
<span class="sourceLineNo">449</span> }<a name="line.449"></a>
<span class="sourceLineNo">450</span> } else {<a name="line.450"></a>
<span class="sourceLineNo">451</span> tz = TimeZone.getDefault();<a name="line.451"></a>
<span class="sourceLineNo">452</span> }<a name="line.452"></a>
<span class="sourceLineNo">453</span><a name="line.453"></a>
<span class="sourceLineNo">454</span> final String option0 = options[0];<a name="line.454"></a>
<span class="sourceLineNo">455</span> final FixedFormat withNanos = FixedFormat.lookupIgnoringNanos(option0);<a name="line.455"></a>
<span class="sourceLineNo">456</span> if (withNanos != null) {<a name="line.456"></a>
<span class="sourceLineNo">457</span> final int[] nanoRange = FixedFormat.nanoRange(option0);<a name="line.457"></a>
<span class="sourceLineNo">458</span> final int nanoStart = nanoRange[0];<a name="line.458"></a>
<span class="sourceLineNo">459</span> final int nanoEnd = nanoRange[1];<a name="line.459"></a>
<span class="sourceLineNo">460</span> final int secondFractionDigits = nanoEnd - nanoStart;<a name="line.460"></a>
<span class="sourceLineNo">461</span> return new FixedDateFormat(withNanos, tz, secondFractionDigits);<a name="line.461"></a>
<span class="sourceLineNo">462</span> }<a name="line.462"></a>
<span class="sourceLineNo">463</span> final FixedFormat type = FixedFormat.lookup(option0);<a name="line.463"></a>
<span class="sourceLineNo">464</span> return type == null ? null : new FixedDateFormat(type, tz);<a name="line.464"></a>
<span class="sourceLineNo">465</span> }<a name="line.465"></a>
<span class="sourceLineNo">466</span><a name="line.466"></a>
<span class="sourceLineNo">467</span> /**<a name="line.467"></a>
<span class="sourceLineNo">468</span> * Returns a new {@code FixedDateFormat} object for the specified {@code FixedFormat} and a {@code TimeZone.getDefault()} TimeZone.<a name="line.468"></a>
<span class="sourceLineNo">469</span> *<a name="line.469"></a>
<span class="sourceLineNo">470</span> * @param format the format to use<a name="line.470"></a>
<span class="sourceLineNo">471</span> * @return a new {@code FixedDateFormat} object<a name="line.471"></a>
<span class="sourceLineNo">472</span> */<a name="line.472"></a>
<span class="sourceLineNo">473</span> public static FixedDateFormat create(final FixedFormat format) {<a name="line.473"></a>
<span class="sourceLineNo">474</span> return new FixedDateFormat(format, TimeZone.getDefault());<a name="line.474"></a>
<span class="sourceLineNo">475</span> }<a name="line.475"></a>
<span class="sourceLineNo">476</span><a name="line.476"></a>
<span class="sourceLineNo">477</span> /**<a name="line.477"></a>
<span class="sourceLineNo">478</span> * Returns a new {@code FixedDateFormat} object for the specified {@code FixedFormat} and TimeZone.<a name="line.478"></a>
<span class="sourceLineNo">479</span> *<a name="line.479"></a>
<span class="sourceLineNo">480</span> * @param format the format to use<a name="line.480"></a>
<span class="sourceLineNo">481</span> * @param tz the time zone to use<a name="line.481"></a>
<span class="sourceLineNo">482</span> * @return a new {@code FixedDateFormat} object<a name="line.482"></a>
<span class="sourceLineNo">483</span> */<a name="line.483"></a>
<span class="sourceLineNo">484</span> public static FixedDateFormat create(final FixedFormat format, final TimeZone tz) {<a name="line.484"></a>
<span class="sourceLineNo">485</span> return new FixedDateFormat(format, tz != null ? tz : TimeZone.getDefault());<a name="line.485"></a>
<span class="sourceLineNo">486</span> }<a name="line.486"></a>
<span class="sourceLineNo">487</span><a name="line.487"></a>
<span class="sourceLineNo">488</span> /**<a name="line.488"></a>
<span class="sourceLineNo">489</span> * Returns the full pattern of the selected fixed format.<a name="line.489"></a>
<span class="sourceLineNo">490</span> *<a name="line.490"></a>
<span class="sourceLineNo">491</span> * @return the full date-time pattern<a name="line.491"></a>
<span class="sourceLineNo">492</span> */<a name="line.492"></a>
<span class="sourceLineNo">493</span> public String getFormat() {<a name="line.493"></a>
<span class="sourceLineNo">494</span> return fixedFormat.getPattern();<a name="line.494"></a>
<span class="sourceLineNo">495</span> }<a name="line.495"></a>
<span class="sourceLineNo">496</span><a name="line.496"></a>
<span class="sourceLineNo">497</span> /**<a name="line.497"></a>
<span class="sourceLineNo">498</span> * Returns the time zone.<a name="line.498"></a>
<span class="sourceLineNo">499</span> *<a name="line.499"></a>
<span class="sourceLineNo">500</span> * @return the time zone<a name="line.500"></a>
<span class="sourceLineNo">501</span> */<a name="line.501"></a>
<span class="sourceLineNo">502</span> public TimeZone getTimeZone() {<a name="line.502"></a>
<span class="sourceLineNo">503</span> return timeZone;<a name="line.503"></a>
<span class="sourceLineNo">504</span> }<a name="line.504"></a>
<span class="sourceLineNo">505</span><a name="line.505"></a>
<span class="sourceLineNo">506</span> /**<a name="line.506"></a>
<span class="sourceLineNo">507</span> * &lt;p&gt;Returns the number of milliseconds since midnight in the time zone that this {@code FixedDateFormat}<a name="line.507"></a>
<span class="sourceLineNo">508</span> * was constructed with for the specified currentTime.&lt;/p&gt;<a name="line.508"></a>
<span class="sourceLineNo">509</span> * &lt;p&gt;As a side effect, this method updates the cached formatted date and the cached date demarcation timestamps<a name="line.509"></a>
<span class="sourceLineNo">510</span> * when the specified current time is outside the previously set demarcation timestamps for the start or end<a name="line.510"></a>
<span class="sourceLineNo">511</span> * of the current day.&lt;/p&gt;<a name="line.511"></a>
<span class="sourceLineNo">512</span> * @param currentTime the current time in millis since the epoch<a name="line.512"></a>
<span class="sourceLineNo">513</span> * @return the number of milliseconds since midnight for the specified time<a name="line.513"></a>
<span class="sourceLineNo">514</span> */<a name="line.514"></a>
<span class="sourceLineNo">515</span> // Profiling showed this method is important to log4j performance. Modify with care!<a name="line.515"></a>
<span class="sourceLineNo">516</span> // 30 bytes (allows immediate JVM inlining: &lt;= -XX:MaxInlineSize=35 bytes)<a name="line.516"></a>
<span class="sourceLineNo">517</span> public long millisSinceMidnight(final long currentTime) {<a name="line.517"></a>
<span class="sourceLineNo">518</span> if (currentTime &gt;= midnightTomorrow || currentTime &lt; midnightToday) {<a name="line.518"></a>
<span class="sourceLineNo">519</span> updateMidnightMillis(currentTime);<a name="line.519"></a>
<span class="sourceLineNo">520</span> }<a name="line.520"></a>
<span class="sourceLineNo">521</span> return currentTime - midnightToday;<a name="line.521"></a>
<span class="sourceLineNo">522</span> }<a name="line.522"></a>
<span class="sourceLineNo">523</span><a name="line.523"></a>
<span class="sourceLineNo">524</span> private void updateMidnightMillis(final long now) {<a name="line.524"></a>
<span class="sourceLineNo">525</span> if (now &gt;= midnightTomorrow || now &lt; midnightToday) {<a name="line.525"></a>
<span class="sourceLineNo">526</span> synchronized (this) {<a name="line.526"></a>
<span class="sourceLineNo">527</span> updateCachedDate(now);<a name="line.527"></a>
<span class="sourceLineNo">528</span> midnightToday = calcMidnightMillis(now, 0);<a name="line.528"></a>
<span class="sourceLineNo">529</span> midnightTomorrow = calcMidnightMillis(now, 1);<a name="line.529"></a>
<span class="sourceLineNo">530</span><a name="line.530"></a>
<span class="sourceLineNo">531</span> updateDaylightSavingTime();<a name="line.531"></a>
<span class="sourceLineNo">532</span> }<a name="line.532"></a>
<span class="sourceLineNo">533</span> }<a name="line.533"></a>
<span class="sourceLineNo">534</span> }<a name="line.534"></a>
<span class="sourceLineNo">535</span><a name="line.535"></a>
<span class="sourceLineNo">536</span> private long calcMidnightMillis(final long time, final int addDays) {<a name="line.536"></a>
<span class="sourceLineNo">537</span> final Calendar cal = Calendar.getInstance(timeZone);<a name="line.537"></a>
<span class="sourceLineNo">538</span> cal.setTimeInMillis(time);<a name="line.538"></a>
<span class="sourceLineNo">539</span> cal.set(Calendar.HOUR_OF_DAY, 0);<a name="line.539"></a>
<span class="sourceLineNo">540</span> cal.set(Calendar.MINUTE, 0);<a name="line.540"></a>
<span class="sourceLineNo">541</span> cal.set(Calendar.SECOND, 0);<a name="line.541"></a>
<span class="sourceLineNo">542</span> cal.set(Calendar.MILLISECOND, 0);<a name="line.542"></a>
<span class="sourceLineNo">543</span> cal.add(Calendar.DATE, addDays);<a name="line.543"></a>
<span class="sourceLineNo">544</span> return cal.getTimeInMillis();<a name="line.544"></a>
<span class="sourceLineNo">545</span> }<a name="line.545"></a>
<span class="sourceLineNo">546</span><a name="line.546"></a>
<span class="sourceLineNo">547</span> private void updateDaylightSavingTime() {<a name="line.547"></a>
<span class="sourceLineNo">548</span> Arrays.fill(dstOffsets, 0);<a name="line.548"></a>
<span class="sourceLineNo">549</span> final int ONE_HOUR = (int) TimeUnit.HOURS.toMillis(1);<a name="line.549"></a>
<span class="sourceLineNo">550</span> if (timeZone.getOffset(midnightToday) != timeZone.getOffset(midnightToday + 23 * ONE_HOUR)) {<a name="line.550"></a>
<span class="sourceLineNo">551</span> for (int i = 0; i &lt; dstOffsets.length; i++) {<a name="line.551"></a>
<span class="sourceLineNo">552</span> final long time = midnightToday + i * ONE_HOUR;<a name="line.552"></a>
<span class="sourceLineNo">553</span> dstOffsets[i] = timeZone.getOffset(time) - timeZone.getRawOffset();<a name="line.553"></a>
<span class="sourceLineNo">554</span> }<a name="line.554"></a>
<span class="sourceLineNo">555</span> if (dstOffsets[0] &gt; dstOffsets[23]) { // clock is moved backwards.<a name="line.555"></a>
<span class="sourceLineNo">556</span> // we obtain midnightTonight with Calendar.getInstance(TimeZone), so it already includes raw offset<a name="line.556"></a>
<span class="sourceLineNo">557</span> for (int i = dstOffsets.length - 1; i &gt;= 0; i--) {<a name="line.557"></a>
<span class="sourceLineNo">558</span> dstOffsets[i] -= dstOffsets[0]; //<a name="line.558"></a>
<span class="sourceLineNo">559</span> }<a name="line.559"></a>
<span class="sourceLineNo">560</span> }<a name="line.560"></a>
<span class="sourceLineNo">561</span> }<a name="line.561"></a>
<span class="sourceLineNo">562</span> }<a name="line.562"></a>
<span class="sourceLineNo">563</span><a name="line.563"></a>
<span class="sourceLineNo">564</span> private void updateCachedDate(final long now) {<a name="line.564"></a>
<span class="sourceLineNo">565</span> if (fastDateFormat != null) {<a name="line.565"></a>
<span class="sourceLineNo">566</span> final StringBuilder result = fastDateFormat.format(now, new StringBuilder());<a name="line.566"></a>
<span class="sourceLineNo">567</span> cachedDate = result.toString().toCharArray();<a name="line.567"></a>
<span class="sourceLineNo">568</span> dateLength = result.length();<a name="line.568"></a>
<span class="sourceLineNo">569</span> }<a name="line.569"></a>
<span class="sourceLineNo">570</span> }<a name="line.570"></a>
<span class="sourceLineNo">571</span><a name="line.571"></a>
<span class="sourceLineNo">572</span> public String formatInstant(final Instant instant) {<a name="line.572"></a>
<span class="sourceLineNo">573</span> final char[] result = new char[length &lt;&lt; 1]; // double size for locales with lengthy DateFormatSymbols<a name="line.573"></a>
<span class="sourceLineNo">574</span> final int written = formatInstant(instant, result, 0);<a name="line.574"></a>
<span class="sourceLineNo">575</span> return new String(result, 0, written);<a name="line.575"></a>
<span class="sourceLineNo">576</span> }<a name="line.576"></a>
<span class="sourceLineNo">577</span><a name="line.577"></a>
<span class="sourceLineNo">578</span> public int formatInstant(final Instant instant, final char[] buffer, final int startPos) {<a name="line.578"></a>
<span class="sourceLineNo">579</span> final long epochMillisecond = instant.getEpochMillisecond();<a name="line.579"></a>
<span class="sourceLineNo">580</span> int result = format(epochMillisecond, buffer, startPos);<a name="line.580"></a>
<span class="sourceLineNo">581</span> result -= digitsLessThanThree();<a name="line.581"></a>
<span class="sourceLineNo">582</span> final int pos = formatNanoOfMillisecond(instant.getNanoOfMillisecond(), buffer, startPos + result);<a name="line.582"></a>
<span class="sourceLineNo">583</span> return writeTimeZone(epochMillisecond, buffer, pos);<a name="line.583"></a>
<span class="sourceLineNo">584</span> }<a name="line.584"></a>
<span class="sourceLineNo">585</span><a name="line.585"></a>
<span class="sourceLineNo">586</span> private int digitsLessThanThree() { // in case user specified only 1 or 2 'n' format characters<a name="line.586"></a>
<span class="sourceLineNo">587</span> return Math.max(0, FixedFormat.MILLI_FRACTION_DIGITS - secondFractionDigits);<a name="line.587"></a>
<span class="sourceLineNo">588</span> }<a name="line.588"></a>
<span class="sourceLineNo">589</span><a name="line.589"></a>
<span class="sourceLineNo">590</span> // Profiling showed this method is important to log4j performance. Modify with care!<a name="line.590"></a>
<span class="sourceLineNo">591</span> // 28 bytes (allows immediate JVM inlining: &lt;= -XX:MaxInlineSize=35 bytes)<a name="line.591"></a>
<span class="sourceLineNo">592</span> public String format(final long epochMillis) {<a name="line.592"></a>
<span class="sourceLineNo">593</span> final char[] result = new char[length &lt;&lt; 1]; // double size for locales with lengthy DateFormatSymbols<a name="line.593"></a>
<span class="sourceLineNo">594</span> final int written = format(epochMillis, result, 0);<a name="line.594"></a>
<span class="sourceLineNo">595</span> return new String(result, 0, written);<a name="line.595"></a>
<span class="sourceLineNo">596</span> }<a name="line.596"></a>
<span class="sourceLineNo">597</span><a name="line.597"></a>
<span class="sourceLineNo">598</span> // Profiling showed this method is important to log4j performance. Modify with care!<a name="line.598"></a>
<span class="sourceLineNo">599</span> // 31 bytes (allows immediate JVM inlining: &lt;= -XX:MaxInlineSize=35 bytes)<a name="line.599"></a>
<span class="sourceLineNo">600</span> public int format(final long epochMillis, final char[] buffer, final int startPos) {<a name="line.600"></a>
<span class="sourceLineNo">601</span> // Calculate values by getting the ms values first and do then<a name="line.601"></a>
<span class="sourceLineNo">602</span> // calculate the hour minute and second values divisions.<a name="line.602"></a>
<span class="sourceLineNo">603</span><a name="line.603"></a>
<span class="sourceLineNo">604</span> // Get daytime in ms: this does fit into an int<a name="line.604"></a>
<span class="sourceLineNo">605</span> // int ms = (int) (time % 86400000);<a name="line.605"></a>
<span class="sourceLineNo">606</span> final int ms = (int) (millisSinceMidnight(epochMillis));<a name="line.606"></a>
<span class="sourceLineNo">607</span> writeDate(buffer, startPos);<a name="line.607"></a>
<span class="sourceLineNo">608</span> final int pos = writeTime(ms, buffer, startPos + dateLength);<a name="line.608"></a>
<span class="sourceLineNo">609</span> return pos - startPos;<a name="line.609"></a>
<span class="sourceLineNo">610</span> }<a name="line.610"></a>
<span class="sourceLineNo">611</span><a name="line.611"></a>
<span class="sourceLineNo">612</span> // Profiling showed this method is important to log4j performance. Modify with care!<a name="line.612"></a>
<span class="sourceLineNo">613</span> // 22 bytes (allows immediate JVM inlining: &lt;= -XX:MaxInlineSize=35 bytes)<a name="line.613"></a>
<span class="sourceLineNo">614</span> private void writeDate(final char[] buffer, final int startPos) {<a name="line.614"></a>
<span class="sourceLineNo">615</span> if (cachedDate != null) {<a name="line.615"></a>
<span class="sourceLineNo">616</span> System.arraycopy(cachedDate, 0, buffer, startPos, dateLength);<a name="line.616"></a>
<span class="sourceLineNo">617</span> }<a name="line.617"></a>
<span class="sourceLineNo">618</span> }<a name="line.618"></a>
<span class="sourceLineNo">619</span><a name="line.619"></a>
<span class="sourceLineNo">620</span> // Profiling showed this method is important to log4j performance. Modify with care!<a name="line.620"></a>
<span class="sourceLineNo">621</span> // 262 bytes (will be inlined when hot enough: &lt;= -XX:FreqInlineSize=325 bytes on Linux)<a name="line.621"></a>
<span class="sourceLineNo">622</span> private int writeTime(int ms, final char[] buffer, int pos) {<a name="line.622"></a>
<span class="sourceLineNo">623</span> final int hourOfDay = ms / 3600000;<a name="line.623"></a>
<span class="sourceLineNo">624</span> final int hours = hourOfDay + daylightSavingTime(hourOfDay) / 3600000;<a name="line.624"></a>
<span class="sourceLineNo">625</span> ms -= 3600000 * hourOfDay;<a name="line.625"></a>
<span class="sourceLineNo">626</span><a name="line.626"></a>
<span class="sourceLineNo">627</span> final int minutes = ms / 60000;<a name="line.627"></a>
<span class="sourceLineNo">628</span> ms -= 60000 * minutes;<a name="line.628"></a>
<span class="sourceLineNo">629</span><a name="line.629"></a>
<span class="sourceLineNo">630</span> final int seconds = ms / 1000;<a name="line.630"></a>
<span class="sourceLineNo">631</span> ms -= 1000 * seconds;<a name="line.631"></a>
<span class="sourceLineNo">632</span><a name="line.632"></a>
<span class="sourceLineNo">633</span> // Hour<a name="line.633"></a>
<span class="sourceLineNo">634</span> int temp = hours / 10;<a name="line.634"></a>
<span class="sourceLineNo">635</span> buffer[pos++] = ((char) (temp + '0'));<a name="line.635"></a>
<span class="sourceLineNo">636</span><a name="line.636"></a>
<span class="sourceLineNo">637</span> // Do subtract to get remainder instead of doing % 10<a name="line.637"></a>
<span class="sourceLineNo">638</span> buffer[pos++] = ((char) (hours - 10 * temp + '0'));<a name="line.638"></a>
<span class="sourceLineNo">639</span> buffer[pos] = timeSeparatorChar;<a name="line.639"></a>
<span class="sourceLineNo">640</span> pos += timeSeparatorLength;<a name="line.640"></a>
<span class="sourceLineNo">641</span><a name="line.641"></a>
<span class="sourceLineNo">642</span> // Minute<a name="line.642"></a>
<span class="sourceLineNo">643</span> temp = minutes / 10;<a name="line.643"></a>
<span class="sourceLineNo">644</span> buffer[pos++] = ((char) (temp + '0'));<a name="line.644"></a>
<span class="sourceLineNo">645</span><a name="line.645"></a>
<span class="sourceLineNo">646</span> // Do subtract to get remainder instead of doing % 10<a name="line.646"></a>
<span class="sourceLineNo">647</span> buffer[pos++] = ((char) (minutes - 10 * temp + '0'));<a name="line.647"></a>
<span class="sourceLineNo">648</span> buffer[pos] = timeSeparatorChar;<a name="line.648"></a>
<span class="sourceLineNo">649</span> pos += timeSeparatorLength;<a name="line.649"></a>
<span class="sourceLineNo">650</span><a name="line.650"></a>
<span class="sourceLineNo">651</span> // Second<a name="line.651"></a>
<span class="sourceLineNo">652</span> temp = seconds / 10;<a name="line.652"></a>
<span class="sourceLineNo">653</span> buffer[pos++] = ((char) (temp + '0'));<a name="line.653"></a>
<span class="sourceLineNo">654</span> buffer[pos++] = ((char) (seconds - 10 * temp + '0'));<a name="line.654"></a>
<span class="sourceLineNo">655</span> buffer[pos] = millisSeparatorChar;<a name="line.655"></a>
<span class="sourceLineNo">656</span> pos += millisSeparatorLength;<a name="line.656"></a>
<span class="sourceLineNo">657</span><a name="line.657"></a>
<span class="sourceLineNo">658</span> // Millisecond<a name="line.658"></a>
<span class="sourceLineNo">659</span> temp = ms / 100;<a name="line.659"></a>
<span class="sourceLineNo">660</span> buffer[pos++] = ((char) (temp + '0'));<a name="line.660"></a>
<span class="sourceLineNo">661</span><a name="line.661"></a>
<span class="sourceLineNo">662</span> ms -= 100 * temp;<a name="line.662"></a>
<span class="sourceLineNo">663</span> temp = ms / 10;<a name="line.663"></a>
<span class="sourceLineNo">664</span> buffer[pos++] = ((char) (temp + '0'));<a name="line.664"></a>
<span class="sourceLineNo">665</span><a name="line.665"></a>
<span class="sourceLineNo">666</span> ms -= 10 * temp;<a name="line.666"></a>
<span class="sourceLineNo">667</span> buffer[pos++] = ((char) (ms + '0'));<a name="line.667"></a>
<span class="sourceLineNo">668</span> return pos;<a name="line.668"></a>
<span class="sourceLineNo">669</span> }<a name="line.669"></a>
<span class="sourceLineNo">670</span><a name="line.670"></a>
<span class="sourceLineNo">671</span> private int writeTimeZone(final long epochMillis, final char[] buffer, int pos) {<a name="line.671"></a>
<span class="sourceLineNo">672</span> if (fixedTimeZoneFormat != null) {<a name="line.672"></a>
<span class="sourceLineNo">673</span> pos = fixedTimeZoneFormat.write(timeZone.getOffset(epochMillis), buffer, pos);<a name="line.673"></a>
<span class="sourceLineNo">674</span> }<a name="line.674"></a>
<span class="sourceLineNo">675</span> return pos;<a name="line.675"></a>
<span class="sourceLineNo">676</span> }<a name="line.676"></a>
<span class="sourceLineNo">677</span><a name="line.677"></a>
<span class="sourceLineNo">678</span> static int[] TABLE = {<a name="line.678"></a>
<span class="sourceLineNo">679</span> 100000, // 0<a name="line.679"></a>
<span class="sourceLineNo">680</span> 10000, // 1<a name="line.680"></a>
<span class="sourceLineNo">681</span> 1000, // 2<a name="line.681"></a>
<span class="sourceLineNo">682</span> 100, // 3<a name="line.682"></a>
<span class="sourceLineNo">683</span> 10, // 4<a name="line.683"></a>
<span class="sourceLineNo">684</span> 1, // 5<a name="line.684"></a>
<span class="sourceLineNo">685</span> };<a name="line.685"></a>
<span class="sourceLineNo">686</span><a name="line.686"></a>
<span class="sourceLineNo">687</span> private int formatNanoOfMillisecond(final int nanoOfMillisecond, final char[] buffer, int pos) {<a name="line.687"></a>
<span class="sourceLineNo">688</span> int temp;<a name="line.688"></a>
<span class="sourceLineNo">689</span> int remain = nanoOfMillisecond;<a name="line.689"></a>
<span class="sourceLineNo">690</span> for (int i = 0; i &lt; secondFractionDigits - FixedFormat.MILLI_FRACTION_DIGITS; i++) {<a name="line.690"></a>
<span class="sourceLineNo">691</span> final int divisor = TABLE[i];<a name="line.691"></a>
<span class="sourceLineNo">692</span> temp = remain / divisor;<a name="line.692"></a>
<span class="sourceLineNo">693</span> buffer[pos++] = ((char) (temp + '0'));<a name="line.693"></a>
<span class="sourceLineNo">694</span> remain -= divisor * temp; // equivalent of remain % 10<a name="line.694"></a>
<span class="sourceLineNo">695</span> }<a name="line.695"></a>
<span class="sourceLineNo">696</span> return pos;<a name="line.696"></a>
<span class="sourceLineNo">697</span> }<a name="line.697"></a>
<span class="sourceLineNo">698</span><a name="line.698"></a>
<span class="sourceLineNo">699</span> private int daylightSavingTime(final int hourOfDay) {<a name="line.699"></a>
<span class="sourceLineNo">700</span> return hourOfDay &gt; 23 ? dstOffsets[23] : dstOffsets[hourOfDay];<a name="line.700"></a>
<span class="sourceLineNo">701</span> }<a name="line.701"></a>
<span class="sourceLineNo">702</span>}<a name="line.702"></a>
</pre>
</div>
</body>
</html>