Modified: websites/production/commons/content/proper/commons-text/apidocs/src-html/org/apache/commons/text/StringEscapeUtils.Builder.html ============================================================================== --- websites/production/commons/content/proper/commons-text/apidocs/src-html/org/apache/commons/text/StringEscapeUtils.Builder.html (original) +++ websites/production/commons/content/proper/commons-text/apidocs/src-html/org/apache/commons/text/StringEscapeUtils.Builder.html Mon Jan 23 12:35:12 2017 @@ -24,10 +24,10 @@ <span class="sourceLineNo">016</span> */<a name="line.16"></a> <span class="sourceLineNo">017</span>package org.apache.commons.text;<a name="line.17"></a> <span class="sourceLineNo">018</span><a name="line.18"></a> -<span class="sourceLineNo">019</span>import org.apache.commons.lang3.CharUtils;<a name="line.19"></a> -<span class="sourceLineNo">020</span>import org.apache.commons.lang3.StringUtils;<a name="line.20"></a> -<span class="sourceLineNo">021</span>import org.apache.commons.text.translate.AggregateTranslator;<a name="line.21"></a> -<span class="sourceLineNo">022</span>import org.apache.commons.text.translate.CharSequenceTranslator;<a name="line.22"></a> +<span class="sourceLineNo">019</span>import org.apache.commons.lang3.StringUtils;<a name="line.19"></a> +<span class="sourceLineNo">020</span>import org.apache.commons.text.translate.AggregateTranslator;<a name="line.20"></a> +<span class="sourceLineNo">021</span>import org.apache.commons.text.translate.CharSequenceTranslator;<a name="line.21"></a> +<span class="sourceLineNo">022</span>import org.apache.commons.text.translate.CsvTranslators;<a name="line.22"></a> <span class="sourceLineNo">023</span>import org.apache.commons.text.translate.EntityArrays;<a name="line.23"></a> <span class="sourceLineNo">024</span>import org.apache.commons.text.translate.JavaUnicodeEscaper;<a name="line.24"></a> <span class="sourceLineNo">025</span>import org.apache.commons.text.translate.LookupTranslator;<a name="line.25"></a> @@ -40,956 +40,910 @@ <span class="sourceLineNo">032</span><a name="line.32"></a> <span class="sourceLineNo">033</span>import java.io.IOException;<a name="line.33"></a> <span class="sourceLineNo">034</span>import java.io.Writer;<a name="line.34"></a> -<span class="sourceLineNo">035</span><a name="line.35"></a> -<span class="sourceLineNo">036</span>/**<a name="line.36"></a> -<span class="sourceLineNo">037</span> * <p>Escapes and unescapes {@code String}s for<a name="line.37"></a> -<span class="sourceLineNo">038</span> * Java, Java Script, HTML and XML.</p><a name="line.38"></a> -<span class="sourceLineNo">039</span> *<a name="line.39"></a> -<span class="sourceLineNo">040</span> * <p>#ThreadSafe#</p><a name="line.40"></a> -<span class="sourceLineNo">041</span> *<a name="line.41"></a> +<span class="sourceLineNo">035</span>import java.util.Collections;<a name="line.35"></a> +<span class="sourceLineNo">036</span>import java.util.HashMap;<a name="line.36"></a> +<span class="sourceLineNo">037</span>import java.util.Map;<a name="line.37"></a> +<span class="sourceLineNo">038</span><a name="line.38"></a> +<span class="sourceLineNo">039</span>/**<a name="line.39"></a> +<span class="sourceLineNo">040</span> * <p>Escapes and unescapes {@code String}s for<a name="line.40"></a> +<span class="sourceLineNo">041</span> * Java, Java Script, HTML and XML.</p><a name="line.41"></a> <span class="sourceLineNo">042</span> *<a name="line.42"></a> -<span class="sourceLineNo">043</span> * <p><a name="line.43"></a> -<span class="sourceLineNo">044</span> * This code has been adapted from Apache Commons Lang 3.5.<a name="line.44"></a> -<span class="sourceLineNo">045</span> * </p><a name="line.45"></a> -<span class="sourceLineNo">046</span> *<a name="line.46"></a> -<span class="sourceLineNo">047</span> * @since 1.0<a name="line.47"></a> -<span class="sourceLineNo">048</span> */<a name="line.48"></a> -<span class="sourceLineNo">049</span>public class StringEscapeUtils {<a name="line.49"></a> -<span class="sourceLineNo">050</span><a name="line.50"></a> -<span class="sourceLineNo">051</span> /* ESCAPE TRANSLATORS */<a name="line.51"></a> -<span class="sourceLineNo">052</span><a name="line.52"></a> -<span class="sourceLineNo">053</span> /**<a name="line.53"></a> -<span class="sourceLineNo">054</span> * Translator object for escaping Java. <a name="line.54"></a> -<span class="sourceLineNo">055</span> *<a name="line.55"></a> -<span class="sourceLineNo">056</span> * While {@link #escapeJava(String)} is the expected method of use, this <a name="line.56"></a> -<span class="sourceLineNo">057</span> * object allows the Java escaping functionality to be used <a name="line.57"></a> -<span class="sourceLineNo">058</span> * as the foundation for a custom translator.<a name="line.58"></a> -<span class="sourceLineNo">059</span> */<a name="line.59"></a> -<span class="sourceLineNo">060</span> public static final CharSequenceTranslator ESCAPE_JAVA =<a name="line.60"></a> -<span class="sourceLineNo">061</span> new LookupTranslator(<a name="line.61"></a> -<span class="sourceLineNo">062</span> new String[][] {<a name="line.62"></a> -<span class="sourceLineNo">063</span> {"\"", "\\\""},<a name="line.63"></a> -<span class="sourceLineNo">064</span> {"\\", "\\\\"},<a name="line.64"></a> -<span class="sourceLineNo">065</span> }).with(<a name="line.65"></a> -<span class="sourceLineNo">066</span> new LookupTranslator(EntityArrays.JAVA_CTRL_CHARS_ESCAPE())<a name="line.66"></a> -<span class="sourceLineNo">067</span> ).with(<a name="line.67"></a> -<span class="sourceLineNo">068</span> JavaUnicodeEscaper.outsideOf(32, 0x7f)<a name="line.68"></a> -<span class="sourceLineNo">069</span> );<a name="line.69"></a> -<span class="sourceLineNo">070</span><a name="line.70"></a> -<span class="sourceLineNo">071</span> /**<a name="line.71"></a> -<span class="sourceLineNo">072</span> * Translator object for escaping EcmaScript/JavaScript. <a name="line.72"></a> -<span class="sourceLineNo">073</span> *<a name="line.73"></a> -<span class="sourceLineNo">074</span> * While {@link #escapeEcmaScript(String)} is the expected method of use, this <a name="line.74"></a> -<span class="sourceLineNo">075</span> * object allows the EcmaScript escaping functionality to be used <a name="line.75"></a> -<span class="sourceLineNo">076</span> * as the foundation for a custom translator.<a name="line.76"></a> -<span class="sourceLineNo">077</span> */<a name="line.77"></a> -<span class="sourceLineNo">078</span> public static final CharSequenceTranslator ESCAPE_ECMASCRIPT =<a name="line.78"></a> -<span class="sourceLineNo">079</span> new AggregateTranslator(<a name="line.79"></a> -<span class="sourceLineNo">080</span> new LookupTranslator(<a name="line.80"></a> -<span class="sourceLineNo">081</span> new String[][] {<a name="line.81"></a> -<span class="sourceLineNo">082</span> {"'", "\\'"},<a name="line.82"></a> -<span class="sourceLineNo">083</span> {"\"", "\\\""},<a name="line.83"></a> -<span class="sourceLineNo">084</span> {"\\", "\\\\"},<a name="line.84"></a> -<span class="sourceLineNo">085</span> {"/", "\\/"}<a name="line.85"></a> -<span class="sourceLineNo">086</span> }),<a name="line.86"></a> -<span class="sourceLineNo">087</span> new LookupTranslator(EntityArrays.JAVA_CTRL_CHARS_ESCAPE()),<a name="line.87"></a> -<span class="sourceLineNo">088</span> JavaUnicodeEscaper.outsideOf(32, 0x7f)<a name="line.88"></a> -<span class="sourceLineNo">089</span> );<a name="line.89"></a> -<span class="sourceLineNo">090</span><a name="line.90"></a> -<span class="sourceLineNo">091</span> /**<a name="line.91"></a> -<span class="sourceLineNo">092</span> * Translator object for escaping Json.<a name="line.92"></a> -<span class="sourceLineNo">093</span> *<a name="line.93"></a> -<span class="sourceLineNo">094</span> * While {@link #escapeJson(String)} is the expected method of use, this<a name="line.94"></a> -<span class="sourceLineNo">095</span> * object allows the Json escaping functionality to be used<a name="line.95"></a> -<span class="sourceLineNo">096</span> * as the foundation for a custom translator.<a name="line.96"></a> -<span class="sourceLineNo">097</span> */<a name="line.97"></a> -<span class="sourceLineNo">098</span> public static final CharSequenceTranslator ESCAPE_JSON =<a name="line.98"></a> -<span class="sourceLineNo">099</span> new AggregateTranslator(<a name="line.99"></a> -<span class="sourceLineNo">100</span> new LookupTranslator(<a name="line.100"></a> -<span class="sourceLineNo">101</span> new String[][] {<a name="line.101"></a> -<span class="sourceLineNo">102</span> {"\"", "\\\""},<a name="line.102"></a> -<span class="sourceLineNo">103</span> {"\\", "\\\\"},<a name="line.103"></a> -<span class="sourceLineNo">104</span> {"/", "\\/"}<a name="line.104"></a> -<span class="sourceLineNo">105</span> }),<a name="line.105"></a> -<span class="sourceLineNo">106</span> new LookupTranslator(EntityArrays.JAVA_CTRL_CHARS_ESCAPE()),<a name="line.106"></a> -<span class="sourceLineNo">107</span> JavaUnicodeEscaper.outsideOf(32, 0x7f)<a name="line.107"></a> -<span class="sourceLineNo">108</span> );<a name="line.108"></a> -<span class="sourceLineNo">109</span><a name="line.109"></a> -<span class="sourceLineNo">110</span> /**<a name="line.110"></a> -<span class="sourceLineNo">111</span> * Translator object for escaping XML 1.0.<a name="line.111"></a> -<span class="sourceLineNo">112</span> *<a name="line.112"></a> -<span class="sourceLineNo">113</span> * While {@link #escapeXml10(String)} is the expected method of use, this<a name="line.113"></a> -<span class="sourceLineNo">114</span> * object allows the XML escaping functionality to be used<a name="line.114"></a> -<span class="sourceLineNo">115</span> * as the foundation for a custom translator.<a name="line.115"></a> -<span class="sourceLineNo">116</span> */<a name="line.116"></a> -<span class="sourceLineNo">117</span> public static final CharSequenceTranslator ESCAPE_XML10 =<a name="line.117"></a> -<span class="sourceLineNo">118</span> new AggregateTranslator(<a name="line.118"></a> -<span class="sourceLineNo">119</span> new LookupTranslator(EntityArrays.BASIC_ESCAPE()),<a name="line.119"></a> -<span class="sourceLineNo">120</span> new LookupTranslator(EntityArrays.APOS_ESCAPE()),<a name="line.120"></a> -<span class="sourceLineNo">121</span> new LookupTranslator(<a name="line.121"></a> -<span class="sourceLineNo">122</span> new String[][] {<a name="line.122"></a> -<span class="sourceLineNo">123</span> { "\u0000", StringUtils.EMPTY },<a name="line.123"></a> -<span class="sourceLineNo">124</span> { "\u0001", StringUtils.EMPTY },<a name="line.124"></a> -<span class="sourceLineNo">125</span> { "\u0002", StringUtils.EMPTY },<a name="line.125"></a> -<span class="sourceLineNo">126</span> { "\u0003", StringUtils.EMPTY },<a name="line.126"></a> -<span class="sourceLineNo">127</span> { "\u0004", StringUtils.EMPTY },<a name="line.127"></a> -<span class="sourceLineNo">128</span> { "\u0005", StringUtils.EMPTY },<a name="line.128"></a> -<span class="sourceLineNo">129</span> { "\u0006", StringUtils.EMPTY },<a name="line.129"></a> -<span class="sourceLineNo">130</span> { "\u0007", StringUtils.EMPTY },<a name="line.130"></a> -<span class="sourceLineNo">131</span> { "\u0008", StringUtils.EMPTY },<a name="line.131"></a> -<span class="sourceLineNo">132</span> { "\u000b", StringUtils.EMPTY },<a name="line.132"></a> -<span class="sourceLineNo">133</span> { "\u000c", StringUtils.EMPTY },<a name="line.133"></a> -<span class="sourceLineNo">134</span> { "\u000e", StringUtils.EMPTY },<a name="line.134"></a> -<span class="sourceLineNo">135</span> { "\u000f", StringUtils.EMPTY },<a name="line.135"></a> -<span class="sourceLineNo">136</span> { "\u0010", StringUtils.EMPTY },<a name="line.136"></a> -<span class="sourceLineNo">137</span> { "\u0011", StringUtils.EMPTY },<a name="line.137"></a> -<span class="sourceLineNo">138</span> { "\u0012", StringUtils.EMPTY },<a name="line.138"></a> -<span class="sourceLineNo">139</span> { "\u0013", StringUtils.EMPTY },<a name="line.139"></a> -<span class="sourceLineNo">140</span> { "\u0014", StringUtils.EMPTY },<a name="line.140"></a> -<span class="sourceLineNo">141</span> { "\u0015", StringUtils.EMPTY },<a name="line.141"></a> -<span class="sourceLineNo">142</span> { "\u0016", StringUtils.EMPTY },<a name="line.142"></a> -<span class="sourceLineNo">143</span> { "\u0017", StringUtils.EMPTY },<a name="line.143"></a> -<span class="sourceLineNo">144</span> { "\u0018", StringUtils.EMPTY },<a name="line.144"></a> -<span class="sourceLineNo">145</span> { "\u0019", StringUtils.EMPTY },<a name="line.145"></a> -<span class="sourceLineNo">146</span> { "\u001a", StringUtils.EMPTY },<a name="line.146"></a> -<span class="sourceLineNo">147</span> { "\u001b", StringUtils.EMPTY },<a name="line.147"></a> -<span class="sourceLineNo">148</span> { "\u001c", StringUtils.EMPTY },<a name="line.148"></a> -<span class="sourceLineNo">149</span> { "\u001d", StringUtils.EMPTY },<a name="line.149"></a> -<span class="sourceLineNo">150</span> { "\u001e", StringUtils.EMPTY },<a name="line.150"></a> -<span class="sourceLineNo">151</span> { "\u001f", StringUtils.EMPTY },<a name="line.151"></a> -<span class="sourceLineNo">152</span> { "\ufffe", StringUtils.EMPTY },<a name="line.152"></a> -<span class="sourceLineNo">153</span> { "\uffff", StringUtils.EMPTY }<a name="line.153"></a> -<span class="sourceLineNo">154</span> }),<a name="line.154"></a> -<span class="sourceLineNo">155</span> NumericEntityEscaper.between(0x7f, 0x84),<a name="line.155"></a> -<span class="sourceLineNo">156</span> NumericEntityEscaper.between(0x86, 0x9f),<a name="line.156"></a> -<span class="sourceLineNo">157</span> new UnicodeUnpairedSurrogateRemover()<a name="line.157"></a> -<span class="sourceLineNo">158</span> );<a name="line.158"></a> -<span class="sourceLineNo">159</span><a name="line.159"></a> -<span class="sourceLineNo">160</span> /**<a name="line.160"></a> -<span class="sourceLineNo">161</span> * Translator object for escaping XML 1.1.<a name="line.161"></a> -<span class="sourceLineNo">162</span> *<a name="line.162"></a> -<span class="sourceLineNo">163</span> * While {@link #escapeXml11(String)} is the expected method of use, this<a name="line.163"></a> -<span class="sourceLineNo">164</span> * object allows the XML escaping functionality to be used<a name="line.164"></a> -<span class="sourceLineNo">165</span> * as the foundation for a custom translator.<a name="line.165"></a> -<span class="sourceLineNo">166</span> */<a name="line.166"></a> -<span class="sourceLineNo">167</span> public static final CharSequenceTranslator ESCAPE_XML11 =<a name="line.167"></a> -<span class="sourceLineNo">168</span> new AggregateTranslator(<a name="line.168"></a> -<span class="sourceLineNo">169</span> new LookupTranslator(EntityArrays.BASIC_ESCAPE()),<a name="line.169"></a> -<span class="sourceLineNo">170</span> new LookupTranslator(EntityArrays.APOS_ESCAPE()),<a name="line.170"></a> -<span class="sourceLineNo">171</span> new LookupTranslator(<a name="line.171"></a> -<span class="sourceLineNo">172</span> new String[][] {<a name="line.172"></a> -<span class="sourceLineNo">173</span> { "\u0000", StringUtils.EMPTY },<a name="line.173"></a> -<span class="sourceLineNo">174</span> { "\u000b", "&#11;" },<a name="line.174"></a> -<span class="sourceLineNo">175</span> { "\u000c", "&#12;" },<a name="line.175"></a> -<span class="sourceLineNo">176</span> { "\ufffe", StringUtils.EMPTY },<a name="line.176"></a> -<span class="sourceLineNo">177</span> { "\uffff", StringUtils.EMPTY }<a name="line.177"></a> -<span class="sourceLineNo">178</span> }),<a name="line.178"></a> -<span class="sourceLineNo">179</span> NumericEntityEscaper.between(0x1, 0x8),<a name="line.179"></a> -<span class="sourceLineNo">180</span> NumericEntityEscaper.between(0xe, 0x1f),<a name="line.180"></a> -<span class="sourceLineNo">181</span> NumericEntityEscaper.between(0x7f, 0x84),<a name="line.181"></a> -<span class="sourceLineNo">182</span> NumericEntityEscaper.between(0x86, 0x9f),<a name="line.182"></a> -<span class="sourceLineNo">183</span> new UnicodeUnpairedSurrogateRemover()<a name="line.183"></a> -<span class="sourceLineNo">184</span> );<a name="line.184"></a> -<span class="sourceLineNo">185</span><a name="line.185"></a> -<span class="sourceLineNo">186</span> /**<a name="line.186"></a> -<span class="sourceLineNo">187</span> * Translator object for escaping HTML version 3.0.<a name="line.187"></a> -<span class="sourceLineNo">188</span> *<a name="line.188"></a> -<span class="sourceLineNo">189</span> * While {@link #escapeHtml3(String)} is the expected method of use, this <a name="line.189"></a> -<span class="sourceLineNo">190</span> * object allows the HTML escaping functionality to be used <a name="line.190"></a> -<span class="sourceLineNo">191</span> * as the foundation for a custom translator.<a name="line.191"></a> -<span class="sourceLineNo">192</span> */<a name="line.192"></a> -<span class="sourceLineNo">193</span> public static final CharSequenceTranslator ESCAPE_HTML3 =<a name="line.193"></a> -<span class="sourceLineNo">194</span> new AggregateTranslator(<a name="line.194"></a> -<span class="sourceLineNo">195</span> new LookupTranslator(EntityArrays.BASIC_ESCAPE()),<a name="line.195"></a> -<span class="sourceLineNo">196</span> new LookupTranslator(EntityArrays.ISO8859_1_ESCAPE())<a name="line.196"></a> -<span class="sourceLineNo">197</span> );<a name="line.197"></a> -<span class="sourceLineNo">198</span><a name="line.198"></a> -<span class="sourceLineNo">199</span> /**<a name="line.199"></a> -<span class="sourceLineNo">200</span> * The improved translator object for escaping HTML version 3.0.<a name="line.200"></a> -<span class="sourceLineNo">201</span> * The 'improved' part of this translator is that it checks if the html is already translated.<a name="line.201"></a> -<span class="sourceLineNo">202</span> * This check prevents double, triple, or recursive translations.<a name="line.202"></a> -<span class="sourceLineNo">203</span> *<a name="line.203"></a> -<span class="sourceLineNo">204</span> * While {@link #escapeHtml3Once(String)} is the expected method of use, this<a name="line.204"></a> -<span class="sourceLineNo">205</span> * object allows the HTML escaping functionality to be used<a name="line.205"></a> -<span class="sourceLineNo">206</span> * as the foundation for a custom translator.<a name="line.206"></a> -<span class="sourceLineNo">207</span> *<a name="line.207"></a> -<span class="sourceLineNo">208</span> * Note that, multiple lookup tables should be passed to this translator<a name="line.208"></a> -<span class="sourceLineNo">209</span> * instead of passing multiple instances of this translator to the<a name="line.209"></a> -<span class="sourceLineNo">210</span> * AggregateTranslator. Because, a SingleLookupTranslator only checks the values of the<a name="line.210"></a> -<span class="sourceLineNo">211</span> * lookup table passed to that instance while deciding whether a value is<a name="line.211"></a> -<span class="sourceLineNo">212</span> * already translated or not.<a name="line.212"></a> -<span class="sourceLineNo">213</span> */<a name="line.213"></a> -<span class="sourceLineNo">214</span> public static final CharSequenceTranslator ESCAPE_HTML3_ONCE =<a name="line.214"></a> -<span class="sourceLineNo">215</span> new SingleLookupTranslator(EntityArrays.BASIC_ESCAPE(), EntityArrays.ISO8859_1_ESCAPE());<a name="line.215"></a> -<span class="sourceLineNo">216</span><a name="line.216"></a> -<span class="sourceLineNo">217</span><a name="line.217"></a> -<span class="sourceLineNo">218</span> /**<a name="line.218"></a> -<span class="sourceLineNo">219</span> * Translator object for escaping HTML version 4.0.<a name="line.219"></a> -<span class="sourceLineNo">220</span> *<a name="line.220"></a> -<span class="sourceLineNo">221</span> * While {@link #escapeHtml4(String)} is the expected method of use, this <a name="line.221"></a> -<span class="sourceLineNo">222</span> * object allows the HTML escaping functionality to be used <a name="line.222"></a> -<span class="sourceLineNo">223</span> * as the foundation for a custom translator.<a name="line.223"></a> -<span class="sourceLineNo">224</span> */<a name="line.224"></a> -<span class="sourceLineNo">225</span> public static final CharSequenceTranslator ESCAPE_HTML4 =<a name="line.225"></a> -<span class="sourceLineNo">226</span> new AggregateTranslator(<a name="line.226"></a> -<span class="sourceLineNo">227</span> new LookupTranslator(EntityArrays.BASIC_ESCAPE()),<a name="line.227"></a> -<span class="sourceLineNo">228</span> new LookupTranslator(EntityArrays.ISO8859_1_ESCAPE()),<a name="line.228"></a> -<span class="sourceLineNo">229</span> new LookupTranslator(EntityArrays.HTML40_EXTENDED_ESCAPE())<a name="line.229"></a> -<span class="sourceLineNo">230</span> );<a name="line.230"></a> -<span class="sourceLineNo">231</span><a name="line.231"></a> -<span class="sourceLineNo">232</span> /**<a name="line.232"></a> -<span class="sourceLineNo">233</span> * The improved translator object for escaping HTML version 4.0.<a name="line.233"></a> -<span class="sourceLineNo">234</span> * The 'improved' part of this translator is that it checks if the html is already translated.<a name="line.234"></a> -<span class="sourceLineNo">235</span> * This check prevents double, triple, or recursive translations.<a name="line.235"></a> -<span class="sourceLineNo">236</span> *<a name="line.236"></a> -<span class="sourceLineNo">237</span> * While {@link #escapeHtml4Once(String)} is the expected method of use, this<a name="line.237"></a> -<span class="sourceLineNo">238</span> * object allows the HTML escaping functionality to be used<a name="line.238"></a> -<span class="sourceLineNo">239</span> * as the foundation for a custom translator.<a name="line.239"></a> -<span class="sourceLineNo">240</span> *<a name="line.240"></a> -<span class="sourceLineNo">241</span> * Note that, multiple lookup tables should be passed to this translator<a name="line.241"></a> -<span class="sourceLineNo">242</span> * instead of passing multiple instances of this translator to the<a name="line.242"></a> -<span class="sourceLineNo">243</span> * AggregateTranslator. Because, a SingleLookupTranslator only checks the values of the<a name="line.243"></a> -<span class="sourceLineNo">244</span> * lookup table passed to that instance while deciding whether a value is<a name="line.244"></a> -<span class="sourceLineNo">245</span> * already translated or not.<a name="line.245"></a> -<span class="sourceLineNo">246</span> */<a name="line.246"></a> -<span class="sourceLineNo">247</span> public static final CharSequenceTranslator ESCAPE_HTML4_ONCE =<a name="line.247"></a> -<span class="sourceLineNo">248</span> new SingleLookupTranslator(EntityArrays.BASIC_ESCAPE(), EntityArrays.ISO8859_1_ESCAPE(), EntityArrays.HTML40_EXTENDED_ESCAPE());<a name="line.248"></a> -<span class="sourceLineNo">249</span><a name="line.249"></a> -<span class="sourceLineNo">250</span> /**<a name="line.250"></a> -<span class="sourceLineNo">251</span> * Translator object for escaping individual Comma Separated Values. <a name="line.251"></a> -<span class="sourceLineNo">252</span> *<a name="line.252"></a> -<span class="sourceLineNo">253</span> * While {@link #escapeCsv(String)} is the expected method of use, this <a name="line.253"></a> -<span class="sourceLineNo">254</span> * object allows the CSV escaping functionality to be used <a name="line.254"></a> -<span class="sourceLineNo">255</span> * as the foundation for a custom translator.<a name="line.255"></a> -<span class="sourceLineNo">256</span> */<a name="line.256"></a> -<span class="sourceLineNo">257</span> public static final CharSequenceTranslator ESCAPE_CSV = new CsvEscaper();<a name="line.257"></a> -<span class="sourceLineNo">258</span><a name="line.258"></a> -<span class="sourceLineNo">259</span> // TODO: Create a parent class - 'SinglePassTranslator' ?<a name="line.259"></a> -<span class="sourceLineNo">260</span> // It would handle the index checking + length returning, <a name="line.260"></a> -<span class="sourceLineNo">261</span> // and could also have an optimization check method.<a name="line.261"></a> -<span class="sourceLineNo">262</span> static class CsvEscaper extends CharSequenceTranslator {<a name="line.262"></a> -<span class="sourceLineNo">263</span><a name="line.263"></a> -<span class="sourceLineNo">264</span> private static final char CSV_DELIMITER = ',';<a name="line.264"></a> -<span class="sourceLineNo">265</span> private static final char CSV_QUOTE = '"';<a name="line.265"></a> -<span class="sourceLineNo">266</span> private static final String CSV_QUOTE_STR = String.valueOf(CSV_QUOTE);<a name="line.266"></a> -<span class="sourceLineNo">267</span> private static final char[] CSV_SEARCH_CHARS =<a name="line.267"></a> -<span class="sourceLineNo">268</span> new char[] {CSV_DELIMITER, CSV_QUOTE, CharUtils.CR, CharUtils.LF};<a name="line.268"></a> -<span class="sourceLineNo">269</span><a name="line.269"></a> -<span class="sourceLineNo">270</span> @Override<a name="line.270"></a> -<span class="sourceLineNo">271</span> public int translate(final CharSequence input, final int index, final Writer out) throws IOException {<a name="line.271"></a> -<span class="sourceLineNo">272</span><a name="line.272"></a> -<span class="sourceLineNo">273</span> if(index != 0) {<a name="line.273"></a> -<span class="sourceLineNo">274</span> throw new IllegalStateException("CsvEscaper should never reach the [1] index");<a name="line.274"></a> -<span class="sourceLineNo">275</span> }<a name="line.275"></a> -<span class="sourceLineNo">276</span><a name="line.276"></a> -<span class="sourceLineNo">277</span> if (StringUtils.containsNone(input.toString(), CSV_SEARCH_CHARS)) {<a name="line.277"></a> -<span class="sourceLineNo">278</span> out.write(input.toString());<a name="line.278"></a> -<span class="sourceLineNo">279</span> } else {<a name="line.279"></a> -<span class="sourceLineNo">280</span> out.write(CSV_QUOTE);<a name="line.280"></a> -<span class="sourceLineNo">281</span> out.write(StringUtils.replace(input.toString(), CSV_QUOTE_STR, CSV_QUOTE_STR + CSV_QUOTE_STR));<a name="line.281"></a> -<span class="sourceLineNo">282</span> out.write(CSV_QUOTE);<a name="line.282"></a> -<span class="sourceLineNo">283</span> }<a name="line.283"></a> -<span class="sourceLineNo">284</span> return Character.codePointCount(input, 0, input.length());<a name="line.284"></a> -<span class="sourceLineNo">285</span> }<a name="line.285"></a> -<span class="sourceLineNo">286</span> }<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> * Translator object for escaping Shell command language.<a name="line.289"></a> -<span class="sourceLineNo">290</span> *<a name="line.290"></a> -<span class="sourceLineNo">291</span> * @see <a href="http://pubs.opengroup.org/onlinepubs/7908799/xcu/chap2.html">Shell Command Language</a><a name="line.291"></a> -<span class="sourceLineNo">292</span> */<a name="line.292"></a> -<span class="sourceLineNo">293</span> public static final CharSequenceTranslator ESCAPE_XSI =<a name="line.293"></a> -<span class="sourceLineNo">294</span> new LookupTranslator(<a name="line.294"></a> -<span class="sourceLineNo">295</span> new String[][] {<a name="line.295"></a> -<span class="sourceLineNo">296</span> {"|", "\\|"},<a name="line.296"></a> -<span class="sourceLineNo">297</span> {"&", "\\&"},<a name="line.297"></a> -<span class="sourceLineNo">298</span> {";", "\\;"},<a name="line.298"></a> -<span class="sourceLineNo">299</span> {"<", "\\<"},<a name="line.299"></a> -<span class="sourceLineNo">300</span> {">", "\\>"},<a name="line.300"></a> -<span class="sourceLineNo">301</span> {"(", "\\("},<a name="line.301"></a> -<span class="sourceLineNo">302</span> {")", "\\)"},<a name="line.302"></a> -<span class="sourceLineNo">303</span> {"$", "\\$"},<a name="line.303"></a> -<span class="sourceLineNo">304</span> {"`", "\\`"},<a name="line.304"></a> -<span class="sourceLineNo">305</span> {"\\", "\\\\"},<a name="line.305"></a> -<span class="sourceLineNo">306</span> {"\"", "\\\""},<a name="line.306"></a> -<span class="sourceLineNo">307</span> {"'", "\\'"},<a name="line.307"></a> -<span class="sourceLineNo">308</span> {" ", "\\ "},<a name="line.308"></a> -<span class="sourceLineNo">309</span> {"\t", "\\\t"},<a name="line.309"></a> -<span class="sourceLineNo">310</span> {"\r\n", ""},<a name="line.310"></a> -<span class="sourceLineNo">311</span> {"\n", ""},<a name="line.311"></a> -<span class="sourceLineNo">312</span> {"*", "\\*"},<a name="line.312"></a> -<span class="sourceLineNo">313</span> {"?", "\\?"},<a name="line.313"></a> -<span class="sourceLineNo">314</span> {"[", "\\["},<a name="line.314"></a> -<span class="sourceLineNo">315</span> {"#", "\\#"},<a name="line.315"></a> -<span class="sourceLineNo">316</span> {"~", "\\~"},<a name="line.316"></a> -<span class="sourceLineNo">317</span> {"=", "\\="},<a name="line.317"></a> -<span class="sourceLineNo">318</span> {"%", "\\%"},<a name="line.318"></a> -<span class="sourceLineNo">319</span> });<a name="line.319"></a> -<span class="sourceLineNo">320</span><a name="line.320"></a> -<span class="sourceLineNo">321</span> /* UNESCAPE TRANSLATORS */<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> * Translator object for unescaping escaped Java. <a name="line.324"></a> -<span class="sourceLineNo">325</span> *<a name="line.325"></a> -<span class="sourceLineNo">326</span> * While {@link #unescapeJava(String)} is the expected method of use, this <a name="line.326"></a> -<span class="sourceLineNo">327</span> * object allows the Java unescaping functionality to be used <a name="line.327"></a> -<span class="sourceLineNo">328</span> * as the foundation for a custom translator.<a name="line.328"></a> -<span class="sourceLineNo">329</span> */<a name="line.329"></a> -<span class="sourceLineNo">330</span> // TODO: throw "illegal character: \92" as an Exception if a \ on the end of the Java (as per the compiler)?<a name="line.330"></a> -<span class="sourceLineNo">331</span> public static final CharSequenceTranslator UNESCAPE_JAVA =<a name="line.331"></a> -<span class="sourceLineNo">332</span> new AggregateTranslator(<a name="line.332"></a> -<span class="sourceLineNo">333</span> new OctalUnescaper(), // .between('\1', '\377'),<a name="line.333"></a> -<span class="sourceLineNo">334</span> new UnicodeUnescaper(),<a name="line.334"></a> -<span class="sourceLineNo">335</span> new LookupTranslator(EntityArrays.JAVA_CTRL_CHARS_UNESCAPE()),<a name="line.335"></a> -<span class="sourceLineNo">336</span> new LookupTranslator(<a name="line.336"></a> -<span class="sourceLineNo">337</span> new String[][] {<a name="line.337"></a> -<span class="sourceLineNo">338</span> {"\\\\", "\\"},<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> })<a name="line.342"></a> -<span class="sourceLineNo">343</span> );<a name="line.343"></a> -<span class="sourceLineNo">344</span><a name="line.344"></a> -<span class="sourceLineNo">345</span> /**<a name="line.345"></a> -<span class="sourceLineNo">346</span> * Translator object for unescaping escaped EcmaScript. <a name="line.346"></a> -<span class="sourceLineNo">347</span> *<a name="line.347"></a> -<span class="sourceLineNo">348</span> * While {@link #unescapeEcmaScript(String)} is the expected method of use, this <a name="line.348"></a> -<span class="sourceLineNo">349</span> * object allows the EcmaScript unescaping functionality to be used <a name="line.349"></a> -<span class="sourceLineNo">350</span> * as the foundation for a custom translator.<a name="line.350"></a> -<span class="sourceLineNo">351</span> */<a name="line.351"></a> -<span class="sourceLineNo">352</span> public static final CharSequenceTranslator UNESCAPE_ECMASCRIPT = UNESCAPE_JAVA;<a name="line.352"></a> -<span class="sourceLineNo">353</span><a name="line.353"></a> -<span class="sourceLineNo">354</span> /**<a name="line.354"></a> -<span class="sourceLineNo">355</span> * Translator object for unescaping escaped Json.<a name="line.355"></a> -<span class="sourceLineNo">356</span> *<a name="line.356"></a> -<span class="sourceLineNo">357</span> * While {@link #unescapeJson(String)} is the expected method of use, this<a name="line.357"></a> -<span class="sourceLineNo">358</span> * object allows the Json unescaping functionality to be used<a name="line.358"></a> -<span class="sourceLineNo">359</span> * as the foundation for a custom translator.<a name="line.359"></a> -<span class="sourceLineNo">360</span> */<a name="line.360"></a> -<span class="sourceLineNo">361</span> public static final CharSequenceTranslator UNESCAPE_JSON = UNESCAPE_JAVA;<a name="line.361"></a> -<span class="sourceLineNo">362</span><a name="line.362"></a> -<span class="sourceLineNo">363</span> /**<a name="line.363"></a> -<span class="sourceLineNo">364</span> * Translator object for unescaping escaped HTML 3.0. <a name="line.364"></a> -<span class="sourceLineNo">365</span> *<a name="line.365"></a> -<span class="sourceLineNo">366</span> * While {@link #unescapeHtml3(String)} is the expected method of use, this <a name="line.366"></a> -<span class="sourceLineNo">367</span> * object allows the HTML unescaping functionality to be used <a name="line.367"></a> -<span class="sourceLineNo">368</span> * as the foundation for a custom translator.<a name="line.368"></a> -<span class="sourceLineNo">369</span> */<a name="line.369"></a> -<span class="sourceLineNo">370</span> public static final CharSequenceTranslator UNESCAPE_HTML3 =<a name="line.370"></a> -<span class="sourceLineNo">371</span> new AggregateTranslator(<a name="line.371"></a> -<span class="sourceLineNo">372</span> new LookupTranslator(EntityArrays.BASIC_UNESCAPE()),<a name="line.372"></a> -<span class="sourceLineNo">373</span> new LookupTranslator(EntityArrays.ISO8859_1_UNESCAPE()),<a name="line.373"></a> -<span class="sourceLineNo">374</span> new NumericEntityUnescaper()<a name="line.374"></a> -<span class="sourceLineNo">375</span> );<a name="line.375"></a> -<span class="sourceLineNo">376</span><a name="line.376"></a> -<span class="sourceLineNo">377</span> /**<a name="line.377"></a> -<span class="sourceLineNo">378</span> * Translator object for unescaping escaped HTML 4.0. <a name="line.378"></a> -<span class="sourceLineNo">379</span> *<a name="line.379"></a> -<span class="sourceLineNo">380</span> * While {@link #unescapeHtml4(String)} is the expected method of use, this <a name="line.380"></a> -<span class="sourceLineNo">381</span> * object allows the HTML unescaping functionality to be used <a name="line.381"></a> -<span class="sourceLineNo">382</span> * as the foundation for a custom translator.<a name="line.382"></a> -<span class="sourceLineNo">383</span> */<a name="line.383"></a> -<span class="sourceLineNo">384</span> public static final CharSequenceTranslator UNESCAPE_HTML4 =<a name="line.384"></a> -<span class="sourceLineNo">385</span> new AggregateTranslator(<a name="line.385"></a> -<span class="sourceLineNo">386</span> new LookupTranslator(EntityArrays.BASIC_UNESCAPE()),<a name="line.386"></a> -<span class="sourceLineNo">387</span> new LookupTranslator(EntityArrays.ISO8859_1_UNESCAPE()),<a name="line.387"></a> -<span class="sourceLineNo">388</span> new LookupTranslator(EntityArrays.HTML40_EXTENDED_UNESCAPE()),<a name="line.388"></a> -<span class="sourceLineNo">389</span> new NumericEntityUnescaper()<a name="line.389"></a> -<span class="sourceLineNo">390</span> );<a name="line.390"></a> -<span class="sourceLineNo">391</span><a name="line.391"></a> -<span class="sourceLineNo">392</span> /**<a name="line.392"></a> -<span class="sourceLineNo">393</span> * Translator object for unescaping escaped XML.<a name="line.393"></a> -<span class="sourceLineNo">394</span> *<a name="line.394"></a> -<span class="sourceLineNo">395</span> * While {@link #unescapeXml(String)} is the expected method of use, this <a name="line.395"></a> -<span class="sourceLineNo">396</span> * object allows the XML unescaping functionality to be used <a name="line.396"></a> -<span class="sourceLineNo">397</span> * as the foundation for a custom translator.<a name="line.397"></a> -<span class="sourceLineNo">398</span> */<a name="line.398"></a> -<span class="sourceLineNo">399</span> public static final CharSequenceTranslator UNESCAPE_XML =<a name="line.399"></a> -<span class="sourceLineNo">400</span> new AggregateTranslator(<a name="line.400"></a> -<span class="sourceLineNo">401</span> new LookupTranslator(EntityArrays.BASIC_UNESCAPE()),<a name="line.401"></a> -<span class="sourceLineNo">402</span> new LookupTranslator(EntityArrays.APOS_UNESCAPE()),<a name="line.402"></a> -<span class="sourceLineNo">403</span> new NumericEntityUnescaper()<a name="line.403"></a> -<span class="sourceLineNo">404</span> );<a name="line.404"></a> -<span class="sourceLineNo">405</span><a name="line.405"></a> -<span class="sourceLineNo">406</span> /**<a name="line.406"></a> -<span class="sourceLineNo">407</span> * Translator object for unescaping escaped Comma Separated Value entries.<a name="line.407"></a> -<span class="sourceLineNo">408</span> *<a name="line.408"></a> -<span class="sourceLineNo">409</span> * While {@link #unescapeCsv(String)} is the expected method of use, this <a name="line.409"></a> -<span class="sourceLineNo">410</span> * object allows the CSV unescaping functionality to be used <a name="line.410"></a> -<span class="sourceLineNo">411</span> * as the foundation for a custom translator.<a name="line.411"></a> -<span class="sourceLineNo">412</span> */<a name="line.412"></a> -<span class="sourceLineNo">413</span> public static final CharSequenceTranslator UNESCAPE_CSV = new CsvUnescaper();<a name="line.413"></a> -<span class="sourceLineNo">414</span><a name="line.414"></a> -<span class="sourceLineNo">415</span> static class CsvUnescaper extends CharSequenceTranslator {<a name="line.415"></a> -<span class="sourceLineNo">416</span><a name="line.416"></a> -<span class="sourceLineNo">417</span> private static final char CSV_DELIMITER = ',';<a name="line.417"></a> -<span class="sourceLineNo">418</span> private static final char CSV_QUOTE = '"';<a name="line.418"></a> -<span class="sourceLineNo">419</span> private static final String CSV_QUOTE_STR = String.valueOf(CSV_QUOTE);<a name="line.419"></a> -<span class="sourceLineNo">420</span> private static final char[] CSV_SEARCH_CHARS =<a name="line.420"></a> -<span class="sourceLineNo">421</span> new char[] {CSV_DELIMITER, CSV_QUOTE, CharUtils.CR, CharUtils.LF};<a name="line.421"></a> -<span class="sourceLineNo">422</span><a name="line.422"></a> -<span class="sourceLineNo">423</span> @Override<a name="line.423"></a> -<span class="sourceLineNo">424</span> public int translate(final CharSequence input, final int index, final Writer out) throws IOException {<a name="line.424"></a> -<span class="sourceLineNo">425</span><a name="line.425"></a> -<span class="sourceLineNo">426</span> if(index != 0) {<a name="line.426"></a> -<span class="sourceLineNo">427</span> throw new IllegalStateException("CsvUnescaper should never reach the [1] index");<a name="line.427"></a> -<span class="sourceLineNo">428</span> }<a name="line.428"></a> -<span class="sourceLineNo">429</span><a name="line.429"></a> -<span class="sourceLineNo">430</span> if ( input.charAt(0) != CSV_QUOTE || input.charAt(input.length() - 1) != CSV_QUOTE ) {<a name="line.430"></a> -<span class="sourceLineNo">431</span> out.write(input.toString());<a name="line.431"></a> -<span class="sourceLineNo">432</span> return Character.codePointCount(input, 0, input.length());<a name="line.432"></a> -<span class="sourceLineNo">433</span> }<a name="line.433"></a> -<span class="sourceLineNo">434</span><a name="line.434"></a> -<span class="sourceLineNo">435</span> // strip quotes<a name="line.435"></a> -<span class="sourceLineNo">436</span> final String quoteless = input.subSequence(1, input.length() - 1).toString();<a name="line.436"></a> -<span class="sourceLineNo">437</span><a name="line.437"></a> -<span class="sourceLineNo">438</span> if ( StringUtils.containsAny(quoteless, CSV_SEARCH_CHARS) ) {<a name="line.438"></a> -<span class="sourceLineNo">439</span> // deal with escaped quotes; ie) ""<a name="line.439"></a> -<span class="sourceLineNo">440</span> out.write(StringUtils.replace(quoteless, CSV_QUOTE_STR + CSV_QUOTE_STR, CSV_QUOTE_STR));<a name="line.440"></a> -<span class="sourceLineNo">441</span> } else {<a name="line.441"></a> -<span class="sourceLineNo">442</span> out.write(input.toString());<a name="line.442"></a> -<span class="sourceLineNo">443</span> }<a name="line.443"></a> -<span class="sourceLineNo">444</span> return Character.codePointCount(input, 0, input.length());<a name="line.444"></a> -<span class="sourceLineNo">445</span> }<a name="line.445"></a> -<span class="sourceLineNo">446</span> }<a name="line.446"></a> -<span class="sourceLineNo">447</span><a name="line.447"></a> -<span class="sourceLineNo">448</span> public static final CharSequenceTranslator UNESCAPE_XSI = new XsiUnescaper();<a name="line.448"></a> -<span class="sourceLineNo">449</span><a name="line.449"></a> -<span class="sourceLineNo">450</span> /**<a name="line.450"></a> -<span class="sourceLineNo">451</span> * Translator object for unescaping backslash escaped entries.<a name="line.451"></a> +<span class="sourceLineNo">043</span> * <p>#ThreadSafe#</p><a name="line.43"></a> +<span class="sourceLineNo">044</span> *<a name="line.44"></a> +<span class="sourceLineNo">045</span> *<a name="line.45"></a> +<span class="sourceLineNo">046</span> * <p><a name="line.46"></a> +<span class="sourceLineNo">047</span> * This code has been adapted from Apache Commons Lang 3.5.<a name="line.47"></a> +<span class="sourceLineNo">048</span> * </p><a name="line.48"></a> +<span class="sourceLineNo">049</span> *<a name="line.49"></a> +<span class="sourceLineNo">050</span> * @since 1.0<a name="line.50"></a> +<span class="sourceLineNo">051</span> */<a name="line.51"></a> +<span class="sourceLineNo">052</span>public class StringEscapeUtils {<a name="line.52"></a> +<span class="sourceLineNo">053</span><a name="line.53"></a> +<span class="sourceLineNo">054</span> /* ESCAPE TRANSLATORS */<a name="line.54"></a> +<span class="sourceLineNo">055</span><a name="line.55"></a> +<span class="sourceLineNo">056</span> /**<a name="line.56"></a> +<span class="sourceLineNo">057</span> * Translator object for escaping Java. <a name="line.57"></a> +<span class="sourceLineNo">058</span> *<a name="line.58"></a> +<span class="sourceLineNo">059</span> * While {@link #escapeJava(String)} is the expected method of use, this <a name="line.59"></a> +<span class="sourceLineNo">060</span> * object allows the Java escaping functionality to be used <a name="line.60"></a> +<span class="sourceLineNo">061</span> * as the foundation for a custom translator.<a name="line.61"></a> +<span class="sourceLineNo">062</span> */<a name="line.62"></a> +<span class="sourceLineNo">063</span> public static final CharSequenceTranslator ESCAPE_JAVA;<a name="line.63"></a> +<span class="sourceLineNo">064</span> static {<a name="line.64"></a> +<span class="sourceLineNo">065</span> Map<CharSequence, CharSequence> escapeJavaMap = new HashMap<>();<a name="line.65"></a> +<span class="sourceLineNo">066</span> escapeJavaMap.put("\"", "\\\"");<a name="line.66"></a> +<span class="sourceLineNo">067</span> escapeJavaMap.put("\\", "\\\\");<a name="line.67"></a> +<span class="sourceLineNo">068</span> ESCAPE_JAVA = new AggregateTranslator(<a name="line.68"></a> +<span class="sourceLineNo">069</span> new LookupTranslator(Collections.unmodifiableMap(escapeJavaMap)),<a name="line.69"></a> +<span class="sourceLineNo">070</span> new LookupTranslator(EntityArrays.JAVA_CTRL_CHARS_ESCAPE),<a name="line.70"></a> +<span class="sourceLineNo">071</span> JavaUnicodeEscaper.outsideOf(32, 0x7f)<a name="line.71"></a> +<span class="sourceLineNo">072</span> );<a name="line.72"></a> +<span class="sourceLineNo">073</span> }<a name="line.73"></a> +<span class="sourceLineNo">074</span><a name="line.74"></a> +<span class="sourceLineNo">075</span> /**<a name="line.75"></a> +<span class="sourceLineNo">076</span> * Translator object for escaping EcmaScript/JavaScript. <a name="line.76"></a> +<span class="sourceLineNo">077</span> *<a name="line.77"></a> +<span class="sourceLineNo">078</span> * While {@link #escapeEcmaScript(String)} is the expected method of use, this <a name="line.78"></a> +<span class="sourceLineNo">079</span> * object allows the EcmaScript escaping functionality to be used <a name="line.79"></a> +<span class="sourceLineNo">080</span> * as the foundation for a custom translator.<a name="line.80"></a> +<span class="sourceLineNo">081</span> */<a name="line.81"></a> +<span class="sourceLineNo">082</span> public static final CharSequenceTranslator ESCAPE_ECMASCRIPT;<a name="line.82"></a> +<span class="sourceLineNo">083</span> static {<a name="line.83"></a> +<span class="sourceLineNo">084</span> Map<CharSequence, CharSequence> escapeEcmaScriptMap = new HashMap<>();<a name="line.84"></a> +<span class="sourceLineNo">085</span> escapeEcmaScriptMap.put("'", "\\'");<a name="line.85"></a> +<span class="sourceLineNo">086</span> escapeEcmaScriptMap.put("\"", "\\\"");<a name="line.86"></a> +<span class="sourceLineNo">087</span> escapeEcmaScriptMap.put("\\", "\\\\");<a name="line.87"></a> +<span class="sourceLineNo">088</span> escapeEcmaScriptMap.put("/", "\\/");<a name="line.88"></a> +<span class="sourceLineNo">089</span> ESCAPE_ECMASCRIPT = new AggregateTranslator(<a name="line.89"></a> +<span class="sourceLineNo">090</span> new LookupTranslator(Collections.unmodifiableMap(escapeEcmaScriptMap)),<a name="line.90"></a> +<span class="sourceLineNo">091</span> new LookupTranslator(EntityArrays.JAVA_CTRL_CHARS_ESCAPE),<a name="line.91"></a> +<span class="sourceLineNo">092</span> JavaUnicodeEscaper.outsideOf(32, 0x7f)<a name="line.92"></a> +<span class="sourceLineNo">093</span> );<a name="line.93"></a> +<span class="sourceLineNo">094</span> }<a name="line.94"></a> +<span class="sourceLineNo">095</span><a name="line.95"></a> +<span class="sourceLineNo">096</span> /**<a name="line.96"></a> +<span class="sourceLineNo">097</span> * Translator object for escaping Json.<a name="line.97"></a> +<span class="sourceLineNo">098</span> *<a name="line.98"></a> +<span class="sourceLineNo">099</span> * While {@link #escapeJson(String)} is the expected method of use, this<a name="line.99"></a> +<span class="sourceLineNo">100</span> * object allows the Json escaping functionality to be used<a name="line.100"></a> +<span class="sourceLineNo">101</span> * as the foundation for a custom translator.<a name="line.101"></a> +<span class="sourceLineNo">102</span> */<a name="line.102"></a> +<span class="sourceLineNo">103</span> public static final CharSequenceTranslator ESCAPE_JSON;<a name="line.103"></a> +<span class="sourceLineNo">104</span> static {<a name="line.104"></a> +<span class="sourceLineNo">105</span> Map<CharSequence, CharSequence> escapeJsonMap = new HashMap<>();<a name="line.105"></a> +<span class="sourceLineNo">106</span> escapeJsonMap.put("\"", "\\\"");<a name="line.106"></a> +<span class="sourceLineNo">107</span> escapeJsonMap.put("\\", "\\\\");<a name="line.107"></a> +<span class="sourceLineNo">108</span> escapeJsonMap.put("/", "\\/");<a name="line.108"></a> +<span class="sourceLineNo">109</span> ESCAPE_JSON = new AggregateTranslator(<a name="line.109"></a> +<span class="sourceLineNo">110</span> new LookupTranslator(Collections.unmodifiableMap(escapeJsonMap)),<a name="line.110"></a> +<span class="sourceLineNo">111</span> new LookupTranslator(EntityArrays.JAVA_CTRL_CHARS_ESCAPE),<a name="line.111"></a> +<span class="sourceLineNo">112</span> JavaUnicodeEscaper.outsideOf(32, 0x7f)<a name="line.112"></a> +<span class="sourceLineNo">113</span> );<a name="line.113"></a> +<span class="sourceLineNo">114</span> }<a name="line.114"></a> +<span class="sourceLineNo">115</span><a name="line.115"></a> +<span class="sourceLineNo">116</span> /**<a name="line.116"></a> +<span class="sourceLineNo">117</span> * Translator object for escaping XML 1.0.<a name="line.117"></a> +<span class="sourceLineNo">118</span> *<a name="line.118"></a> +<span class="sourceLineNo">119</span> * While {@link #escapeXml10(String)} is the expected method of use, this<a name="line.119"></a> +<span class="sourceLineNo">120</span> * object allows the XML escaping functionality to be used<a name="line.120"></a> +<span class="sourceLineNo">121</span> * as the foundation for a custom translator.<a name="line.121"></a> +<span class="sourceLineNo">122</span> */<a name="line.122"></a> +<span class="sourceLineNo">123</span> public static final CharSequenceTranslator ESCAPE_XML10;<a name="line.123"></a> +<span class="sourceLineNo">124</span> static {<a name="line.124"></a> +<span class="sourceLineNo">125</span> Map<CharSequence, CharSequence> escapeXml10Map = new HashMap<>();<a name="line.125"></a> +<span class="sourceLineNo">126</span> escapeXml10Map.put("\u0000", StringUtils.EMPTY);<a name="line.126"></a> +<span class="sourceLineNo">127</span> escapeXml10Map.put("\u0001", StringUtils.EMPTY);<a name="line.127"></a> +<span class="sourceLineNo">128</span> escapeXml10Map.put("\u0002", StringUtils.EMPTY);<a name="line.128"></a> +<span class="sourceLineNo">129</span> escapeXml10Map.put("\u0003", StringUtils.EMPTY);<a name="line.129"></a> +<span class="sourceLineNo">130</span> escapeXml10Map.put("\u0004", StringUtils.EMPTY);<a name="line.130"></a> +<span class="sourceLineNo">131</span> escapeXml10Map.put("\u0005", StringUtils.EMPTY);<a name="line.131"></a> +<span class="sourceLineNo">132</span> escapeXml10Map.put("\u0006", StringUtils.EMPTY);<a name="line.132"></a> +<span class="sourceLineNo">133</span> escapeXml10Map.put("\u0007", StringUtils.EMPTY);<a name="line.133"></a> +<span class="sourceLineNo">134</span> escapeXml10Map.put("\u0008", StringUtils.EMPTY);<a name="line.134"></a> +<span class="sourceLineNo">135</span> escapeXml10Map.put("\u000b", StringUtils.EMPTY);<a name="line.135"></a> +<span class="sourceLineNo">136</span> escapeXml10Map.put("\u000c", StringUtils.EMPTY);<a name="line.136"></a> +<span class="sourceLineNo">137</span> escapeXml10Map.put("\u000e", StringUtils.EMPTY);<a name="line.137"></a> +<span class="sourceLineNo">138</span> escapeXml10Map.put("\u000f", StringUtils.EMPTY);<a name="line.138"></a> +<span class="sourceLineNo">139</span> escapeXml10Map.put("\u0010", StringUtils.EMPTY);<a name="line.139"></a> +<span class="sourceLineNo">140</span> escapeXml10Map.put("\u0011", StringUtils.EMPTY);<a name="line.140"></a> +<span class="sourceLineNo">141</span> escapeXml10Map.put("\u0012", StringUtils.EMPTY);<a name="line.141"></a> +<span class="sourceLineNo">142</span> escapeXml10Map.put("\u0013", StringUtils.EMPTY);<a name="line.142"></a> +<span class="sourceLineNo">143</span> escapeXml10Map.put("\u0014", StringUtils.EMPTY);<a name="line.143"></a> +<span class="sourceLineNo">144</span> escapeXml10Map.put("\u0015", StringUtils.EMPTY);<a name="line.144"></a> +<span class="sourceLineNo">145</span> escapeXml10Map.put("\u0016", StringUtils.EMPTY);<a name="line.145"></a> +<span class="sourceLineNo">146</span> escapeXml10Map.put("\u0017", StringUtils.EMPTY);<a name="line.146"></a> +<span class="sourceLineNo">147</span> escapeXml10Map.put("\u0018", StringUtils.EMPTY);<a name="line.147"></a> +<span class="sourceLineNo">148</span> escapeXml10Map.put("\u0019", StringUtils.EMPTY);<a name="line.148"></a> +<span class="sourceLineNo">149</span> escapeXml10Map.put("\u001a", StringUtils.EMPTY);<a name="line.149"></a> +<span class="sourceLineNo">150</span> escapeXml10Map.put("\u001b", StringUtils.EMPTY);<a name="line.150"></a> +<span class="sourceLineNo">151</span> escapeXml10Map.put("\u001c", StringUtils.EMPTY);<a name="line.151"></a> +<span class="sourceLineNo">152</span> escapeXml10Map.put("\u001d", StringUtils.EMPTY);<a name="line.152"></a> +<span class="sourceLineNo">153</span> escapeXml10Map.put("\u001e", StringUtils.EMPTY);<a name="line.153"></a> +<span class="sourceLineNo">154</span> escapeXml10Map.put("\u001f", StringUtils.EMPTY);<a name="line.154"></a> +<span class="sourceLineNo">155</span> escapeXml10Map.put("\ufffe", StringUtils.EMPTY);<a name="line.155"></a> +<span class="sourceLineNo">156</span> escapeXml10Map.put("\uffff", StringUtils.EMPTY);<a name="line.156"></a> +<span class="sourceLineNo">157</span> ESCAPE_XML10 = new AggregateTranslator(<a name="line.157"></a> +<span class="sourceLineNo">158</span> new LookupTranslator(EntityArrays.BASIC_ESCAPE),<a name="line.158"></a> +<span class="sourceLineNo">159</span> new LookupTranslator(EntityArrays.APOS_ESCAPE),<a name="line.159"></a> +<span class="sourceLineNo">160</span> new LookupTranslator(Collections.unmodifiableMap(escapeXml10Map)),<a name="line.160"></a> +<span class="sourceLineNo">161</span> NumericEntityEscaper.between(0x7f, 0x84),<a name="line.161"></a> +<span class="sourceLineNo">162</span> NumericEntityEscaper.between(0x86, 0x9f),<a name="line.162"></a> +<span class="sourceLineNo">163</span> new UnicodeUnpairedSurrogateRemover()<a name="line.163"></a> +<span class="sourceLineNo">164</span> );<a name="line.164"></a> +<span class="sourceLineNo">165</span> }<a name="line.165"></a> +<span class="sourceLineNo">166</span><a name="line.166"></a> +<span class="sourceLineNo">167</span> /**<a name="line.167"></a> +<span class="sourceLineNo">168</span> * Translator object for escaping XML 1.1.<a name="line.168"></a> +<span class="sourceLineNo">169</span> *<a name="line.169"></a> +<span class="sourceLineNo">170</span> * While {@link #escapeXml11(String)} is the expected method of use, this<a name="line.170"></a> +<span class="sourceLineNo">171</span> * object allows the XML escaping functionality to be used<a name="line.171"></a> +<span class="sourceLineNo">172</span> * as the foundation for a custom translator.<a name="line.172"></a> +<span class="sourceLineNo">173</span> */<a name="line.173"></a> +<span class="sourceLineNo">174</span> public static final CharSequenceTranslator ESCAPE_XML11;<a name="line.174"></a> +<span class="sourceLineNo">175</span> static {<a name="line.175"></a> +<span class="sourceLineNo">176</span> Map<CharSequence, CharSequence> escapeXml11Map = new HashMap<>();<a name="line.176"></a> +<span class="sourceLineNo">177</span> escapeXml11Map.put("\u0000", StringUtils.EMPTY);<a name="line.177"></a> +<span class="sourceLineNo">178</span> escapeXml11Map.put("\u000b", "&#11;");<a name="line.178"></a> +<span class="sourceLineNo">179</span> escapeXml11Map.put("\u000c", "&#12;");<a name="line.179"></a> +<span class="sourceLineNo">180</span> escapeXml11Map.put("\ufffe", StringUtils.EMPTY);<a name="line.180"></a> +<span class="sourceLineNo">181</span> escapeXml11Map.put("\uffff", StringUtils.EMPTY);<a name="line.181"></a> +<span class="sourceLineNo">182</span> ESCAPE_XML11 = new AggregateTranslator(<a name="line.182"></a> +<span class="sourceLineNo">183</span> new LookupTranslator(EntityArrays.BASIC_ESCAPE),<a name="line.183"></a> +<span class="sourceLineNo">184</span> new LookupTranslator(EntityArrays.APOS_ESCAPE),<a name="line.184"></a> +<span class="sourceLineNo">185</span> new LookupTranslator(Collections.unmodifiableMap(escapeXml11Map)),<a name="line.185"></a> +<span class="sourceLineNo">186</span> NumericEntityEscaper.between(0x1, 0x8),<a name="line.186"></a> +<span class="sourceLineNo">187</span> NumericEntityEscaper.between(0xe, 0x1f),<a name="line.187"></a> +<span class="sourceLineNo">188</span> NumericEntityEscaper.between(0x7f, 0x84),<a name="line.188"></a> +<span class="sourceLineNo">189</span> NumericEntityEscaper.between(0x86, 0x9f),<a name="line.189"></a> +<span class="sourceLineNo">190</span> new UnicodeUnpairedSurrogateRemover()<a name="line.190"></a> +<span class="sourceLineNo">191</span> );<a name="line.191"></a> +<span class="sourceLineNo">192</span> }<a name="line.192"></a> +<span class="sourceLineNo">193</span><a name="line.193"></a> +<span class="sourceLineNo">194</span> /**<a name="line.194"></a> +<span class="sourceLineNo">195</span> * Translator object for escaping HTML version 3.0.<a name="line.195"></a> +<span class="sourceLineNo">196</span> *<a name="line.196"></a> +<span class="sourceLineNo">197</span> * While {@link #escapeHtml3(String)} is the expected method of use, this <a name="line.197"></a> +<span class="sourceLineNo">198</span> * object allows the HTML escaping functionality to be used <a name="line.198"></a> +<span class="sourceLineNo">199</span> * as the foundation for a custom translator.<a name="line.199"></a> +<span class="sourceLineNo">200</span> */<a name="line.200"></a> +<span class="sourceLineNo">201</span> public static final CharSequenceTranslator ESCAPE_HTML3 =<a name="line.201"></a> +<span class="sourceLineNo">202</span> new AggregateTranslator(<a name="line.202"></a> +<span class="sourceLineNo">203</span> new LookupTranslator(EntityArrays.BASIC_ESCAPE),<a name="line.203"></a> +<span class="sourceLineNo">204</span> new LookupTranslator(EntityArrays.ISO8859_1_ESCAPE)<a name="line.204"></a> +<span class="sourceLineNo">205</span> );<a name="line.205"></a> +<span class="sourceLineNo">206</span><a name="line.206"></a> +<span class="sourceLineNo">207</span> /**<a name="line.207"></a> +<span class="sourceLineNo">208</span> * The improved translator object for escaping HTML version 3.0.<a name="line.208"></a> +<span class="sourceLineNo">209</span> * The 'improved' part of this translator is that it checks if the html is already translated.<a name="line.209"></a> +<span class="sourceLineNo">210</span> * This check prevents double, triple, or recursive translations.<a name="line.210"></a> +<span class="sourceLineNo">211</span> *<a name="line.211"></a> +<span class="sourceLineNo">212</span> * While {@link #escapeHtml3Once(String)} is the expected method of use, this<a name="line.212"></a> +<span class="sourceLineNo">213</span> * object allows the HTML escaping functionality to be used<a name="line.213"></a> +<span class="sourceLineNo">214</span> * as the foundation for a custom translator.<a name="line.214"></a> +<span class="sourceLineNo">215</span> *<a name="line.215"></a> +<span class="sourceLineNo">216</span> * Note that, multiple lookup tables should be passed to this translator<a name="line.216"></a> +<span class="sourceLineNo">217</span> * instead of passing multiple instances of this translator to the<a name="line.217"></a> +<span class="sourceLineNo">218</span> * AggregateTranslator. Because, a SingleLookupTranslator only checks the values of the<a name="line.218"></a> +<span class="sourceLineNo">219</span> * lookup table passed to that instance while deciding whether a value is<a name="line.219"></a> +<span class="sourceLineNo">220</span> * already translated or not.<a name="line.220"></a> +<span class="sourceLineNo">221</span> */<a name="line.221"></a> +<span class="sourceLineNo">222</span> public static final CharSequenceTranslator ESCAPE_HTML3_ONCE =<a name="line.222"></a> +<span class="sourceLineNo">223</span> new SingleLookupTranslator(EntityArrays.BASIC_ESCAPE, EntityArrays.ISO8859_1_ESCAPE);<a name="line.223"></a> +<span class="sourceLineNo">224</span><a name="line.224"></a> +<span class="sourceLineNo">225</span><a name="line.225"></a> +<span class="sourceLineNo">226</span> /**<a name="line.226"></a> +<span class="sourceLineNo">227</span> * Translator object for escaping HTML version 4.0.<a name="line.227"></a> +<span class="sourceLineNo">228</span> *<a name="line.228"></a> +<span class="sourceLineNo">229</span> * While {@link #escapeHtml4(String)} is the expected method of use, this <a name="line.229"></a> +<span class="sourceLineNo">230</span> * object allows the HTML escaping functionality to be used <a name="line.230"></a> +<span class="sourceLineNo">231</span> * as the foundation for a custom translator.<a name="line.231"></a> +<span class="sourceLineNo">232</span> */<a name="line.232"></a> +<span class="sourceLineNo">233</span> public static final CharSequenceTranslator ESCAPE_HTML4 =<a name="line.233"></a> +<span class="sourceLineNo">234</span> new AggregateTranslator(<a name="line.234"></a> +<span class="sourceLineNo">235</span> new LookupTranslator(EntityArrays.BASIC_ESCAPE),<a name="line.235"></a> +<span class="sourceLineNo">236</span> new LookupTranslator(EntityArrays.ISO8859_1_ESCAPE),<a name="line.236"></a> +<span class="sourceLineNo">237</span> new LookupTranslator(EntityArrays.HTML40_EXTENDED_ESCAPE)<a name="line.237"></a> +<span class="sourceLineNo">238</span> );<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> * The improved translator object for escaping HTML version 4.0.<a name="line.241"></a> +<span class="sourceLineNo">242</span> * The 'improved' part of this translator is that it checks if the html is already translated.<a name="line.242"></a> +<span class="sourceLineNo">243</span> * This check prevents double, triple, or recursive translations.<a name="line.243"></a> +<span class="sourceLineNo">244</span> *<a name="line.244"></a> +<span class="sourceLineNo">245</span> * While {@link #escapeHtml4Once(String)} is the expected method of use, this<a name="line.245"></a> +<span class="sourceLineNo">246</span> * object allows the HTML escaping functionality to be used<a name="line.246"></a> +<span class="sourceLineNo">247</span> * as the foundation for a custom translator.<a name="line.247"></a> +<span class="sourceLineNo">248</span> *<a name="line.248"></a> +<span class="sourceLineNo">249</span> * Note that, multiple lookup tables should be passed to this translator<a name="line.249"></a> +<span class="sourceLineNo">250</span> * instead of passing multiple instances of this translator to the<a name="line.250"></a> +<span class="sourceLineNo">251</span> * AggregateTranslator. Because, a SingleLookupTranslator only checks the values of the<a name="line.251"></a> +<span class="sourceLineNo">252</span> * lookup table passed to that instance while deciding whether a value is<a name="line.252"></a> +<span class="sourceLineNo">253</span> * already translated or not.<a name="line.253"></a> +<span class="sourceLineNo">254</span> */<a name="line.254"></a> +<span class="sourceLineNo">255</span> public static final CharSequenceTranslator ESCAPE_HTML4_ONCE =<a name="line.255"></a> +<span class="sourceLineNo">256</span> new SingleLookupTranslator(<a name="line.256"></a> +<span class="sourceLineNo">257</span> EntityArrays.BASIC_ESCAPE,<a name="line.257"></a> +<span class="sourceLineNo">258</span> EntityArrays.ISO8859_1_ESCAPE,<a name="line.258"></a> +<span class="sourceLineNo">259</span> EntityArrays.HTML40_EXTENDED_ESCAPE<a name="line.259"></a> +<span class="sourceLineNo">260</span> );<a name="line.260"></a> +<span class="sourceLineNo">261</span><a name="line.261"></a> +<span class="sourceLineNo">262</span> /**<a name="line.262"></a> +<span class="sourceLineNo">263</span> * Translator object for escaping individual Comma Separated Values. <a name="line.263"></a> +<span class="sourceLineNo">264</span> *<a name="line.264"></a> +<span class="sourceLineNo">265</span> * While {@link #escapeCsv(String)} is the expected method of use, this <a name="line.265"></a> +<span class="sourceLineNo">266</span> * object allows the CSV escaping functionality to be used <a name="line.266"></a> +<span class="sourceLineNo">267</span> * as the foundation for a custom translator.<a name="line.267"></a> +<span class="sourceLineNo">268</span> */<a name="line.268"></a> +<span class="sourceLineNo">269</span> public static final CharSequenceTranslator ESCAPE_CSV = new CsvTranslators.CsvEscaper();<a name="line.269"></a> +<span class="sourceLineNo">270</span><a name="line.270"></a> +<span class="sourceLineNo">271</span> /**<a name="line.271"></a> +<span class="sourceLineNo">272</span> * Translator object for escaping Shell command language.<a name="line.272"></a> +<span class="sourceLineNo">273</span> *<a name="line.273"></a> +<span class="sourceLineNo">274</span> * @see <a href="http://pubs.opengroup.org/onlinepubs/7908799/xcu/chap2.html">Shell Command Language</a><a name="line.274"></a> +<span class="sourceLineNo">275</span> */<a name="line.275"></a> +<span class="sourceLineNo">276</span> public static final CharSequenceTranslator ESCAPE_XSI;<a name="line.276"></a> +<span class="sourceLineNo">277</span> static {<a name="line.277"></a> +<span class="sourceLineNo">278</span> Map<CharSequence, CharSequence> escapeXsiMap = new HashMap<>();<a name="line.278"></a> +<span class="sourceLineNo">279</span> escapeXsiMap.put("|", "\\|");<a name="line.279"></a> +<span class="sourceLineNo">280</span> escapeXsiMap.put("&", "\\&");<a name="line.280"></a> +<span class="sourceLineNo">281</span> escapeXsiMap.put(";", "\\;");<a name="line.281"></a> +<span class="sourceLineNo">282</span> escapeXsiMap.put("<", "\\<");<a name="line.282"></a> +<span class="sourceLineNo">283</span> escapeXsiMap.put(">", "\\>");<a name="line.283"></a> +<span class="sourceLineNo">284</span> escapeXsiMap.put("(", "\\(");<a name="line.284"></a> +<span class="sourceLineNo">285</span> escapeXsiMap.put(")", "\\)");<a name="line.285"></a> +<span class="sourceLineNo">286</span> escapeXsiMap.put("$", "\\$");<a name="line.286"></a> +<span class="sourceLineNo">287</span> escapeXsiMap.put("`", "\\`");<a name="line.287"></a> +<span class="sourceLineNo">288</span> escapeXsiMap.put("\\", "\\\\");<a name="line.288"></a> +<span class="sourceLineNo">289</span> escapeXsiMap.put("\"", "\\\"");<a name="line.289"></a> +<span class="sourceLineNo">290</span> escapeXsiMap.put("'", "\\'");<a name="line.290"></a> +<span class="sourceLineNo">291</span> escapeXsiMap.put(" ", "\\ ");<a name="line.291"></a> +<span class="sourceLineNo">292</span> escapeXsiMap.put("\t", "\\\t");<a name="line.292"></a> +<span class="sourceLineNo">293</span> escapeXsiMap.put("\r\n", "");<a name="line.293"></a> +<span class="sourceLineNo">294</span> escapeXsiMap.put("\n", "");<a name="line.294"></a> +<span class="sourceLineNo">295</span> escapeXsiMap.put("*", "\\*");<a name="line.295"></a> +<span class="sourceLineNo">296</span> escapeXsiMap.put("?", "\\?");<a name="line.296"></a> +<span class="sourceLineNo">297</span> escapeXsiMap.put("[", "\\[");<a name="line.297"></a> +<span class="sourceLineNo">298</span> escapeXsiMap.put("#", "\\#");<a name="line.298"></a> +<span class="sourceLineNo">299</span> escapeXsiMap.put("~", "\\~");<a name="line.299"></a> +<span class="sourceLineNo">300</span> escapeXsiMap.put("=", "\\=");<a name="line.300"></a> +<span class="sourceLineNo">301</span> escapeXsiMap.put("%", "\\%");<a name="line.301"></a> +<span class="sourceLineNo">302</span> ESCAPE_XSI = new LookupTranslator(<a name="line.302"></a> +<span class="sourceLineNo">303</span> Collections.unmodifiableMap(escapeXsiMap)<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> /* UNESCAPE TRANSLATORS */<a name="line.307"></a> +<span class="sourceLineNo">308</span><a name="line.308"></a> +<span class="sourceLineNo">309</span> /**<a name="line.309"></a> +<span class="sourceLineNo">310</span> * Translator object for unescaping escaped Java. <a name="line.310"></a> +<span class="sourceLineNo">311</span> *<a name="line.311"></a> +<span class="sourceLineNo">312</span> * While {@link #unescapeJava(String)} is the expected method of use, this <a name="line.312"></a> +<span class="sourceLineNo">313</span> * object allows the Java unescaping functionality to be used <a name="line.313"></a> +<span class="sourceLineNo">314</span> * as the foundation for a custom translator.<a name="line.314"></a> +<span class="sourceLineNo">315</span> */<a name="line.315"></a> +<span class="sourceLineNo">316</span> // TODO: throw "illegal character: \92" as an Exception if a \ on the end of the Java (as per the compiler)?<a name="line.316"></a> +<span class="sourceLineNo">317</span> public static final CharSequenceTranslator UNESCAPE_JAVA;<a name="line.317"></a> +<span class="sourceLineNo">318</span> static {<a name="line.318"></a> +<span class="sourceLineNo">319</span> Map<CharSequence, CharSequence> unescapeJavaMap = new HashMap<>();<a name="line.319"></a> +<span class="sourceLineNo">320</span> unescapeJavaMap.put("\\\\", "\\");<a name="line.320"></a> +<span class="sourceLineNo">321</span> unescapeJavaMap.put("\\\"", "\"");<a name="line.321"></a> +<span class="sourceLineNo">322</span> unescapeJavaMap.put("\\'", "'");<a name="line.322"></a> +<span class="sourceLineNo">323</span> unescapeJavaMap.put("\\", "");<a name="line.323"></a> +<span class="sourceLineNo">324</span> UNESCAPE_JAVA = new AggregateTranslator(<a name="line.324"></a> +<span class="sourceLineNo">325</span> new OctalUnescaper(), // .between('\1', '\377'),<a name="line.325"></a> +<span class="sourceLineNo">326</span> new UnicodeUnescaper(),<a name="line.326"></a> +<span class="sourceLineNo">327</span> new LookupTranslator(EntityArrays.JAVA_CTRL_CHARS_UNESCAPE),<a name="line.327"></a> +<span class="sourceLineNo">328</span> new LookupTranslator(Collections.unmodifiableMap(unescapeJavaMap))<a name="line.328"></a> +<span class="sourceLineNo">329</span> );<a name="line.329"></a> +<span class="sourceLineNo">330</span> }<a name="line.330"></a> +<span class="sourceLineNo">331</span><a name="line.331"></a> +<span class="sourceLineNo">332</span> /**<a name="line.332"></a> +<span class="sourceLineNo">333</span> * Translator object for unescaping escaped EcmaScript. <a name="line.333"></a> +<span class="sourceLineNo">334</span> *<a name="line.334"></a> +<span class="sourceLineNo">335</span> * While {@link #unescapeEcmaScript(String)} is the expected method of use, this <a name="line.335"></a> +<span class="sourceLineNo">336</span> * object allows the EcmaScript unescaping functionality to be used <a name="line.336"></a> +<span class="sourceLineNo">337</span> * as the foundation for a custom translator.<a name="line.337"></a> +<span class="sourceLineNo">338</span> */<a name="line.338"></a> +<span class="sourceLineNo">339</span> public static final CharSequenceTranslator UNESCAPE_ECMASCRIPT = UNESCAPE_JAVA;<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> * Translator object for unescaping escaped Json.<a name="line.342"></a> +<span class="sourceLineNo">343</span> *<a name="line.343"></a> +<span class="sourceLineNo">344</span> * While {@link #unescapeJson(String)} is the expected method of use, this<a name="line.344"></a> +<span class="sourceLineNo">345</span> * object allows the Json unescaping functionality to be used<a name="line.345"></a> +<span class="sourceLineNo">346</span> * as the foundation for a custom translator.<a name="line.346"></a> +<span class="sourceLineNo">347</span> */<a name="line.347"></a> +<span class="sourceLineNo">348</span> public static final CharSequenceTranslator UNESCAPE_JSON = UNESCAPE_JAVA;<a name="line.348"></a> +<span class="sourceLineNo">349</span><a name="line.349"></a> +<span class="sourceLineNo">350</span> /**<a name="line.350"></a> +<span class="sourceLineNo">351</span> * Translator object for unescaping escaped HTML 3.0. <a name="line.351"></a> +<span class="sourceLineNo">352</span> *<a name="line.352"></a> +<span class="sourceLineNo">353</span> * While {@link #unescapeHtml3(String)} is the expected method of use, this <a name="line.353"></a> +<span class="sourceLineNo">354</span> * object allows the HTML unescaping functionality to be used <a name="line.354"></a> +<span class="sourceLineNo">355</span> * as the foundation for a custom translator.<a name="line.355"></a> +<span class="sourceLineNo">356</span> */<a name="line.356"></a> +<span class="sourceLineNo">357</span> public static final CharSequenceTranslator UNESCAPE_HTML3 =<a name="line.357"></a> +<span class="sourceLineNo">358</span> new AggregateTranslator(<a name="line.358"></a> +<span class="sourceLineNo">359</span> new LookupTranslator(EntityArrays.BASIC_UNESCAPE),<a name="line.359"></a> +<span class="sourceLineNo">360</span> new LookupTranslator(EntityArrays.ISO8859_1_UNESCAPE),<a name="line.360"></a> +<span class="sourceLineNo">361</span> new NumericEntityUnescaper()<a name="line.361"></a> +<span class="sourceLineNo">362</span> );<a name="line.362"></a> +<span class="sourceLineNo">363</span><a name="line.363"></a> +<span class="sourceLineNo">364</span> /**<a name="line.364"></a> +<span class="sourceLineNo">365</span> * Translator object for unescaping escaped HTML 4.0. <a name="line.365"></a> +<span class="sourceLineNo">366</span> *<a name="line.366"></a> +<span class="sourceLineNo">367</span> * While {@link #unescapeHtml4(String)} is the expected method of use, this <a name="line.367"></a> +<span class="sourceLineNo">368</span> * object allows the HTML unescaping functionality to be used <a name="line.368"></a> +<span class="sourceLineNo">369</span> * as the foundation for a custom translator.<a name="line.369"></a> +<span class="sourceLineNo">370</span> */<a name="line.370"></a> +<span class="sourceLineNo">371</span> public static final CharSequenceTranslator UNESCAPE_HTML4 =<a name="line.371"></a> +<span class="sourceLineNo">372</span> new AggregateTranslator(<a name="line.372"></a> +<span class="sourceLineNo">373</span> new LookupTranslator(EntityArrays.BASIC_UNESCAPE),<a name="line.373"></a> +<span class="sourceLineNo">374</span> new LookupTranslator(EntityArrays.ISO8859_1_UNESCAPE),<a name="line.374"></a> +<span class="sourceLineNo">375</span> new LookupTranslator(EntityArrays.HTML40_EXTENDED_UNESCAPE),<a name="line.375"></a> +<span class="sourceLineNo">376</span> new NumericEntityUnescaper()<a name="line.376"></a> +<span class="sourceLineNo">377</span> );<a name="line.377"></a> +<span class="sourceLineNo">378</span><a name="line.378"></a> +<span class="sourceLineNo">379</span> /**<a name="line.379"></a> +<span class="sourceLineNo">380</span> * Translator object for unescaping escaped XML.<a name="line.380"></a> +<span class="sourceLineNo">381</span> *<a name="line.381"></a> +<span class="sourceLineNo">382</span> * While {@link #unescapeXml(String)} is the expected method of use, this <a name="line.382"></a> +<span class="sourceLineNo">383</span> * object allows the XML unescaping functionality to be used <a name="line.383"></a> +<span class="sourceLineNo">384</span> * as the foundation for a custom translator.<a name="line.384"></a> +<span class="sourceLineNo">385</span> */<a name="line.385"></a> +<span class="sourceLineNo">386</span> public static final CharSequenceTranslator UNESCAPE_XML =<a name="line.386"></a> +<span class="sourceLineNo">387</span> new AggregateTranslator(<a name="line.387"></a> +<span class="sourceLineNo">388</span> new LookupTranslator(EntityArrays.BASIC_UNESCAPE),<a name="line.388"></a> +<span class="sourceLineNo">389</span> new LookupTranslator(EntityArrays.APOS_UNESCAPE),<a name="line.389"></a> +<span class="sourceLineNo">390</span> new NumericEntityUnescaper()<a name="line.390"></a> +<span class="sourceLineNo">391</span> );<a name="line.391"></a> +<span class="sourceLineNo">392</span><a name="line.392"></a> +<span class="sourceLineNo">393</span> /**<a name="line.393"></a> +<span class="sourceLineNo">394</span> * Translator object for unescaping escaped Comma Separated Value entries.<a name="line.394"></a> +<span class="sourceLineNo">395</span> *<a name="line.395"></a> +<span class="sourceLineNo">396</span> * While {@link #unescapeCsv(String)} is the expected method of use, this <a name="line.396"></a> +<span class="sourceLineNo">397</span> * object allows the CSV unescaping functionality to be used <a name="line.397"></a> +<span class="sourceLineNo">398</span> * as the foundation for a custom translator.<a name="line.398"></a> +<span class="sourceLineNo">399</span> */<a name="line.399"></a> +<span class="sourceLineNo">400</span> public static final CharSequenceTranslator UNESCAPE_CSV = new CsvTranslators.CsvUnescaper();<a name="line.400"></a> +<span class="sourceLineNo">401</span><a name="line.401"></a> +<span class="sourceLineNo">402</span> public static final CharSequenceTranslator UNESCAPE_XSI = new XsiUnescaper();<a name="line.402"></a> +<span class="sourceLineNo">403</span><a name="line.403"></a> +<span class="sourceLineNo">404</span> /**<a name="line.404"></a> +<span class="sourceLineNo">405</span> * Translator object for unescaping backslash escaped entries.<a name="line.405"></a> +<span class="sourceLineNo">406</span> */<a name="line.406"></a> +<span class="sourceLineNo">407</span> static class XsiUnescaper extends CharSequenceTranslator {<a name="line.407"></a> +<span class="sourceLineNo">408</span><a name="line.408"></a> +<span class="sourceLineNo">409</span> private static final char BACKSLASH = '\\';<a name="line.409"></a> +<span class="sourceLineNo">410</span><a name="line.410"></a> +<span class="sourceLineNo">411</span> @Override<a name="line.411"></a> +<span class="sourceLineNo">412</span> public int translate(final CharSequence input, final int index, final Writer out) throws IOException {<a name="line.412"></a> +<span class="sourceLineNo">413</span><a name="line.413"></a> +<span class="sourceLineNo">414</span> if(index != 0) {<a name="line.414"></a> +<span class="sourceLineNo">415</span> throw new IllegalStateException("XsiUnescaper should never reach the [1] index");<a name="line.415"></a> +<span class="sourceLineNo">416</span> }<a name="line.416"></a> +<span class="sourceLineNo">417</span><a name="line.417"></a> +<span class="sourceLineNo">418</span> String s = input.toString();<a name="line.418"></a> +<span class="sourceLineNo">419</span><a name="line.419"></a> +<span class="sourceLineNo">420</span> int segmentStart = 0;<a name="line.420"></a> +<span class="sourceLineNo">421</span> int searchOffset = 0;<a name="line.421"></a> +<span class="sourceLineNo">422</span> while (true) {<a name="line.422"></a> +<span class="sourceLineNo">423</span> int pos = s.indexOf(BACKSLASH, searchOffset);<a name="line.423"></a> +<span class="sourceLineNo">424</span> if (pos == -1) {<a name="line.424"></a> +<span class="sourceLineNo">425</span> if (segmentStart < s.length()) {<a name="line.425"></a> +<span class="sourceLineNo">426</span> out.write(s.substring(segmentStart));<a name="line.426"></a> +<span class="sourceLineNo">427</span> }<a name="line.427"></a> +<span class="sourceLineNo">428</span> break;<a name="line.428"></a> +<span class="sourceLineNo">429</span> }<a name="line.429"></a> +<span class="sourceLineNo">430</span> if (pos > segmentStart) {<a name="line.430"></a> +<span class="sourceLineNo">431</span> out.write(s.substring(segmentStart, pos));<a name="line.431"></a> +<span class="sourceLineNo">432</span> }<a name="line.432"></a> +<span class="sourceLineNo">433</span> segmentStart = pos + 1;<a name="line.433"></a> +<span class="sourceLineNo">434</span> searchOffset = pos + 2;<a name="line.434"></a> +<span class="sourceLineNo">435</span> }<a name="line.435"></a> +<span class="sourceLineNo">436</span><a name="line.436"></a> +<span class="sourceLineNo">437</span> return Character.codePointCount(input, 0, input.length());<a name="line.437"></a> +<span class="sourceLineNo">438</span> }<a name="line.438"></a> +<span class="sourceLineNo">439</span> }<a name="line.439"></a> +<span class="sourceLineNo">440</span><a name="line.440"></a> +<span class="sourceLineNo">441</span> /* Helper functions */<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> * <p>{@code StringEscapeUtils} instances should NOT be constructed in<a name="line.444"></a> +<span class="sourceLineNo">445</span> * standard programming.</p><a name="line.445"></a> +<span class="sourceLineNo">446</span> *<a name="line.446"></a> +<span class="sourceLineNo">447</span> * <p>Instead, the class should be used as:</p><a name="line.447"></a> +<span class="sourceLineNo">448</span> * <pre>StringEscapeUtils.escapeJava("foo");</pre><a name="line.448"></a> +<span class="sourceLineNo">449</span> *<a name="line.449"></a> +<span class="sourceLineNo">450</span> * <p>This constructor is public to permit tools that require a JavaBean<a name="line.450"></a> +<span class="sourceLineNo">451</span> * instance to operate.</p><a name="line.451"></a> <span class="sourceLineNo">452</span> */<a name="line.452"></a> -<span class="sourceLineNo">453</span> static class XsiUnescaper extends CharSequenceTranslator {<a name="line.453"></a> -<span class="sourceLineNo">454</span><a name="line.454"></a> -<span class="sourceLineNo">455</span> private static final char BACKSLASH = '\\';<a name="line.455"></a> +<span class="sourceLineNo">453</span> public StringEscapeUtils() {<a name="line.453"></a> +<span class="sourceLineNo">454</span> super();<a name="line.454"></a> +<span class="sourceLineNo">455</span> }<a name="line.455"></a> <span class="sourceLineNo">456</span><a name="line.456"></a> -<span class="sourceLineNo">457</span> @Override<a name="line.457"></a> -<span class="sourceLineNo">458</span> public int translate(final CharSequence input, final int index, final Writer out) throws IOException {<a name="line.458"></a> -<span class="sourceLineNo">459</span><a name="line.459"></a>
[... 992 lines stripped ...]