blob: 08cfd38cd84b7adb9b1c5824972ccad6f330e6c5 [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>package org.apache.logging.log4j.core.lookup;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.util.ArrayList;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.Enumeration;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.HashMap;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Iterator;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.List;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Map;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.Properties;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.LogEvent;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.ConfigurationAware;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.util.Strings;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>/**<a name="line.32"></a>
<span class="sourceLineNo">033</span> * Substitutes variables within a string by values.<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;p&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> * This class takes a piece of text and substitutes all the variables within it.<a name="line.35"></a>
<span class="sourceLineNo">036</span> * The default definition of a variable is &lt;code&gt;${variableName}&lt;/code&gt;.<a name="line.36"></a>
<span class="sourceLineNo">037</span> * The prefix and suffix can be changed via constructors and set methods.<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;/p&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> * &lt;p&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> * Variable values are typically resolved from a map, but could also be resolved<a name="line.40"></a>
<span class="sourceLineNo">041</span> * from system properties, or by supplying a custom variable resolver.<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;/p&gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;p&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> * The simplest example is to use this class to replace Java System properties. For example:<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;/p&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> * &lt;pre&gt;<a name="line.46"></a>
<span class="sourceLineNo">047</span> * StrSubstitutor.replaceSystemProperties(<a name="line.47"></a>
<span class="sourceLineNo">048</span> * "You are running with java.version = ${java.version} and os.name = ${os.name}.");<a name="line.48"></a>
<span class="sourceLineNo">049</span> * &lt;/pre&gt;<a name="line.49"></a>
<span class="sourceLineNo">050</span> * &lt;p&gt;<a name="line.50"></a>
<span class="sourceLineNo">051</span> * Typical usage of this class follows the following pattern: First an instance is created<a name="line.51"></a>
<span class="sourceLineNo">052</span> * and initialized with the map that contains the values for the available variables.<a name="line.52"></a>
<span class="sourceLineNo">053</span> * If a prefix and/or suffix for variables should be used other than the default ones,<a name="line.53"></a>
<span class="sourceLineNo">054</span> * the appropriate settings can be performed. After that the &lt;code&gt;replace()&lt;/code&gt;<a name="line.54"></a>
<span class="sourceLineNo">055</span> * method can be called passing in the source text for interpolation. In the returned<a name="line.55"></a>
<span class="sourceLineNo">056</span> * text all variable references (as long as their values are known) will be resolved.<a name="line.56"></a>
<span class="sourceLineNo">057</span> * The following example demonstrates this:<a name="line.57"></a>
<span class="sourceLineNo">058</span> * &lt;/p&gt;<a name="line.58"></a>
<span class="sourceLineNo">059</span> * &lt;pre&gt;<a name="line.59"></a>
<span class="sourceLineNo">060</span> * Map valuesMap = HashMap();<a name="line.60"></a>
<span class="sourceLineNo">061</span> * valuesMap.put(&amp;quot;animal&amp;quot;, &amp;quot;quick brown fox&amp;quot;);<a name="line.61"></a>
<span class="sourceLineNo">062</span> * valuesMap.put(&amp;quot;target&amp;quot;, &amp;quot;lazy dog&amp;quot;);<a name="line.62"></a>
<span class="sourceLineNo">063</span> * String templateString = &amp;quot;The ${animal} jumped over the ${target}.&amp;quot;;<a name="line.63"></a>
<span class="sourceLineNo">064</span> * StrSubstitutor sub = new StrSubstitutor(valuesMap);<a name="line.64"></a>
<span class="sourceLineNo">065</span> * String resolvedString = sub.replace(templateString);<a name="line.65"></a>
<span class="sourceLineNo">066</span> * &lt;/pre&gt;<a name="line.66"></a>
<span class="sourceLineNo">067</span> * &lt;p&gt;yielding:&lt;/p&gt;<a name="line.67"></a>
<span class="sourceLineNo">068</span> * &lt;pre&gt;<a name="line.68"></a>
<span class="sourceLineNo">069</span> * The quick brown fox jumped over the lazy dog.<a name="line.69"></a>
<span class="sourceLineNo">070</span> * &lt;/pre&gt;<a name="line.70"></a>
<span class="sourceLineNo">071</span> * &lt;p&gt;<a name="line.71"></a>
<span class="sourceLineNo">072</span> * Also, this class allows to set a default value for unresolved variables.<a name="line.72"></a>
<span class="sourceLineNo">073</span> * The default value for a variable can be appended to the variable name after the variable<a name="line.73"></a>
<span class="sourceLineNo">074</span> * default value delimiter. The default value of the variable default value delimiter is ':-',<a name="line.74"></a>
<span class="sourceLineNo">075</span> * as in bash and other *nix shells, as those are arguably where the default ${} delimiter set originated.<a name="line.75"></a>
<span class="sourceLineNo">076</span> * The variable default value delimiter can be manually set by calling {@link #setValueDelimiterMatcher(StrMatcher)},<a name="line.76"></a>
<span class="sourceLineNo">077</span> * {@link #setValueDelimiter(char)} or {@link #setValueDelimiter(String)}.<a name="line.77"></a>
<span class="sourceLineNo">078</span> * The following shows an example with variable default value settings:<a name="line.78"></a>
<span class="sourceLineNo">079</span> * &lt;/p&gt;<a name="line.79"></a>
<span class="sourceLineNo">080</span> * &lt;pre&gt;<a name="line.80"></a>
<span class="sourceLineNo">081</span> * Map valuesMap = HashMap();<a name="line.81"></a>
<span class="sourceLineNo">082</span> * valuesMap.put(&amp;quot;animal&amp;quot;, &amp;quot;quick brown fox&amp;quot;);<a name="line.82"></a>
<span class="sourceLineNo">083</span> * valuesMap.put(&amp;quot;target&amp;quot;, &amp;quot;lazy dog&amp;quot;);<a name="line.83"></a>
<span class="sourceLineNo">084</span> * String templateString = &amp;quot;The ${animal} jumped over the ${target}. ${undefined.number:-1234567890}.&amp;quot;;<a name="line.84"></a>
<span class="sourceLineNo">085</span> * StrSubstitutor sub = new StrSubstitutor(valuesMap);<a name="line.85"></a>
<span class="sourceLineNo">086</span> * String resolvedString = sub.replace(templateString);<a name="line.86"></a>
<span class="sourceLineNo">087</span> * &lt;/pre&gt;<a name="line.87"></a>
<span class="sourceLineNo">088</span> * &lt;p&gt;yielding:&lt;/p&gt;<a name="line.88"></a>
<span class="sourceLineNo">089</span> * &lt;pre&gt;<a name="line.89"></a>
<span class="sourceLineNo">090</span> * The quick brown fox jumped over the lazy dog. 1234567890.<a name="line.90"></a>
<span class="sourceLineNo">091</span> * &lt;/pre&gt;<a name="line.91"></a>
<span class="sourceLineNo">092</span> * &lt;p&gt;<a name="line.92"></a>
<span class="sourceLineNo">093</span> * In addition to this usage pattern there are some static convenience methods that<a name="line.93"></a>
<span class="sourceLineNo">094</span> * cover the most common use cases. These methods can be used without the need of<a name="line.94"></a>
<span class="sourceLineNo">095</span> * manually creating an instance. However if multiple replace operations are to be<a name="line.95"></a>
<span class="sourceLineNo">096</span> * performed, creating and reusing an instance of this class will be more efficient.<a name="line.96"></a>
<span class="sourceLineNo">097</span> * &lt;/p&gt;<a name="line.97"></a>
<span class="sourceLineNo">098</span> * &lt;p&gt;<a name="line.98"></a>
<span class="sourceLineNo">099</span> * Variable replacement works in a recursive way. Thus, if a variable value contains<a name="line.99"></a>
<span class="sourceLineNo">100</span> * a variable then that variable will also be replaced. Cyclic replacements are<a name="line.100"></a>
<span class="sourceLineNo">101</span> * detected and will cause an exception to be thrown.<a name="line.101"></a>
<span class="sourceLineNo">102</span> * &lt;/p&gt;<a name="line.102"></a>
<span class="sourceLineNo">103</span> * &lt;p&gt;<a name="line.103"></a>
<span class="sourceLineNo">104</span> * Sometimes the interpolation's result must contain a variable prefix. As an example<a name="line.104"></a>
<span class="sourceLineNo">105</span> * take the following source text:<a name="line.105"></a>
<span class="sourceLineNo">106</span> * &lt;/p&gt;<a name="line.106"></a>
<span class="sourceLineNo">107</span> * &lt;pre&gt;<a name="line.107"></a>
<span class="sourceLineNo">108</span> * The variable ${${name}} must be used.<a name="line.108"></a>
<span class="sourceLineNo">109</span> * &lt;/pre&gt;<a name="line.109"></a>
<span class="sourceLineNo">110</span> * &lt;p&gt;<a name="line.110"></a>
<span class="sourceLineNo">111</span> * Here only the variable's name referred to in the text should be replaced resulting<a name="line.111"></a>
<span class="sourceLineNo">112</span> * in the text (assuming that the value of the &lt;code&gt;name&lt;/code&gt; variable is &lt;code&gt;x&lt;/code&gt;):<a name="line.112"></a>
<span class="sourceLineNo">113</span> * &lt;/p&gt;<a name="line.113"></a>
<span class="sourceLineNo">114</span> * &lt;pre&gt;<a name="line.114"></a>
<span class="sourceLineNo">115</span> * The variable ${x} must be used.<a name="line.115"></a>
<span class="sourceLineNo">116</span> * &lt;/pre&gt;<a name="line.116"></a>
<span class="sourceLineNo">117</span> * &lt;p&gt;<a name="line.117"></a>
<span class="sourceLineNo">118</span> * To achieve this effect there are two possibilities: Either set a different prefix<a name="line.118"></a>
<span class="sourceLineNo">119</span> * and suffix for variables which do not conflict with the result text you want to<a name="line.119"></a>
<span class="sourceLineNo">120</span> * produce. The other possibility is to use the escape character, by default '$'.<a name="line.120"></a>
<span class="sourceLineNo">121</span> * If this character is placed before a variable reference, this reference is ignored<a name="line.121"></a>
<span class="sourceLineNo">122</span> * and won't be replaced. For example:<a name="line.122"></a>
<span class="sourceLineNo">123</span> * &lt;/p&gt;<a name="line.123"></a>
<span class="sourceLineNo">124</span> * &lt;pre&gt;<a name="line.124"></a>
<span class="sourceLineNo">125</span> * The variable $${${name}} must be used.<a name="line.125"></a>
<span class="sourceLineNo">126</span> * &lt;/pre&gt;<a name="line.126"></a>
<span class="sourceLineNo">127</span> * &lt;p&gt;<a name="line.127"></a>
<span class="sourceLineNo">128</span> * In some complex scenarios you might even want to perform substitution in the<a name="line.128"></a>
<span class="sourceLineNo">129</span> * names of variables, for instance<a name="line.129"></a>
<span class="sourceLineNo">130</span> * &lt;/p&gt;<a name="line.130"></a>
<span class="sourceLineNo">131</span> * &lt;pre&gt;<a name="line.131"></a>
<span class="sourceLineNo">132</span> * ${jre-${java.specification.version}}<a name="line.132"></a>
<span class="sourceLineNo">133</span> * &lt;/pre&gt;<a name="line.133"></a>
<span class="sourceLineNo">134</span> * &lt;p&gt;<a name="line.134"></a>
<span class="sourceLineNo">135</span> * &lt;code&gt;StrSubstitutor&lt;/code&gt; supports this recursive substitution in variable<a name="line.135"></a>
<span class="sourceLineNo">136</span> * names, but it has to be enabled explicitly by setting the<a name="line.136"></a>
<span class="sourceLineNo">137</span> * {@link #setEnableSubstitutionInVariables(boolean) enableSubstitutionInVariables}<a name="line.137"></a>
<span class="sourceLineNo">138</span> * property to &lt;b&gt;true&lt;/b&gt;.<a name="line.138"></a>
<span class="sourceLineNo">139</span> * &lt;/p&gt;<a name="line.139"></a>
<span class="sourceLineNo">140</span> */<a name="line.140"></a>
<span class="sourceLineNo">141</span>public class StrSubstitutor implements ConfigurationAware {<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span> /**<a name="line.143"></a>
<span class="sourceLineNo">144</span> * Constant for the default escape character.<a name="line.144"></a>
<span class="sourceLineNo">145</span> */<a name="line.145"></a>
<span class="sourceLineNo">146</span> public static final char DEFAULT_ESCAPE = '$';<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> /**<a name="line.148"></a>
<span class="sourceLineNo">149</span> * Constant for the default variable prefix.<a name="line.149"></a>
<span class="sourceLineNo">150</span> */<a name="line.150"></a>
<span class="sourceLineNo">151</span> public static final StrMatcher DEFAULT_PREFIX = StrMatcher.stringMatcher(DEFAULT_ESCAPE + "{");<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> * Constant for the default variable suffix.<a name="line.154"></a>
<span class="sourceLineNo">155</span> */<a name="line.155"></a>
<span class="sourceLineNo">156</span> public static final StrMatcher DEFAULT_SUFFIX = StrMatcher.stringMatcher("}");<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span> /**<a name="line.158"></a>
<span class="sourceLineNo">159</span> * Constant for the default value delimiter of a variable.<a name="line.159"></a>
<span class="sourceLineNo">160</span> */<a name="line.160"></a>
<span class="sourceLineNo">161</span> public static final String DEFAULT_VALUE_DELIMITER_STRING = ":-";<a name="line.161"></a>
<span class="sourceLineNo">162</span> public static final StrMatcher DEFAULT_VALUE_DELIMITER = StrMatcher.stringMatcher(DEFAULT_VALUE_DELIMITER_STRING);<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span> public static final String ESCAPE_DELIMITER_STRING = ":\\-";<a name="line.164"></a>
<span class="sourceLineNo">165</span> public static final StrMatcher DEFAULT_VALUE_ESCAPE_DELIMITER = StrMatcher.stringMatcher(ESCAPE_DELIMITER_STRING);<a name="line.165"></a>
<span class="sourceLineNo">166</span><a name="line.166"></a>
<span class="sourceLineNo">167</span> private static final int BUF_SIZE = 256;<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span> /**<a name="line.169"></a>
<span class="sourceLineNo">170</span> * Stores the escape character.<a name="line.170"></a>
<span class="sourceLineNo">171</span> */<a name="line.171"></a>
<span class="sourceLineNo">172</span> private char escapeChar;<a name="line.172"></a>
<span class="sourceLineNo">173</span><a name="line.173"></a>
<span class="sourceLineNo">174</span> /**<a name="line.174"></a>
<span class="sourceLineNo">175</span> * Stores the variable prefix.<a name="line.175"></a>
<span class="sourceLineNo">176</span> */<a name="line.176"></a>
<span class="sourceLineNo">177</span> private StrMatcher prefixMatcher;<a name="line.177"></a>
<span class="sourceLineNo">178</span><a name="line.178"></a>
<span class="sourceLineNo">179</span> /**<a name="line.179"></a>
<span class="sourceLineNo">180</span> * Stores the variable suffix.<a name="line.180"></a>
<span class="sourceLineNo">181</span> */<a name="line.181"></a>
<span class="sourceLineNo">182</span> private StrMatcher suffixMatcher;<a name="line.182"></a>
<span class="sourceLineNo">183</span><a name="line.183"></a>
<span class="sourceLineNo">184</span> /**<a name="line.184"></a>
<span class="sourceLineNo">185</span> * Stores the default variable value delimiter<a name="line.185"></a>
<span class="sourceLineNo">186</span> */<a name="line.186"></a>
<span class="sourceLineNo">187</span> private String valueDelimiterString;<a name="line.187"></a>
<span class="sourceLineNo">188</span> private StrMatcher valueDelimiterMatcher;<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> * Escape string to avoid matching the value delimiter matcher;<a name="line.191"></a>
<span class="sourceLineNo">192</span> */<a name="line.192"></a>
<span class="sourceLineNo">193</span> private StrMatcher valueEscapeDelimiterMatcher;<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> * Variable resolution is delegated to an implementer of VariableResolver.<a name="line.196"></a>
<span class="sourceLineNo">197</span> */<a name="line.197"></a>
<span class="sourceLineNo">198</span> private StrLookup variableResolver;<a name="line.198"></a>
<span class="sourceLineNo">199</span><a name="line.199"></a>
<span class="sourceLineNo">200</span> /**<a name="line.200"></a>
<span class="sourceLineNo">201</span> * The flag whether substitution in variable names is enabled.<a name="line.201"></a>
<span class="sourceLineNo">202</span> */<a name="line.202"></a>
<span class="sourceLineNo">203</span> private boolean enableSubstitutionInVariables = true;<a name="line.203"></a>
<span class="sourceLineNo">204</span><a name="line.204"></a>
<span class="sourceLineNo">205</span> /**<a name="line.205"></a>
<span class="sourceLineNo">206</span> * The currently active Configuration for use by ConfigurationAware StrLookup implementations.<a name="line.206"></a>
<span class="sourceLineNo">207</span> */<a name="line.207"></a>
<span class="sourceLineNo">208</span> private Configuration configuration;<a name="line.208"></a>
<span class="sourceLineNo">209</span><a name="line.209"></a>
<span class="sourceLineNo">210</span> //-----------------------------------------------------------------------<a name="line.210"></a>
<span class="sourceLineNo">211</span> /**<a name="line.211"></a>
<span class="sourceLineNo">212</span> * Creates a new instance with defaults for variable prefix and suffix<a name="line.212"></a>
<span class="sourceLineNo">213</span> * and the escaping character.<a name="line.213"></a>
<span class="sourceLineNo">214</span> */<a name="line.214"></a>
<span class="sourceLineNo">215</span> public StrSubstitutor() {<a name="line.215"></a>
<span class="sourceLineNo">216</span> this(null, DEFAULT_PREFIX, DEFAULT_SUFFIX, DEFAULT_ESCAPE);<a name="line.216"></a>
<span class="sourceLineNo">217</span> }<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> * Creates a new instance and initializes it. Uses defaults for variable<a name="line.220"></a>
<span class="sourceLineNo">221</span> * prefix and suffix and the escaping character.<a name="line.221"></a>
<span class="sourceLineNo">222</span> *<a name="line.222"></a>
<span class="sourceLineNo">223</span> * @param valueMap the map with the variables' values, may be null<a name="line.223"></a>
<span class="sourceLineNo">224</span> */<a name="line.224"></a>
<span class="sourceLineNo">225</span> public StrSubstitutor(final Map&lt;String, String&gt; valueMap) {<a name="line.225"></a>
<span class="sourceLineNo">226</span> this(new MapLookup(valueMap), DEFAULT_PREFIX, DEFAULT_SUFFIX, DEFAULT_ESCAPE);<a name="line.226"></a>
<span class="sourceLineNo">227</span> }<a name="line.227"></a>
<span class="sourceLineNo">228</span><a name="line.228"></a>
<span class="sourceLineNo">229</span> /**<a name="line.229"></a>
<span class="sourceLineNo">230</span> * Creates a new instance and initializes it. Uses a default escaping character.<a name="line.230"></a>
<span class="sourceLineNo">231</span> *<a name="line.231"></a>
<span class="sourceLineNo">232</span> * @param valueMap the map with the variables' values, may be null<a name="line.232"></a>
<span class="sourceLineNo">233</span> * @param prefix the prefix for variables, not null<a name="line.233"></a>
<span class="sourceLineNo">234</span> * @param suffix the suffix for variables, not null<a name="line.234"></a>
<span class="sourceLineNo">235</span> * @throws IllegalArgumentException if the prefix or suffix is null<a name="line.235"></a>
<span class="sourceLineNo">236</span> */<a name="line.236"></a>
<span class="sourceLineNo">237</span> public StrSubstitutor(final Map&lt;String, String&gt; valueMap, final String prefix, final String suffix) {<a name="line.237"></a>
<span class="sourceLineNo">238</span> this(new MapLookup(valueMap), prefix, suffix, DEFAULT_ESCAPE);<a name="line.238"></a>
<span class="sourceLineNo">239</span> }<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> * Creates a new instance and initializes it.<a name="line.242"></a>
<span class="sourceLineNo">243</span> *<a name="line.243"></a>
<span class="sourceLineNo">244</span> * @param valueMap the map with the variables' values, may be null<a name="line.244"></a>
<span class="sourceLineNo">245</span> * @param prefix the prefix for variables, not null<a name="line.245"></a>
<span class="sourceLineNo">246</span> * @param suffix the suffix for variables, not null<a name="line.246"></a>
<span class="sourceLineNo">247</span> * @param escape the escape character<a name="line.247"></a>
<span class="sourceLineNo">248</span> * @throws IllegalArgumentException if the prefix or suffix is null<a name="line.248"></a>
<span class="sourceLineNo">249</span> */<a name="line.249"></a>
<span class="sourceLineNo">250</span> public StrSubstitutor(final Map&lt;String, String&gt; valueMap, final String prefix, final String suffix,<a name="line.250"></a>
<span class="sourceLineNo">251</span> final char escape) {<a name="line.251"></a>
<span class="sourceLineNo">252</span> this(new MapLookup(valueMap), prefix, suffix, escape);<a name="line.252"></a>
<span class="sourceLineNo">253</span> }<a name="line.253"></a>
<span class="sourceLineNo">254</span><a name="line.254"></a>
<span class="sourceLineNo">255</span> /**<a name="line.255"></a>
<span class="sourceLineNo">256</span> * Creates a new instance and initializes it.<a name="line.256"></a>
<span class="sourceLineNo">257</span> *<a name="line.257"></a>
<span class="sourceLineNo">258</span> * @param valueMap the map with the variables' values, may be null<a name="line.258"></a>
<span class="sourceLineNo">259</span> * @param prefix the prefix for variables, not null<a name="line.259"></a>
<span class="sourceLineNo">260</span> * @param suffix the suffix for variables, not null<a name="line.260"></a>
<span class="sourceLineNo">261</span> * @param escape the escape character<a name="line.261"></a>
<span class="sourceLineNo">262</span> * @param valueDelimiter the variable default value delimiter, may be null<a name="line.262"></a>
<span class="sourceLineNo">263</span> * @throws IllegalArgumentException if the prefix or suffix is null<a name="line.263"></a>
<span class="sourceLineNo">264</span> */<a name="line.264"></a>
<span class="sourceLineNo">265</span> public StrSubstitutor(final Map&lt;String, String&gt; valueMap, final String prefix, final String suffix,<a name="line.265"></a>
<span class="sourceLineNo">266</span> final char escape, final String valueDelimiter) {<a name="line.266"></a>
<span class="sourceLineNo">267</span> this(new MapLookup(valueMap), prefix, suffix, escape, valueDelimiter);<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> * Creates a new instance and initializes it. Uses defaults for variable<a name="line.271"></a>
<span class="sourceLineNo">272</span> * prefix and suffix and the escaping character.<a name="line.272"></a>
<span class="sourceLineNo">273</span> *<a name="line.273"></a>
<span class="sourceLineNo">274</span> * @param properties the map with the variables' values, may be null<a name="line.274"></a>
<span class="sourceLineNo">275</span> */<a name="line.275"></a>
<span class="sourceLineNo">276</span> public StrSubstitutor(final Properties properties) {<a name="line.276"></a>
<span class="sourceLineNo">277</span> this(toTypeSafeMap(properties));<a name="line.277"></a>
<span class="sourceLineNo">278</span> }<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> * Creates a new instance and initializes it.<a name="line.281"></a>
<span class="sourceLineNo">282</span> *<a name="line.282"></a>
<span class="sourceLineNo">283</span> * @param variableResolver the variable resolver, may be null<a name="line.283"></a>
<span class="sourceLineNo">284</span> */<a name="line.284"></a>
<span class="sourceLineNo">285</span> public StrSubstitutor(final StrLookup variableResolver) {<a name="line.285"></a>
<span class="sourceLineNo">286</span> this(variableResolver, DEFAULT_PREFIX, DEFAULT_SUFFIX, DEFAULT_ESCAPE);<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> * Creates a new instance and initializes it.<a name="line.290"></a>
<span class="sourceLineNo">291</span> *<a name="line.291"></a>
<span class="sourceLineNo">292</span> * @param variableResolver the variable resolver, may be null<a name="line.292"></a>
<span class="sourceLineNo">293</span> * @param prefix the prefix for variables, not null<a name="line.293"></a>
<span class="sourceLineNo">294</span> * @param suffix the suffix for variables, not null<a name="line.294"></a>
<span class="sourceLineNo">295</span> * @param escape the escape character<a name="line.295"></a>
<span class="sourceLineNo">296</span> * @throws IllegalArgumentException if the prefix or suffix is null<a name="line.296"></a>
<span class="sourceLineNo">297</span> */<a name="line.297"></a>
<span class="sourceLineNo">298</span> public StrSubstitutor(final StrLookup variableResolver, final String prefix, final String suffix,<a name="line.298"></a>
<span class="sourceLineNo">299</span> final char escape) {<a name="line.299"></a>
<span class="sourceLineNo">300</span> this.setVariableResolver(variableResolver);<a name="line.300"></a>
<span class="sourceLineNo">301</span> this.setVariablePrefix(prefix);<a name="line.301"></a>
<span class="sourceLineNo">302</span> this.setVariableSuffix(suffix);<a name="line.302"></a>
<span class="sourceLineNo">303</span> this.setEscapeChar(escape);<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> /**<a name="line.306"></a>
<span class="sourceLineNo">307</span> * Creates a new instance and initializes it.<a name="line.307"></a>
<span class="sourceLineNo">308</span> *<a name="line.308"></a>
<span class="sourceLineNo">309</span> * @param variableResolver the variable resolver, may be null<a name="line.309"></a>
<span class="sourceLineNo">310</span> * @param prefix the prefix for variables, not null<a name="line.310"></a>
<span class="sourceLineNo">311</span> * @param suffix the suffix for variables, not null<a name="line.311"></a>
<span class="sourceLineNo">312</span> * @param escape the escape character<a name="line.312"></a>
<span class="sourceLineNo">313</span> * @param valueDelimiter the variable default value delimiter string, may be null<a name="line.313"></a>
<span class="sourceLineNo">314</span> * @throws IllegalArgumentException if the prefix or suffix is null<a name="line.314"></a>
<span class="sourceLineNo">315</span> */<a name="line.315"></a>
<span class="sourceLineNo">316</span> public StrSubstitutor(final StrLookup variableResolver, final String prefix, final String suffix, final char escape, final String valueDelimiter) {<a name="line.316"></a>
<span class="sourceLineNo">317</span> this.setVariableResolver(variableResolver);<a name="line.317"></a>
<span class="sourceLineNo">318</span> this.setVariablePrefix(prefix);<a name="line.318"></a>
<span class="sourceLineNo">319</span> this.setVariableSuffix(suffix);<a name="line.319"></a>
<span class="sourceLineNo">320</span> this.setEscapeChar(escape);<a name="line.320"></a>
<span class="sourceLineNo">321</span> this.setValueDelimiter(valueDelimiter);<a name="line.321"></a>
<span class="sourceLineNo">322</span> }<a name="line.322"></a>
<span class="sourceLineNo">323</span><a name="line.323"></a>
<span class="sourceLineNo">324</span> /**<a name="line.324"></a>
<span class="sourceLineNo">325</span> * Creates a new instance and initializes it.<a name="line.325"></a>
<span class="sourceLineNo">326</span> *<a name="line.326"></a>
<span class="sourceLineNo">327</span> * @param variableResolver the variable resolver, may be null<a name="line.327"></a>
<span class="sourceLineNo">328</span> * @param prefixMatcher the prefix for variables, not null<a name="line.328"></a>
<span class="sourceLineNo">329</span> * @param suffixMatcher the suffix for variables, not null<a name="line.329"></a>
<span class="sourceLineNo">330</span> * @param escape the escape character<a name="line.330"></a>
<span class="sourceLineNo">331</span> * @throws IllegalArgumentException if the prefix or suffix is null<a name="line.331"></a>
<span class="sourceLineNo">332</span> */<a name="line.332"></a>
<span class="sourceLineNo">333</span> public StrSubstitutor(final StrLookup variableResolver, final StrMatcher prefixMatcher,<a name="line.333"></a>
<span class="sourceLineNo">334</span> final StrMatcher suffixMatcher,<a name="line.334"></a>
<span class="sourceLineNo">335</span> final char escape) {<a name="line.335"></a>
<span class="sourceLineNo">336</span> this(variableResolver, prefixMatcher, suffixMatcher, escape, DEFAULT_VALUE_DELIMITER,<a name="line.336"></a>
<span class="sourceLineNo">337</span> DEFAULT_VALUE_ESCAPE_DELIMITER);<a name="line.337"></a>
<span class="sourceLineNo">338</span> this.valueDelimiterString = DEFAULT_VALUE_DELIMITER_STRING;<a name="line.338"></a>
<span class="sourceLineNo">339</span> }<a name="line.339"></a>
<span class="sourceLineNo">340</span><a name="line.340"></a>
<span class="sourceLineNo">341</span> /**<a name="line.341"></a>
<span class="sourceLineNo">342</span> * Creates a new instance and initializes it.<a name="line.342"></a>
<span class="sourceLineNo">343</span> *<a name="line.343"></a>
<span class="sourceLineNo">344</span> * @param variableResolver the variable resolver, may be null<a name="line.344"></a>
<span class="sourceLineNo">345</span> * @param prefixMatcher the prefix for variables, not null<a name="line.345"></a>
<span class="sourceLineNo">346</span> * @param suffixMatcher the suffix for variables, not null<a name="line.346"></a>
<span class="sourceLineNo">347</span> * @param escape the escape character<a name="line.347"></a>
<span class="sourceLineNo">348</span> * @param valueDelimiterMatcher the variable default value delimiter matcher, may be null<a name="line.348"></a>
<span class="sourceLineNo">349</span> * @throws IllegalArgumentException if the prefix or suffix is null<a name="line.349"></a>
<span class="sourceLineNo">350</span> */<a name="line.350"></a>
<span class="sourceLineNo">351</span> public StrSubstitutor(final StrLookup variableResolver, final StrMatcher prefixMatcher,<a name="line.351"></a>
<span class="sourceLineNo">352</span> final StrMatcher suffixMatcher, final char escape, final StrMatcher valueDelimiterMatcher) {<a name="line.352"></a>
<span class="sourceLineNo">353</span> this.setVariableResolver(variableResolver);<a name="line.353"></a>
<span class="sourceLineNo">354</span> this.setVariablePrefixMatcher(prefixMatcher);<a name="line.354"></a>
<span class="sourceLineNo">355</span> this.setVariableSuffixMatcher(suffixMatcher);<a name="line.355"></a>
<span class="sourceLineNo">356</span> this.setEscapeChar(escape);<a name="line.356"></a>
<span class="sourceLineNo">357</span> this.setValueDelimiterMatcher(valueDelimiterMatcher);<a name="line.357"></a>
<span class="sourceLineNo">358</span> }<a name="line.358"></a>
<span class="sourceLineNo">359</span><a name="line.359"></a>
<span class="sourceLineNo">360</span> /**<a name="line.360"></a>
<span class="sourceLineNo">361</span> * Creates a new instance and initializes it.<a name="line.361"></a>
<span class="sourceLineNo">362</span> *<a name="line.362"></a>
<span class="sourceLineNo">363</span> * @param variableResolver the variable resolver, may be null<a name="line.363"></a>
<span class="sourceLineNo">364</span> * @param prefixMatcher the prefix for variables, not null<a name="line.364"></a>
<span class="sourceLineNo">365</span> * @param suffixMatcher the suffix for variables, not null<a name="line.365"></a>
<span class="sourceLineNo">366</span> * @param escape the escape character<a name="line.366"></a>
<span class="sourceLineNo">367</span> * @param valueDelimiterMatcher the variable default value delimiter matcher, may be null<a name="line.367"></a>
<span class="sourceLineNo">368</span> * @param valueEscapeMatcher the matcher to escape defaulting, may be null.<a name="line.368"></a>
<span class="sourceLineNo">369</span> * @throws IllegalArgumentException if the prefix or suffix is null<a name="line.369"></a>
<span class="sourceLineNo">370</span> */<a name="line.370"></a>
<span class="sourceLineNo">371</span> public StrSubstitutor(final StrLookup variableResolver, final StrMatcher prefixMatcher,<a name="line.371"></a>
<span class="sourceLineNo">372</span> final StrMatcher suffixMatcher, final char escape, final StrMatcher valueDelimiterMatcher,<a name="line.372"></a>
<span class="sourceLineNo">373</span> final StrMatcher valueEscapeMatcher) {<a name="line.373"></a>
<span class="sourceLineNo">374</span> this.setVariableResolver(variableResolver);<a name="line.374"></a>
<span class="sourceLineNo">375</span> this.setVariablePrefixMatcher(prefixMatcher);<a name="line.375"></a>
<span class="sourceLineNo">376</span> this.setVariableSuffixMatcher(suffixMatcher);<a name="line.376"></a>
<span class="sourceLineNo">377</span> this.setEscapeChar(escape);<a name="line.377"></a>
<span class="sourceLineNo">378</span> this.setValueDelimiterMatcher(valueDelimiterMatcher);<a name="line.378"></a>
<span class="sourceLineNo">379</span> valueEscapeDelimiterMatcher = valueEscapeMatcher;<a name="line.379"></a>
<span class="sourceLineNo">380</span> }<a name="line.380"></a>
<span class="sourceLineNo">381</span><a name="line.381"></a>
<span class="sourceLineNo">382</span> //-----------------------------------------------------------------------<a name="line.382"></a>
<span class="sourceLineNo">383</span> /**<a name="line.383"></a>
<span class="sourceLineNo">384</span> * Replaces all the occurrences of variables in the given source object with<a name="line.384"></a>
<span class="sourceLineNo">385</span> * their matching values from the map.<a name="line.385"></a>
<span class="sourceLineNo">386</span> *<a name="line.386"></a>
<span class="sourceLineNo">387</span> * @param source the source text containing the variables to substitute, null returns null<a name="line.387"></a>
<span class="sourceLineNo">388</span> * @param valueMap the map with the values, may be null<a name="line.388"></a>
<span class="sourceLineNo">389</span> * @return the result of the replace operation<a name="line.389"></a>
<span class="sourceLineNo">390</span> */<a name="line.390"></a>
<span class="sourceLineNo">391</span> public static String replace(final Object source, final Map&lt;String, String&gt; valueMap) {<a name="line.391"></a>
<span class="sourceLineNo">392</span> return new StrSubstitutor(valueMap).replace(source);<a name="line.392"></a>
<span class="sourceLineNo">393</span> }<a name="line.393"></a>
<span class="sourceLineNo">394</span><a name="line.394"></a>
<span class="sourceLineNo">395</span> /**<a name="line.395"></a>
<span class="sourceLineNo">396</span> * Replaces all the occurrences of variables in the given source object with<a name="line.396"></a>
<span class="sourceLineNo">397</span> * their matching values from the map. This method allows to specify a<a name="line.397"></a>
<span class="sourceLineNo">398</span> * custom variable prefix and suffix<a name="line.398"></a>
<span class="sourceLineNo">399</span> *<a name="line.399"></a>
<span class="sourceLineNo">400</span> * @param source the source text containing the variables to substitute, null returns null<a name="line.400"></a>
<span class="sourceLineNo">401</span> * @param valueMap the map with the values, may be null<a name="line.401"></a>
<span class="sourceLineNo">402</span> * @param prefix the prefix of variables, not null<a name="line.402"></a>
<span class="sourceLineNo">403</span> * @param suffix the suffix of variables, not null<a name="line.403"></a>
<span class="sourceLineNo">404</span> * @return the result of the replace operation<a name="line.404"></a>
<span class="sourceLineNo">405</span> * @throws IllegalArgumentException if the prefix or suffix is null<a name="line.405"></a>
<span class="sourceLineNo">406</span> */<a name="line.406"></a>
<span class="sourceLineNo">407</span> public static String replace(final Object source, final Map&lt;String, String&gt; valueMap, final String prefix,<a name="line.407"></a>
<span class="sourceLineNo">408</span> final String suffix) {<a name="line.408"></a>
<span class="sourceLineNo">409</span> return new StrSubstitutor(valueMap, prefix, suffix).replace(source);<a name="line.409"></a>
<span class="sourceLineNo">410</span> }<a name="line.410"></a>
<span class="sourceLineNo">411</span><a name="line.411"></a>
<span class="sourceLineNo">412</span> /**<a name="line.412"></a>
<span class="sourceLineNo">413</span> * Replaces all the occurrences of variables in the given source object with their matching<a name="line.413"></a>
<span class="sourceLineNo">414</span> * values from the properties.<a name="line.414"></a>
<span class="sourceLineNo">415</span> *<a name="line.415"></a>
<span class="sourceLineNo">416</span> * @param source the source text containing the variables to substitute, null returns null<a name="line.416"></a>
<span class="sourceLineNo">417</span> * @param valueProperties the properties with values, may be null<a name="line.417"></a>
<span class="sourceLineNo">418</span> * @return the result of the replace operation<a name="line.418"></a>
<span class="sourceLineNo">419</span> */<a name="line.419"></a>
<span class="sourceLineNo">420</span> public static String replace(final Object source, final Properties valueProperties) {<a name="line.420"></a>
<span class="sourceLineNo">421</span> if (valueProperties == null) {<a name="line.421"></a>
<span class="sourceLineNo">422</span> return source.toString();<a name="line.422"></a>
<span class="sourceLineNo">423</span> }<a name="line.423"></a>
<span class="sourceLineNo">424</span> final Map&lt;String, String&gt; valueMap = new HashMap&lt;&gt;();<a name="line.424"></a>
<span class="sourceLineNo">425</span> final Enumeration&lt;?&gt; propNames = valueProperties.propertyNames();<a name="line.425"></a>
<span class="sourceLineNo">426</span> while (propNames.hasMoreElements()) {<a name="line.426"></a>
<span class="sourceLineNo">427</span> final String propName = (String) propNames.nextElement();<a name="line.427"></a>
<span class="sourceLineNo">428</span> final String propValue = valueProperties.getProperty(propName);<a name="line.428"></a>
<span class="sourceLineNo">429</span> valueMap.put(propName, propValue);<a name="line.429"></a>
<span class="sourceLineNo">430</span> }<a name="line.430"></a>
<span class="sourceLineNo">431</span> return StrSubstitutor.replace(source, valueMap);<a name="line.431"></a>
<span class="sourceLineNo">432</span> }<a name="line.432"></a>
<span class="sourceLineNo">433</span><a name="line.433"></a>
<span class="sourceLineNo">434</span> private static Map&lt;String, String&gt; toTypeSafeMap(final Properties properties) {<a name="line.434"></a>
<span class="sourceLineNo">435</span> final Map&lt;String, String&gt; map = new HashMap&lt;&gt;(properties.size());<a name="line.435"></a>
<span class="sourceLineNo">436</span> for (final String name : properties.stringPropertyNames()) {<a name="line.436"></a>
<span class="sourceLineNo">437</span> map.put(name, properties.getProperty(name));<a name="line.437"></a>
<span class="sourceLineNo">438</span> }<a name="line.438"></a>
<span class="sourceLineNo">439</span> return map;<a name="line.439"></a>
<span class="sourceLineNo">440</span> }<a name="line.440"></a>
<span class="sourceLineNo">441</span><a name="line.441"></a>
<span class="sourceLineNo">442</span> //-----------------------------------------------------------------------<a name="line.442"></a>
<span class="sourceLineNo">443</span> /**<a name="line.443"></a>
<span class="sourceLineNo">444</span> * Replaces all the occurrences of variables with their matching values<a name="line.444"></a>
<span class="sourceLineNo">445</span> * from the resolver using the given source string as a template.<a name="line.445"></a>
<span class="sourceLineNo">446</span> *<a name="line.446"></a>
<span class="sourceLineNo">447</span> * @param source the string to replace in, null returns null<a name="line.447"></a>
<span class="sourceLineNo">448</span> * @return the result of the replace operation<a name="line.448"></a>
<span class="sourceLineNo">449</span> */<a name="line.449"></a>
<span class="sourceLineNo">450</span> public String replace(final String source) {<a name="line.450"></a>
<span class="sourceLineNo">451</span> return replace(null, source);<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> /**<a name="line.454"></a>
<span class="sourceLineNo">455</span> * Replaces all the occurrences of variables with their matching values<a name="line.455"></a>
<span class="sourceLineNo">456</span> * from the resolver using the given source string as a template.<a name="line.456"></a>
<span class="sourceLineNo">457</span> *<a name="line.457"></a>
<span class="sourceLineNo">458</span> * @param event The current LogEvent if there is one.<a name="line.458"></a>
<span class="sourceLineNo">459</span> * @param source the string to replace in, null returns null<a name="line.459"></a>
<span class="sourceLineNo">460</span> * @return the result of the replace operation<a name="line.460"></a>
<span class="sourceLineNo">461</span> */<a name="line.461"></a>
<span class="sourceLineNo">462</span> public String replace(final LogEvent event, final String source) {<a name="line.462"></a>
<span class="sourceLineNo">463</span> if (source == null) {<a name="line.463"></a>
<span class="sourceLineNo">464</span> return null;<a name="line.464"></a>
<span class="sourceLineNo">465</span> }<a name="line.465"></a>
<span class="sourceLineNo">466</span> final StringBuilder buf = new StringBuilder(source);<a name="line.466"></a>
<span class="sourceLineNo">467</span> if (!substitute(event, buf, 0, source.length())) {<a name="line.467"></a>
<span class="sourceLineNo">468</span> return source;<a name="line.468"></a>
<span class="sourceLineNo">469</span> }<a name="line.469"></a>
<span class="sourceLineNo">470</span> return buf.toString();<a name="line.470"></a>
<span class="sourceLineNo">471</span> }<a name="line.471"></a>
<span class="sourceLineNo">472</span><a name="line.472"></a>
<span class="sourceLineNo">473</span> /**<a name="line.473"></a>
<span class="sourceLineNo">474</span> * Replaces all the occurrences of variables with their matching values<a name="line.474"></a>
<span class="sourceLineNo">475</span> * from the resolver using the given source string as a template.<a name="line.475"></a>
<span class="sourceLineNo">476</span> * &lt;p&gt;<a name="line.476"></a>
<span class="sourceLineNo">477</span> * Only the specified portion of the string will be processed.<a name="line.477"></a>
<span class="sourceLineNo">478</span> * The rest of the string is not processed, and is not returned.<a name="line.478"></a>
<span class="sourceLineNo">479</span> * &lt;/p&gt;<a name="line.479"></a>
<span class="sourceLineNo">480</span> *<a name="line.480"></a>
<span class="sourceLineNo">481</span> * @param source the string to replace in, null returns null<a name="line.481"></a>
<span class="sourceLineNo">482</span> * @param offset the start offset within the array, must be valid<a name="line.482"></a>
<span class="sourceLineNo">483</span> * @param length the length within the array to be processed, must be valid<a name="line.483"></a>
<span class="sourceLineNo">484</span> * @return the result of the replace operation<a name="line.484"></a>
<span class="sourceLineNo">485</span> */<a name="line.485"></a>
<span class="sourceLineNo">486</span> public String replace(final String source, final int offset, final int length) {<a name="line.486"></a>
<span class="sourceLineNo">487</span> return replace(null, source, offset, length);<a name="line.487"></a>
<span class="sourceLineNo">488</span> }<a name="line.488"></a>
<span class="sourceLineNo">489</span><a name="line.489"></a>
<span class="sourceLineNo">490</span> /**<a name="line.490"></a>
<span class="sourceLineNo">491</span> * Replaces all the occurrences of variables with their matching values<a name="line.491"></a>
<span class="sourceLineNo">492</span> * from the resolver using the given source string as a template.<a name="line.492"></a>
<span class="sourceLineNo">493</span> * &lt;p&gt;<a name="line.493"></a>
<span class="sourceLineNo">494</span> * Only the specified portion of the string will be processed.<a name="line.494"></a>
<span class="sourceLineNo">495</span> * The rest of the string is not processed, and is not returned.<a name="line.495"></a>
<span class="sourceLineNo">496</span> * &lt;/p&gt;<a name="line.496"></a>
<span class="sourceLineNo">497</span> *<a name="line.497"></a>
<span class="sourceLineNo">498</span> * @param event the current LogEvent, if one exists.<a name="line.498"></a>
<span class="sourceLineNo">499</span> * @param source the string to replace in, null returns null<a name="line.499"></a>
<span class="sourceLineNo">500</span> * @param offset the start offset within the array, must be valid<a name="line.500"></a>
<span class="sourceLineNo">501</span> * @param length the length within the array to be processed, must be valid<a name="line.501"></a>
<span class="sourceLineNo">502</span> * @return the result of the replace operation<a name="line.502"></a>
<span class="sourceLineNo">503</span> */<a name="line.503"></a>
<span class="sourceLineNo">504</span> public String replace(final LogEvent event, final String source, final int offset, final int length) {<a name="line.504"></a>
<span class="sourceLineNo">505</span> if (source == null) {<a name="line.505"></a>
<span class="sourceLineNo">506</span> return null;<a name="line.506"></a>
<span class="sourceLineNo">507</span> }<a name="line.507"></a>
<span class="sourceLineNo">508</span> final StringBuilder buf = new StringBuilder(length).append(source, offset, length);<a name="line.508"></a>
<span class="sourceLineNo">509</span> if (!substitute(event, buf, 0, length)) {<a name="line.509"></a>
<span class="sourceLineNo">510</span> return source.substring(offset, offset + length);<a name="line.510"></a>
<span class="sourceLineNo">511</span> }<a name="line.511"></a>
<span class="sourceLineNo">512</span> return buf.toString();<a name="line.512"></a>
<span class="sourceLineNo">513</span> }<a name="line.513"></a>
<span class="sourceLineNo">514</span><a name="line.514"></a>
<span class="sourceLineNo">515</span> //-----------------------------------------------------------------------<a name="line.515"></a>
<span class="sourceLineNo">516</span> /**<a name="line.516"></a>
<span class="sourceLineNo">517</span> * Replaces all the occurrences of variables with their matching values<a name="line.517"></a>
<span class="sourceLineNo">518</span> * from the resolver using the given source array as a template.<a name="line.518"></a>
<span class="sourceLineNo">519</span> * The array is not altered by this method.<a name="line.519"></a>
<span class="sourceLineNo">520</span> *<a name="line.520"></a>
<span class="sourceLineNo">521</span> * @param source the character array to replace in, not altered, null returns null<a name="line.521"></a>
<span class="sourceLineNo">522</span> * @return the result of the replace operation<a name="line.522"></a>
<span class="sourceLineNo">523</span> */<a name="line.523"></a>
<span class="sourceLineNo">524</span> public String replace(final char[] source) {<a name="line.524"></a>
<span class="sourceLineNo">525</span> return replace(null, source);<a name="line.525"></a>
<span class="sourceLineNo">526</span> }<a name="line.526"></a>
<span class="sourceLineNo">527</span><a name="line.527"></a>
<span class="sourceLineNo">528</span> //-----------------------------------------------------------------------<a name="line.528"></a>
<span class="sourceLineNo">529</span> /**<a name="line.529"></a>
<span class="sourceLineNo">530</span> * Replaces all the occurrences of variables with their matching values<a name="line.530"></a>
<span class="sourceLineNo">531</span> * from the resolver using the given source array as a template.<a name="line.531"></a>
<span class="sourceLineNo">532</span> * The array is not altered by this method.<a name="line.532"></a>
<span class="sourceLineNo">533</span> *<a name="line.533"></a>
<span class="sourceLineNo">534</span> * @param event the current LogEvent, if one exists.<a name="line.534"></a>
<span class="sourceLineNo">535</span> * @param source the character array to replace in, not altered, null returns null<a name="line.535"></a>
<span class="sourceLineNo">536</span> * @return the result of the replace operation<a name="line.536"></a>
<span class="sourceLineNo">537</span> */<a name="line.537"></a>
<span class="sourceLineNo">538</span> public String replace(final LogEvent event, final char[] source) {<a name="line.538"></a>
<span class="sourceLineNo">539</span> if (source == null) {<a name="line.539"></a>
<span class="sourceLineNo">540</span> return null;<a name="line.540"></a>
<span class="sourceLineNo">541</span> }<a name="line.541"></a>
<span class="sourceLineNo">542</span> final StringBuilder buf = new StringBuilder(source.length).append(source);<a name="line.542"></a>
<span class="sourceLineNo">543</span> substitute(event, buf, 0, source.length);<a name="line.543"></a>
<span class="sourceLineNo">544</span> return buf.toString();<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> /**<a name="line.547"></a>
<span class="sourceLineNo">548</span> * Replaces all the occurrences of variables with their matching values<a name="line.548"></a>
<span class="sourceLineNo">549</span> * from the resolver using the given source array as a template.<a name="line.549"></a>
<span class="sourceLineNo">550</span> * The array is not altered by this method.<a name="line.550"></a>
<span class="sourceLineNo">551</span> * &lt;p&gt;<a name="line.551"></a>
<span class="sourceLineNo">552</span> * Only the specified portion of the array will be processed.<a name="line.552"></a>
<span class="sourceLineNo">553</span> * The rest of the array is not processed, and is not returned.<a name="line.553"></a>
<span class="sourceLineNo">554</span> * &lt;/p&gt;<a name="line.554"></a>
<span class="sourceLineNo">555</span> *<a name="line.555"></a>
<span class="sourceLineNo">556</span> * @param source the character array to replace in, not altered, null returns null<a name="line.556"></a>
<span class="sourceLineNo">557</span> * @param offset the start offset within the array, must be valid<a name="line.557"></a>
<span class="sourceLineNo">558</span> * @param length the length within the array to be processed, must be valid<a name="line.558"></a>
<span class="sourceLineNo">559</span> * @return the result of the replace operation<a name="line.559"></a>
<span class="sourceLineNo">560</span> */<a name="line.560"></a>
<span class="sourceLineNo">561</span> public String replace(final char[] source, final int offset, final int length) {<a name="line.561"></a>
<span class="sourceLineNo">562</span> return replace(null, source, offset, length);<a name="line.562"></a>
<span class="sourceLineNo">563</span> }<a name="line.563"></a>
<span class="sourceLineNo">564</span><a name="line.564"></a>
<span class="sourceLineNo">565</span> /**<a name="line.565"></a>
<span class="sourceLineNo">566</span> * Replaces all the occurrences of variables with their matching values<a name="line.566"></a>
<span class="sourceLineNo">567</span> * from the resolver using the given source array as a template.<a name="line.567"></a>
<span class="sourceLineNo">568</span> * The array is not altered by this method.<a name="line.568"></a>
<span class="sourceLineNo">569</span> * &lt;p&gt;<a name="line.569"></a>
<span class="sourceLineNo">570</span> * Only the specified portion of the array will be processed.<a name="line.570"></a>
<span class="sourceLineNo">571</span> * The rest of the array is not processed, and is not returned.<a name="line.571"></a>
<span class="sourceLineNo">572</span> * &lt;/p&gt;<a name="line.572"></a>
<span class="sourceLineNo">573</span> *<a name="line.573"></a>
<span class="sourceLineNo">574</span> * @param event the current LogEvent, if one exists.<a name="line.574"></a>
<span class="sourceLineNo">575</span> * @param source the character array to replace in, not altered, null returns null<a name="line.575"></a>
<span class="sourceLineNo">576</span> * @param offset the start offset within the array, must be valid<a name="line.576"></a>
<span class="sourceLineNo">577</span> * @param length the length within the array to be processed, must be valid<a name="line.577"></a>
<span class="sourceLineNo">578</span> * @return the result of the replace operation<a name="line.578"></a>
<span class="sourceLineNo">579</span> */<a name="line.579"></a>
<span class="sourceLineNo">580</span> public String replace(final LogEvent event, final char[] source, final int offset, final int length) {<a name="line.580"></a>
<span class="sourceLineNo">581</span> if (source == null) {<a name="line.581"></a>
<span class="sourceLineNo">582</span> return null;<a name="line.582"></a>
<span class="sourceLineNo">583</span> }<a name="line.583"></a>
<span class="sourceLineNo">584</span> final StringBuilder buf = new StringBuilder(length).append(source, offset, length);<a name="line.584"></a>
<span class="sourceLineNo">585</span> substitute(event, buf, 0, length);<a name="line.585"></a>
<span class="sourceLineNo">586</span> return buf.toString();<a name="line.586"></a>
<span class="sourceLineNo">587</span> }<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> /**<a name="line.590"></a>
<span class="sourceLineNo">591</span> * Replaces all the occurrences of variables with their matching values<a name="line.591"></a>
<span class="sourceLineNo">592</span> * from the resolver using the given source buffer as a template.<a name="line.592"></a>
<span class="sourceLineNo">593</span> * The buffer is not altered by this method.<a name="line.593"></a>
<span class="sourceLineNo">594</span> *<a name="line.594"></a>
<span class="sourceLineNo">595</span> * @param source the buffer to use as a template, not changed, null returns null<a name="line.595"></a>
<span class="sourceLineNo">596</span> * @return the result of the replace operation<a name="line.596"></a>
<span class="sourceLineNo">597</span> */<a name="line.597"></a>
<span class="sourceLineNo">598</span> public String replace(final StringBuffer source) {<a name="line.598"></a>
<span class="sourceLineNo">599</span> return replace(null, source);<a name="line.599"></a>
<span class="sourceLineNo">600</span> }<a name="line.600"></a>
<span class="sourceLineNo">601</span><a name="line.601"></a>
<span class="sourceLineNo">602</span> //-----------------------------------------------------------------------<a name="line.602"></a>
<span class="sourceLineNo">603</span> /**<a name="line.603"></a>
<span class="sourceLineNo">604</span> * Replaces all the occurrences of variables with their matching values<a name="line.604"></a>
<span class="sourceLineNo">605</span> * from the resolver using the given source buffer as a template.<a name="line.605"></a>
<span class="sourceLineNo">606</span> * The buffer is not altered by this method.<a name="line.606"></a>
<span class="sourceLineNo">607</span> *<a name="line.607"></a>
<span class="sourceLineNo">608</span> * @param event the current LogEvent, if one exists.<a name="line.608"></a>
<span class="sourceLineNo">609</span> * @param source the buffer to use as a template, not changed, null returns null<a name="line.609"></a>
<span class="sourceLineNo">610</span> * @return the result of the replace operation<a name="line.610"></a>
<span class="sourceLineNo">611</span> */<a name="line.611"></a>
<span class="sourceLineNo">612</span> public String replace(final LogEvent event, final StringBuffer source) {<a name="line.612"></a>
<span class="sourceLineNo">613</span> if (source == null) {<a name="line.613"></a>
<span class="sourceLineNo">614</span> return null;<a name="line.614"></a>
<span class="sourceLineNo">615</span> }<a name="line.615"></a>
<span class="sourceLineNo">616</span> final StringBuilder buf = new StringBuilder(source.length()).append(source);<a name="line.616"></a>
<span class="sourceLineNo">617</span> substitute(event, buf, 0, buf.length());<a name="line.617"></a>
<span class="sourceLineNo">618</span> return buf.toString();<a name="line.618"></a>
<span class="sourceLineNo">619</span> }<a name="line.619"></a>
<span class="sourceLineNo">620</span><a name="line.620"></a>
<span class="sourceLineNo">621</span> /**<a name="line.621"></a>
<span class="sourceLineNo">622</span> * Replaces all the occurrences of variables with their matching values<a name="line.622"></a>
<span class="sourceLineNo">623</span> * from the resolver using the given source buffer as a template.<a name="line.623"></a>
<span class="sourceLineNo">624</span> * The buffer is not altered by this method.<a name="line.624"></a>
<span class="sourceLineNo">625</span> * &lt;p&gt;<a name="line.625"></a>
<span class="sourceLineNo">626</span> * Only the specified portion of the buffer will be processed.<a name="line.626"></a>
<span class="sourceLineNo">627</span> * The rest of the buffer is not processed, and is not returned.<a name="line.627"></a>
<span class="sourceLineNo">628</span> * &lt;/p&gt;<a name="line.628"></a>
<span class="sourceLineNo">629</span> *<a name="line.629"></a>
<span class="sourceLineNo">630</span> * @param source the buffer to use as a template, not changed, null returns null<a name="line.630"></a>
<span class="sourceLineNo">631</span> * @param offset the start offset within the array, must be valid<a name="line.631"></a>
<span class="sourceLineNo">632</span> * @param length the length within the array to be processed, must be valid<a name="line.632"></a>
<span class="sourceLineNo">633</span> * @return the result of the replace operation<a name="line.633"></a>
<span class="sourceLineNo">634</span> */<a name="line.634"></a>
<span class="sourceLineNo">635</span> public String replace(final StringBuffer source, final int offset, final int length) {<a name="line.635"></a>
<span class="sourceLineNo">636</span> return replace(null, source, offset, length);<a name="line.636"></a>
<span class="sourceLineNo">637</span> }<a name="line.637"></a>
<span class="sourceLineNo">638</span><a name="line.638"></a>
<span class="sourceLineNo">639</span> /**<a name="line.639"></a>
<span class="sourceLineNo">640</span> * Replaces all the occurrences of variables with their matching values<a name="line.640"></a>
<span class="sourceLineNo">641</span> * from the resolver using the given source buffer as a template.<a name="line.641"></a>
<span class="sourceLineNo">642</span> * The buffer is not altered by this method.<a name="line.642"></a>
<span class="sourceLineNo">643</span> * &lt;p&gt;<a name="line.643"></a>
<span class="sourceLineNo">644</span> * Only the specified portion of the buffer will be processed.<a name="line.644"></a>
<span class="sourceLineNo">645</span> * The rest of the buffer is not processed, and is not returned.<a name="line.645"></a>
<span class="sourceLineNo">646</span> * &lt;/p&gt;<a name="line.646"></a>
<span class="sourceLineNo">647</span> *<a name="line.647"></a>
<span class="sourceLineNo">648</span> * @param event the current LogEvent, if one exists.<a name="line.648"></a>
<span class="sourceLineNo">649</span> * @param source the buffer to use as a template, not changed, null returns null<a name="line.649"></a>
<span class="sourceLineNo">650</span> * @param offset the start offset within the array, must be valid<a name="line.650"></a>
<span class="sourceLineNo">651</span> * @param length the length within the array to be processed, must be valid<a name="line.651"></a>
<span class="sourceLineNo">652</span> * @return the result of the replace operation<a name="line.652"></a>
<span class="sourceLineNo">653</span> */<a name="line.653"></a>
<span class="sourceLineNo">654</span> public String replace(final LogEvent event, final StringBuffer source, final int offset, final int length) {<a name="line.654"></a>
<span class="sourceLineNo">655</span> if (source == null) {<a name="line.655"></a>
<span class="sourceLineNo">656</span> return null;<a name="line.656"></a>
<span class="sourceLineNo">657</span> }<a name="line.657"></a>
<span class="sourceLineNo">658</span> final StringBuilder buf = new StringBuilder(length).append(source, offset, length);<a name="line.658"></a>
<span class="sourceLineNo">659</span> substitute(event, buf, 0, length);<a name="line.659"></a>
<span class="sourceLineNo">660</span> return buf.toString();<a name="line.660"></a>
<span class="sourceLineNo">661</span> }<a name="line.661"></a>
<span class="sourceLineNo">662</span><a name="line.662"></a>
<span class="sourceLineNo">663</span> //-----------------------------------------------------------------------<a name="line.663"></a>
<span class="sourceLineNo">664</span> /**<a name="line.664"></a>
<span class="sourceLineNo">665</span> * Replaces all the occurrences of variables with their matching values<a name="line.665"></a>
<span class="sourceLineNo">666</span> * from the resolver using the given source builder as a template.<a name="line.666"></a>
<span class="sourceLineNo">667</span> * The builder is not altered by this method.<a name="line.667"></a>
<span class="sourceLineNo">668</span> *<a name="line.668"></a>
<span class="sourceLineNo">669</span> * @param source the builder to use as a template, not changed, null returns null<a name="line.669"></a>
<span class="sourceLineNo">670</span> * @return the result of the replace operation<a name="line.670"></a>
<span class="sourceLineNo">671</span> */<a name="line.671"></a>
<span class="sourceLineNo">672</span> public String replace(final StringBuilder source) {<a name="line.672"></a>
<span class="sourceLineNo">673</span> return replace(null, source);<a name="line.673"></a>
<span class="sourceLineNo">674</span> }<a name="line.674"></a>
<span class="sourceLineNo">675</span><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> * Replaces all the occurrences of variables with their matching values<a name="line.678"></a>
<span class="sourceLineNo">679</span> * from the resolver using the given source builder as a template.<a name="line.679"></a>
<span class="sourceLineNo">680</span> * The builder is not altered by this method.<a name="line.680"></a>
<span class="sourceLineNo">681</span> *<a name="line.681"></a>
<span class="sourceLineNo">682</span> * @param event The LogEvent.<a name="line.682"></a>
<span class="sourceLineNo">683</span> * @param source the builder to use as a template, not changed, null returns null.<a name="line.683"></a>
<span class="sourceLineNo">684</span> * @return the result of the replace operation.<a name="line.684"></a>
<span class="sourceLineNo">685</span> */<a name="line.685"></a>
<span class="sourceLineNo">686</span> public String replace(final LogEvent event, final StringBuilder source) {<a name="line.686"></a>
<span class="sourceLineNo">687</span> if (source == null) {<a name="line.687"></a>
<span class="sourceLineNo">688</span> return null;<a name="line.688"></a>
<span class="sourceLineNo">689</span> }<a name="line.689"></a>
<span class="sourceLineNo">690</span> final StringBuilder buf = new StringBuilder(source.length()).append(source);<a name="line.690"></a>
<span class="sourceLineNo">691</span> substitute(event, buf, 0, buf.length());<a name="line.691"></a>
<span class="sourceLineNo">692</span> return buf.toString();<a name="line.692"></a>
<span class="sourceLineNo">693</span> }<a name="line.693"></a>
<span class="sourceLineNo">694</span> /**<a name="line.694"></a>
<span class="sourceLineNo">695</span> * Replaces all the occurrences of variables with their matching values<a name="line.695"></a>
<span class="sourceLineNo">696</span> * from the resolver using the given source builder as a template.<a name="line.696"></a>
<span class="sourceLineNo">697</span> * The builder is not altered by this method.<a name="line.697"></a>
<span class="sourceLineNo">698</span> * &lt;p&gt;<a name="line.698"></a>
<span class="sourceLineNo">699</span> * Only the specified portion of the builder will be processed.<a name="line.699"></a>
<span class="sourceLineNo">700</span> * The rest of the builder is not processed, and is not returned.<a name="line.700"></a>
<span class="sourceLineNo">701</span> * &lt;/p&gt;<a name="line.701"></a>
<span class="sourceLineNo">702</span> *<a name="line.702"></a>
<span class="sourceLineNo">703</span> * @param source the builder to use as a template, not changed, null returns null<a name="line.703"></a>
<span class="sourceLineNo">704</span> * @param offset the start offset within the array, must be valid<a name="line.704"></a>
<span class="sourceLineNo">705</span> * @param length the length within the array to be processed, must be valid<a name="line.705"></a>
<span class="sourceLineNo">706</span> * @return the result of the replace operation<a name="line.706"></a>
<span class="sourceLineNo">707</span> */<a name="line.707"></a>
<span class="sourceLineNo">708</span> public String replace(final StringBuilder source, final int offset, final int length) {<a name="line.708"></a>
<span class="sourceLineNo">709</span> return replace(null, source, offset, length);<a name="line.709"></a>
<span class="sourceLineNo">710</span> }<a name="line.710"></a>
<span class="sourceLineNo">711</span><a name="line.711"></a>
<span class="sourceLineNo">712</span> /**<a name="line.712"></a>
<span class="sourceLineNo">713</span> * Replaces all the occurrences of variables with their matching values<a name="line.713"></a>
<span class="sourceLineNo">714</span> * from the resolver using the given source builder as a template.<a name="line.714"></a>
<span class="sourceLineNo">715</span> * The builder is not altered by this method.<a name="line.715"></a>
<span class="sourceLineNo">716</span> * &lt;p&gt;<a name="line.716"></a>
<span class="sourceLineNo">717</span> * Only the specified portion of the builder will be processed.<a name="line.717"></a>
<span class="sourceLineNo">718</span> * The rest of the builder is not processed, and is not returned.<a name="line.718"></a>
<span class="sourceLineNo">719</span> * &lt;/p&gt;<a name="line.719"></a>
<span class="sourceLineNo">720</span> *<a name="line.720"></a>
<span class="sourceLineNo">721</span> * @param event the current LogEvent, if one exists.<a name="line.721"></a>
<span class="sourceLineNo">722</span> * @param source the builder to use as a template, not changed, null returns null<a name="line.722"></a>
<span class="sourceLineNo">723</span> * @param offset the start offset within the array, must be valid<a name="line.723"></a>
<span class="sourceLineNo">724</span> * @param length the length within the array to be processed, must be valid<a name="line.724"></a>
<span class="sourceLineNo">725</span> * @return the result of the replace operation<a name="line.725"></a>
<span class="sourceLineNo">726</span> */<a name="line.726"></a>
<span class="sourceLineNo">727</span> public String replace(final LogEvent event, final StringBuilder source, final int offset, final int length) {<a name="line.727"></a>
<span class="sourceLineNo">728</span> if (source == null) {<a name="line.728"></a>
<span class="sourceLineNo">729</span> return null;<a name="line.729"></a>
<span class="sourceLineNo">730</span> }<a name="line.730"></a>
<span class="sourceLineNo">731</span> final StringBuilder buf = new StringBuilder(length).append(source, offset, length);<a name="line.731"></a>
<span class="sourceLineNo">732</span> substitute(event, buf, 0, length);<a name="line.732"></a>
<span class="sourceLineNo">733</span> return buf.toString();<a name="line.733"></a>
<span class="sourceLineNo">734</span> }<a name="line.734"></a>
<span class="sourceLineNo">735</span><a name="line.735"></a>
<span class="sourceLineNo">736</span> //-----------------------------------------------------------------------<a name="line.736"></a>
<span class="sourceLineNo">737</span> /**<a name="line.737"></a>
<span class="sourceLineNo">738</span> * Replaces all the occurrences of variables in the given source object with<a name="line.738"></a>
<span class="sourceLineNo">739</span> * their matching values from the resolver. The input source object is<a name="line.739"></a>
<span class="sourceLineNo">740</span> * converted to a string using &lt;code&gt;toString&lt;/code&gt; and is not altered.<a name="line.740"></a>
<span class="sourceLineNo">741</span> *<a name="line.741"></a>
<span class="sourceLineNo">742</span> * @param source the source to replace in, null returns null<a name="line.742"></a>
<span class="sourceLineNo">743</span> * @return the result of the replace operation<a name="line.743"></a>
<span class="sourceLineNo">744</span> */<a name="line.744"></a>
<span class="sourceLineNo">745</span> public String replace(final Object source) {<a name="line.745"></a>
<span class="sourceLineNo">746</span> return replace(null, source);<a name="line.746"></a>
<span class="sourceLineNo">747</span> }<a name="line.747"></a>
<span class="sourceLineNo">748</span> //-----------------------------------------------------------------------<a name="line.748"></a>
<span class="sourceLineNo">749</span> /**<a name="line.749"></a>
<span class="sourceLineNo">750</span> * Replaces all the occurrences of variables in the given source object with<a name="line.750"></a>
<span class="sourceLineNo">751</span> * their matching values from the resolver. The input source object is<a name="line.751"></a>
<span class="sourceLineNo">752</span> * converted to a string using &lt;code&gt;toString&lt;/code&gt; and is not altered.<a name="line.752"></a>
<span class="sourceLineNo">753</span> *<a name="line.753"></a>
<span class="sourceLineNo">754</span> * @param event the current LogEvent, if one exists.<a name="line.754"></a>
<span class="sourceLineNo">755</span> * @param source the source to replace in, null returns null<a name="line.755"></a>
<span class="sourceLineNo">756</span> * @return the result of the replace operation<a name="line.756"></a>
<span class="sourceLineNo">757</span> */<a name="line.757"></a>
<span class="sourceLineNo">758</span> public String replace(final LogEvent event, final Object source) {<a name="line.758"></a>
<span class="sourceLineNo">759</span> if (source == null) {<a name="line.759"></a>
<span class="sourceLineNo">760</span> return null;<a name="line.760"></a>
<span class="sourceLineNo">761</span> }<a name="line.761"></a>
<span class="sourceLineNo">762</span> final StringBuilder buf = new StringBuilder().append(source);<a name="line.762"></a>
<span class="sourceLineNo">763</span> substitute(event, buf, 0, buf.length());<a name="line.763"></a>
<span class="sourceLineNo">764</span> return buf.toString();<a name="line.764"></a>
<span class="sourceLineNo">765</span> }<a name="line.765"></a>
<span class="sourceLineNo">766</span><a name="line.766"></a>
<span class="sourceLineNo">767</span> //-----------------------------------------------------------------------<a name="line.767"></a>
<span class="sourceLineNo">768</span> /**<a name="line.768"></a>
<span class="sourceLineNo">769</span> * Replaces all the occurrences of variables within the given source buffer<a name="line.769"></a>
<span class="sourceLineNo">770</span> * with their matching values from the resolver.<a name="line.770"></a>
<span class="sourceLineNo">771</span> * The buffer is updated with the result.<a name="line.771"></a>
<span class="sourceLineNo">772</span> *<a name="line.772"></a>
<span class="sourceLineNo">773</span> * @param source the buffer to replace in, updated, null returns zero<a name="line.773"></a>
<span class="sourceLineNo">774</span> * @return true if altered<a name="line.774"></a>
<span class="sourceLineNo">775</span> */<a name="line.775"></a>
<span class="sourceLineNo">776</span> public boolean replaceIn(final StringBuffer source) {<a name="line.776"></a>
<span class="sourceLineNo">777</span> if (source == null) {<a name="line.777"></a>
<span class="sourceLineNo">778</span> return false;<a name="line.778"></a>
<span class="sourceLineNo">779</span> }<a name="line.779"></a>
<span class="sourceLineNo">780</span> return replaceIn(source, 0, source.length());<a name="line.780"></a>
<span class="sourceLineNo">781</span> }<a name="line.781"></a>
<span class="sourceLineNo">782</span><a name="line.782"></a>
<span class="sourceLineNo">783</span> /**<a name="line.783"></a>
<span class="sourceLineNo">784</span> * Replaces all the occurrences of variables within the given source buffer<a name="line.784"></a>
<span class="sourceLineNo">785</span> * with their matching values from the resolver.<a name="line.785"></a>
<span class="sourceLineNo">786</span> * The buffer is updated with the result.<a name="line.786"></a>
<span class="sourceLineNo">787</span> * &lt;p&gt;<a name="line.787"></a>
<span class="sourceLineNo">788</span> * Only the specified portion of the buffer will be processed.<a name="line.788"></a>
<span class="sourceLineNo">789</span> * The rest of the buffer is not processed, but it is not deleted.<a name="line.789"></a>
<span class="sourceLineNo">790</span> * &lt;/p&gt;<a name="line.790"></a>
<span class="sourceLineNo">791</span> *<a name="line.791"></a>
<span class="sourceLineNo">792</span> * @param source the buffer to replace in, updated, null returns zero<a name="line.792"></a>
<span class="sourceLineNo">793</span> * @param offset the start offset within the array, must be valid<a name="line.793"></a>
<span class="sourceLineNo">794</span> * @param length the length within the buffer to be processed, must be valid<a name="line.794"></a>
<span class="sourceLineNo">795</span> * @return true if altered<a name="line.795"></a>
<span class="sourceLineNo">796</span> */<a name="line.796"></a>
<span class="sourceLineNo">797</span> public boolean replaceIn(final StringBuffer source, final int offset, final int length) {<a name="line.797"></a>
<span class="sourceLineNo">798</span> return replaceIn(null, source, offset, length);<a name="line.798"></a>
<span class="sourceLineNo">799</span> }<a name="line.799"></a>
<span class="sourceLineNo">800</span><a name="line.800"></a>
<span class="sourceLineNo">801</span> /**<a name="line.801"></a>
<span class="sourceLineNo">802</span> * Replaces all the occurrences of variables within the given source buffer<a name="line.802"></a>
<span class="sourceLineNo">803</span> * with their matching values from the resolver.<a name="line.803"></a>
<span class="sourceLineNo">804</span> * The buffer is updated with the result.<a name="line.804"></a>
<span class="sourceLineNo">805</span> * &lt;p&gt;<a name="line.805"></a>
<span class="sourceLineNo">806</span> * Only the specified portion of the buffer will be processed.<a name="line.806"></a>
<span class="sourceLineNo">807</span> * The rest of the buffer is not processed, but it is not deleted.<a name="line.807"></a>
<span class="sourceLineNo">808</span> * &lt;/p&gt;<a name="line.808"></a>
<span class="sourceLineNo">809</span> *<a name="line.809"></a>
<span class="sourceLineNo">810</span> * @param event the current LogEvent, if one exists.<a name="line.810"></a>
<span class="sourceLineNo">811</span> * @param source the buffer to replace in, updated, null returns zero<a name="line.811"></a>
<span class="sourceLineNo">812</span> * @param offset the start offset within the array, must be valid<a name="line.812"></a>
<span class="sourceLineNo">813</span> * @param length the length within the buffer to be processed, must be valid<a name="line.813"></a>
<span class="sourceLineNo">814</span> * @return true if altered<a name="line.814"></a>
<span class="sourceLineNo">815</span> */<a name="line.815"></a>
<span class="sourceLineNo">816</span> public boolean replaceIn(final LogEvent event, final StringBuffer source, final int offset, final int length) {<a name="line.816"></a>
<span class="sourceLineNo">817</span> if (source == null) {<a name="line.817"></a>
<span class="sourceLineNo">818</span> return false;<a name="line.818"></a>
<span class="sourceLineNo">819</span> }<a name="line.819"></a>
<span class="sourceLineNo">820</span> final StringBuilder buf = new StringBuilder(length).append(source, offset, length);<a name="line.820"></a>
<span class="sourceLineNo">821</span> if (!substitute(event, buf, 0, length)) {<a name="line.821"></a>
<span class="sourceLineNo">822</span> return false;<a name="line.822"></a>
<span class="sourceLineNo">823</span> }<a name="line.823"></a>
<span class="sourceLineNo">824</span> source.replace(offset, offset + length, buf.toString());<a name="line.824"></a>
<span class="sourceLineNo">825</span> return true;<a name="line.825"></a>
<span class="sourceLineNo">826</span> }<a name="line.826"></a>
<span class="sourceLineNo">827</span><a name="line.827"></a>
<span class="sourceLineNo">828</span> //-----------------------------------------------------------------------<a name="line.828"></a>
<span class="sourceLineNo">829</span> /**<a name="line.829"></a>
<span class="sourceLineNo">830</span> * Replaces all the occurrences of variables within the given source<a name="line.830"></a>
<span class="sourceLineNo">831</span> * builder with their matching values from the resolver.<a name="line.831"></a>
<span class="sourceLineNo">832</span> *<a name="line.832"></a>
<span class="sourceLineNo">833</span> * @param source the builder to replace in, updated, null returns zero<a name="line.833"></a>
<span class="sourceLineNo">834</span> * @return true if altered<a name="line.834"></a>
<span class="sourceLineNo">835</span> */<a name="line.835"></a>
<span class="sourceLineNo">836</span> public boolean replaceIn(final StringBuilder source) {<a name="line.836"></a>
<span class="sourceLineNo">837</span> return replaceIn(null, source);<a name="line.837"></a>
<span class="sourceLineNo">838</span> }<a name="line.838"></a>
<span class="sourceLineNo">839</span><a name="line.839"></a>
<span class="sourceLineNo">840</span> //-----------------------------------------------------------------------<a name="line.840"></a>
<span class="sourceLineNo">841</span> /**<a name="line.841"></a>
<span class="sourceLineNo">842</span> * Replaces all the occurrences of variables within the given source<a name="line.842"></a>
<span class="sourceLineNo">843</span> * builder with their matching values from the resolver.<a name="line.843"></a>
<span class="sourceLineNo">844</span> *<a name="line.844"></a>
<span class="sourceLineNo">845</span> * @param event the current LogEvent, if one exists.<a name="line.845"></a>
<span class="sourceLineNo">846</span> * @param source the builder to replace in, updated, null returns zero<a name="line.846"></a>
<span class="sourceLineNo">847</span> * @return true if altered<a name="line.847"></a>
<span class="sourceLineNo">848</span> */<a name="line.848"></a>
<span class="sourceLineNo">849</span> public boolean replaceIn(final LogEvent event, final StringBuilder source) {<a name="line.849"></a>
<span class="sourceLineNo">850</span> if (source == null) {<a name="line.850"></a>
<span class="sourceLineNo">851</span> return false;<a name="line.851"></a>
<span class="sourceLineNo">852</span> }<a name="line.852"></a>
<span class="sourceLineNo">853</span> return substitute(event, source, 0, source.length());<a name="line.853"></a>
<span class="sourceLineNo">854</span> }<a name="line.854"></a>
<span class="sourceLineNo">855</span> /**<a name="line.855"></a>
<span class="sourceLineNo">856</span> * Replaces all the occurrences of variables within the given source<a name="line.856"></a>
<span class="sourceLineNo">857</span> * builder with their matching values from the resolver.<a name="line.857"></a>
<span class="sourceLineNo">858</span> * &lt;p&gt;<a name="line.858"></a>
<span class="sourceLineNo">859</span> * Only the specified portion of the builder will be processed.<a name="line.859"></a>
<span class="sourceLineNo">860</span> * The rest of the builder is not processed, but it is not deleted.<a name="line.860"></a>
<span class="sourceLineNo">861</span> * &lt;/p&gt;<a name="line.861"></a>
<span class="sourceLineNo">862</span> *<a name="line.862"></a>
<span class="sourceLineNo">863</span> * @param source the builder to replace in, null returns zero<a name="line.863"></a>
<span class="sourceLineNo">864</span> * @param offset the start offset within the array, must be valid<a name="line.864"></a>
<span class="sourceLineNo">865</span> * @param length the length within the builder to be processed, must be valid<a name="line.865"></a>
<span class="sourceLineNo">866</span> * @return true if altered<a name="line.866"></a>
<span class="sourceLineNo">867</span> */<a name="line.867"></a>
<span class="sourceLineNo">868</span> public boolean replaceIn(final StringBuilder source, final int offset, final int length) {<a name="line.868"></a>
<span class="sourceLineNo">869</span> return replaceIn(null, source, offset, length);<a name="line.869"></a>
<span class="sourceLineNo">870</span> }<a name="line.870"></a>
<span class="sourceLineNo">871</span><a name="line.871"></a>
<span class="sourceLineNo">872</span> /**<a name="line.872"></a>
<span class="sourceLineNo">873</span> * Replaces all the occurrences of variables within the given source<a name="line.873"></a>
<span class="sourceLineNo">874</span> * builder with their matching values from the resolver.<a name="line.874"></a>
<span class="sourceLineNo">875</span> * &lt;p&gt;<a name="line.875"></a>
<span class="sourceLineNo">876</span> * Only the specified portion of the builder will be processed.<a name="line.876"></a>
<span class="sourceLineNo">877</span> * The rest of the builder is not processed, but it is not deleted.<a name="line.877"></a>
<span class="sourceLineNo">878</span> * &lt;/p&gt;<a name="line.878"></a>
<span class="sourceLineNo">879</span> *<a name="line.879"></a>
<span class="sourceLineNo">880</span> * @param event the current LogEvent, if one is present.<a name="line.880"></a>
<span class="sourceLineNo">881</span> * @param source the builder to replace in, null returns zero<a name="line.881"></a>
<span class="sourceLineNo">882</span> * @param offset the start offset within the array, must be valid<a name="line.882"></a>
<span class="sourceLineNo">883</span> * @param length the length within the builder to be processed, must be valid<a name="line.883"></a>
<span class="sourceLineNo">884</span> * @return true if altered<a name="line.884"></a>
<span class="sourceLineNo">885</span> */<a name="line.885"></a>
<span class="sourceLineNo">886</span> public boolean replaceIn(final LogEvent event, final StringBuilder source, final int offset, final int length) {<a name="line.886"></a>
<span class="sourceLineNo">887</span> if (source == null) {<a name="line.887"></a>
<span class="sourceLineNo">888</span> return false;<a name="line.888"></a>
<span class="sourceLineNo">889</span> }<a name="line.889"></a>
<span class="sourceLineNo">890</span> return substitute(event, source, offset, length);<a name="line.890"></a>
<span class="sourceLineNo">891</span> }<a name="line.891"></a>
<span class="sourceLineNo">892</span><a name="line.892"></a>
<span class="sourceLineNo">893</span> //-----------------------------------------------------------------------<a name="line.893"></a>
<span class="sourceLineNo">894</span> /**<a name="line.894"></a>
<span class="sourceLineNo">895</span> * Internal method that substitutes the variables.<a name="line.895"></a>
<span class="sourceLineNo">896</span> * &lt;p&gt;<a name="line.896"></a>
<span class="sourceLineNo">897</span> * Most users of this class do not need to call this method. This method will<a name="line.897"></a>
<span class="sourceLineNo">898</span> * be called automatically by another (public) method.<a name="line.898"></a>
<span class="sourceLineNo">899</span> * &lt;/p&gt;<a name="line.899"></a>
<span class="sourceLineNo">900</span> * &lt;p&gt;<a name="line.900"></a>
<span class="sourceLineNo">901</span> * Writers of subclasses can override this method if they need access to<a name="line.901"></a>
<span class="sourceLineNo">902</span> * the substitution process at the start or end.<a name="line.902"></a>
<span class="sourceLineNo">903</span> * &lt;/p&gt;<a name="line.903"></a>
<span class="sourceLineNo">904</span> *<a name="line.904"></a>
<span class="sourceLineNo">905</span> * @param event The current LogEvent, if there is one.<a name="line.905"></a>
<span class="sourceLineNo">906</span> * @param buf the string builder to substitute into, not null<a name="line.906"></a>
<span class="sourceLineNo">907</span> * @param offset the start offset within the builder, must be valid<a name="line.907"></a>
<span class="sourceLineNo">908</span> * @param length the length within the builder to be processed, must be valid<a name="line.908"></a>
<span class="sourceLineNo">909</span> * @return true if altered<a name="line.909"></a>
<span class="sourceLineNo">910</span> */<a name="line.910"></a>
<span class="sourceLineNo">911</span> protected boolean substitute(final LogEvent event, final StringBuilder buf, final int offset, final int length) {<a name="line.911"></a>
<span class="sourceLineNo">912</span> return substitute(event, buf, offset, length, null) &gt; 0;<a name="line.912"></a>
<span class="sourceLineNo">913</span> }<a name="line.913"></a>
<span class="sourceLineNo">914</span><a name="line.914"></a>
<span class="sourceLineNo">915</span> /**<a name="line.915"></a>
<span class="sourceLineNo">916</span> * Recursive handler for multiple levels of interpolation. This is the main<a name="line.916"></a>
<span class="sourceLineNo">917</span> * interpolation method, which resolves the values of all variable references<a name="line.917"></a>
<span class="sourceLineNo">918</span> * contained in the passed in text.<a name="line.918"></a>
<span class="sourceLineNo">919</span> *<a name="line.919"></a>
<span class="sourceLineNo">920</span> * @param event The current LogEvent, if there is one.<a name="line.920"></a>
<span class="sourceLineNo">921</span> * @param buf the string builder to substitute into, not null<a name="line.921"></a>
<span class="sourceLineNo">922</span> * @param offset the start offset within the builder, must be valid<a name="line.922"></a>
<span class="sourceLineNo">923</span> * @param length the length within the builder to be processed, must be valid<a name="line.923"></a>
<span class="sourceLineNo">924</span> * @param priorVariables the stack keeping track of the replaced variables, may be null<a name="line.924"></a>
<span class="sourceLineNo">925</span> * @return the length change that occurs, unless priorVariables is null when the int<a name="line.925"></a>
<span class="sourceLineNo">926</span> * represents a boolean flag as to whether any change occurred.<a name="line.926"></a>
<span class="sourceLineNo">927</span> */<a name="line.927"></a>
<span class="sourceLineNo">928</span> private int substitute(final LogEvent event, final StringBuilder buf, final int offset, final int length,<a name="line.928"></a>
<span class="sourceLineNo">929</span> List&lt;String&gt; priorVariables) {<a name="line.929"></a>
<span class="sourceLineNo">930</span> final StrMatcher prefixMatcher = getVariablePrefixMatcher();<a name="line.930"></a>
<span class="sourceLineNo">931</span> final StrMatcher suffixMatcher = getVariableSuffixMatcher();<a name="line.931"></a>
<span class="sourceLineNo">932</span> final char escape = getEscapeChar();<a name="line.932"></a>
<span class="sourceLineNo">933</span> final StrMatcher valueDelimiterMatcher = getValueDelimiterMatcher();<a name="line.933"></a>
<span class="sourceLineNo">934</span> final boolean substitutionInVariablesEnabled = isEnableSubstitutionInVariables();<a name="line.934"></a>
<span class="sourceLineNo">935</span><a name="line.935"></a>
<span class="sourceLineNo">936</span> final boolean top = priorVariables == null;<a name="line.936"></a>
<span class="sourceLineNo">937</span> boolean altered = false;<a name="line.937"></a>
<span class="sourceLineNo">938</span> int lengthChange = 0;<a name="line.938"></a>
<span class="sourceLineNo">939</span> char[] chars = getChars(buf);<a name="line.939"></a>
<span class="sourceLineNo">940</span> int bufEnd = offset + length;<a name="line.940"></a>
<span class="sourceLineNo">941</span> int pos = offset;<a name="line.941"></a>
<span class="sourceLineNo">942</span> while (pos &lt; bufEnd) {<a name="line.942"></a>
<span class="sourceLineNo">943</span> final int startMatchLen = prefixMatcher.isMatch(chars, pos, offset, bufEnd);<a name="line.943"></a>
<span class="sourceLineNo">944</span> if (startMatchLen == 0) {<a name="line.944"></a>
<span class="sourceLineNo">945</span> pos++;<a name="line.945"></a>
<span class="sourceLineNo">946</span> } else {<a name="line.946"></a>
<span class="sourceLineNo">947</span> // found variable start marker<a name="line.947"></a>
<span class="sourceLineNo">948</span> if (pos &gt; offset &amp;&amp; chars[pos - 1] == escape) {<a name="line.948"></a>
<span class="sourceLineNo">949</span> // escaped<a name="line.949"></a>
<span class="sourceLineNo">950</span> buf.deleteCharAt(pos - 1);<a name="line.950"></a>
<span class="sourceLineNo">951</span> chars = getChars(buf);<a name="line.951"></a>
<span class="sourceLineNo">952</span> lengthChange--;<a name="line.952"></a>
<span class="sourceLineNo">953</span> altered = true;<a name="line.953"></a>
<span class="sourceLineNo">954</span> bufEnd--;<a name="line.954"></a>
<span class="sourceLineNo">955</span> } else {<a name="line.955"></a>
<span class="sourceLineNo">956</span> // find suffix<a name="line.956"></a>
<span class="sourceLineNo">957</span> final int startPos = pos;<a name="line.957"></a>
<span class="sourceLineNo">958</span> pos += startMatchLen;<a name="line.958"></a>
<span class="sourceLineNo">959</span> int endMatchLen = 0;<a name="line.959"></a>
<span class="sourceLineNo">960</span> int nestedVarCount = 0;<a name="line.960"></a>
<span class="sourceLineNo">961</span> while (pos &lt; bufEnd) {<a name="line.961"></a>
<span class="sourceLineNo">962</span> if (substitutionInVariablesEnabled<a name="line.962"></a>
<span class="sourceLineNo">963</span> &amp;&amp; (endMatchLen = prefixMatcher.isMatch(chars, pos, offset, bufEnd)) != 0) {<a name="line.963"></a>
<span class="sourceLineNo">964</span> // found a nested variable start<a name="line.964"></a>
<span class="sourceLineNo">965</span> nestedVarCount++;<a name="line.965"></a>
<span class="sourceLineNo">966</span> pos += endMatchLen;<a name="line.966"></a>
<span class="sourceLineNo">967</span> continue;<a name="line.967"></a>
<span class="sourceLineNo">968</span> }<a name="line.968"></a>
<span class="sourceLineNo">969</span><a name="line.969"></a>
<span class="sourceLineNo">970</span> endMatchLen = suffixMatcher.isMatch(chars, pos, offset, bufEnd);<a name="line.970"></a>
<span class="sourceLineNo">971</span> if (endMatchLen == 0) {<a name="line.971"></a>
<span class="sourceLineNo">972</span> pos++;<a name="line.972"></a>
<span class="sourceLineNo">973</span> } else {<a name="line.973"></a>
<span class="sourceLineNo">974</span> // found variable end marker<a name="line.974"></a>
<span class="sourceLineNo">975</span> if (nestedVarCount == 0) {<a name="line.975"></a>
<span class="sourceLineNo">976</span> String varNameExpr = new String(chars, startPos + startMatchLen, pos - startPos - startMatchLen);<a name="line.976"></a>
<span class="sourceLineNo">977</span> if (substitutionInVariablesEnabled) {<a name="line.977"></a>
<span class="sourceLineNo">978</span> final StringBuilder bufName = new StringBuilder(varNameExpr);<a name="line.978"></a>
<span class="sourceLineNo">979</span> substitute(event, bufName, 0, bufName.length());<a name="line.979"></a>
<span class="sourceLineNo">980</span> varNameExpr = bufName.toString();<a name="line.980"></a>
<span class="sourceLineNo">981</span> }<a name="line.981"></a>
<span class="sourceLineNo">982</span> pos += endMatchLen;<a name="line.982"></a>
<span class="sourceLineNo">983</span> final int endPos = pos;<a name="line.983"></a>
<span class="sourceLineNo">984</span><a name="line.984"></a>
<span class="sourceLineNo">985</span> String varName = varNameExpr;<a name="line.985"></a>
<span class="sourceLineNo">986</span> String varDefaultValue = null;<a name="line.986"></a>
<span class="sourceLineNo">987</span><a name="line.987"></a>
<span class="sourceLineNo">988</span> if (valueDelimiterMatcher != null) {<a name="line.988"></a>
<span class="sourceLineNo">989</span> final char [] varNameExprChars = varNameExpr.toCharArray();<a name="line.989"></a>
<span class="sourceLineNo">990</span> int valueDelimiterMatchLen = 0;<a name="line.990"></a>
<span class="sourceLineNo">991</span> for (int i = 0; i &lt; varNameExprChars.length; i++) {<a name="line.991"></a>
<span class="sourceLineNo">992</span> // if there's any nested variable when nested variable substitution disabled, then stop resolving name and default value.<a name="line.992"></a>
<span class="sourceLineNo">993</span> if (!substitutionInVariablesEnabled<a name="line.993"></a>
<span class="sourceLineNo">994</span> &amp;&amp; prefixMatcher.isMatch(varNameExprChars, i, i, varNameExprChars.length) != 0) {<a name="line.994"></a>
<span class="sourceLineNo">995</span> break;<a name="line.995"></a>
<span class="sourceLineNo">996</span> }<a name="line.996"></a>
<span class="sourceLineNo">997</span> if (valueEscapeDelimiterMatcher != null) {<a name="line.997"></a>
<span class="sourceLineNo">998</span> int matchLen = valueEscapeDelimiterMatcher.isMatch(varNameExprChars, i);<a name="line.998"></a>
<span class="sourceLineNo">999</span> if (matchLen != 0) {<a name="line.999"></a>
<span class="sourceLineNo">1000</span> String varNamePrefix = varNameExpr.substring(0, i) + Interpolator.PREFIX_SEPARATOR;<a name="line.1000"></a>
<span class="sourceLineNo">1001</span> varName = varNamePrefix + varNameExpr.substring(i + matchLen - 1);<a name="line.1001"></a>
<span class="sourceLineNo">1002</span> for (int j = i + matchLen; j &lt; varNameExprChars.length; ++j){<a name="line.1002"></a>
<span class="sourceLineNo">1003</span> if ((valueDelimiterMatchLen = valueDelimiterMatcher.isMatch(varNameExprChars, j)) != 0) {<a name="line.1003"></a>
<span class="sourceLineNo">1004</span> varName = varNamePrefix + varNameExpr.substring(i + matchLen, j);<a name="line.1004"></a>
<span class="sourceLineNo">1005</span> varDefaultValue = varNameExpr.substring(j + valueDelimiterMatchLen);<a name="line.1005"></a>
<span class="sourceLineNo">1006</span> break;<a name="line.1006"></a>
<span class="sourceLineNo">1007</span> }<a name="line.1007"></a>
<span class="sourceLineNo">1008</span> }<a name="line.1008"></a>
<span class="sourceLineNo">1009</span> break;<a name="line.1009"></a>
<span class="sourceLineNo">1010</span> } else {<a name="line.1010"></a>
<span class="sourceLineNo">1011</span> if ((valueDelimiterMatchLen = valueDelimiterMatcher.isMatch(varNameExprChars, i)) != 0) {<a name="line.1011"></a>
<span class="sourceLineNo">1012</span> varName = varNameExpr.substring(0, i);<a name="line.1012"></a>
<span class="sourceLineNo">1013</span> varDefaultValue = varNameExpr.substring(i + valueDelimiterMatchLen);<a name="line.1013"></a>
<span class="sourceLineNo">1014</span> break;<a name="line.1014"></a>
<span class="sourceLineNo">1015</span> }<a name="line.1015"></a>
<span class="sourceLineNo">1016</span> }<a name="line.1016"></a>
<span class="sourceLineNo">1017</span> } else {<a name="line.1017"></a>
<span class="sourceLineNo">1018</span> if ((valueDelimiterMatchLen = valueDelimiterMatcher.isMatch(varNameExprChars, i)) != 0) {<a name="line.1018"></a>
<span class="sourceLineNo">1019</span> varName = varNameExpr.substring(0, i);<a name="line.1019"></a>
<span class="sourceLineNo">1020</span> varDefaultValue = varNameExpr.substring(i + valueDelimiterMatchLen);<a name="line.1020"></a>
<span class="sourceLineNo">1021</span> break;<a name="line.1021"></a>
<span class="sourceLineNo">1022</span> }<a name="line.1022"></a>
<span class="sourceLineNo">1023</span> }<a name="line.1023"></a>
<span class="sourceLineNo">1024</span> }<a name="line.1024"></a>
<span class="sourceLineNo">1025</span> }<a name="line.1025"></a>
<span class="sourceLineNo">1026</span><a name="line.1026"></a>
<span class="sourceLineNo">1027</span> // on the first call initialize priorVariables<a name="line.1027"></a>
<span class="sourceLineNo">1028</span> if (priorVariables == null) {<a name="line.1028"></a>
<span class="sourceLineNo">1029</span> priorVariables = new ArrayList&lt;&gt;();<a name="line.1029"></a>
<span class="sourceLineNo">1030</span> priorVariables.add(new String(chars, offset, length + lengthChange));<a name="line.1030"></a>
<span class="sourceLineNo">1031</span> }<a name="line.1031"></a>
<span class="sourceLineNo">1032</span><a name="line.1032"></a>
<span class="sourceLineNo">1033</span> // handle cyclic substitution<a name="line.1033"></a>
<span class="sourceLineNo">1034</span> checkCyclicSubstitution(varName, priorVariables);<a name="line.1034"></a>
<span class="sourceLineNo">1035</span> priorVariables.add(varName);<a name="line.1035"></a>
<span class="sourceLineNo">1036</span><a name="line.1036"></a>
<span class="sourceLineNo">1037</span> // resolve the variable<a name="line.1037"></a>
<span class="sourceLineNo">1038</span> String varValue = resolveVariable(event, varName, buf, startPos, endPos);<a name="line.1038"></a>
<span class="sourceLineNo">1039</span> if (varValue == null) {<a name="line.1039"></a>
<span class="sourceLineNo">1040</span> varValue = varDefaultValue;<a name="line.1040"></a>
<span class="sourceLineNo">1041</span> }<a name="line.1041"></a>
<span class="sourceLineNo">1042</span> if (varValue != null) {<a name="line.1042"></a>
<span class="sourceLineNo">1043</span> // recursive replace<a name="line.1043"></a>
<span class="sourceLineNo">1044</span> final int varLen = varValue.length();<a name="line.1044"></a>
<span class="sourceLineNo">1045</span> buf.replace(startPos, endPos, varValue);<a name="line.1045"></a>
<span class="sourceLineNo">1046</span> altered = true;<a name="line.1046"></a>
<span class="sourceLineNo">1047</span> int change = substitute(event, buf, startPos, varLen, priorVariables);<a name="line.1047"></a>
<span class="sourceLineNo">1048</span> change = change + (varLen - (endPos - startPos));<a name="line.1048"></a>
<span class="sourceLineNo">1049</span> pos += change;<a name="line.1049"></a>
<span class="sourceLineNo">1050</span> bufEnd += change;<a name="line.1050"></a>
<span class="sourceLineNo">1051</span> lengthChange += change;<a name="line.1051"></a>
<span class="sourceLineNo">1052</span> chars = getChars(buf); // in case buffer was altered<a name="line.1052"></a>
<span class="sourceLineNo">1053</span> }<a name="line.1053"></a>
<span class="sourceLineNo">1054</span><a name="line.1054"></a>
<span class="sourceLineNo">1055</span> // remove variable from the cyclic stack<a name="line.1055"></a>
<span class="sourceLineNo">1056</span> priorVariables.remove(priorVariables.size() - 1);<a name="line.1056"></a>
<span class="sourceLineNo">1057</span> break;<a name="line.1057"></a>
<span class="sourceLineNo">1058</span> }<a name="line.1058"></a>
<span class="sourceLineNo">1059</span> nestedVarCount--;<a name="line.1059"></a>
<span class="sourceLineNo">1060</span> pos += endMatchLen;<a name="line.1060"></a>
<span class="sourceLineNo">1061</span> }<a name="line.1061"></a>
<span class="sourceLineNo">1062</span> }<a name="line.1062"></a>
<span class="sourceLineNo">1063</span> }<a name="line.1063"></a>
<span class="sourceLineNo">1064</span> }<a name="line.1064"></a>
<span class="sourceLineNo">1065</span> }<a name="line.1065"></a>
<span class="sourceLineNo">1066</span> if (top) {<a name="line.1066"></a>
<span class="sourceLineNo">1067</span> return altered ? 1 : 0;<a name="line.1067"></a>
<span class="sourceLineNo">1068</span> }<a name="line.1068"></a>
<span class="sourceLineNo">1069</span> return lengthChange;<a name="line.1069"></a>
<span class="sourceLineNo">1070</span> }<a name="line.1070"></a>
<span class="sourceLineNo">1071</span><a name="line.1071"></a>
<span class="sourceLineNo">1072</span> /**<a name="line.1072"></a>
<span class="sourceLineNo">1073</span> * Checks if the specified variable is already in the stack (list) of variables.<a name="line.1073"></a>
<span class="sourceLineNo">1074</span> *<a name="line.1074"></a>
<span class="sourceLineNo">1075</span> * @param varName the variable name to check<a name="line.1075"></a>
<span class="sourceLineNo">1076</span> * @param priorVariables the list of prior variables<a name="line.1076"></a>
<span class="sourceLineNo">1077</span> */<a name="line.1077"></a>
<span class="sourceLineNo">1078</span> private void checkCyclicSubstitution(final String varName, final List&lt;String&gt; priorVariables) {<a name="line.1078"></a>
<span class="sourceLineNo">1079</span> if (!priorVariables.contains(varName)) {<a name="line.1079"></a>
<span class="sourceLineNo">1080</span> return;<a name="line.1080"></a>
<span class="sourceLineNo">1081</span> }<a name="line.1081"></a>
<span class="sourceLineNo">1082</span> final StringBuilder buf = new StringBuilder(BUF_SIZE);<a name="line.1082"></a>
<span class="sourceLineNo">1083</span> buf.append("Infinite loop in property interpolation of ");<a name="line.1083"></a>
<span class="sourceLineNo">1084</span> buf.append(priorVariables.remove(0));<a name="line.1084"></a>
<span class="sourceLineNo">1085</span> buf.append(": ");<a name="line.1085"></a>
<span class="sourceLineNo">1086</span> appendWithSeparators(buf, priorVariables, "-&gt;");<a name="line.1086"></a>
<span class="sourceLineNo">1087</span> throw new IllegalStateException(buf.toString());<a name="line.1087"></a>
<span class="sourceLineNo">1088</span> }<a name="line.1088"></a>
<span class="sourceLineNo">1089</span><a name="line.1089"></a>
<span class="sourceLineNo">1090</span> /**<a name="line.1090"></a>
<span class="sourceLineNo">1091</span> * Internal method that resolves the value of a variable.<a name="line.1091"></a>
<span class="sourceLineNo">1092</span> * &lt;p&gt;<a name="line.1092"></a>
<span class="sourceLineNo">1093</span> * Most users of this class do not need to call this method. This method is<a name="line.1093"></a>
<span class="sourceLineNo">1094</span> * called automatically by the substitution process.<a name="line.1094"></a>
<span class="sourceLineNo">1095</span> * &lt;/p&gt;<a name="line.1095"></a>
<span class="sourceLineNo">1096</span> * &lt;p&gt;<a name="line.1096"></a>
<span class="sourceLineNo">1097</span> * Writers of subclasses can override this method if they need to alter<a name="line.1097"></a>
<span class="sourceLineNo">1098</span> * how each substitution occurs. The method is passed the variable's name<a name="line.1098"></a>
<span class="sourceLineNo">1099</span> * and must return the corresponding value. This implementation uses the<a name="line.1099"></a>
<span class="sourceLineNo">1100</span> * {@link #getVariableResolver()} with the variable's name as the key.<a name="line.1100"></a>
<span class="sourceLineNo">1101</span> * &lt;/p&gt;<a name="line.1101"></a>
<span class="sourceLineNo">1102</span> *<a name="line.1102"></a>
<span class="sourceLineNo">1103</span> * @param event The LogEvent, if there is one.<a name="line.1103"></a>
<span class="sourceLineNo">1104</span> * @param variableName the name of the variable, not null<a name="line.1104"></a>
<span class="sourceLineNo">1105</span> * @param buf the buffer where the substitution is occurring, not null<a name="line.1105"></a>
<span class="sourceLineNo">1106</span> * @param startPos the start position of the variable including the prefix, valid<a name="line.1106"></a>
<span class="sourceLineNo">1107</span> * @param endPos the end position of the variable including the suffix, valid<a name="line.1107"></a>
<span class="sourceLineNo">1108</span> * @return the variable's value or &lt;b&gt;null&lt;/b&gt; if the variable is unknown<a name="line.1108"></a>
<span class="sourceLineNo">1109</span> */<a name="line.1109"></a>
<span class="sourceLineNo">1110</span> protected String resolveVariable(final LogEvent event, final String variableName, final StringBuilder buf,<a name="line.1110"></a>
<span class="sourceLineNo">1111</span> final int startPos, final int endPos) {<a name="line.1111"></a>
<span class="sourceLineNo">1112</span> final StrLookup resolver = getVariableResolver();<a name="line.1112"></a>
<span class="sourceLineNo">1113</span> if (resolver == null) {<a name="line.1113"></a>
<span class="sourceLineNo">1114</span> return null;<a name="line.1114"></a>
<span class="sourceLineNo">1115</span> }<a name="line.1115"></a>
<span class="sourceLineNo">1116</span> return resolver.lookup(event, variableName);<a name="line.1116"></a>
<span class="sourceLineNo">1117</span> }<a name="line.1117"></a>
<span class="sourceLineNo">1118</span><a name="line.1118"></a>
<span class="sourceLineNo">1119</span> // Escape<a name="line.1119"></a>
<span class="sourceLineNo">1120</span> //-----------------------------------------------------------------------<a name="line.1120"></a>
<span class="sourceLineNo">1121</span> /**<a name="line.1121"></a>
<span class="sourceLineNo">1122</span> * Returns the escape character.<a name="line.1122"></a>
<span class="sourceLineNo">1123</span> *<a name="line.1123"></a>
<span class="sourceLineNo">1124</span> * @return the character used for escaping variable references<a name="line.1124"></a>
<span class="sourceLineNo">1125</span> */<a name="line.1125"></a>
<span class="sourceLineNo">1126</span> public char getEscapeChar() {<a name="line.1126"></a>
<span class="sourceLineNo">1127</span> return this.escapeChar;<a name="line.1127"></a>
<span class="sourceLineNo">1128</span> }<a name="line.1128"></a>
<span class="sourceLineNo">1129</span><a name="line.1129"></a>
<span class="sourceLineNo">1130</span> /**<a name="line.1130"></a>
<span class="sourceLineNo">1131</span> * Sets the escape character.<a name="line.1131"></a>
<span class="sourceLineNo">1132</span> * If this character is placed before a variable reference in the source<a name="line.1132"></a>
<span class="sourceLineNo">1133</span> * text, this variable will be ignored.<a name="line.1133"></a>
<span class="sourceLineNo">1134</span> *<a name="line.1134"></a>
<span class="sourceLineNo">1135</span> * @param escapeCharacter the escape character (0 for disabling escaping)<a name="line.1135"></a>
<span class="sourceLineNo">1136</span> */<a name="line.1136"></a>
<span class="sourceLineNo">1137</span> public void setEscapeChar(final char escapeCharacter) {<a name="line.1137"></a>
<span class="sourceLineNo">1138</span> this.escapeChar = escapeCharacter;<a name="line.1138"></a>
<span class="sourceLineNo">1139</span> }<a name="line.1139"></a>
<span class="sourceLineNo">1140</span><a name="line.1140"></a>
<span class="sourceLineNo">1141</span> // Prefix<a name="line.1141"></a>
<span class="sourceLineNo">1142</span> //-----------------------------------------------------------------------<a name="line.1142"></a>
<span class="sourceLineNo">1143</span> /**<a name="line.1143"></a>
<span class="sourceLineNo">1144</span> * Gets the variable prefix matcher currently in use.<a name="line.1144"></a>
<span class="sourceLineNo">1145</span> * &lt;p&gt;<a name="line.1145"></a>
<span class="sourceLineNo">1146</span> * The variable prefix is the character or characters that identify the<a name="line.1146"></a>
<span class="sourceLineNo">1147</span> * start of a variable. This prefix is expressed in terms of a matcher<a name="line.1147"></a>
<span class="sourceLineNo">1148</span> * allowing advanced prefix matches.<a name="line.1148"></a>
<span class="sourceLineNo">1149</span> * &lt;/p&gt;<a name="line.1149"></a>
<span class="sourceLineNo">1150</span> *<a name="line.1150"></a>
<span class="sourceLineNo">1151</span> * @return the prefix matcher in use<a name="line.1151"></a>
<span class="sourceLineNo">1152</span> */<a name="line.1152"></a>
<span class="sourceLineNo">1153</span> public StrMatcher getVariablePrefixMatcher() {<a name="line.1153"></a>
<span class="sourceLineNo">1154</span> return prefixMatcher;<a name="line.1154"></a>
<span class="sourceLineNo">1155</span> }<a name="line.1155"></a>
<span class="sourceLineNo">1156</span><a name="line.1156"></a>
<span class="sourceLineNo">1157</span> /**<a name="line.1157"></a>
<span class="sourceLineNo">1158</span> * Sets the variable prefix matcher currently in use.<a name="line.1158"></a>
<span class="sourceLineNo">1159</span> * &lt;p&gt;<a name="line.1159"></a>
<span class="sourceLineNo">1160</span> * The variable prefix is the character or characters that identify the<a name="line.1160"></a>
<span class="sourceLineNo">1161</span> * start of a variable. This prefix is expressed in terms of a matcher<a name="line.1161"></a>
<span class="sourceLineNo">1162</span> * allowing advanced prefix matches.<a name="line.1162"></a>
<span class="sourceLineNo">1163</span> * &lt;/p&gt;<a name="line.1163"></a>
<span class="sourceLineNo">1164</span> *<a name="line.1164"></a>
<span class="sourceLineNo">1165</span> * @param prefixMatcher the prefix matcher to use, null ignored<a name="line.1165"></a>
<span class="sourceLineNo">1166</span> * @return this, to enable chaining<a name="line.1166"></a>
<span class="sourceLineNo">1167</span> * @throws IllegalArgumentException if the prefix matcher is null<a name="line.1167"></a>
<span class="sourceLineNo">1168</span> */<a name="line.1168"></a>
<span class="sourceLineNo">1169</span> public StrSubstitutor setVariablePrefixMatcher(final StrMatcher prefixMatcher) {<a name="line.1169"></a>
<span class="sourceLineNo">1170</span> if (prefixMatcher == null) {<a name="line.1170"></a>
<span class="sourceLineNo">1171</span> throw new IllegalArgumentException("Variable prefix matcher must not be null!");<a name="line.1171"></a>
<span class="sourceLineNo">1172</span> }<a name="line.1172"></a>
<span class="sourceLineNo">1173</span> this.prefixMatcher = prefixMatcher;<a name="line.1173"></a>
<span class="sourceLineNo">1174</span> return this;<a name="line.1174"></a>
<span class="sourceLineNo">1175</span> }<a name="line.1175"></a>
<span class="sourceLineNo">1176</span><a name="line.1176"></a>
<span class="sourceLineNo">1177</span> /**<a name="line.1177"></a>
<span class="sourceLineNo">1178</span> * Sets the variable prefix to use.<a name="line.1178"></a>
<span class="sourceLineNo">1179</span> * &lt;p&gt;<a name="line.1179"></a>
<span class="sourceLineNo">1180</span> * The variable prefix is the character or characters that identify the<a name="line.1180"></a>
<span class="sourceLineNo">1181</span> * start of a variable. This method allows a single character prefix to<a name="line.1181"></a>
<span class="sourceLineNo">1182</span> * be easily set.<a name="line.1182"></a>
<span class="sourceLineNo">1183</span> * &lt;/p&gt;<a name="line.1183"></a>
<span class="sourceLineNo">1184</span> *<a name="line.1184"></a>
<span class="sourceLineNo">1185</span> * @param prefix the prefix character to use<a name="line.1185"></a>
<span class="sourceLineNo">1186</span> * @return this, to enable chaining<a name="line.1186"></a>
<span class="sourceLineNo">1187</span> */<a name="line.1187"></a>
<span class="sourceLineNo">1188</span> public StrSubstitutor setVariablePrefix(final char prefix) {<a name="line.1188"></a>
<span class="sourceLineNo">1189</span> return setVariablePrefixMatcher(StrMatcher.charMatcher(prefix));<a name="line.1189"></a>
<span class="sourceLineNo">1190</span> }<a name="line.1190"></a>
<span class="sourceLineNo">1191</span><a name="line.1191"></a>
<span class="sourceLineNo">1192</span> /**<a name="line.1192"></a>
<span class="sourceLineNo">1193</span> * Sets the variable prefix to use.<a name="line.1193"></a>
<span class="sourceLineNo">1194</span> * &lt;p&gt;<a name="line.1194"></a>
<span class="sourceLineNo">1195</span> * The variable prefix is the character or characters that identify the<a name="line.1195"></a>
<span class="sourceLineNo">1196</span> * start of a variable. This method allows a string prefix to be easily set.<a name="line.1196"></a>
<span class="sourceLineNo">1197</span> * &lt;/p&gt;<a name="line.1197"></a>
<span class="sourceLineNo">1198</span> *<a name="line.1198"></a>
<span class="sourceLineNo">1199</span> * @param prefix the prefix for variables, not null<a name="line.1199"></a>
<span class="sourceLineNo">1200</span> * @return this, to enable chaining<a name="line.1200"></a>
<span class="sourceLineNo">1201</span> * @throws IllegalArgumentException if the prefix is null<a name="line.1201"></a>
<span class="sourceLineNo">1202</span> */<a name="line.1202"></a>
<span class="sourceLineNo">1203</span> public StrSubstitutor setVariablePrefix(final String prefix) {<a name="line.1203"></a>
<span class="sourceLineNo">1204</span> if (prefix == null) {<a name="line.1204"></a>
<span class="sourceLineNo">1205</span> throw new IllegalArgumentException("Variable prefix must not be null!");<a name="line.1205"></a>
<span class="sourceLineNo">1206</span> }<a name="line.1206"></a>
<span class="sourceLineNo">1207</span> return setVariablePrefixMatcher(StrMatcher.stringMatcher(prefix));<a name="line.1207"></a>
<span class="sourceLineNo">1208</span> }<a name="line.1208"></a>
<span class="sourceLineNo">1209</span><a name="line.1209"></a>
<span class="sourceLineNo">1210</span> // Suffix<a name="line.1210"></a>
<span class="sourceLineNo">1211</span> //-----------------------------------------------------------------------<a name="line.1211"></a>
<span class="sourceLineNo">1212</span> /**<a name="line.1212"></a>
<span class="sourceLineNo">1213</span> * Gets the variable suffix matcher currently in use.<a name="line.1213"></a>
<span class="sourceLineNo">1214</span> * &lt;p&gt;<a name="line.1214"></a>
<span class="sourceLineNo">1215</span> * The variable suffix is the character or characters that identify the<a name="line.1215"></a>
<span class="sourceLineNo">1216</span> * end of a variable. This suffix is expressed in terms of a matcher<a name="line.1216"></a>
<span class="sourceLineNo">1217</span> * allowing advanced suffix matches.<a name="line.1217"></a>
<span class="sourceLineNo">1218</span> * &lt;/p&gt;<a name="line.1218"></a>
<span class="sourceLineNo">1219</span> *<a name="line.1219"></a>
<span class="sourceLineNo">1220</span> * @return the suffix matcher in use<a name="line.1220"></a>
<span class="sourceLineNo">1221</span> */<a name="line.1221"></a>
<span class="sourceLineNo">1222</span> public StrMatcher getVariableSuffixMatcher() {<a name="line.1222"></a>
<span class="sourceLineNo">1223</span> return suffixMatcher;<a name="line.1223"></a>
<span class="sourceLineNo">1224</span> }<a name="line.1224"></a>
<span class="sourceLineNo">1225</span><a name="line.1225"></a>
<span class="sourceLineNo">1226</span> /**<a name="line.1226"></a>
<span class="sourceLineNo">1227</span> * Sets the variable suffix matcher currently in use.<a name="line.1227"></a>
<span class="sourceLineNo">1228</span> * &lt;p&gt;<a name="line.1228"></a>
<span class="sourceLineNo">1229</span> * The variable suffix is the character or characters that identify the<a name="line.1229"></a>
<span class="sourceLineNo">1230</span> * end of a variable. This suffix is expressed in terms of a matcher<a name="line.1230"></a>
<span class="sourceLineNo">1231</span> * allowing advanced suffix matches.<a name="line.1231"></a>
<span class="sourceLineNo">1232</span> * &lt;/p&gt;<a name="line.1232"></a>
<span class="sourceLineNo">1233</span> *<a name="line.1233"></a>
<span class="sourceLineNo">1234</span> * @param suffixMatcher the suffix matcher to use, null ignored<a name="line.1234"></a>
<span class="sourceLineNo">1235</span> * @return this, to enable chaining<a name="line.1235"></a>
<span class="sourceLineNo">1236</span> * @throws IllegalArgumentException if the suffix matcher is null<a name="line.1236"></a>
<span class="sourceLineNo">1237</span> */<a name="line.1237"></a>
<span class="sourceLineNo">1238</span> public StrSubstitutor setVariableSuffixMatcher(final StrMatcher suffixMatcher) {<a name="line.1238"></a>
<span class="sourceLineNo">1239</span> if (suffixMatcher == null) {<a name="line.1239"></a>
<span class="sourceLineNo">1240</span> throw new IllegalArgumentException("Variable suffix matcher must not be null!");<a name="line.1240"></a>
<span class="sourceLineNo">1241</span> }<a name="line.1241"></a>
<span class="sourceLineNo">1242</span> this.suffixMatcher = suffixMatcher;<a name="line.1242"></a>
<span class="sourceLineNo">1243</span> return this;<a name="line.1243"></a>
<span class="sourceLineNo">1244</span> }<a name="line.1244"></a>
<span class="sourceLineNo">1245</span><a name="line.1245"></a>
<span class="sourceLineNo">1246</span> /**<a name="line.1246"></a>
<span class="sourceLineNo">1247</span> * Sets the variable suffix to use.<a name="line.1247"></a>
<span class="sourceLineNo">1248</span> * &lt;p&gt;<a name="line.1248"></a>
<span class="sourceLineNo">1249</span> * The variable suffix is the character or characters that identify the<a name="line.1249"></a>
<span class="sourceLineNo">1250</span> * end of a variable. This method allows a single character suffix to<a name="line.1250"></a>
<span class="sourceLineNo">1251</span> * be easily set.<a name="line.1251"></a>
<span class="sourceLineNo">1252</span> * &lt;/p&gt;<a name="line.1252"></a>
<span class="sourceLineNo">1253</span> *<a name="line.1253"></a>
<span class="sourceLineNo">1254</span> * @param suffix the suffix character to use<a name="line.1254"></a>
<span class="sourceLineNo">1255</span> * @return this, to enable chaining<a name="line.1255"></a>
<span class="sourceLineNo">1256</span> */<a name="line.1256"></a>
<span class="sourceLineNo">1257</span> public StrSubstitutor setVariableSuffix(final char suffix) {<a name="line.1257"></a>
<span class="sourceLineNo">1258</span> return setVariableSuffixMatcher(StrMatcher.charMatcher(suffix));<a name="line.1258"></a>
<span class="sourceLineNo">1259</span> }<a name="line.1259"></a>
<span class="sourceLineNo">1260</span><a name="line.1260"></a>
<span class="sourceLineNo">1261</span> /**<a name="line.1261"></a>
<span class="sourceLineNo">1262</span> * Sets the variable suffix to use.<a name="line.1262"></a>
<span class="sourceLineNo">1263</span> * &lt;p&gt;<a name="line.1263"></a>
<span class="sourceLineNo">1264</span> * The variable suffix is the character or characters that identify the<a name="line.1264"></a>
<span class="sourceLineNo">1265</span> * end of a variable. This method allows a string suffix to be easily set.<a name="line.1265"></a>
<span class="sourceLineNo">1266</span> * &lt;/p&gt;<a name="line.1266"></a>
<span class="sourceLineNo">1267</span> *<a name="line.1267"></a>
<span class="sourceLineNo">1268</span> * @param suffix the suffix for variables, not null<a name="line.1268"></a>
<span class="sourceLineNo">1269</span> * @return this, to enable chaining<a name="line.1269"></a>
<span class="sourceLineNo">1270</span> * @throws IllegalArgumentException if the suffix is null<a name="line.1270"></a>
<span class="sourceLineNo">1271</span> */<a name="line.1271"></a>
<span class="sourceLineNo">1272</span> public StrSubstitutor setVariableSuffix(final String suffix) {<a name="line.1272"></a>
<span class="sourceLineNo">1273</span> if (suffix == null) {<a name="line.1273"></a>
<span class="sourceLineNo">1274</span> throw new IllegalArgumentException("Variable suffix must not be null!");<a name="line.1274"></a>
<span class="sourceLineNo">1275</span> }<a name="line.1275"></a>
<span class="sourceLineNo">1276</span> return setVariableSuffixMatcher(StrMatcher.stringMatcher(suffix));<a name="line.1276"></a>
<span class="sourceLineNo">1277</span> }<a name="line.1277"></a>
<span class="sourceLineNo">1278</span><a name="line.1278"></a>
<span class="sourceLineNo">1279</span> // Variable Default Value Delimiter<a name="line.1279"></a>
<span class="sourceLineNo">1280</span> //-----------------------------------------------------------------------<a name="line.1280"></a>
<span class="sourceLineNo">1281</span> /**<a name="line.1281"></a>
<span class="sourceLineNo">1282</span> * Gets the variable default value delimiter matcher currently in use.<a name="line.1282"></a>
<span class="sourceLineNo">1283</span> * &lt;p&gt;<a name="line.1283"></a>
<span class="sourceLineNo">1284</span> * The variable default value delimiter is the character or characters that delimit the<a name="line.1284"></a>
<span class="sourceLineNo">1285</span> * variable name and the variable default value. This delimiter is expressed in terms of a matcher<a name="line.1285"></a>
<span class="sourceLineNo">1286</span> * allowing advanced variable default value delimiter matches.<a name="line.1286"></a>
<span class="sourceLineNo">1287</span> * &lt;/p&gt;<a name="line.1287"></a>
<span class="sourceLineNo">1288</span> * &lt;p&gt;<a name="line.1288"></a>
<span class="sourceLineNo">1289</span> * If it returns null, then the variable default value resolution is disabled.<a name="line.1289"></a>
<span class="sourceLineNo">1290</span> * &lt;/p&gt;<a name="line.1290"></a>
<span class="sourceLineNo">1291</span> *<a name="line.1291"></a>
<span class="sourceLineNo">1292</span> * @return the variable default value delimiter matcher in use, may be null<a name="line.1292"></a>
<span class="sourceLineNo">1293</span> */<a name="line.1293"></a>
<span class="sourceLineNo">1294</span> public StrMatcher getValueDelimiterMatcher() {<a name="line.1294"></a>
<span class="sourceLineNo">1295</span> return valueDelimiterMatcher;<a name="line.1295"></a>
<span class="sourceLineNo">1296</span> }<a name="line.1296"></a>
<span class="sourceLineNo">1297</span><a name="line.1297"></a>
<span class="sourceLineNo">1298</span> /**<a name="line.1298"></a>
<span class="sourceLineNo">1299</span> * Sets the variable default value delimiter matcher to use.<a name="line.1299"></a>
<span class="sourceLineNo">1300</span> * &lt;p&gt;<a name="line.1300"></a>
<span class="sourceLineNo">1301</span> * The variable default value delimiter is the character or characters that delimit the<a name="line.1301"></a>
<span class="sourceLineNo">1302</span> * variable name and the variable default value. This delimiter is expressed in terms of a matcher<a name="line.1302"></a>
<span class="sourceLineNo">1303</span> * allowing advanced variable default value delimiter matches.<a name="line.1303"></a>
<span class="sourceLineNo">1304</span> * &lt;/p&gt;<a name="line.1304"></a>
<span class="sourceLineNo">1305</span> * &lt;p&gt;<a name="line.1305"></a>
<span class="sourceLineNo">1306</span> * If the &lt;code&gt;valueDelimiterMatcher&lt;/code&gt; is null, then the variable default value resolution<a name="line.1306"></a>
<span class="sourceLineNo">1307</span> * becomes disabled.<a name="line.1307"></a>
<span class="sourceLineNo">1308</span> * &lt;/p&gt;<a name="line.1308"></a>
<span class="sourceLineNo">1309</span> *<a name="line.1309"></a>
<span class="sourceLineNo">1310</span> * @param valueDelimiterMatcher variable default value delimiter matcher to use, may be null<a name="line.1310"></a>
<span class="sourceLineNo">1311</span> * @return this, to enable chaining<a name="line.1311"></a>
<span class="sourceLineNo">1312</span> */<a name="line.1312"></a>
<span class="sourceLineNo">1313</span> public StrSubstitutor setValueDelimiterMatcher(final StrMatcher valueDelimiterMatcher) {<a name="line.1313"></a>
<span class="sourceLineNo">1314</span> this.valueDelimiterMatcher = valueDelimiterMatcher;<a name="line.1314"></a>
<span class="sourceLineNo">1315</span> return this;<a name="line.1315"></a>
<span class="sourceLineNo">1316</span> }<a name="line.1316"></a>
<span class="sourceLineNo">1317</span><a name="line.1317"></a>
<span class="sourceLineNo">1318</span> /**<a name="line.1318"></a>
<span class="sourceLineNo">1319</span> * Sets the variable default value delimiter to use.<a name="line.1319"></a>
<span class="sourceLineNo">1320</span> * &lt;p&gt;<a name="line.1320"></a>
<span class="sourceLineNo">1321</span> * The variable default value delimiter is the character or characters that delimit the<a name="line.1321"></a>
<span class="sourceLineNo">1322</span> * variable name and the variable default value. This method allows a single character<a name="line.1322"></a>
<span class="sourceLineNo">1323</span> * variable default value delimiter to be easily set.<a name="line.1323"></a>
<span class="sourceLineNo">1324</span> * &lt;/p&gt;<a name="line.1324"></a>
<span class="sourceLineNo">1325</span> *<a name="line.1325"></a>
<span class="sourceLineNo">1326</span> * @param valueDelimiter the variable default value delimiter character to use<a name="line.1326"></a>
<span class="sourceLineNo">1327</span> * @return this, to enable chaining<a name="line.1327"></a>
<span class="sourceLineNo">1328</span> */<a name="line.1328"></a>
<span class="sourceLineNo">1329</span> public StrSubstitutor setValueDelimiter(final char valueDelimiter) {<a name="line.1329"></a>
<span class="sourceLineNo">1330</span> return setValueDelimiterMatcher(StrMatcher.charMatcher(valueDelimiter));<a name="line.1330"></a>
<span class="sourceLineNo">1331</span> }<a name="line.1331"></a>
<span class="sourceLineNo">1332</span><a name="line.1332"></a>
<span class="sourceLineNo">1333</span> /**<a name="line.1333"></a>
<span class="sourceLineNo">1334</span> * Sets the variable default value delimiter to use.<a name="line.1334"></a>
<span class="sourceLineNo">1335</span> * &lt;p&gt;<a name="line.1335"></a>
<span class="sourceLineNo">1336</span> * The variable default value delimiter is the character or characters that delimit the<a name="line.1336"></a>
<span class="sourceLineNo">1337</span> * variable name and the variable default value. This method allows a string<a name="line.1337"></a>
<span class="sourceLineNo">1338</span> * variable default value delimiter to be easily set.<a name="line.1338"></a>
<span class="sourceLineNo">1339</span> * &lt;/p&gt;<a name="line.1339"></a>
<span class="sourceLineNo">1340</span> * &lt;p&gt;<a name="line.1340"></a>
<span class="sourceLineNo">1341</span> * If the &lt;code&gt;valueDelimiter&lt;/code&gt; is null or empty string, then the variable default<a name="line.1341"></a>
<span class="sourceLineNo">1342</span> * value resolution becomes disabled.<a name="line.1342"></a>
<span class="sourceLineNo">1343</span> * &lt;/p&gt;<a name="line.1343"></a>
<span class="sourceLineNo">1344</span> *<a name="line.1344"></a>
<span class="sourceLineNo">1345</span> * @param valueDelimiter the variable default value delimiter string to use, may be null or empty<a name="line.1345"></a>
<span class="sourceLineNo">1346</span> * @return this, to enable chaining<a name="line.1346"></a>
<span class="sourceLineNo">1347</span> */<a name="line.1347"></a>
<span class="sourceLineNo">1348</span> public StrSubstitutor setValueDelimiter(final String valueDelimiter) {<a name="line.1348"></a>
<span class="sourceLineNo">1349</span> if (Strings.isEmpty(valueDelimiter)) {<a name="line.1349"></a>
<span class="sourceLineNo">1350</span> setValueDelimiterMatcher(null);<a name="line.1350"></a>
<span class="sourceLineNo">1351</span> return this;<a name="line.1351"></a>
<span class="sourceLineNo">1352</span> }<a name="line.1352"></a>
<span class="sourceLineNo">1353</span> String escapeValue = valueDelimiter.substring(0, valueDelimiter.length() - 1) + "\\"<a name="line.1353"></a>
<span class="sourceLineNo">1354</span> + valueDelimiter.substring(valueDelimiter.length() - 1);<a name="line.1354"></a>
<span class="sourceLineNo">1355</span> valueEscapeDelimiterMatcher = StrMatcher.stringMatcher(escapeValue);<a name="line.1355"></a>
<span class="sourceLineNo">1356</span> return setValueDelimiterMatcher(StrMatcher.stringMatcher(valueDelimiter));<a name="line.1356"></a>
<span class="sourceLineNo">1357</span> }<a name="line.1357"></a>
<span class="sourceLineNo">1358</span><a name="line.1358"></a>
<span class="sourceLineNo">1359</span> // Resolver<a name="line.1359"></a>
<span class="sourceLineNo">1360</span> //-----------------------------------------------------------------------<a name="line.1360"></a>
<span class="sourceLineNo">1361</span> /**<a name="line.1361"></a>
<span class="sourceLineNo">1362</span> * Gets the VariableResolver that is used to lookup variables.<a name="line.1362"></a>
<span class="sourceLineNo">1363</span> *<a name="line.1363"></a>
<span class="sourceLineNo">1364</span> * @return the VariableResolver<a name="line.1364"></a>
<span class="sourceLineNo">1365</span> */<a name="line.1365"></a>
<span class="sourceLineNo">1366</span> public StrLookup getVariableResolver() {<a name="line.1366"></a>
<span class="sourceLineNo">1367</span> return this.variableResolver;<a name="line.1367"></a>
<span class="sourceLineNo">1368</span> }<a name="line.1368"></a>
<span class="sourceLineNo">1369</span><a name="line.1369"></a>
<span class="sourceLineNo">1370</span> /**<a name="line.1370"></a>
<span class="sourceLineNo">1371</span> * Sets the VariableResolver that is used to lookup variables.<a name="line.1371"></a>
<span class="sourceLineNo">1372</span> *<a name="line.1372"></a>
<span class="sourceLineNo">1373</span> * @param variableResolver the VariableResolver<a name="line.1373"></a>
<span class="sourceLineNo">1374</span> */<a name="line.1374"></a>
<span class="sourceLineNo">1375</span> public void setVariableResolver(final StrLookup variableResolver) {<a name="line.1375"></a>
<span class="sourceLineNo">1376</span> if (variableResolver instanceof ConfigurationAware &amp;&amp; this.configuration != null) {<a name="line.1376"></a>
<span class="sourceLineNo">1377</span> ((ConfigurationAware) variableResolver).setConfiguration(this.configuration);<a name="line.1377"></a>
<span class="sourceLineNo">1378</span> }<a name="line.1378"></a>
<span class="sourceLineNo">1379</span> this.variableResolver = variableResolver;<a name="line.1379"></a>
<span class="sourceLineNo">1380</span> }<a name="line.1380"></a>
<span class="sourceLineNo">1381</span><a name="line.1381"></a>
<span class="sourceLineNo">1382</span> // Substitution support in variable names<a name="line.1382"></a>
<span class="sourceLineNo">1383</span> //-----------------------------------------------------------------------<a name="line.1383"></a>
<span class="sourceLineNo">1384</span> /**<a name="line.1384"></a>
<span class="sourceLineNo">1385</span> * Returns a flag whether substitution is done in variable names.<a name="line.1385"></a>
<span class="sourceLineNo">1386</span> *<a name="line.1386"></a>
<span class="sourceLineNo">1387</span> * @return the substitution in variable names flag<a name="line.1387"></a>
<span class="sourceLineNo">1388</span> */<a name="line.1388"></a>
<span class="sourceLineNo">1389</span> public boolean isEnableSubstitutionInVariables() {<a name="line.1389"></a>
<span class="sourceLineNo">1390</span> return enableSubstitutionInVariables;<a name="line.1390"></a>
<span class="sourceLineNo">1391</span> }<a name="line.1391"></a>
<span class="sourceLineNo">1392</span><a name="line.1392"></a>
<span class="sourceLineNo">1393</span> /**<a name="line.1393"></a>
<span class="sourceLineNo">1394</span> * Sets a flag whether substitution is done in variable names. If set to<a name="line.1394"></a>
<span class="sourceLineNo">1395</span> * &lt;b&gt;true&lt;/b&gt;, the names of variables can contain other variables which are<a name="line.1395"></a>
<span class="sourceLineNo">1396</span> * processed first before the original variable is evaluated, e.g.<a name="line.1396"></a>
<span class="sourceLineNo">1397</span> * &lt;code&gt;${jre-${java.version}}&lt;/code&gt;. The default value is &lt;b&gt;true&lt;/b&gt;.<a name="line.1397"></a>
<span class="sourceLineNo">1398</span> *<a name="line.1398"></a>
<span class="sourceLineNo">1399</span> * @param enableSubstitutionInVariables the new value of the flag<a name="line.1399"></a>
<span class="sourceLineNo">1400</span> */<a name="line.1400"></a>
<span class="sourceLineNo">1401</span> public void setEnableSubstitutionInVariables(final boolean enableSubstitutionInVariables) {<a name="line.1401"></a>
<span class="sourceLineNo">1402</span> this.enableSubstitutionInVariables = enableSubstitutionInVariables;<a name="line.1402"></a>
<span class="sourceLineNo">1403</span> }<a name="line.1403"></a>
<span class="sourceLineNo">1404</span><a name="line.1404"></a>
<span class="sourceLineNo">1405</span> private char[] getChars(final StringBuilder sb) {<a name="line.1405"></a>
<span class="sourceLineNo">1406</span> final char[] chars = new char[sb.length()];<a name="line.1406"></a>
<span class="sourceLineNo">1407</span> sb.getChars(0, sb.length(), chars, 0);<a name="line.1407"></a>
<span class="sourceLineNo">1408</span> return chars;<a name="line.1408"></a>
<span class="sourceLineNo">1409</span> }<a name="line.1409"></a>
<span class="sourceLineNo">1410</span><a name="line.1410"></a>
<span class="sourceLineNo">1411</span> /**<a name="line.1411"></a>
<span class="sourceLineNo">1412</span> * Appends a iterable placing separators between each value, but<a name="line.1412"></a>
<span class="sourceLineNo">1413</span> * not before the first or after the last.<a name="line.1413"></a>
<span class="sourceLineNo">1414</span> * Appending a null iterable will have no effect..<a name="line.1414"></a>
<span class="sourceLineNo">1415</span> *<a name="line.1415"></a>
<span class="sourceLineNo">1416</span> * @param sb StringBuilder that contains the String being constructed.<a name="line.1416"></a>
<span class="sourceLineNo">1417</span> * @param iterable the iterable to append<a name="line.1417"></a>
<span class="sourceLineNo">1418</span> * @param separator the separator to use, null means no separator<a name="line.1418"></a>
<span class="sourceLineNo">1419</span> */<a name="line.1419"></a>
<span class="sourceLineNo">1420</span> public void appendWithSeparators(final StringBuilder sb, final Iterable&lt;?&gt; iterable, String separator) {<a name="line.1420"></a>
<span class="sourceLineNo">1421</span> if (iterable != null) {<a name="line.1421"></a>
<span class="sourceLineNo">1422</span> separator = separator == null ? Strings.EMPTY : separator;<a name="line.1422"></a>
<span class="sourceLineNo">1423</span> final Iterator&lt;?&gt; it = iterable.iterator();<a name="line.1423"></a>
<span class="sourceLineNo">1424</span> while (it.hasNext()) {<a name="line.1424"></a>
<span class="sourceLineNo">1425</span> sb.append(it.next());<a name="line.1425"></a>
<span class="sourceLineNo">1426</span> if (it.hasNext()) {<a name="line.1426"></a>
<span class="sourceLineNo">1427</span> sb.append(separator);<a name="line.1427"></a>
<span class="sourceLineNo">1428</span> }<a name="line.1428"></a>
<span class="sourceLineNo">1429</span> }<a name="line.1429"></a>
<span class="sourceLineNo">1430</span> }<a name="line.1430"></a>
<span class="sourceLineNo">1431</span> }<a name="line.1431"></a>
<span class="sourceLineNo">1432</span><a name="line.1432"></a>
<span class="sourceLineNo">1433</span> @Override<a name="line.1433"></a>
<span class="sourceLineNo">1434</span> public String toString() {<a name="line.1434"></a>
<span class="sourceLineNo">1435</span> return "StrSubstitutor(" + variableResolver.toString() + ')';<a name="line.1435"></a>
<span class="sourceLineNo">1436</span> }<a name="line.1436"></a>
<span class="sourceLineNo">1437</span><a name="line.1437"></a>
<span class="sourceLineNo">1438</span> @Override<a name="line.1438"></a>
<span class="sourceLineNo">1439</span> public void setConfiguration(final Configuration configuration) {<a name="line.1439"></a>
<span class="sourceLineNo">1440</span> this.configuration = configuration;<a name="line.1440"></a>
<span class="sourceLineNo">1441</span> if (this.variableResolver instanceof ConfigurationAware) {<a name="line.1441"></a>
<span class="sourceLineNo">1442</span> ((ConfigurationAware) this.variableResolver).setConfiguration(this.configuration);<a name="line.1442"></a>
<span class="sourceLineNo">1443</span> }<a name="line.1443"></a>
<span class="sourceLineNo">1444</span> }<a name="line.1444"></a>
<span class="sourceLineNo">1445</span>}<a name="line.1445"></a>
</pre>
</div>
</body>
</html>