Google Git
Sign in
apache / logging-log4j-site / d0d0de55986756593c08e5d2b8059541eacaf428 / . / log4j-2.0-alpha1-SNAPSHOT / log4j-core / apidocs / src-html / org / apache / logging / log4j / core / pattern / DatePatternConverter.html
blob: 1b537aece185b07d84632929ca7fe552d3b1e124 [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT> *<a name="line.8"></a>
<FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT> *<a name="line.10"></a>
<FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT> * See the license for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT> * limitations under the license.<a name="line.15"></a>
<FONT color="green">016</FONT> */<a name="line.16"></a>
<FONT color="green">017</FONT> package org.apache.logging.log4j.core.pattern;<a name="line.17"></a>
<FONT color="green">018</FONT> <a name="line.18"></a>
<FONT color="green">019</FONT> import org.apache.logging.log4j.core.LogEvent;<a name="line.19"></a>
<FONT color="green">020</FONT> import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.20"></a>
<FONT color="green">021</FONT> <a name="line.21"></a>
<FONT color="green">022</FONT> import java.text.SimpleDateFormat;<a name="line.22"></a>
<FONT color="green">023</FONT> import java.util.Date;<a name="line.23"></a>
<FONT color="green">024</FONT> import java.util.TimeZone;<a name="line.24"></a>
<FONT color="green">025</FONT> <a name="line.25"></a>
<FONT color="green">026</FONT> <a name="line.26"></a>
<FONT color="green">027</FONT> /**<a name="line.27"></a>
<FONT color="green">028</FONT> * Convert and format the event's date in a StringBuffer.<a name="line.28"></a>
<FONT color="green">029</FONT> */<a name="line.29"></a>
<FONT color="green">030</FONT> @Plugin(name = "DatePatternConverter", type = "Converter")<a name="line.30"></a>
<FONT color="green">031</FONT> @ConverterKeys({"d", "date" })<a name="line.31"></a>
<FONT color="green">032</FONT> public final class DatePatternConverter extends LogEventPatternConverter implements ArrayPatternConverter {<a name="line.32"></a>
<FONT color="green">033</FONT> /**<a name="line.33"></a>
<FONT color="green">034</FONT> * ABSOLUTE string literal.<a name="line.34"></a>
<FONT color="green">035</FONT> */<a name="line.35"></a>
<FONT color="green">036</FONT> private static final String ABSOLUTE_FORMAT = "ABSOLUTE";<a name="line.36"></a>
<FONT color="green">037</FONT> /**<a name="line.37"></a>
<FONT color="green">038</FONT> * SimpleTimePattern for ABSOLUTE.<a name="line.38"></a>
<FONT color="green">039</FONT> */<a name="line.39"></a>
<FONT color="green">040</FONT> private static final String ABSOLUTE_TIME_PATTERN = "HH:mm:ss,SSS";<a name="line.40"></a>
<FONT color="green">041</FONT> <a name="line.41"></a>
<FONT color="green">042</FONT> <a name="line.42"></a>
<FONT color="green">043</FONT> /**<a name="line.43"></a>
<FONT color="green">044</FONT> * DATE string literal.<a name="line.44"></a>
<FONT color="green">045</FONT> */<a name="line.45"></a>
<FONT color="green">046</FONT> private static final String DATE_AND_TIME_FORMAT = "DATE";<a name="line.46"></a>
<FONT color="green">047</FONT> /**<a name="line.47"></a>
<FONT color="green">048</FONT> * SimpleTimePattern for DATE.<a name="line.48"></a>
<FONT color="green">049</FONT> */<a name="line.49"></a>
<FONT color="green">050</FONT> private static final String DATE_AND_TIME_PATTERN = "dd MMM yyyy HH:mm:ss,SSS";<a name="line.50"></a>
<FONT color="green">051</FONT> <a name="line.51"></a>
<FONT color="green">052</FONT> /**<a name="line.52"></a>
<FONT color="green">053</FONT> * ISO8601 string literal.<a name="line.53"></a>
<FONT color="green">054</FONT> */<a name="line.54"></a>
<FONT color="green">055</FONT> private static final String ISO8601_FORMAT = "ISO8601";<a name="line.55"></a>
<FONT color="green">056</FONT> /**<a name="line.56"></a>
<FONT color="green">057</FONT> * SimpleTimePattern for ISO8601.<a name="line.57"></a>
<FONT color="green">058</FONT> */<a name="line.58"></a>
<FONT color="green">059</FONT> private static final String ISO8601_PATTERN = "yyyy-MM-dd HH:mm:ss,SSS";<a name="line.59"></a>
<FONT color="green">060</FONT> /**<a name="line.60"></a>
<FONT color="green">061</FONT> * Date format.<a name="line.61"></a>
<FONT color="green">062</FONT> */<a name="line.62"></a>
<FONT color="green">063</FONT> private String cachedDate;<a name="line.63"></a>
<FONT color="green">064</FONT> <a name="line.64"></a>
<FONT color="green">065</FONT> private long lastTimestamp;<a name="line.65"></a>
<FONT color="green">066</FONT> <a name="line.66"></a>
<FONT color="green">067</FONT> private SimpleDateFormat simpleFormat;<a name="line.67"></a>
<FONT color="green">068</FONT> <a name="line.68"></a>
<FONT color="green">069</FONT> /**<a name="line.69"></a>
<FONT color="green">070</FONT> * Private constructor.<a name="line.70"></a>
<FONT color="green">071</FONT> *<a name="line.71"></a>
<FONT color="green">072</FONT> * @param options options, may be null.<a name="line.72"></a>
<FONT color="green">073</FONT> */<a name="line.73"></a>
<FONT color="green">074</FONT> private DatePatternConverter(final String[] options) {<a name="line.74"></a>
<FONT color="green">075</FONT> super("Date", "date");<a name="line.75"></a>
<FONT color="green">076</FONT> <a name="line.76"></a>
<FONT color="green">077</FONT> String patternOption;<a name="line.77"></a>
<FONT color="green">078</FONT> <a name="line.78"></a>
<FONT color="green">079</FONT> if ((options == null) || (options.length == 0)) {<a name="line.79"></a>
<FONT color="green">080</FONT> // the branch could be optimized, but here we are making explicit<a name="line.80"></a>
<FONT color="green">081</FONT> // that null values for patternOption are allowed.<a name="line.81"></a>
<FONT color="green">082</FONT> patternOption = null;<a name="line.82"></a>
<FONT color="green">083</FONT> } else {<a name="line.83"></a>
<FONT color="green">084</FONT> patternOption = options[0];<a name="line.84"></a>
<FONT color="green">085</FONT> }<a name="line.85"></a>
<FONT color="green">086</FONT> <a name="line.86"></a>
<FONT color="green">087</FONT> String pattern;<a name="line.87"></a>
<FONT color="green">088</FONT> <a name="line.88"></a>
<FONT color="green">089</FONT> if (patternOption == null || patternOption.equalsIgnoreCase(ISO8601_FORMAT)) {<a name="line.89"></a>
<FONT color="green">090</FONT> pattern = ISO8601_PATTERN;<a name="line.90"></a>
<FONT color="green">091</FONT> } else if (patternOption.equalsIgnoreCase(ABSOLUTE_FORMAT)) {<a name="line.91"></a>
<FONT color="green">092</FONT> pattern = ABSOLUTE_TIME_PATTERN;<a name="line.92"></a>
<FONT color="green">093</FONT> } else if (patternOption.equalsIgnoreCase(DATE_AND_TIME_FORMAT)) {<a name="line.93"></a>
<FONT color="green">094</FONT> pattern = DATE_AND_TIME_PATTERN;<a name="line.94"></a>
<FONT color="green">095</FONT> } else {<a name="line.95"></a>
<FONT color="green">096</FONT> pattern = patternOption;<a name="line.96"></a>
<FONT color="green">097</FONT> }<a name="line.97"></a>
<FONT color="green">098</FONT> <a name="line.98"></a>
<FONT color="green">099</FONT> try {<a name="line.99"></a>
<FONT color="green">100</FONT> simpleFormat = new SimpleDateFormat(pattern);<a name="line.100"></a>
<FONT color="green">101</FONT> } catch (IllegalArgumentException e) {<a name="line.101"></a>
<FONT color="green">102</FONT> LOGGER.warn("Could not instantiate SimpleDateFormat with pattern " + patternOption, e);<a name="line.102"></a>
<FONT color="green">103</FONT> <a name="line.103"></a>
<FONT color="green">104</FONT> // default to the ISO8601 format<a name="line.104"></a>
<FONT color="green">105</FONT> simpleFormat = new SimpleDateFormat(ISO8601_PATTERN);<a name="line.105"></a>
<FONT color="green">106</FONT> }<a name="line.106"></a>
<FONT color="green">107</FONT> <a name="line.107"></a>
<FONT color="green">108</FONT> // if the option list contains a TZ option, then set it.<a name="line.108"></a>
<FONT color="green">109</FONT> if ((options != null) &amp;&amp; (options.length &gt; 1)) {<a name="line.109"></a>
<FONT color="green">110</FONT> TimeZone tz = TimeZone.getTimeZone(options[1]);<a name="line.110"></a>
<FONT color="green">111</FONT> simpleFormat.setTimeZone(tz);<a name="line.111"></a>
<FONT color="green">112</FONT> }<a name="line.112"></a>
<FONT color="green">113</FONT> }<a name="line.113"></a>
<FONT color="green">114</FONT> <a name="line.114"></a>
<FONT color="green">115</FONT> /**<a name="line.115"></a>
<FONT color="green">116</FONT> * Obtains an instance of pattern converter.<a name="line.116"></a>
<FONT color="green">117</FONT> *<a name="line.117"></a>
<FONT color="green">118</FONT> * @param options options, may be null.<a name="line.118"></a>
<FONT color="green">119</FONT> * @return instance of pattern converter.<a name="line.119"></a>
<FONT color="green">120</FONT> */<a name="line.120"></a>
<FONT color="green">121</FONT> public static DatePatternConverter newInstance(final String[] options) {<a name="line.121"></a>
<FONT color="green">122</FONT> return new DatePatternConverter(options);<a name="line.122"></a>
<FONT color="green">123</FONT> }<a name="line.123"></a>
<FONT color="green">124</FONT> <a name="line.124"></a>
<FONT color="green">125</FONT> /**<a name="line.125"></a>
<FONT color="green">126</FONT> * {@inheritDoc}<a name="line.126"></a>
<FONT color="green">127</FONT> */<a name="line.127"></a>
<FONT color="green">128</FONT> public void format(final LogEvent event, final StringBuilder output) {<a name="line.128"></a>
<FONT color="green">129</FONT> long timestamp = event.getMillis();<a name="line.129"></a>
<FONT color="green">130</FONT> <a name="line.130"></a>
<FONT color="green">131</FONT> synchronized (this) {<a name="line.131"></a>
<FONT color="green">132</FONT> if (timestamp != lastTimestamp) {<a name="line.132"></a>
<FONT color="green">133</FONT> lastTimestamp = timestamp;<a name="line.133"></a>
<FONT color="green">134</FONT> cachedDate = simpleFormat.format(timestamp);<a name="line.134"></a>
<FONT color="green">135</FONT> }<a name="line.135"></a>
<FONT color="green">136</FONT> }<a name="line.136"></a>
<FONT color="green">137</FONT> output.append(cachedDate);<a name="line.137"></a>
<FONT color="green">138</FONT> }<a name="line.138"></a>
<FONT color="green">139</FONT> <a name="line.139"></a>
<FONT color="green">140</FONT> public void format(Object[] objects, final StringBuilder toAppendTo) {<a name="line.140"></a>
<FONT color="green">141</FONT> for (Object obj : objects) {<a name="line.141"></a>
<FONT color="green">142</FONT> if (obj instanceof Date) {<a name="line.142"></a>
<FONT color="green">143</FONT> format(obj, toAppendTo);<a name="line.143"></a>
<FONT color="green">144</FONT> break;<a name="line.144"></a>
<FONT color="green">145</FONT> }<a name="line.145"></a>
<FONT color="green">146</FONT> }<a name="line.146"></a>
<FONT color="green">147</FONT> }<a name="line.147"></a>
<FONT color="green">148</FONT> <a name="line.148"></a>
<FONT color="green">149</FONT> /**<a name="line.149"></a>
<FONT color="green">150</FONT> * {@inheritDoc}<a name="line.150"></a>
<FONT color="green">151</FONT> */<a name="line.151"></a>
<FONT color="green">152</FONT> public void format(final Object obj, final StringBuilder output) {<a name="line.152"></a>
<FONT color="green">153</FONT> if (obj instanceof Date) {<a name="line.153"></a>
<FONT color="green">154</FONT> format((Date) obj, output);<a name="line.154"></a>
<FONT color="green">155</FONT> }<a name="line.155"></a>
<FONT color="green">156</FONT> <a name="line.156"></a>
<FONT color="green">157</FONT> super.format(obj, output);<a name="line.157"></a>
<FONT color="green">158</FONT> }<a name="line.158"></a>
<FONT color="green">159</FONT> <a name="line.159"></a>
<FONT color="green">160</FONT> /**<a name="line.160"></a>
<FONT color="green">161</FONT> * Append formatted date to string buffer.<a name="line.161"></a>
<FONT color="green">162</FONT> *<a name="line.162"></a>
<FONT color="green">163</FONT> * @param date date<a name="line.163"></a>
<FONT color="green">164</FONT> * @param toAppendTo buffer to which formatted date is appended.<a name="line.164"></a>
<FONT color="green">165</FONT> */<a name="line.165"></a>
<FONT color="green">166</FONT> public void format(final Date date, final StringBuilder toAppendTo) {<a name="line.166"></a>
<FONT color="green">167</FONT> synchronized (this) {<a name="line.167"></a>
<FONT color="green">168</FONT> toAppendTo.append(simpleFormat.format(date.getTime()));<a name="line.168"></a>
<FONT color="green">169</FONT> }<a name="line.169"></a>
<FONT color="green">170</FONT> }<a name="line.170"></a>
<FONT color="green">171</FONT> <a name="line.171"></a>
<FONT color="green">172</FONT> public String getPattern() {<a name="line.172"></a>
<FONT color="green">173</FONT> return simpleFormat.toPattern();<a name="line.173"></a>
<FONT color="green">174</FONT> }<a name="line.174"></a>
<FONT color="green">175</FONT> <a name="line.175"></a>
<FONT color="green">176</FONT> }<a name="line.176"></a>
</PRE>
</BODY>
</HTML>