blob: 4d327ad484056a3658133b990bffee6355b98790 [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.Logger;<a name="line.19"></a>
<FONT color="green">020</FONT> import org.apache.logging.log4j.core.config.Configuration;<a name="line.20"></a>
<FONT color="green">021</FONT> import org.apache.logging.log4j.core.config.plugins.PluginManager;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.logging.log4j.core.config.plugins.PluginType;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.logging.log4j.status.StatusLogger;<a name="line.23"></a>
<FONT color="green">024</FONT> <a name="line.24"></a>
<FONT color="green">025</FONT> import java.lang.reflect.Method;<a name="line.25"></a>
<FONT color="green">026</FONT> import java.util.ArrayList;<a name="line.26"></a>
<FONT color="green">027</FONT> import java.util.HashMap;<a name="line.27"></a>
<FONT color="green">028</FONT> import java.util.Iterator;<a name="line.28"></a>
<FONT color="green">029</FONT> import java.util.List;<a name="line.29"></a>
<FONT color="green">030</FONT> import java.util.Map;<a name="line.30"></a>
<FONT color="green">031</FONT> <a name="line.31"></a>
<FONT color="green">032</FONT> /**<a name="line.32"></a>
<FONT color="green">033</FONT> * Most of the work of the {@link org.apache.logging.log4j.core.layout.PatternLayout} class<a name="line.33"></a>
<FONT color="green">034</FONT> * is delegated to the PatternParser class.<a name="line.34"></a>
<FONT color="green">035</FONT> * &lt;p&gt;It is this class that parses conversion patterns and creates<a name="line.35"></a>
<FONT color="green">036</FONT> * a chained list of {@link PatternConverter PatternConverters}.<a name="line.36"></a>
<FONT color="green">037</FONT> */<a name="line.37"></a>
<FONT color="green">038</FONT> public final class PatternParser {<a name="line.38"></a>
<FONT color="green">039</FONT> /**<a name="line.39"></a>
<FONT color="green">040</FONT> * Escape character for format specifier.<a name="line.40"></a>
<FONT color="green">041</FONT> */<a name="line.41"></a>
<FONT color="green">042</FONT> private static final char ESCAPE_CHAR = '%';<a name="line.42"></a>
<FONT color="green">043</FONT> <a name="line.43"></a>
<FONT color="green">044</FONT> /**<a name="line.44"></a>
<FONT color="green">045</FONT> * The states the parser can be in while parsing the pattern.<a name="line.45"></a>
<FONT color="green">046</FONT> */<a name="line.46"></a>
<FONT color="green">047</FONT> private enum ParserState {<a name="line.47"></a>
<FONT color="green">048</FONT> /**<a name="line.48"></a>
<FONT color="green">049</FONT> * Literal state.<a name="line.49"></a>
<FONT color="green">050</FONT> */<a name="line.50"></a>
<FONT color="green">051</FONT> LITERAL_STATE,<a name="line.51"></a>
<FONT color="green">052</FONT> <a name="line.52"></a>
<FONT color="green">053</FONT> /**<a name="line.53"></a>
<FONT color="green">054</FONT> * In converter name state.<a name="line.54"></a>
<FONT color="green">055</FONT> */<a name="line.55"></a>
<FONT color="green">056</FONT> CONVERTER_STATE,<a name="line.56"></a>
<FONT color="green">057</FONT> <a name="line.57"></a>
<FONT color="green">058</FONT> /**<a name="line.58"></a>
<FONT color="green">059</FONT> * Dot state.<a name="line.59"></a>
<FONT color="green">060</FONT> */<a name="line.60"></a>
<FONT color="green">061</FONT> DOT_STATE,<a name="line.61"></a>
<FONT color="green">062</FONT> <a name="line.62"></a>
<FONT color="green">063</FONT> /**<a name="line.63"></a>
<FONT color="green">064</FONT> * Min state.<a name="line.64"></a>
<FONT color="green">065</FONT> */<a name="line.65"></a>
<FONT color="green">066</FONT> MIN_STATE,<a name="line.66"></a>
<FONT color="green">067</FONT> <a name="line.67"></a>
<FONT color="green">068</FONT> /**<a name="line.68"></a>
<FONT color="green">069</FONT> * Max state.<a name="line.69"></a>
<FONT color="green">070</FONT> */<a name="line.70"></a>
<FONT color="green">071</FONT> MAX_STATE;<a name="line.71"></a>
<FONT color="green">072</FONT> }<a name="line.72"></a>
<FONT color="green">073</FONT> <a name="line.73"></a>
<FONT color="green">074</FONT> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.74"></a>
<FONT color="green">075</FONT> <a name="line.75"></a>
<FONT color="green">076</FONT> private static final int BUF_SIZE = 32;<a name="line.76"></a>
<FONT color="green">077</FONT> <a name="line.77"></a>
<FONT color="green">078</FONT> private static final int DECIMAL = 10;<a name="line.78"></a>
<FONT color="green">079</FONT> <a name="line.79"></a>
<FONT color="green">080</FONT> /**<a name="line.80"></a>
<FONT color="green">081</FONT> * Does pattern process exceptions.<a name="line.81"></a>
<FONT color="green">082</FONT> */<a name="line.82"></a>
<FONT color="green">083</FONT> private boolean handlesExceptions;<a name="line.83"></a>
<FONT color="green">084</FONT> <a name="line.84"></a>
<FONT color="green">085</FONT> private Configuration config;<a name="line.85"></a>
<FONT color="green">086</FONT> <a name="line.86"></a>
<FONT color="green">087</FONT> private final Map&lt;String, Class&lt;PatternConverter&gt;&gt; converterRules;<a name="line.87"></a>
<FONT color="green">088</FONT> <a name="line.88"></a>
<FONT color="green">089</FONT> <a name="line.89"></a>
<FONT color="green">090</FONT> /**<a name="line.90"></a>
<FONT color="green">091</FONT> * Constructor.<a name="line.91"></a>
<FONT color="green">092</FONT> * @param converterKey The type of converters that will be used.<a name="line.92"></a>
<FONT color="green">093</FONT> */<a name="line.93"></a>
<FONT color="green">094</FONT> public PatternParser(String converterKey) {<a name="line.94"></a>
<FONT color="green">095</FONT> this(null, converterKey, null);<a name="line.95"></a>
<FONT color="green">096</FONT> }<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> * Constructor.<a name="line.99"></a>
<FONT color="green">100</FONT> * @param config The current Configuration.<a name="line.100"></a>
<FONT color="green">101</FONT> * @param converterKey The key to lookup the converters.<a name="line.101"></a>
<FONT color="green">102</FONT> * @param expected The expected base Class of each Converter.<a name="line.102"></a>
<FONT color="green">103</FONT> */<a name="line.103"></a>
<FONT color="green">104</FONT> public PatternParser(Configuration config, String converterKey, Class expected) {<a name="line.104"></a>
<FONT color="green">105</FONT> this.config = config;<a name="line.105"></a>
<FONT color="green">106</FONT> PluginManager manager = new PluginManager(converterKey, expected);<a name="line.106"></a>
<FONT color="green">107</FONT> manager.collectPlugins();<a name="line.107"></a>
<FONT color="green">108</FONT> Map&lt;String, PluginType&gt; plugins = manager.getPlugins();<a name="line.108"></a>
<FONT color="green">109</FONT> Map&lt;String, Class&lt;PatternConverter&gt;&gt; converters = new HashMap&lt;String, Class&lt;PatternConverter&gt;&gt;();<a name="line.109"></a>
<FONT color="green">110</FONT> <a name="line.110"></a>
<FONT color="green">111</FONT> for (PluginType type : plugins.values()) {<a name="line.111"></a>
<FONT color="green">112</FONT> try {<a name="line.112"></a>
<FONT color="green">113</FONT> Class&lt;PatternConverter&gt; clazz = type.getPluginClass();<a name="line.113"></a>
<FONT color="green">114</FONT> ConverterKeys keys = clazz.getAnnotation(ConverterKeys.class);<a name="line.114"></a>
<FONT color="green">115</FONT> if (keys != null) {<a name="line.115"></a>
<FONT color="green">116</FONT> for (String key : keys.value()) {<a name="line.116"></a>
<FONT color="green">117</FONT> converters.put(key, clazz);<a name="line.117"></a>
<FONT color="green">118</FONT> }<a name="line.118"></a>
<FONT color="green">119</FONT> }<a name="line.119"></a>
<FONT color="green">120</FONT> } catch (Exception ex) {<a name="line.120"></a>
<FONT color="green">121</FONT> LOGGER.error("Error processing plugin " + type.getElementName(), ex);<a name="line.121"></a>
<FONT color="green">122</FONT> }<a name="line.122"></a>
<FONT color="green">123</FONT> }<a name="line.123"></a>
<FONT color="green">124</FONT> converterRules = converters;<a name="line.124"></a>
<FONT color="green">125</FONT> }<a name="line.125"></a>
<FONT color="green">126</FONT> <a name="line.126"></a>
<FONT color="green">127</FONT> <a name="line.127"></a>
<FONT color="green">128</FONT> public List&lt;PatternConverter&gt; parse(String pattern) {<a name="line.128"></a>
<FONT color="green">129</FONT> List&lt;PatternConverter&gt; converters = new ArrayList&lt;PatternConverter&gt;();<a name="line.129"></a>
<FONT color="green">130</FONT> List&lt;FormattingInfo&gt; fields = new ArrayList&lt;FormattingInfo&gt;();<a name="line.130"></a>
<FONT color="green">131</FONT> <a name="line.131"></a>
<FONT color="green">132</FONT> parse(pattern, converters, fields);<a name="line.132"></a>
<FONT color="green">133</FONT> <a name="line.133"></a>
<FONT color="green">134</FONT> LogEventPatternConverter[] patternConverters = new LogEventPatternConverter[converters.size()];<a name="line.134"></a>
<FONT color="green">135</FONT> FormattingInfo[] patternFields = new FormattingInfo[converters.size()];<a name="line.135"></a>
<FONT color="green">136</FONT> <a name="line.136"></a>
<FONT color="green">137</FONT> int i = 0;<a name="line.137"></a>
<FONT color="green">138</FONT> Iterator fieldIter = fields.iterator();<a name="line.138"></a>
<FONT color="green">139</FONT> <a name="line.139"></a>
<FONT color="green">140</FONT> for (PatternConverter converter : converters) {<a name="line.140"></a>
<FONT color="green">141</FONT> if (converter instanceof LogEventPatternConverter) {<a name="line.141"></a>
<FONT color="green">142</FONT> patternConverters[i] = (LogEventPatternConverter) converter;<a name="line.142"></a>
<FONT color="green">143</FONT> handlesExceptions |= patternConverters[i].handlesThrowable();<a name="line.143"></a>
<FONT color="green">144</FONT> } else {<a name="line.144"></a>
<FONT color="green">145</FONT> patternConverters[i] = new LiteralPatternConverter("");<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> if (fieldIter.hasNext()) {<a name="line.148"></a>
<FONT color="green">149</FONT> patternFields[i] = (FormattingInfo) fieldIter.next();<a name="line.149"></a>
<FONT color="green">150</FONT> } else {<a name="line.150"></a>
<FONT color="green">151</FONT> patternFields[i] = FormattingInfo.getDefault();<a name="line.151"></a>
<FONT color="green">152</FONT> }<a name="line.152"></a>
<FONT color="green">153</FONT> <a name="line.153"></a>
<FONT color="green">154</FONT> i++;<a name="line.154"></a>
<FONT color="green">155</FONT> }<a name="line.155"></a>
<FONT color="green">156</FONT> return converters;<a name="line.156"></a>
<FONT color="green">157</FONT> }<a name="line.157"></a>
<FONT color="green">158</FONT> <a name="line.158"></a>
<FONT color="green">159</FONT> public boolean handlesExceptions() {<a name="line.159"></a>
<FONT color="green">160</FONT> return handlesExceptions;<a name="line.160"></a>
<FONT color="green">161</FONT> }<a name="line.161"></a>
<FONT color="green">162</FONT> <a name="line.162"></a>
<FONT color="green">163</FONT> /**<a name="line.163"></a>
<FONT color="green">164</FONT> * Extract the converter identifier found at position i.<a name="line.164"></a>
<FONT color="green">165</FONT> * &lt;p/&gt;<a name="line.165"></a>
<FONT color="green">166</FONT> * After this function returns, the variable i will point to the<a name="line.166"></a>
<FONT color="green">167</FONT> * first char after the end of the converter identifier.<a name="line.167"></a>
<FONT color="green">168</FONT> * &lt;p/&gt;<a name="line.168"></a>
<FONT color="green">169</FONT> * If i points to a char which is not a character acceptable at the<a name="line.169"></a>
<FONT color="green">170</FONT> * start of a unicode identifier, the value null is returned.<a name="line.170"></a>
<FONT color="green">171</FONT> *<a name="line.171"></a>
<FONT color="green">172</FONT> * @param lastChar last processed character.<a name="line.172"></a>
<FONT color="green">173</FONT> * @param pattern format string.<a name="line.173"></a>
<FONT color="green">174</FONT> * @param i current index into pattern format.<a name="line.174"></a>
<FONT color="green">175</FONT> * @param convBuf buffer to receive conversion specifier.<a name="line.175"></a>
<FONT color="green">176</FONT> * @param currentLiteral literal to be output in case format specifier in unrecognized.<a name="line.176"></a>
<FONT color="green">177</FONT> * @return position in pattern after converter.<a name="line.177"></a>
<FONT color="green">178</FONT> */<a name="line.178"></a>
<FONT color="green">179</FONT> private static int extractConverter(<a name="line.179"></a>
<FONT color="green">180</FONT> char lastChar, final String pattern, int i, final StringBuilder convBuf,<a name="line.180"></a>
<FONT color="green">181</FONT> final StringBuilder currentLiteral) {<a name="line.181"></a>
<FONT color="green">182</FONT> convBuf.setLength(0);<a name="line.182"></a>
<FONT color="green">183</FONT> <a name="line.183"></a>
<FONT color="green">184</FONT> // When this method is called, lastChar points to the first character of the<a name="line.184"></a>
<FONT color="green">185</FONT> // conversion word. For example:<a name="line.185"></a>
<FONT color="green">186</FONT> // For "%hello" lastChar = 'h'<a name="line.186"></a>
<FONT color="green">187</FONT> // For "%-5hello" lastChar = 'h'<a name="line.187"></a>
<FONT color="green">188</FONT> //System.out.println("lastchar is "+lastChar);<a name="line.188"></a>
<FONT color="green">189</FONT> if (!Character.isUnicodeIdentifierStart(lastChar)) {<a name="line.189"></a>
<FONT color="green">190</FONT> return i;<a name="line.190"></a>
<FONT color="green">191</FONT> }<a name="line.191"></a>
<FONT color="green">192</FONT> <a name="line.192"></a>
<FONT color="green">193</FONT> convBuf.append(lastChar);<a name="line.193"></a>
<FONT color="green">194</FONT> <a name="line.194"></a>
<FONT color="green">195</FONT> while ((i &lt; pattern.length()) &amp;&amp; Character.isUnicodeIdentifierPart(pattern.charAt(i))) {<a name="line.195"></a>
<FONT color="green">196</FONT> convBuf.append(pattern.charAt(i));<a name="line.196"></a>
<FONT color="green">197</FONT> currentLiteral.append(pattern.charAt(i));<a name="line.197"></a>
<FONT color="green">198</FONT> i++;<a name="line.198"></a>
<FONT color="green">199</FONT> }<a name="line.199"></a>
<FONT color="green">200</FONT> <a name="line.200"></a>
<FONT color="green">201</FONT> return i;<a name="line.201"></a>
<FONT color="green">202</FONT> }<a name="line.202"></a>
<FONT color="green">203</FONT> <a name="line.203"></a>
<FONT color="green">204</FONT> /**<a name="line.204"></a>
<FONT color="green">205</FONT> * Extract options.<a name="line.205"></a>
<FONT color="green">206</FONT> *<a name="line.206"></a>
<FONT color="green">207</FONT> * @param pattern conversion pattern.<a name="line.207"></a>
<FONT color="green">208</FONT> * @param i start of options.<a name="line.208"></a>
<FONT color="green">209</FONT> * @param options array to receive extracted options<a name="line.209"></a>
<FONT color="green">210</FONT> * @return position in pattern after options.<a name="line.210"></a>
<FONT color="green">211</FONT> */<a name="line.211"></a>
<FONT color="green">212</FONT> private static int extractOptions(String pattern, int i, List&lt;String&gt; options) {<a name="line.212"></a>
<FONT color="green">213</FONT> while ((i &lt; pattern.length()) &amp;&amp; (pattern.charAt(i) == '{')) {<a name="line.213"></a>
<FONT color="green">214</FONT> int end = pattern.indexOf('}', i);<a name="line.214"></a>
<FONT color="green">215</FONT> <a name="line.215"></a>
<FONT color="green">216</FONT> if (end == -1) {<a name="line.216"></a>
<FONT color="green">217</FONT> break;<a name="line.217"></a>
<FONT color="green">218</FONT> }<a name="line.218"></a>
<FONT color="green">219</FONT> <a name="line.219"></a>
<FONT color="green">220</FONT> String r = pattern.substring(i + 1, end);<a name="line.220"></a>
<FONT color="green">221</FONT> options.add(r);<a name="line.221"></a>
<FONT color="green">222</FONT> i = end + 1;<a name="line.222"></a>
<FONT color="green">223</FONT> }<a name="line.223"></a>
<FONT color="green">224</FONT> <a name="line.224"></a>
<FONT color="green">225</FONT> return i;<a name="line.225"></a>
<FONT color="green">226</FONT> }<a name="line.226"></a>
<FONT color="green">227</FONT> <a name="line.227"></a>
<FONT color="green">228</FONT> /**<a name="line.228"></a>
<FONT color="green">229</FONT> * Parse a format specifier.<a name="line.229"></a>
<FONT color="green">230</FONT> *<a name="line.230"></a>
<FONT color="green">231</FONT> * @param pattern pattern to parse.<a name="line.231"></a>
<FONT color="green">232</FONT> * @param patternConverters list to receive pattern converters.<a name="line.232"></a>
<FONT color="green">233</FONT> * @param formattingInfos list to receive field specifiers corresponding to pattern converters.<a name="line.233"></a>
<FONT color="green">234</FONT> */<a name="line.234"></a>
<FONT color="green">235</FONT> public void parse(final String pattern, final List&lt;PatternConverter&gt; patternConverters,<a name="line.235"></a>
<FONT color="green">236</FONT> final List&lt;FormattingInfo&gt; formattingInfos) {<a name="line.236"></a>
<FONT color="green">237</FONT> if (pattern == null) {<a name="line.237"></a>
<FONT color="green">238</FONT> throw new NullPointerException("pattern");<a name="line.238"></a>
<FONT color="green">239</FONT> }<a name="line.239"></a>
<FONT color="green">240</FONT> <a name="line.240"></a>
<FONT color="green">241</FONT> StringBuilder currentLiteral = new StringBuilder(BUF_SIZE);<a name="line.241"></a>
<FONT color="green">242</FONT> <a name="line.242"></a>
<FONT color="green">243</FONT> int patternLength = pattern.length();<a name="line.243"></a>
<FONT color="green">244</FONT> ParserState state = ParserState.LITERAL_STATE;<a name="line.244"></a>
<FONT color="green">245</FONT> char c;<a name="line.245"></a>
<FONT color="green">246</FONT> int i = 0;<a name="line.246"></a>
<FONT color="green">247</FONT> FormattingInfo formattingInfo = FormattingInfo.getDefault();<a name="line.247"></a>
<FONT color="green">248</FONT> <a name="line.248"></a>
<FONT color="green">249</FONT> while (i &lt; patternLength) {<a name="line.249"></a>
<FONT color="green">250</FONT> c = pattern.charAt(i++);<a name="line.250"></a>
<FONT color="green">251</FONT> <a name="line.251"></a>
<FONT color="green">252</FONT> switch (state) {<a name="line.252"></a>
<FONT color="green">253</FONT> case LITERAL_STATE:<a name="line.253"></a>
<FONT color="green">254</FONT> <a name="line.254"></a>
<FONT color="green">255</FONT> // In literal state, the last char is always a literal.<a name="line.255"></a>
<FONT color="green">256</FONT> if (i == patternLength) {<a name="line.256"></a>
<FONT color="green">257</FONT> currentLiteral.append(c);<a name="line.257"></a>
<FONT color="green">258</FONT> <a name="line.258"></a>
<FONT color="green">259</FONT> continue;<a name="line.259"></a>
<FONT color="green">260</FONT> }<a name="line.260"></a>
<FONT color="green">261</FONT> <a name="line.261"></a>
<FONT color="green">262</FONT> if (c == ESCAPE_CHAR) {<a name="line.262"></a>
<FONT color="green">263</FONT> // peek at the next char.<a name="line.263"></a>
<FONT color="green">264</FONT> switch (pattern.charAt(i)) {<a name="line.264"></a>
<FONT color="green">265</FONT> case ESCAPE_CHAR:<a name="line.265"></a>
<FONT color="green">266</FONT> currentLiteral.append(c);<a name="line.266"></a>
<FONT color="green">267</FONT> i++; // move pointer<a name="line.267"></a>
<FONT color="green">268</FONT> <a name="line.268"></a>
<FONT color="green">269</FONT> break;<a name="line.269"></a>
<FONT color="green">270</FONT> <a name="line.270"></a>
<FONT color="green">271</FONT> default:<a name="line.271"></a>
<FONT color="green">272</FONT> <a name="line.272"></a>
<FONT color="green">273</FONT> if (currentLiteral.length() != 0) {<a name="line.273"></a>
<FONT color="green">274</FONT> patternConverters.add(new LiteralPatternConverter(currentLiteral.toString()));<a name="line.274"></a>
<FONT color="green">275</FONT> formattingInfos.add(FormattingInfo.getDefault());<a name="line.275"></a>
<FONT color="green">276</FONT> }<a name="line.276"></a>
<FONT color="green">277</FONT> <a name="line.277"></a>
<FONT color="green">278</FONT> currentLiteral.setLength(0);<a name="line.278"></a>
<FONT color="green">279</FONT> currentLiteral.append(c); // append %<a name="line.279"></a>
<FONT color="green">280</FONT> state = ParserState.CONVERTER_STATE;<a name="line.280"></a>
<FONT color="green">281</FONT> formattingInfo = FormattingInfo.getDefault();<a name="line.281"></a>
<FONT color="green">282</FONT> }<a name="line.282"></a>
<FONT color="green">283</FONT> } else {<a name="line.283"></a>
<FONT color="green">284</FONT> currentLiteral.append(c);<a name="line.284"></a>
<FONT color="green">285</FONT> }<a name="line.285"></a>
<FONT color="green">286</FONT> <a name="line.286"></a>
<FONT color="green">287</FONT> break;<a name="line.287"></a>
<FONT color="green">288</FONT> <a name="line.288"></a>
<FONT color="green">289</FONT> case CONVERTER_STATE:<a name="line.289"></a>
<FONT color="green">290</FONT> currentLiteral.append(c);<a name="line.290"></a>
<FONT color="green">291</FONT> <a name="line.291"></a>
<FONT color="green">292</FONT> switch (c) {<a name="line.292"></a>
<FONT color="green">293</FONT> case '-':<a name="line.293"></a>
<FONT color="green">294</FONT> formattingInfo =<a name="line.294"></a>
<FONT color="green">295</FONT> new FormattingInfo(true, formattingInfo.getMinLength(),<a name="line.295"></a>
<FONT color="green">296</FONT> formattingInfo.getMaxLength());<a name="line.296"></a>
<FONT color="green">297</FONT> <a name="line.297"></a>
<FONT color="green">298</FONT> break;<a name="line.298"></a>
<FONT color="green">299</FONT> <a name="line.299"></a>
<FONT color="green">300</FONT> case '.':<a name="line.300"></a>
<FONT color="green">301</FONT> state = ParserState.DOT_STATE;<a name="line.301"></a>
<FONT color="green">302</FONT> <a name="line.302"></a>
<FONT color="green">303</FONT> break;<a name="line.303"></a>
<FONT color="green">304</FONT> <a name="line.304"></a>
<FONT color="green">305</FONT> default:<a name="line.305"></a>
<FONT color="green">306</FONT> <a name="line.306"></a>
<FONT color="green">307</FONT> if ((c &gt;= '0') &amp;&amp; (c &lt;= '9')) {<a name="line.307"></a>
<FONT color="green">308</FONT> formattingInfo = new FormattingInfo(formattingInfo.isLeftAligned(), c - '0',<a name="line.308"></a>
<FONT color="green">309</FONT> formattingInfo.getMaxLength());<a name="line.309"></a>
<FONT color="green">310</FONT> state = ParserState.MIN_STATE;<a name="line.310"></a>
<FONT color="green">311</FONT> } else {<a name="line.311"></a>
<FONT color="green">312</FONT> i = finalizeConverter(c, pattern, i, currentLiteral, formattingInfo,<a name="line.312"></a>
<FONT color="green">313</FONT> converterRules, patternConverters, formattingInfos);<a name="line.313"></a>
<FONT color="green">314</FONT> <a name="line.314"></a>
<FONT color="green">315</FONT> // Next pattern is assumed to be a literal.<a name="line.315"></a>
<FONT color="green">316</FONT> state = ParserState.LITERAL_STATE;<a name="line.316"></a>
<FONT color="green">317</FONT> formattingInfo = FormattingInfo.getDefault();<a name="line.317"></a>
<FONT color="green">318</FONT> currentLiteral.setLength(0);<a name="line.318"></a>
<FONT color="green">319</FONT> }<a name="line.319"></a>
<FONT color="green">320</FONT> } // switch<a name="line.320"></a>
<FONT color="green">321</FONT> <a name="line.321"></a>
<FONT color="green">322</FONT> break;<a name="line.322"></a>
<FONT color="green">323</FONT> <a name="line.323"></a>
<FONT color="green">324</FONT> case MIN_STATE:<a name="line.324"></a>
<FONT color="green">325</FONT> currentLiteral.append(c);<a name="line.325"></a>
<FONT color="green">326</FONT> <a name="line.326"></a>
<FONT color="green">327</FONT> if ((c &gt;= '0') &amp;&amp; (c &lt;= '9')) {<a name="line.327"></a>
<FONT color="green">328</FONT> // Multiply the existing value and add the value of the number just encountered.<a name="line.328"></a>
<FONT color="green">329</FONT> formattingInfo = new FormattingInfo(formattingInfo.isLeftAligned(),<a name="line.329"></a>
<FONT color="green">330</FONT> (formattingInfo.getMinLength() * DECIMAL) + (c - '0'),<a name="line.330"></a>
<FONT color="green">331</FONT> formattingInfo.getMaxLength());<a name="line.331"></a>
<FONT color="green">332</FONT> } else if (c == '.') {<a name="line.332"></a>
<FONT color="green">333</FONT> state = ParserState.DOT_STATE;<a name="line.333"></a>
<FONT color="green">334</FONT> } else {<a name="line.334"></a>
<FONT color="green">335</FONT> i = finalizeConverter(c, pattern, i, currentLiteral, formattingInfo,<a name="line.335"></a>
<FONT color="green">336</FONT> converterRules, patternConverters, formattingInfos);<a name="line.336"></a>
<FONT color="green">337</FONT> state = ParserState.LITERAL_STATE;<a name="line.337"></a>
<FONT color="green">338</FONT> formattingInfo = FormattingInfo.getDefault();<a name="line.338"></a>
<FONT color="green">339</FONT> currentLiteral.setLength(0);<a name="line.339"></a>
<FONT color="green">340</FONT> }<a name="line.340"></a>
<FONT color="green">341</FONT> <a name="line.341"></a>
<FONT color="green">342</FONT> break;<a name="line.342"></a>
<FONT color="green">343</FONT> <a name="line.343"></a>
<FONT color="green">344</FONT> case DOT_STATE:<a name="line.344"></a>
<FONT color="green">345</FONT> currentLiteral.append(c);<a name="line.345"></a>
<FONT color="green">346</FONT> <a name="line.346"></a>
<FONT color="green">347</FONT> if ((c &gt;= '0') &amp;&amp; (c &lt;= '9')) {<a name="line.347"></a>
<FONT color="green">348</FONT> formattingInfo = new FormattingInfo(formattingInfo.isLeftAligned(),<a name="line.348"></a>
<FONT color="green">349</FONT> formattingInfo.getMinLength(), c - '0');<a name="line.349"></a>
<FONT color="green">350</FONT> state = ParserState.MAX_STATE;<a name="line.350"></a>
<FONT color="green">351</FONT> } else {<a name="line.351"></a>
<FONT color="green">352</FONT> LOGGER.error("Error occurred in position " + i<a name="line.352"></a>
<FONT color="green">353</FONT> + ".\n Was expecting digit, instead got char \"" + c + "\".");<a name="line.353"></a>
<FONT color="green">354</FONT> <a name="line.354"></a>
<FONT color="green">355</FONT> state = ParserState.LITERAL_STATE;<a name="line.355"></a>
<FONT color="green">356</FONT> }<a name="line.356"></a>
<FONT color="green">357</FONT> <a name="line.357"></a>
<FONT color="green">358</FONT> break;<a name="line.358"></a>
<FONT color="green">359</FONT> <a name="line.359"></a>
<FONT color="green">360</FONT> case MAX_STATE:<a name="line.360"></a>
<FONT color="green">361</FONT> currentLiteral.append(c);<a name="line.361"></a>
<FONT color="green">362</FONT> <a name="line.362"></a>
<FONT color="green">363</FONT> if ((c &gt;= '0') &amp;&amp; (c &lt;= '9')) {<a name="line.363"></a>
<FONT color="green">364</FONT> // Multiply the existing value and add the value of the number just encountered.<a name="line.364"></a>
<FONT color="green">365</FONT> formattingInfo = new FormattingInfo(<a name="line.365"></a>
<FONT color="green">366</FONT> formattingInfo.isLeftAligned(), formattingInfo.getMinLength(),<a name="line.366"></a>
<FONT color="green">367</FONT> (formattingInfo.getMaxLength() * DECIMAL) + (c - '0'));<a name="line.367"></a>
<FONT color="green">368</FONT> } else {<a name="line.368"></a>
<FONT color="green">369</FONT> i = finalizeConverter(c, pattern, i, currentLiteral, formattingInfo,<a name="line.369"></a>
<FONT color="green">370</FONT> converterRules, patternConverters, formattingInfos);<a name="line.370"></a>
<FONT color="green">371</FONT> state = ParserState.LITERAL_STATE;<a name="line.371"></a>
<FONT color="green">372</FONT> formattingInfo = FormattingInfo.getDefault();<a name="line.372"></a>
<FONT color="green">373</FONT> currentLiteral.setLength(0);<a name="line.373"></a>
<FONT color="green">374</FONT> }<a name="line.374"></a>
<FONT color="green">375</FONT> <a name="line.375"></a>
<FONT color="green">376</FONT> break;<a name="line.376"></a>
<FONT color="green">377</FONT> } // switch<a name="line.377"></a>
<FONT color="green">378</FONT> }<a name="line.378"></a>
<FONT color="green">379</FONT> <a name="line.379"></a>
<FONT color="green">380</FONT> // while<a name="line.380"></a>
<FONT color="green">381</FONT> if (currentLiteral.length() != 0) {<a name="line.381"></a>
<FONT color="green">382</FONT> patternConverters.add(new LiteralPatternConverter(currentLiteral.toString()));<a name="line.382"></a>
<FONT color="green">383</FONT> formattingInfos.add(FormattingInfo.getDefault());<a name="line.383"></a>
<FONT color="green">384</FONT> }<a name="line.384"></a>
<FONT color="green">385</FONT> }<a name="line.385"></a>
<FONT color="green">386</FONT> <a name="line.386"></a>
<FONT color="green">387</FONT> /**<a name="line.387"></a>
<FONT color="green">388</FONT> * Creates a new PatternConverter.<a name="line.388"></a>
<FONT color="green">389</FONT> *<a name="line.389"></a>
<FONT color="green">390</FONT> * @param converterId converterId.<a name="line.390"></a>
<FONT color="green">391</FONT> * @param currentLiteral literal to be used if converter is unrecognized or following converter<a name="line.391"></a>
<FONT color="green">392</FONT> * if converterId contains extra characters.<a name="line.392"></a>
<FONT color="green">393</FONT> * @param rules map of stock pattern converters keyed by format specifier.<a name="line.393"></a>
<FONT color="green">394</FONT> * @param options converter options.<a name="line.394"></a>
<FONT color="green">395</FONT> * @return converter or null.<a name="line.395"></a>
<FONT color="green">396</FONT> */<a name="line.396"></a>
<FONT color="green">397</FONT> private PatternConverter createConverter(final String converterId, final StringBuilder currentLiteral,<a name="line.397"></a>
<FONT color="green">398</FONT> final Map&lt;String, Class&lt;PatternConverter&gt;&gt; rules,<a name="line.398"></a>
<FONT color="green">399</FONT> final List&lt;String&gt; options) {<a name="line.399"></a>
<FONT color="green">400</FONT> String converterName = converterId;<a name="line.400"></a>
<FONT color="green">401</FONT> Class&lt;PatternConverter&gt; converterClass = null;<a name="line.401"></a>
<FONT color="green">402</FONT> <a name="line.402"></a>
<FONT color="green">403</FONT> for (int i = converterId.length(); (i &gt; 0) &amp;&amp; (converterClass == null); i--) {<a name="line.403"></a>
<FONT color="green">404</FONT> converterName = converterName.substring(0, i);<a name="line.404"></a>
<FONT color="green">405</FONT> <a name="line.405"></a>
<FONT color="green">406</FONT> if ((converterClass == null) &amp;&amp; (rules != null)) {<a name="line.406"></a>
<FONT color="green">407</FONT> converterClass = rules.get(converterName);<a name="line.407"></a>
<FONT color="green">408</FONT> }<a name="line.408"></a>
<FONT color="green">409</FONT> }<a name="line.409"></a>
<FONT color="green">410</FONT> <a name="line.410"></a>
<FONT color="green">411</FONT> if (converterClass == null) {<a name="line.411"></a>
<FONT color="green">412</FONT> LOGGER.error("Unrecognized format specifier [" + converterId + "]");<a name="line.412"></a>
<FONT color="green">413</FONT> <a name="line.413"></a>
<FONT color="green">414</FONT> return null;<a name="line.414"></a>
<FONT color="green">415</FONT> }<a name="line.415"></a>
<FONT color="green">416</FONT> <a name="line.416"></a>
<FONT color="green">417</FONT> Method[] methods = converterClass.getDeclaredMethods();<a name="line.417"></a>
<FONT color="green">418</FONT> Method newInstance = null;<a name="line.418"></a>
<FONT color="green">419</FONT> for (Method method : methods) {<a name="line.419"></a>
<FONT color="green">420</FONT> if (method.getName().equals("newInstance")) {<a name="line.420"></a>
<FONT color="green">421</FONT> if (newInstance == null) {<a name="line.421"></a>
<FONT color="green">422</FONT> newInstance = method;<a name="line.422"></a>
<FONT color="green">423</FONT> } else {<a name="line.423"></a>
<FONT color="green">424</FONT> LOGGER.error("Class " + converterClass + " cannot contain multiple newInstance methods");<a name="line.424"></a>
<FONT color="green">425</FONT> return null;<a name="line.425"></a>
<FONT color="green">426</FONT> }<a name="line.426"></a>
<FONT color="green">427</FONT> }<a name="line.427"></a>
<FONT color="green">428</FONT> }<a name="line.428"></a>
<FONT color="green">429</FONT> if (newInstance == null) {<a name="line.429"></a>
<FONT color="green">430</FONT> LOGGER.error("Class " + converterClass + " does not contain a newInstance method");<a name="line.430"></a>
<FONT color="green">431</FONT> return null;<a name="line.431"></a>
<FONT color="green">432</FONT> }<a name="line.432"></a>
<FONT color="green">433</FONT> <a name="line.433"></a>
<FONT color="green">434</FONT> Class[] parmTypes = newInstance.getParameterTypes();<a name="line.434"></a>
<FONT color="green">435</FONT> Object [] parms = parmTypes.length &gt; 0 ? new Object[parmTypes.length] : null;<a name="line.435"></a>
<FONT color="green">436</FONT> <a name="line.436"></a>
<FONT color="green">437</FONT> if (parms != null) {<a name="line.437"></a>
<FONT color="green">438</FONT> int i = 0;<a name="line.438"></a>
<FONT color="green">439</FONT> boolean errors = false;<a name="line.439"></a>
<FONT color="green">440</FONT> for (Class clazz : parmTypes) {<a name="line.440"></a>
<FONT color="green">441</FONT> if (clazz.isArray() &amp;&amp; clazz.getName().equals("[Ljava.lang.String;")) {<a name="line.441"></a>
<FONT color="green">442</FONT> String[] optionsArray = options.toArray(new String[options.size()]);<a name="line.442"></a>
<FONT color="green">443</FONT> parms[i] = optionsArray;<a name="line.443"></a>
<FONT color="green">444</FONT> } else if (clazz.isAssignableFrom(Configuration.class)) {<a name="line.444"></a>
<FONT color="green">445</FONT> parms[i] = config;<a name="line.445"></a>
<FONT color="green">446</FONT> } else {<a name="line.446"></a>
<FONT color="green">447</FONT> LOGGER.error("Unknown parameter type " + clazz.getName() + " for newInstance method of " +<a name="line.447"></a>
<FONT color="green">448</FONT> converterClass.getName());<a name="line.448"></a>
<FONT color="green">449</FONT> errors = true;<a name="line.449"></a>
<FONT color="green">450</FONT> }<a name="line.450"></a>
<FONT color="green">451</FONT> ++i;<a name="line.451"></a>
<FONT color="green">452</FONT> }<a name="line.452"></a>
<FONT color="green">453</FONT> if (errors) {<a name="line.453"></a>
<FONT color="green">454</FONT> return null;<a name="line.454"></a>
<FONT color="green">455</FONT> }<a name="line.455"></a>
<FONT color="green">456</FONT> }<a name="line.456"></a>
<FONT color="green">457</FONT> <a name="line.457"></a>
<FONT color="green">458</FONT> try {<a name="line.458"></a>
<FONT color="green">459</FONT> Object newObj = newInstance.invoke(null, parms);<a name="line.459"></a>
<FONT color="green">460</FONT> <a name="line.460"></a>
<FONT color="green">461</FONT> if (newObj instanceof PatternConverter) {<a name="line.461"></a>
<FONT color="green">462</FONT> currentLiteral.delete(0, currentLiteral.length()<a name="line.462"></a>
<FONT color="green">463</FONT> - (converterId.length() - converterName.length()));<a name="line.463"></a>
<FONT color="green">464</FONT> <a name="line.464"></a>
<FONT color="green">465</FONT> return (PatternConverter) newObj;<a name="line.465"></a>
<FONT color="green">466</FONT> } else {<a name="line.466"></a>
<FONT color="green">467</FONT> LOGGER.warn("Class " + converterClass.getName() + " does not extend PatternConverter.");<a name="line.467"></a>
<FONT color="green">468</FONT> }<a name="line.468"></a>
<FONT color="green">469</FONT> } catch (Exception ex) {<a name="line.469"></a>
<FONT color="green">470</FONT> LOGGER.error("Error creating converter for " + converterId, ex);<a name="line.470"></a>
<FONT color="green">471</FONT> }<a name="line.471"></a>
<FONT color="green">472</FONT> <a name="line.472"></a>
<FONT color="green">473</FONT> return null;<a name="line.473"></a>
<FONT color="green">474</FONT> }<a name="line.474"></a>
<FONT color="green">475</FONT> <a name="line.475"></a>
<FONT color="green">476</FONT> /**<a name="line.476"></a>
<FONT color="green">477</FONT> * Processes a format specifier sequence.<a name="line.477"></a>
<FONT color="green">478</FONT> *<a name="line.478"></a>
<FONT color="green">479</FONT> * @param c initial character of format specifier.<a name="line.479"></a>
<FONT color="green">480</FONT> * @param pattern conversion pattern<a name="line.480"></a>
<FONT color="green">481</FONT> * @param i current position in conversion pattern.<a name="line.481"></a>
<FONT color="green">482</FONT> * @param currentLiteral current literal.<a name="line.482"></a>
<FONT color="green">483</FONT> * @param formattingInfo current field specifier.<a name="line.483"></a>
<FONT color="green">484</FONT> * @param rules map of stock pattern converters keyed by format specifier.<a name="line.484"></a>
<FONT color="green">485</FONT> * @param patternConverters list to receive parsed pattern converter.<a name="line.485"></a>
<FONT color="green">486</FONT> * @param formattingInfos list to receive corresponding field specifier.<a name="line.486"></a>
<FONT color="green">487</FONT> * @return position after format specifier sequence.<a name="line.487"></a>
<FONT color="green">488</FONT> */<a name="line.488"></a>
<FONT color="green">489</FONT> private int finalizeConverter(char c, String pattern, int i,<a name="line.489"></a>
<FONT color="green">490</FONT> final StringBuilder currentLiteral, final FormattingInfo formattingInfo,<a name="line.490"></a>
<FONT color="green">491</FONT> final Map&lt;String, Class&lt;PatternConverter&gt;&gt; rules,<a name="line.491"></a>
<FONT color="green">492</FONT> final List&lt;PatternConverter&gt; patternConverters, final List&lt;FormattingInfo&gt; formattingInfos) {<a name="line.492"></a>
<FONT color="green">493</FONT> StringBuilder convBuf = new StringBuilder();<a name="line.493"></a>
<FONT color="green">494</FONT> i = extractConverter(c, pattern, i, convBuf, currentLiteral);<a name="line.494"></a>
<FONT color="green">495</FONT> <a name="line.495"></a>
<FONT color="green">496</FONT> String converterId = convBuf.toString();<a name="line.496"></a>
<FONT color="green">497</FONT> <a name="line.497"></a>
<FONT color="green">498</FONT> List&lt;String&gt; options = new ArrayList&lt;String&gt;();<a name="line.498"></a>
<FONT color="green">499</FONT> i = extractOptions(pattern, i, options);<a name="line.499"></a>
<FONT color="green">500</FONT> <a name="line.500"></a>
<FONT color="green">501</FONT> PatternConverter pc = createConverter(converterId, currentLiteral, rules, options);<a name="line.501"></a>
<FONT color="green">502</FONT> <a name="line.502"></a>
<FONT color="green">503</FONT> if (pc == null) {<a name="line.503"></a>
<FONT color="green">504</FONT> StringBuilder msg;<a name="line.504"></a>
<FONT color="green">505</FONT> <a name="line.505"></a>
<FONT color="green">506</FONT> if ((converterId == null) || (converterId.length() == 0)) {<a name="line.506"></a>
<FONT color="green">507</FONT> msg =<a name="line.507"></a>
<FONT color="green">508</FONT> new StringBuilder("Empty conversion specifier starting at position ");<a name="line.508"></a>
<FONT color="green">509</FONT> } else {<a name="line.509"></a>
<FONT color="green">510</FONT> msg = new StringBuilder("Unrecognized conversion specifier [");<a name="line.510"></a>
<FONT color="green">511</FONT> msg.append(converterId);<a name="line.511"></a>
<FONT color="green">512</FONT> msg.append("] starting at position ");<a name="line.512"></a>
<FONT color="green">513</FONT> }<a name="line.513"></a>
<FONT color="green">514</FONT> <a name="line.514"></a>
<FONT color="green">515</FONT> msg.append(Integer.toString(i));<a name="line.515"></a>
<FONT color="green">516</FONT> msg.append(" in conversion pattern.");<a name="line.516"></a>
<FONT color="green">517</FONT> <a name="line.517"></a>
<FONT color="green">518</FONT> LOGGER.error(msg.toString());<a name="line.518"></a>
<FONT color="green">519</FONT> <a name="line.519"></a>
<FONT color="green">520</FONT> patternConverters.add(new LiteralPatternConverter(currentLiteral.toString()));<a name="line.520"></a>
<FONT color="green">521</FONT> formattingInfos.add(FormattingInfo.getDefault());<a name="line.521"></a>
<FONT color="green">522</FONT> } else {<a name="line.522"></a>
<FONT color="green">523</FONT> patternConverters.add(pc);<a name="line.523"></a>
<FONT color="green">524</FONT> formattingInfos.add(formattingInfo);<a name="line.524"></a>
<FONT color="green">525</FONT> <a name="line.525"></a>
<FONT color="green">526</FONT> if (currentLiteral.length() &gt; 0) {<a name="line.526"></a>
<FONT color="green">527</FONT> patternConverters.add(new LiteralPatternConverter(currentLiteral.toString()));<a name="line.527"></a>
<FONT color="green">528</FONT> formattingInfos.add(FormattingInfo.getDefault());<a name="line.528"></a>
<FONT color="green">529</FONT> }<a name="line.529"></a>
<FONT color="green">530</FONT> }<a name="line.530"></a>
<FONT color="green">531</FONT> <a name="line.531"></a>
<FONT color="green">532</FONT> currentLiteral.setLength(0);<a name="line.532"></a>
<FONT color="green">533</FONT> <a name="line.533"></a>
<FONT color="green">534</FONT> return i;<a name="line.534"></a>
<FONT color="green">535</FONT> }<a name="line.535"></a>
<FONT color="green">536</FONT> }<a name="line.536"></a>
</PRE>
</BODY>
</HTML>