| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> *<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> *<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> */<a name="line.16"></a> |
| <span class="sourceLineNo">017</span>package org.apache.logging.log4j.message;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.util.Arrays;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.logging.log4j.util.Constants;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.logging.log4j.util.StringBuilderFormattable;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.logging.log4j.util.StringBuilders;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>/**<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * Handles messages that consist of a format string containing '{}' to represent each replaceable token, and<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * the parameters.<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * <p><a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * This class was originally written for <a href="http://lilithapp.com/">Lilith</a> by Joern Huxhorn where it is<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * licensed under the LGPL. It has been relicensed here with his permission providing that this attribution remain.<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * </p><a name="line.31"></a> |
| <span class="sourceLineNo">032</span> */<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>public class ParameterizedMessage implements Message, StringBuilderFormattable {<a name="line.33"></a> |
| <span class="sourceLineNo">034</span><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> // Should this be configurable?<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> private static final int DEFAULT_STRING_BUILDER_SIZE = 255;<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> * Prefix for recursion.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> */<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> public static final String RECURSION_PREFIX = ParameterFormatter.RECURSION_PREFIX;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> /**<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * Suffix for recursion.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> */<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> public static final String RECURSION_SUFFIX = ParameterFormatter.RECURSION_SUFFIX;<a name="line.45"></a> |
| <span class="sourceLineNo">046</span><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> /**<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * Prefix for errors.<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> */<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> public static final String ERROR_PREFIX = ParameterFormatter.ERROR_PREFIX;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> /**<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * Separator for errors.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> */<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> public static final String ERROR_SEPARATOR = ParameterFormatter.ERROR_SEPARATOR;<a name="line.55"></a> |
| <span class="sourceLineNo">056</span><a name="line.56"></a> |
| <span class="sourceLineNo">057</span> /**<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * Separator for error messages.<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> */<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> public static final String ERROR_MSG_SEPARATOR = ParameterFormatter.ERROR_MSG_SEPARATOR;<a name="line.60"></a> |
| <span class="sourceLineNo">061</span><a name="line.61"></a> |
| <span class="sourceLineNo">062</span> /**<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * Suffix for errors.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> */<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> public static final String ERROR_SUFFIX = ParameterFormatter.ERROR_SUFFIX;<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> private static final long serialVersionUID = -665975803997290697L;<a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> private static final int HASHVAL = 31;<a name="line.69"></a> |
| <span class="sourceLineNo">070</span><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> // storing JDK classes in ThreadLocals does not cause memory leaks in web apps, so this is okay<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> private static ThreadLocal<StringBuilder> threadLocalStringBuilder = new ThreadLocal<>();<a name="line.72"></a> |
| <span class="sourceLineNo">073</span><a name="line.73"></a> |
| <span class="sourceLineNo">074</span> private String messagePattern;<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> private transient Object[] argArray;<a name="line.75"></a> |
| <span class="sourceLineNo">076</span><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> private String formattedMessage;<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> private transient Throwable throwable;<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> private int[] indices;<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> private int usedCount;<a name="line.80"></a> |
| <span class="sourceLineNo">081</span><a name="line.81"></a> |
| <span class="sourceLineNo">082</span> /**<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * Creates a parameterized message.<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * @param messagePattern The message "format" string. This will be a String containing "{}" placeholders<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> * where parameters should be substituted.<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * @param arguments The arguments for substitution.<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * @param throwable A Throwable.<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * @deprecated Use constructor ParameterizedMessage(String, Object[], Throwable) instead<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> */<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> @Deprecated<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> public ParameterizedMessage(final String messagePattern, final String[] arguments, final Throwable throwable) {<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> this.argArray = arguments;<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> this.throwable = throwable;<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> init(messagePattern);<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> }<a name="line.95"></a> |
| <span class="sourceLineNo">096</span><a name="line.96"></a> |
| <span class="sourceLineNo">097</span> /**<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * Creates a parameterized message.<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * @param messagePattern The message "format" string. This will be a String containing "{}" placeholders<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * where parameters should be substituted.<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * @param arguments The arguments for substitution.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * @param throwable A Throwable.<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> */<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> public ParameterizedMessage(final String messagePattern, final Object[] arguments, final Throwable throwable) {<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> this.argArray = arguments;<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> this.throwable = throwable;<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> init(messagePattern);<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> }<a name="line.108"></a> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> /**<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * Constructs a ParameterizedMessage which contains the arguments converted to String as well as an optional<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * Throwable.<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> *<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * <p>If the last argument is a Throwable and is NOT used up by a placeholder in the message pattern it is returned<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * in {@link #getThrowable()} and won't be contained in the created String[].<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * If it is used up {@link #getThrowable()} will return null even if the last argument was a Throwable!</p><a name="line.116"></a> |
| <span class="sourceLineNo">117</span> *<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * @param messagePattern the message pattern that to be checked for placeholders.<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * @param arguments the argument array to be converted.<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> */<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> public ParameterizedMessage(final String messagePattern, final Object... arguments) {<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> this.argArray = arguments;<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> init(messagePattern);<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> }<a name="line.124"></a> |
| <span class="sourceLineNo">125</span><a name="line.125"></a> |
| <span class="sourceLineNo">126</span> /**<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * Constructor with a pattern and a single parameter.<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * @param messagePattern The message pattern.<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * @param arg The parameter.<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> */<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> public ParameterizedMessage(final String messagePattern, final Object arg) {<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> this(messagePattern, new Object[]{arg});<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> /**<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * Constructor with a pattern and two parameters.<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * @param messagePattern The message pattern.<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * @param arg0 The first parameter.<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> * @param arg1 The second parameter.<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> */<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> public ParameterizedMessage(final String messagePattern, final Object arg0, final Object arg1) {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> this(messagePattern, new Object[]{arg0, arg1});<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> }<a name="line.143"></a> |
| <span class="sourceLineNo">144</span><a name="line.144"></a> |
| <span class="sourceLineNo">145</span> private void init(final String messagePattern) {<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> this.messagePattern = messagePattern;<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> final int len = Math.max(1, messagePattern == null ? 0 : messagePattern.length() >> 1); // divide by 2<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> this.indices = new int[len]; // LOG4J2-1542 ensure non-zero array length<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> final int placeholders = ParameterFormatter.countArgumentPlaceholders2(messagePattern, indices);<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> initThrowable(argArray, placeholders);<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> this.usedCount = Math.min(placeholders, argArray == null ? 0 : argArray.length);<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> }<a name="line.152"></a> |
| <span class="sourceLineNo">153</span><a name="line.153"></a> |
| <span class="sourceLineNo">154</span> private void initThrowable(final Object[] params, final int usedParams) {<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> if (params != null) {<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> final int argCount = params.length;<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> if (usedParams < argCount && this.throwable == null && params[argCount - 1] instanceof Throwable) {<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> this.throwable = (Throwable) params[argCount - 1];<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> }<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> }<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> }<a name="line.161"></a> |
| <span class="sourceLineNo">162</span><a name="line.162"></a> |
| <span class="sourceLineNo">163</span> /**<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> * Returns the message pattern.<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> * @return the message pattern.<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> */<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> @Override<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> public String getFormat() {<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> return messagePattern;<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 message parameters.<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * @return the message parameters.<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> */<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> @Override<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> public Object[] getParameters() {<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> return argArray;<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 Throwable that was given as the last argument, if any.<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * It will not survive serialization. The Throwable exists as part of the message<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * primarily so that it can be extracted from the end of the list of parameters<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * and then be added to the LogEvent. As such, the Throwable in the event should<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * not be used once the LogEvent has been constructed.<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> *<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * @return the Throwable, if any.<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> */<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> @Override<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> public Throwable getThrowable() {<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> return throwable;<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> }<a name="line.193"></a> |
| <span class="sourceLineNo">194</span><a name="line.194"></a> |
| <span class="sourceLineNo">195</span> /**<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> * Returns the formatted message.<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> * @return the formatted message.<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> */<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> @Override<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> public String getFormattedMessage() {<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> if (formattedMessage == null) {<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> final StringBuilder buffer = getThreadLocalStringBuilder();<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> formatTo(buffer);<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> formattedMessage = buffer.toString();<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> StringBuilders.trimToMaxSize(buffer, Constants.MAX_REUSABLE_MESSAGE_SIZE);<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> }<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> return formattedMessage;<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> }<a name="line.208"></a> |
| <span class="sourceLineNo">209</span><a name="line.209"></a> |
| <span class="sourceLineNo">210</span> private static StringBuilder getThreadLocalStringBuilder() {<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> StringBuilder buffer = threadLocalStringBuilder.get();<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> if (buffer == null) {<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> buffer = new StringBuilder(DEFAULT_STRING_BUILDER_SIZE);<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> threadLocalStringBuilder.set(buffer);<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> }<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> buffer.setLength(0);<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> return buffer;<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> }<a name="line.218"></a> |
| <span class="sourceLineNo">219</span><a name="line.219"></a> |
| <span class="sourceLineNo">220</span> @Override<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> public void formatTo(final StringBuilder buffer) {<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> if (formattedMessage != null) {<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> buffer.append(formattedMessage);<a name="line.223"></a> |
| <span class="sourceLineNo">224</span> } else {<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> if (indices[0] < 0) {<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> ParameterFormatter.formatMessage(buffer, messagePattern, argArray, usedCount);<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> } else {<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> ParameterFormatter.formatMessage2(buffer, messagePattern, argArray, usedCount, indices);<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> }<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> }<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> }<a name="line.231"></a> |
| <span class="sourceLineNo">232</span><a name="line.232"></a> |
| <span class="sourceLineNo">233</span> /**<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * Replace placeholders in the given messagePattern with arguments.<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> *<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * @param messagePattern the message pattern containing placeholders.<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * @param arguments the arguments to be used to replace placeholders.<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * @return the formatted message.<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> */<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> public static String format(final String messagePattern, final Object[] arguments) {<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> return ParameterFormatter.format(messagePattern, arguments);<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> }<a name="line.242"></a> |
| <span class="sourceLineNo">243</span><a name="line.243"></a> |
| <span class="sourceLineNo">244</span> @Override<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> public boolean equals(final Object o) {<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> if (this == o) {<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> return true;<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> }<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> if (o == null || getClass() != o.getClass()) {<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> return false;<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> }<a name="line.251"></a> |
| <span class="sourceLineNo">252</span><a name="line.252"></a> |
| <span class="sourceLineNo">253</span> final ParameterizedMessage that = (ParameterizedMessage) o;<a name="line.253"></a> |
| <span class="sourceLineNo">254</span><a name="line.254"></a> |
| <span class="sourceLineNo">255</span> if (messagePattern != null ? !messagePattern.equals(that.messagePattern) : that.messagePattern != null) {<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> return false;<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> }<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> if (!Arrays.equals(this.argArray, that.argArray)) {<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> return false;<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> }<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> //if (throwable != null ? !throwable.equals(that.throwable) : that.throwable != null) return false;<a name="line.261"></a> |
| <span class="sourceLineNo">262</span><a name="line.262"></a> |
| <span class="sourceLineNo">263</span> return true;<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> }<a name="line.264"></a> |
| <span class="sourceLineNo">265</span><a name="line.265"></a> |
| <span class="sourceLineNo">266</span> @Override<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> public int hashCode() {<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> int result = messagePattern != null ? messagePattern.hashCode() : 0;<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> result = HASHVAL * result + (argArray != null ? Arrays.hashCode(argArray) : 0);<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> return result;<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> }<a name="line.271"></a> |
| <span class="sourceLineNo">272</span><a name="line.272"></a> |
| <span class="sourceLineNo">273</span> /**<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> * Counts the number of unescaped placeholders in the given messagePattern.<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> *<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> * @param messagePattern the message pattern to be analyzed.<a name="line.276"></a> |
| <span class="sourceLineNo">277</span> * @return the number of unescaped placeholders.<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> */<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> public static int countArgumentPlaceholders(final String messagePattern) {<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> return ParameterFormatter.countArgumentPlaceholders(messagePattern);<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> }<a name="line.281"></a> |
| <span class="sourceLineNo">282</span><a name="line.282"></a> |
| <span class="sourceLineNo">283</span> /**<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> * This method performs a deep toString of the given Object.<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> * Primitive arrays are converted using their respective Arrays.toString methods while<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> * special handling is implemented for "container types", i.e. Object[], Map and Collection because those could<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> * contain themselves.<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> * <p><a name="line.288"></a> |
| <span class="sourceLineNo">289</span> * It should be noted that neither AbstractMap.toString() nor AbstractCollection.toString() implement such a<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> * behavior. They only check if the container is directly contained in itself, but not if a contained container<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> * contains the original one. Because of that, Arrays.toString(Object[]) isn't safe either.<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> * Confusing? Just read the last paragraph again and check the respective toString() implementation.<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> * </p><a name="line.293"></a> |
| <span class="sourceLineNo">294</span> * <p><a name="line.294"></a> |
| <span class="sourceLineNo">295</span> * This means, in effect, that logging would produce a usable output even if an ordinary System.out.println(o)<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> * would produce a relatively hard-to-debug StackOverflowError.<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> * </p><a name="line.297"></a> |
| <span class="sourceLineNo">298</span> * @param o The object.<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> * @return The String representation.<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> */<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> public static String deepToString(final Object o) {<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> return ParameterFormatter.deepToString(o);<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> }<a name="line.303"></a> |
| <span class="sourceLineNo">304</span><a name="line.304"></a> |
| <span class="sourceLineNo">305</span> /**<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> * This method returns the same as if Object.toString() would not have been<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> * overridden in obj.<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> * <p><a name="line.308"></a> |
| <span class="sourceLineNo">309</span> * Note that this isn't 100% secure as collisions can always happen with hash codes.<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> * </p><a name="line.310"></a> |
| <span class="sourceLineNo">311</span> * <p><a name="line.311"></a> |
| <span class="sourceLineNo">312</span> * Copied from Object.hashCode():<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> * </p><a name="line.313"></a> |
| <span class="sourceLineNo">314</span> * <blockquote><a name="line.314"></a> |
| <span class="sourceLineNo">315</span> * As much as is reasonably practical, the hashCode method defined by<a name="line.315"></a> |
| <span class="sourceLineNo">316</span> * class {@code Object} does return distinct integers for distinct<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> * objects. (This is typically implemented by converting the internal<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> * address of the object into an integer, but this implementation<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> * technique is not required by the Java&#8482; programming language.)<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> * </blockquote><a name="line.320"></a> |
| <span class="sourceLineNo">321</span> *<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> * @param obj the Object that is to be converted into an identity string.<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> * @return the identity string as also defined in Object.toString()<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> */<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> public static String identityToString(final Object obj) {<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> return ParameterFormatter.identityToString(obj);<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> }<a name="line.327"></a> |
| <span class="sourceLineNo">328</span><a name="line.328"></a> |
| <span class="sourceLineNo">329</span> @Override<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> public String toString() {<a name="line.330"></a> |
| <span class="sourceLineNo">331</span> return "ParameterizedMessage[messagePattern=" + messagePattern + ", stringArgs=" +<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> Arrays.toString(argArray) + ", throwable=" + throwable + ']';<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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
