blob: 8832c4a8a186d451b5a2dc7b983e53e4b1feeb41 [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.impl;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.Serializable;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.util.Arrays;<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.HashSet;<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.Set;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.Stack;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.pattern.PlainTextRenderer;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.pattern.TextRenderer;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.util.StackLocatorUtil;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.util.Strings;<a name="line.31"></a>
<span class="sourceLineNo">032</span><a name="line.32"></a>
<span class="sourceLineNo">033</span>/**<a name="line.33"></a>
<span class="sourceLineNo">034</span> * Wraps a Throwable to add packaging information about each stack trace element.<a name="line.34"></a>
<span class="sourceLineNo">035</span> *<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;p&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> * A proxy is used to represent a throwable that may not exist in a different class loader or JVM. When an application<a name="line.37"></a>
<span class="sourceLineNo">038</span> * deserializes a ThrowableProxy, the throwable may not be set, but the throwable's information is preserved in other<a name="line.38"></a>
<span class="sourceLineNo">039</span> * fields of the proxy like the message and stack trace.<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;/p&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> *<a name="line.41"></a>
<span class="sourceLineNo">042</span> * &lt;p&gt;<a name="line.42"></a>
<span class="sourceLineNo">043</span> * TODO: Move this class to org.apache.logging.log4j.core because it is used from LogEvent.<a name="line.43"></a>
<span class="sourceLineNo">044</span> * &lt;/p&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;p&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> * TODO: Deserialize: Try to rebuild Throwable if the target exception is in this class loader?<a name="line.46"></a>
<span class="sourceLineNo">047</span> * &lt;/p&gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span> */<a name="line.48"></a>
<span class="sourceLineNo">049</span>public class ThrowableProxy implements Serializable {<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> private static final char EOL = '\n';<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> private static final String EOL_STR = String.valueOf(EOL);<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> private static final long serialVersionUID = -2752771578252251910L;<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span> private final ThrowableProxy causeProxy;<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span> private int commonElementCount;<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> private final ExtendedStackTraceElement[] extendedStackTrace;<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> private final String localizedMessage;<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span> private final String message;<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> private final String name;<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span> private final ThrowableProxy[] suppressedProxies;<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> private final transient Throwable throwable;<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> * For JSON and XML IO via Jackson.<a name="line.74"></a>
<span class="sourceLineNo">075</span> */<a name="line.75"></a>
<span class="sourceLineNo">076</span> @SuppressWarnings("unused")<a name="line.76"></a>
<span class="sourceLineNo">077</span> private ThrowableProxy() {<a name="line.77"></a>
<span class="sourceLineNo">078</span> this.throwable = null;<a name="line.78"></a>
<span class="sourceLineNo">079</span> this.name = null;<a name="line.79"></a>
<span class="sourceLineNo">080</span> this.extendedStackTrace = null;<a name="line.80"></a>
<span class="sourceLineNo">081</span> this.causeProxy = null;<a name="line.81"></a>
<span class="sourceLineNo">082</span> this.message = null;<a name="line.82"></a>
<span class="sourceLineNo">083</span> this.localizedMessage = null;<a name="line.83"></a>
<span class="sourceLineNo">084</span> this.suppressedProxies = ThrowableProxyHelper.EMPTY_THROWABLE_PROXY_ARRAY;<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> /**<a name="line.87"></a>
<span class="sourceLineNo">088</span> * Constructs the wrapper for the Throwable that includes packaging data.<a name="line.88"></a>
<span class="sourceLineNo">089</span> *<a name="line.89"></a>
<span class="sourceLineNo">090</span> * @param throwable The Throwable to wrap, must not be null.<a name="line.90"></a>
<span class="sourceLineNo">091</span> */<a name="line.91"></a>
<span class="sourceLineNo">092</span> public ThrowableProxy(final Throwable throwable) {<a name="line.92"></a>
<span class="sourceLineNo">093</span> this(throwable, null);<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> * Constructs the wrapper for the Throwable that includes packaging data.<a name="line.97"></a>
<span class="sourceLineNo">098</span> *<a name="line.98"></a>
<span class="sourceLineNo">099</span> * @param throwable The Throwable to wrap, must not be null.<a name="line.99"></a>
<span class="sourceLineNo">100</span> * @param visited The set of visited suppressed exceptions.<a name="line.100"></a>
<span class="sourceLineNo">101</span> */<a name="line.101"></a>
<span class="sourceLineNo">102</span> ThrowableProxy(final Throwable throwable, final Set&lt;Throwable&gt; visited) {<a name="line.102"></a>
<span class="sourceLineNo">103</span> this.throwable = throwable;<a name="line.103"></a>
<span class="sourceLineNo">104</span> this.name = throwable.getClass().getName();<a name="line.104"></a>
<span class="sourceLineNo">105</span> this.message = throwable.getMessage();<a name="line.105"></a>
<span class="sourceLineNo">106</span> this.localizedMessage = throwable.getLocalizedMessage();<a name="line.106"></a>
<span class="sourceLineNo">107</span> final Map&lt;String, ThrowableProxyHelper.CacheEntry&gt; map = new HashMap&lt;&gt;();<a name="line.107"></a>
<span class="sourceLineNo">108</span> final Stack&lt;Class&lt;?&gt;&gt; stack = StackLocatorUtil.getCurrentStackTrace();<a name="line.108"></a>
<span class="sourceLineNo">109</span> this.extendedStackTrace = ThrowableProxyHelper.toExtendedStackTrace(this, stack, map, null, throwable.getStackTrace());<a name="line.109"></a>
<span class="sourceLineNo">110</span> final Throwable throwableCause = throwable.getCause();<a name="line.110"></a>
<span class="sourceLineNo">111</span> final Set&lt;Throwable&gt; causeVisited = new HashSet&lt;&gt;(1);<a name="line.111"></a>
<span class="sourceLineNo">112</span> this.causeProxy = throwableCause == null ? null : new ThrowableProxy(throwable, stack, map, throwableCause,<a name="line.112"></a>
<span class="sourceLineNo">113</span> visited, causeVisited);<a name="line.113"></a>
<span class="sourceLineNo">114</span> this.suppressedProxies = ThrowableProxyHelper.toSuppressedProxies(throwable, visited);<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> /**<a name="line.117"></a>
<span class="sourceLineNo">118</span> * Constructs the wrapper for a Throwable that is referenced as the cause by another Throwable.<a name="line.118"></a>
<span class="sourceLineNo">119</span> *<a name="line.119"></a>
<span class="sourceLineNo">120</span> * @param parent The Throwable referencing this Throwable.<a name="line.120"></a>
<span class="sourceLineNo">121</span> * @param stack The Class stack.<a name="line.121"></a>
<span class="sourceLineNo">122</span> * @param map The cache containing the packaging data.<a name="line.122"></a>
<span class="sourceLineNo">123</span> * @param cause The Throwable to wrap.<a name="line.123"></a>
<span class="sourceLineNo">124</span> * @param suppressedVisited TODO<a name="line.124"></a>
<span class="sourceLineNo">125</span> * @param causeVisited TODO<a name="line.125"></a>
<span class="sourceLineNo">126</span> */<a name="line.126"></a>
<span class="sourceLineNo">127</span> private ThrowableProxy(final Throwable parent, final Stack&lt;Class&lt;?&gt;&gt; stack,<a name="line.127"></a>
<span class="sourceLineNo">128</span> final Map&lt;String, ThrowableProxyHelper.CacheEntry&gt; map,<a name="line.128"></a>
<span class="sourceLineNo">129</span> final Throwable cause, final Set&lt;Throwable&gt; suppressedVisited,<a name="line.129"></a>
<span class="sourceLineNo">130</span> final Set&lt;Throwable&gt; causeVisited) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> causeVisited.add(cause);<a name="line.131"></a>
<span class="sourceLineNo">132</span> this.throwable = cause;<a name="line.132"></a>
<span class="sourceLineNo">133</span> this.name = cause.getClass().getName();<a name="line.133"></a>
<span class="sourceLineNo">134</span> this.message = this.throwable.getMessage();<a name="line.134"></a>
<span class="sourceLineNo">135</span> this.localizedMessage = this.throwable.getLocalizedMessage();<a name="line.135"></a>
<span class="sourceLineNo">136</span> this.extendedStackTrace = ThrowableProxyHelper.toExtendedStackTrace(this, stack, map, parent.getStackTrace(), cause.getStackTrace());<a name="line.136"></a>
<span class="sourceLineNo">137</span> final Throwable causeCause = cause.getCause();<a name="line.137"></a>
<span class="sourceLineNo">138</span> this.causeProxy = causeCause == null || causeVisited.contains(causeCause) ? null : new ThrowableProxy(parent,<a name="line.138"></a>
<span class="sourceLineNo">139</span> stack, map, causeCause, suppressedVisited, causeVisited);<a name="line.139"></a>
<span class="sourceLineNo">140</span> this.suppressedProxies = ThrowableProxyHelper.toSuppressedProxies(cause, suppressedVisited);<a name="line.140"></a>
<span class="sourceLineNo">141</span> }<a name="line.141"></a>
<span class="sourceLineNo">142</span><a name="line.142"></a>
<span class="sourceLineNo">143</span> @Override<a name="line.143"></a>
<span class="sourceLineNo">144</span> public boolean equals(final Object obj) {<a name="line.144"></a>
<span class="sourceLineNo">145</span> if (this == obj) {<a name="line.145"></a>
<span class="sourceLineNo">146</span> return true;<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span> if (obj == null) {<a name="line.148"></a>
<span class="sourceLineNo">149</span> return false;<a name="line.149"></a>
<span class="sourceLineNo">150</span> }<a name="line.150"></a>
<span class="sourceLineNo">151</span> if (this.getClass() != obj.getClass()) {<a name="line.151"></a>
<span class="sourceLineNo">152</span> return false;<a name="line.152"></a>
<span class="sourceLineNo">153</span> }<a name="line.153"></a>
<span class="sourceLineNo">154</span> final ThrowableProxy other = (ThrowableProxy) obj;<a name="line.154"></a>
<span class="sourceLineNo">155</span> if (this.causeProxy == null) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> if (other.causeProxy != null) {<a name="line.156"></a>
<span class="sourceLineNo">157</span> return false;<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<a name="line.158"></a>
<span class="sourceLineNo">159</span> } else if (!this.causeProxy.equals(other.causeProxy)) {<a name="line.159"></a>
<span class="sourceLineNo">160</span> return false;<a name="line.160"></a>
<span class="sourceLineNo">161</span> }<a name="line.161"></a>
<span class="sourceLineNo">162</span> if (this.commonElementCount != other.commonElementCount) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> return false;<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span> if (this.name == null) {<a name="line.165"></a>
<span class="sourceLineNo">166</span> if (other.name != null) {<a name="line.166"></a>
<span class="sourceLineNo">167</span> return false;<a name="line.167"></a>
<span class="sourceLineNo">168</span> }<a name="line.168"></a>
<span class="sourceLineNo">169</span> } else if (!this.name.equals(other.name)) {<a name="line.169"></a>
<span class="sourceLineNo">170</span> return false;<a name="line.170"></a>
<span class="sourceLineNo">171</span> }<a name="line.171"></a>
<span class="sourceLineNo">172</span> if (!Arrays.equals(this.extendedStackTrace, other.extendedStackTrace)) {<a name="line.172"></a>
<span class="sourceLineNo">173</span> return false;<a name="line.173"></a>
<span class="sourceLineNo">174</span> }<a name="line.174"></a>
<span class="sourceLineNo">175</span> if (!Arrays.equals(this.suppressedProxies, other.suppressedProxies)) {<a name="line.175"></a>
<span class="sourceLineNo">176</span> return false;<a name="line.176"></a>
<span class="sourceLineNo">177</span> }<a name="line.177"></a>
<span class="sourceLineNo">178</span> return true;<a name="line.178"></a>
<span class="sourceLineNo">179</span> }<a name="line.179"></a>
<span class="sourceLineNo">180</span><a name="line.180"></a>
<span class="sourceLineNo">181</span> /**<a name="line.181"></a>
<span class="sourceLineNo">182</span> * Formats the specified Throwable.<a name="line.182"></a>
<span class="sourceLineNo">183</span> * @param sb StringBuilder to contain the formatted Throwable.<a name="line.183"></a>
<span class="sourceLineNo">184</span> * @param cause The Throwable to format.<a name="line.184"></a>
<span class="sourceLineNo">185</span> * @param suffix<a name="line.185"></a>
<span class="sourceLineNo">186</span> */<a name="line.186"></a>
<span class="sourceLineNo">187</span> public void formatWrapper(final StringBuilder sb, final ThrowableProxy cause, final String suffix) {<a name="line.187"></a>
<span class="sourceLineNo">188</span> this.formatWrapper(sb, cause, null, PlainTextRenderer.getInstance(), suffix);<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> /**<a name="line.191"></a>
<span class="sourceLineNo">192</span> * Formats the specified Throwable.<a name="line.192"></a>
<span class="sourceLineNo">193</span> * @param sb StringBuilder to contain the formatted Throwable.<a name="line.193"></a>
<span class="sourceLineNo">194</span> * @param cause The Throwable to format.<a name="line.194"></a>
<span class="sourceLineNo">195</span> * @param ignorePackages The List of packages to be suppressed from the trace.<a name="line.195"></a>
<span class="sourceLineNo">196</span> * @param suffix<a name="line.196"></a>
<span class="sourceLineNo">197</span> */<a name="line.197"></a>
<span class="sourceLineNo">198</span> @SuppressWarnings("ThrowableResultOfMethodCallIgnored")<a name="line.198"></a>
<span class="sourceLineNo">199</span> public void formatWrapper(final StringBuilder sb, final ThrowableProxy cause, final List&lt;String&gt; ignorePackages, final String suffix) {<a name="line.199"></a>
<span class="sourceLineNo">200</span> this.formatWrapper(sb, cause, ignorePackages, PlainTextRenderer.getInstance(), suffix);<a name="line.200"></a>
<span class="sourceLineNo">201</span> }<a name="line.201"></a>
<span class="sourceLineNo">202</span><a name="line.202"></a>
<span class="sourceLineNo">203</span> /**<a name="line.203"></a>
<span class="sourceLineNo">204</span> * Formats the specified Throwable.<a name="line.204"></a>
<span class="sourceLineNo">205</span> * @param sb StringBuilder to contain the formatted Throwable.<a name="line.205"></a>
<span class="sourceLineNo">206</span> * @param cause The Throwable to format.<a name="line.206"></a>
<span class="sourceLineNo">207</span> * @param ignorePackages The List of packages to be suppressed from the stack trace.<a name="line.207"></a>
<span class="sourceLineNo">208</span> * @param textRenderer The text renderer.<a name="line.208"></a>
<span class="sourceLineNo">209</span> * @param suffix Append this to the end of each stack frame.<a name="line.209"></a>
<span class="sourceLineNo">210</span> */<a name="line.210"></a>
<span class="sourceLineNo">211</span> @SuppressWarnings("ThrowableResultOfMethodCallIgnored")<a name="line.211"></a>
<span class="sourceLineNo">212</span> public void formatWrapper(final StringBuilder sb, final ThrowableProxy cause, final List&lt;String&gt; ignorePackages,<a name="line.212"></a>
<span class="sourceLineNo">213</span> final TextRenderer textRenderer, final String suffix) {<a name="line.213"></a>
<span class="sourceLineNo">214</span> formatWrapper(sb, cause, ignorePackages, textRenderer, suffix, EOL_STR);<a name="line.214"></a>
<span class="sourceLineNo">215</span> }<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> * Formats the specified Throwable.<a name="line.218"></a>
<span class="sourceLineNo">219</span> * @param sb StringBuilder to contain the formatted Throwable.<a name="line.219"></a>
<span class="sourceLineNo">220</span> * @param cause The Throwable to format.<a name="line.220"></a>
<span class="sourceLineNo">221</span> * @param ignorePackages The List of packages to be suppressed from the stack trace.<a name="line.221"></a>
<span class="sourceLineNo">222</span> * @param textRenderer The text renderer.<a name="line.222"></a>
<span class="sourceLineNo">223</span> * @param suffix Append this to the end of each stack frame.<a name="line.223"></a>
<span class="sourceLineNo">224</span> * @param lineSeparator The end-of-line separator.<a name="line.224"></a>
<span class="sourceLineNo">225</span> */<a name="line.225"></a>
<span class="sourceLineNo">226</span> @SuppressWarnings("ThrowableResultOfMethodCallIgnored")<a name="line.226"></a>
<span class="sourceLineNo">227</span> public void formatWrapper(final StringBuilder sb, final ThrowableProxy cause, final List&lt;String&gt; ignorePackages,<a name="line.227"></a>
<span class="sourceLineNo">228</span> final TextRenderer textRenderer, final String suffix, final String lineSeparator) {<a name="line.228"></a>
<span class="sourceLineNo">229</span> ThrowableProxyRenderer.formatWrapper(sb, cause, ignorePackages, textRenderer, suffix, lineSeparator);<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> public ThrowableProxy getCauseProxy() {<a name="line.232"></a>
<span class="sourceLineNo">233</span> return this.causeProxy;<a name="line.233"></a>
<span class="sourceLineNo">234</span> }<a name="line.234"></a>
<span class="sourceLineNo">235</span><a name="line.235"></a>
<span class="sourceLineNo">236</span> /**<a name="line.236"></a>
<span class="sourceLineNo">237</span> * Formats the Throwable that is the cause of this Throwable.<a name="line.237"></a>
<span class="sourceLineNo">238</span> *<a name="line.238"></a>
<span class="sourceLineNo">239</span> * @return The formatted Throwable that caused this Throwable.<a name="line.239"></a>
<span class="sourceLineNo">240</span> * @param suffix<a name="line.240"></a>
<span class="sourceLineNo">241</span> */<a name="line.241"></a>
<span class="sourceLineNo">242</span> public String getCauseStackTraceAsString(final String suffix) {<a name="line.242"></a>
<span class="sourceLineNo">243</span> return this.getCauseStackTraceAsString(null, PlainTextRenderer.getInstance(), suffix, EOL_STR);<a name="line.243"></a>
<span class="sourceLineNo">244</span> }<a name="line.244"></a>
<span class="sourceLineNo">245</span><a name="line.245"></a>
<span class="sourceLineNo">246</span> /**<a name="line.246"></a>
<span class="sourceLineNo">247</span> * Formats the Throwable that is the cause of this Throwable.<a name="line.247"></a>
<span class="sourceLineNo">248</span> *<a name="line.248"></a>
<span class="sourceLineNo">249</span> * @param packages The List of packages to be suppressed from the trace.<a name="line.249"></a>
<span class="sourceLineNo">250</span> * @param suffix Append this to the end of each stack frame.<a name="line.250"></a>
<span class="sourceLineNo">251</span> * @return The formatted Throwable that caused this Throwable.<a name="line.251"></a>
<span class="sourceLineNo">252</span> */<a name="line.252"></a>
<span class="sourceLineNo">253</span> public String getCauseStackTraceAsString(final List&lt;String&gt; packages, final String suffix) {<a name="line.253"></a>
<span class="sourceLineNo">254</span> return getCauseStackTraceAsString(packages, PlainTextRenderer.getInstance(), suffix, EOL_STR);<a name="line.254"></a>
<span class="sourceLineNo">255</span> }<a name="line.255"></a>
<span class="sourceLineNo">256</span><a name="line.256"></a>
<span class="sourceLineNo">257</span> /**<a name="line.257"></a>
<span class="sourceLineNo">258</span> * Formats the Throwable that is the cause of this Throwable.<a name="line.258"></a>
<span class="sourceLineNo">259</span> *<a name="line.259"></a>
<span class="sourceLineNo">260</span> * @param ignorePackages The List of packages to be suppressed from the trace.<a name="line.260"></a>
<span class="sourceLineNo">261</span> * @param textRenderer The text renderer.<a name="line.261"></a>
<span class="sourceLineNo">262</span> * @param suffix Append this to the end of each stack frame.<a name="line.262"></a>
<span class="sourceLineNo">263</span> * @return The formatted Throwable that caused this Throwable.<a name="line.263"></a>
<span class="sourceLineNo">264</span> */<a name="line.264"></a>
<span class="sourceLineNo">265</span> public String getCauseStackTraceAsString(final List&lt;String&gt; ignorePackages, final TextRenderer textRenderer, final String suffix) {<a name="line.265"></a>
<span class="sourceLineNo">266</span> return getCauseStackTraceAsString(ignorePackages, textRenderer, suffix, EOL_STR);<a name="line.266"></a>
<span class="sourceLineNo">267</span> }<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> * Formats the Throwable that is the cause of this Throwable.<a name="line.270"></a>
<span class="sourceLineNo">271</span> *<a name="line.271"></a>
<span class="sourceLineNo">272</span> * @param ignorePackages The List of packages to be suppressed from the stack trace.<a name="line.272"></a>
<span class="sourceLineNo">273</span> * @param textRenderer The text renderer.<a name="line.273"></a>
<span class="sourceLineNo">274</span> * @param suffix Append this to the end of each stack frame.<a name="line.274"></a>
<span class="sourceLineNo">275</span> * @param lineSeparator The end-of-line separator.<a name="line.275"></a>
<span class="sourceLineNo">276</span> * @return The formatted Throwable that caused this Throwable.<a name="line.276"></a>
<span class="sourceLineNo">277</span> */<a name="line.277"></a>
<span class="sourceLineNo">278</span> public String getCauseStackTraceAsString(final List&lt;String&gt; ignorePackages, final TextRenderer textRenderer, final String suffix, final String lineSeparator) {<a name="line.278"></a>
<span class="sourceLineNo">279</span> final StringBuilder sb = new StringBuilder();<a name="line.279"></a>
<span class="sourceLineNo">280</span> ThrowableProxyRenderer.formatCauseStackTrace(this, sb, ignorePackages, textRenderer, suffix, lineSeparator);<a name="line.280"></a>
<span class="sourceLineNo">281</span> return sb.toString();<a name="line.281"></a>
<span class="sourceLineNo">282</span> }<a name="line.282"></a>
<span class="sourceLineNo">283</span><a name="line.283"></a>
<span class="sourceLineNo">284</span> /**<a name="line.284"></a>
<span class="sourceLineNo">285</span> * Returns the number of elements that are being omitted because they are common with the parent Throwable's stack<a name="line.285"></a>
<span class="sourceLineNo">286</span> * trace.<a name="line.286"></a>
<span class="sourceLineNo">287</span> *<a name="line.287"></a>
<span class="sourceLineNo">288</span> * @return The number of elements omitted from the stack trace.<a name="line.288"></a>
<span class="sourceLineNo">289</span> */<a name="line.289"></a>
<span class="sourceLineNo">290</span> public int getCommonElementCount() {<a name="line.290"></a>
<span class="sourceLineNo">291</span> return this.commonElementCount;<a name="line.291"></a>
<span class="sourceLineNo">292</span> }<a name="line.292"></a>
<span class="sourceLineNo">293</span><a name="line.293"></a>
<span class="sourceLineNo">294</span> /**<a name="line.294"></a>
<span class="sourceLineNo">295</span> * Set the value of {@link ThrowableProxy#commonElementCount}.<a name="line.295"></a>
<span class="sourceLineNo">296</span> *<a name="line.296"></a>
<span class="sourceLineNo">297</span> * Method is package-private, to be used internally for initialization.<a name="line.297"></a>
<span class="sourceLineNo">298</span> *<a name="line.298"></a>
<span class="sourceLineNo">299</span> * @param value New value of commonElementCount.<a name="line.299"></a>
<span class="sourceLineNo">300</span> */<a name="line.300"></a>
<span class="sourceLineNo">301</span> void setCommonElementCount(final int value) {<a name="line.301"></a>
<span class="sourceLineNo">302</span> this.commonElementCount = value;<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> * Gets the stack trace including packaging information.<a name="line.306"></a>
<span class="sourceLineNo">307</span> *<a name="line.307"></a>
<span class="sourceLineNo">308</span> * @return The stack trace including packaging information.<a name="line.308"></a>
<span class="sourceLineNo">309</span> */<a name="line.309"></a>
<span class="sourceLineNo">310</span> public ExtendedStackTraceElement[] getExtendedStackTrace() {<a name="line.310"></a>
<span class="sourceLineNo">311</span> return this.extendedStackTrace;<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> * Formats the stack trace including packaging information.<a name="line.315"></a>
<span class="sourceLineNo">316</span> *<a name="line.316"></a>
<span class="sourceLineNo">317</span> * @return The formatted stack trace including packaging information.<a name="line.317"></a>
<span class="sourceLineNo">318</span> */<a name="line.318"></a>
<span class="sourceLineNo">319</span> public String getExtendedStackTraceAsString() {<a name="line.319"></a>
<span class="sourceLineNo">320</span> return this.getExtendedStackTraceAsString(null, PlainTextRenderer.getInstance(), Strings.EMPTY, EOL_STR);<a name="line.320"></a>
<span class="sourceLineNo">321</span> }<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> * Formats the stack trace including packaging information.<a name="line.324"></a>
<span class="sourceLineNo">325</span> *<a name="line.325"></a>
<span class="sourceLineNo">326</span> * @return The formatted stack trace including packaging information.<a name="line.326"></a>
<span class="sourceLineNo">327</span> * @param suffix Append this to the end of each stack frame.<a name="line.327"></a>
<span class="sourceLineNo">328</span> */<a name="line.328"></a>
<span class="sourceLineNo">329</span> public String getExtendedStackTraceAsString(final String suffix) {<a name="line.329"></a>
<span class="sourceLineNo">330</span> return this.getExtendedStackTraceAsString(null, PlainTextRenderer.getInstance(), suffix, EOL_STR);<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> /**<a name="line.333"></a>
<span class="sourceLineNo">334</span> * Formats the stack trace including packaging information.<a name="line.334"></a>
<span class="sourceLineNo">335</span> *<a name="line.335"></a>
<span class="sourceLineNo">336</span> * @param ignorePackages List of packages to be ignored in the trace.<a name="line.336"></a>
<span class="sourceLineNo">337</span> * @param suffix Append this to the end of each stack frame.<a name="line.337"></a>
<span class="sourceLineNo">338</span> * @return The formatted stack trace including packaging information.<a name="line.338"></a>
<span class="sourceLineNo">339</span> */<a name="line.339"></a>
<span class="sourceLineNo">340</span> public String getExtendedStackTraceAsString(final List&lt;String&gt; ignorePackages, final String suffix) {<a name="line.340"></a>
<span class="sourceLineNo">341</span> return getExtendedStackTraceAsString(ignorePackages, PlainTextRenderer.getInstance(), suffix, EOL_STR);<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> * Formats the stack trace including packaging information.<a name="line.345"></a>
<span class="sourceLineNo">346</span> *<a name="line.346"></a>
<span class="sourceLineNo">347</span> * @param ignorePackages List of packages to be ignored in the trace.<a name="line.347"></a>
<span class="sourceLineNo">348</span> * @param textRenderer The message renderer.<a name="line.348"></a>
<span class="sourceLineNo">349</span> * @param suffix Append this to the end of each stack frame.<a name="line.349"></a>
<span class="sourceLineNo">350</span> * @return The formatted stack trace including packaging information.<a name="line.350"></a>
<span class="sourceLineNo">351</span> */<a name="line.351"></a>
<span class="sourceLineNo">352</span> public String getExtendedStackTraceAsString(final List&lt;String&gt; ignorePackages, final TextRenderer textRenderer, final String suffix) {<a name="line.352"></a>
<span class="sourceLineNo">353</span> return getExtendedStackTraceAsString(ignorePackages, textRenderer, suffix, EOL_STR);<a name="line.353"></a>
<span class="sourceLineNo">354</span> }<a name="line.354"></a>
<span class="sourceLineNo">355</span><a name="line.355"></a>
<span class="sourceLineNo">356</span> /**<a name="line.356"></a>
<span class="sourceLineNo">357</span> * Formats the stack trace including packaging information.<a name="line.357"></a>
<span class="sourceLineNo">358</span> *<a name="line.358"></a>
<span class="sourceLineNo">359</span> * @param ignorePackages List of packages to be ignored in the trace.<a name="line.359"></a>
<span class="sourceLineNo">360</span> * @param textRenderer The message renderer.<a name="line.360"></a>
<span class="sourceLineNo">361</span> * @param suffix Append this to the end of each stack frame.<a name="line.361"></a>
<span class="sourceLineNo">362</span> * @param lineSeparator The end-of-line separator.<a name="line.362"></a>
<span class="sourceLineNo">363</span> * @return The formatted stack trace including packaging information.<a name="line.363"></a>
<span class="sourceLineNo">364</span> */<a name="line.364"></a>
<span class="sourceLineNo">365</span> public String getExtendedStackTraceAsString(final List&lt;String&gt; ignorePackages, final TextRenderer textRenderer, final String suffix, final String lineSeparator) {<a name="line.365"></a>
<span class="sourceLineNo">366</span> final StringBuilder sb = new StringBuilder(1024);<a name="line.366"></a>
<span class="sourceLineNo">367</span> formatExtendedStackTraceTo(sb, ignorePackages, textRenderer, suffix, lineSeparator);<a name="line.367"></a>
<span class="sourceLineNo">368</span> return sb.toString();<a name="line.368"></a>
<span class="sourceLineNo">369</span> }<a name="line.369"></a>
<span class="sourceLineNo">370</span><a name="line.370"></a>
<span class="sourceLineNo">371</span> /**<a name="line.371"></a>
<span class="sourceLineNo">372</span> * Formats the stack trace including packaging information.<a name="line.372"></a>
<span class="sourceLineNo">373</span> *<a name="line.373"></a>
<span class="sourceLineNo">374</span> * @param sb Destination.<a name="line.374"></a>
<span class="sourceLineNo">375</span> * @param ignorePackages List of packages to be ignored in the trace.<a name="line.375"></a>
<span class="sourceLineNo">376</span> * @param textRenderer The message renderer.<a name="line.376"></a>
<span class="sourceLineNo">377</span> * @param suffix Append this to the end of each stack frame.<a name="line.377"></a>
<span class="sourceLineNo">378</span> * @param lineSeparator The end-of-line separator.<a name="line.378"></a>
<span class="sourceLineNo">379</span> */<a name="line.379"></a>
<span class="sourceLineNo">380</span> public void formatExtendedStackTraceTo(final StringBuilder sb, final List&lt;String&gt; ignorePackages, final TextRenderer textRenderer, final String suffix, final String lineSeparator) {<a name="line.380"></a>
<span class="sourceLineNo">381</span> ThrowableProxyRenderer.formatExtendedStackTraceTo(this, sb, ignorePackages, textRenderer, suffix, lineSeparator);<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> public String getLocalizedMessage() {<a name="line.384"></a>
<span class="sourceLineNo">385</span> return this.localizedMessage;<a name="line.385"></a>
<span class="sourceLineNo">386</span> }<a name="line.386"></a>
<span class="sourceLineNo">387</span><a name="line.387"></a>
<span class="sourceLineNo">388</span> public String getMessage() {<a name="line.388"></a>
<span class="sourceLineNo">389</span> return this.message;<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> * Return the FQCN of the Throwable.<a name="line.393"></a>
<span class="sourceLineNo">394</span> *<a name="line.394"></a>
<span class="sourceLineNo">395</span> * @return The FQCN of the Throwable.<a name="line.395"></a>
<span class="sourceLineNo">396</span> */<a name="line.396"></a>
<span class="sourceLineNo">397</span> public String getName() {<a name="line.397"></a>
<span class="sourceLineNo">398</span> return this.name;<a name="line.398"></a>
<span class="sourceLineNo">399</span> }<a name="line.399"></a>
<span class="sourceLineNo">400</span><a name="line.400"></a>
<span class="sourceLineNo">401</span> public StackTraceElement[] getStackTrace() {<a name="line.401"></a>
<span class="sourceLineNo">402</span> return this.throwable == null ? null : this.throwable.getStackTrace();<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> /**<a name="line.405"></a>
<span class="sourceLineNo">406</span> * Gets proxies for suppressed exceptions.<a name="line.406"></a>
<span class="sourceLineNo">407</span> *<a name="line.407"></a>
<span class="sourceLineNo">408</span> * @return proxies for suppressed exceptions.<a name="line.408"></a>
<span class="sourceLineNo">409</span> */<a name="line.409"></a>
<span class="sourceLineNo">410</span> public ThrowableProxy[] getSuppressedProxies() {<a name="line.410"></a>
<span class="sourceLineNo">411</span> return this.suppressedProxies;<a name="line.411"></a>
<span class="sourceLineNo">412</span> }<a name="line.412"></a>
<span class="sourceLineNo">413</span><a name="line.413"></a>
<span class="sourceLineNo">414</span> /**<a name="line.414"></a>
<span class="sourceLineNo">415</span> * Formats the suppressed Throwables.<a name="line.415"></a>
<span class="sourceLineNo">416</span> *<a name="line.416"></a>
<span class="sourceLineNo">417</span> * @return The formatted suppressed Throwables.<a name="line.417"></a>
<span class="sourceLineNo">418</span> * @param suffix<a name="line.418"></a>
<span class="sourceLineNo">419</span> */<a name="line.419"></a>
<span class="sourceLineNo">420</span> public String getSuppressedStackTrace(final String suffix) {<a name="line.420"></a>
<span class="sourceLineNo">421</span> final ThrowableProxy[] suppressed = this.getSuppressedProxies();<a name="line.421"></a>
<span class="sourceLineNo">422</span> if (suppressed == null || suppressed.length == 0) {<a name="line.422"></a>
<span class="sourceLineNo">423</span> return Strings.EMPTY;<a name="line.423"></a>
<span class="sourceLineNo">424</span> }<a name="line.424"></a>
<span class="sourceLineNo">425</span> final StringBuilder sb = new StringBuilder("Suppressed Stack Trace Elements:").append(EOL);<a name="line.425"></a>
<span class="sourceLineNo">426</span> for (final ThrowableProxy proxy : suppressed) {<a name="line.426"></a>
<span class="sourceLineNo">427</span> sb.append(proxy.getExtendedStackTraceAsString(suffix));<a name="line.427"></a>
<span class="sourceLineNo">428</span> }<a name="line.428"></a>
<span class="sourceLineNo">429</span> return sb.toString();<a name="line.429"></a>
<span class="sourceLineNo">430</span> }<a name="line.430"></a>
<span class="sourceLineNo">431</span><a name="line.431"></a>
<span class="sourceLineNo">432</span> /**<a name="line.432"></a>
<span class="sourceLineNo">433</span> * The throwable or null if this object is deserialized from XML or JSON.<a name="line.433"></a>
<span class="sourceLineNo">434</span> *<a name="line.434"></a>
<span class="sourceLineNo">435</span> * @return The throwable or null if this object is deserialized from XML or JSON.<a name="line.435"></a>
<span class="sourceLineNo">436</span> */<a name="line.436"></a>
<span class="sourceLineNo">437</span> public Throwable getThrowable() {<a name="line.437"></a>
<span class="sourceLineNo">438</span> return this.throwable;<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> @Override<a name="line.441"></a>
<span class="sourceLineNo">442</span> public int hashCode() {<a name="line.442"></a>
<span class="sourceLineNo">443</span> final int prime = 31;<a name="line.443"></a>
<span class="sourceLineNo">444</span> int result = 1;<a name="line.444"></a>
<span class="sourceLineNo">445</span> result = prime * result + (this.causeProxy == null ? 0 : this.causeProxy.hashCode());<a name="line.445"></a>
<span class="sourceLineNo">446</span> result = prime * result + this.commonElementCount;<a name="line.446"></a>
<span class="sourceLineNo">447</span> result = prime * result + (this.extendedStackTrace == null ? 0 : Arrays.hashCode(this.extendedStackTrace));<a name="line.447"></a>
<span class="sourceLineNo">448</span> result = prime * result + (this.suppressedProxies == null ? 0 : Arrays.hashCode(this.suppressedProxies));<a name="line.448"></a>
<span class="sourceLineNo">449</span> result = prime * result + (this.name == null ? 0 : this.name.hashCode());<a name="line.449"></a>
<span class="sourceLineNo">450</span> return result;<a name="line.450"></a>
<span class="sourceLineNo">451</span> }<a name="line.451"></a>
<span class="sourceLineNo">452</span><a name="line.452"></a>
<span class="sourceLineNo">453</span> @Override<a name="line.453"></a>
<span class="sourceLineNo">454</span> public String toString() {<a name="line.454"></a>
<span class="sourceLineNo">455</span> final String msg = this.message;<a name="line.455"></a>
<span class="sourceLineNo">456</span> return msg != null ? this.name + ": " + msg : this.name;<a name="line.456"></a>
<span class="sourceLineNo">457</span> }<a name="line.457"></a>
<span class="sourceLineNo">458</span>}<a name="line.458"></a>
</pre>
</div>
</body>
</html>