blob: 06a604cc2033289a9486916c3c4c4fd66f007db6 [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="../../../../javadoc.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 contributor license agreements. See the NOTICE file *<a name="line.2"></a>
<span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a>
<span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a>
<span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a>
<span class="sourceLineNo">006</span>// * *<a name="line.6"></a>
<span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a>
<span class="sourceLineNo">008</span>// * *<a name="line.8"></a>
<span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a>
<span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a>
<span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a>
<span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a>
<span class="sourceLineNo">013</span>package org.apache.juneau;<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span><a name="line.15"></a>
<span class="sourceLineNo">016</span>import static org.apache.juneau.collections.JsonMap.*;<a name="line.16"></a>
<span class="sourceLineNo">017</span>import java.lang.annotation.*;<a name="line.17"></a>
<span class="sourceLineNo">018</span>import java.lang.reflect.*;<a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.util.*;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.juneau.collections.*;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.juneau.internal.*;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.juneau.utils.*;<a name="line.23"></a>
<span class="sourceLineNo">024</span><a name="line.24"></a>
<span class="sourceLineNo">025</span>/**<a name="line.25"></a>
<span class="sourceLineNo">026</span> * Parent class for all classes that traverse POJOs.<a name="line.26"></a>
<span class="sourceLineNo">027</span> *<a name="line.27"></a>
<span class="sourceLineNo">028</span> * &lt;h5 class='topic'&gt;Description&lt;/h5&gt;<a name="line.28"></a>
<span class="sourceLineNo">029</span> * &lt;p&gt;<a name="line.29"></a>
<span class="sourceLineNo">030</span> * Base class that serves as the parent class for all serializers and other classes that traverse POJOs.<a name="line.30"></a>
<span class="sourceLineNo">031</span> *<a name="line.31"></a>
<span class="sourceLineNo">032</span> * &lt;ul class='notes'&gt;<a name="line.32"></a>
<span class="sourceLineNo">033</span> * &lt;li class='note'&gt;This class is thread safe and reusable.<a name="line.33"></a>
<span class="sourceLineNo">034</span> * &lt;/ul&gt;<a name="line.34"></a>
<span class="sourceLineNo">035</span> *<a name="line.35"></a>
<span class="sourceLineNo">036</span> * &lt;ul class='seealso'&gt;<a name="line.36"></a>
<span class="sourceLineNo">037</span> * &lt;li class='extlink'&gt;{@source}<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;/ul&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> */<a name="line.39"></a>
<span class="sourceLineNo">040</span>public abstract class BeanTraverseContext extends BeanContextable {<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span> //-------------------------------------------------------------------------------------------------------------------<a name="line.42"></a>
<span class="sourceLineNo">043</span> // Builder<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> /**<a name="line.46"></a>
<span class="sourceLineNo">047</span> * Builder class.<a name="line.47"></a>
<span class="sourceLineNo">048</span> */<a name="line.48"></a>
<span class="sourceLineNo">049</span> @FluentSetters<a name="line.49"></a>
<span class="sourceLineNo">050</span> public abstract static class Builder extends BeanContextable.Builder {<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> boolean detectRecursions, ignoreRecursions;<a name="line.52"></a>
<span class="sourceLineNo">053</span> int initialDepth, maxDepth;<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span> /**<a name="line.55"></a>
<span class="sourceLineNo">056</span> * Constructor, default settings.<a name="line.56"></a>
<span class="sourceLineNo">057</span> */<a name="line.57"></a>
<span class="sourceLineNo">058</span> protected Builder() {<a name="line.58"></a>
<span class="sourceLineNo">059</span> super();<a name="line.59"></a>
<span class="sourceLineNo">060</span> detectRecursions = env("BeanTraverseContext.detectRecursions", false);<a name="line.60"></a>
<span class="sourceLineNo">061</span> ignoreRecursions = env("BeanTraverseContext.ignoreRecursions", false);<a name="line.61"></a>
<span class="sourceLineNo">062</span> initialDepth = env("BeanTraverseContext.initialDepth", 0);<a name="line.62"></a>
<span class="sourceLineNo">063</span> maxDepth = env("BeanTraverseContext.maxDepth", 100);<a name="line.63"></a>
<span class="sourceLineNo">064</span> }<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> /**<a name="line.66"></a>
<span class="sourceLineNo">067</span> * Copy constructor.<a name="line.67"></a>
<span class="sourceLineNo">068</span> *<a name="line.68"></a>
<span class="sourceLineNo">069</span> * @param copyFrom The bean to copy from.<a name="line.69"></a>
<span class="sourceLineNo">070</span> */<a name="line.70"></a>
<span class="sourceLineNo">071</span> protected Builder(BeanTraverseContext copyFrom) {<a name="line.71"></a>
<span class="sourceLineNo">072</span> super(copyFrom);<a name="line.72"></a>
<span class="sourceLineNo">073</span> detectRecursions = copyFrom.detectRecursions;<a name="line.73"></a>
<span class="sourceLineNo">074</span> ignoreRecursions = copyFrom.ignoreRecursions;<a name="line.74"></a>
<span class="sourceLineNo">075</span> initialDepth = copyFrom.initialDepth;<a name="line.75"></a>
<span class="sourceLineNo">076</span> maxDepth = copyFrom.maxDepth;<a name="line.76"></a>
<span class="sourceLineNo">077</span> }<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span> /**<a name="line.79"></a>
<span class="sourceLineNo">080</span> * Copy constructor.<a name="line.80"></a>
<span class="sourceLineNo">081</span> *<a name="line.81"></a>
<span class="sourceLineNo">082</span> * @param copyFrom The builder to copy from.<a name="line.82"></a>
<span class="sourceLineNo">083</span> */<a name="line.83"></a>
<span class="sourceLineNo">084</span> protected Builder(Builder copyFrom) {<a name="line.84"></a>
<span class="sourceLineNo">085</span> super(copyFrom);<a name="line.85"></a>
<span class="sourceLineNo">086</span> detectRecursions = copyFrom.detectRecursions;<a name="line.86"></a>
<span class="sourceLineNo">087</span> ignoreRecursions = copyFrom.ignoreRecursions;<a name="line.87"></a>
<span class="sourceLineNo">088</span> initialDepth = copyFrom.initialDepth;<a name="line.88"></a>
<span class="sourceLineNo">089</span> maxDepth = copyFrom.maxDepth;<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> @Override /* Context.Builder */<a name="line.92"></a>
<span class="sourceLineNo">093</span> public abstract Builder copy();<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span> @Override /* Context.Builder */<a name="line.95"></a>
<span class="sourceLineNo">096</span> public HashKey hashKey() {<a name="line.96"></a>
<span class="sourceLineNo">097</span> return HashKey.of(<a name="line.97"></a>
<span class="sourceLineNo">098</span> super.hashKey(),<a name="line.98"></a>
<span class="sourceLineNo">099</span> detectRecursions,<a name="line.99"></a>
<span class="sourceLineNo">100</span> ignoreRecursions,<a name="line.100"></a>
<span class="sourceLineNo">101</span> initialDepth,<a name="line.101"></a>
<span class="sourceLineNo">102</span> maxDepth<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> //-----------------------------------------------------------------------------------------------------------------<a name="line.106"></a>
<span class="sourceLineNo">107</span> // Properties<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> * Automatically detect POJO recursions.<a name="line.111"></a>
<span class="sourceLineNo">112</span> *<a name="line.112"></a>
<span class="sourceLineNo">113</span> * &lt;p&gt;<a name="line.113"></a>
<span class="sourceLineNo">114</span> * When enabled, specifies that recursions should be checked for during traversal.<a name="line.114"></a>
<span class="sourceLineNo">115</span> *<a name="line.115"></a>
<span class="sourceLineNo">116</span> * &lt;p&gt;<a name="line.116"></a>
<span class="sourceLineNo">117</span> * Recursions can occur when traversing models that aren't true trees but rather contain loops.<a name="line.117"></a>
<span class="sourceLineNo">118</span> * &lt;br&gt;In general, unchecked recursions cause stack-overflow-errors.<a name="line.118"></a>
<span class="sourceLineNo">119</span> * &lt;br&gt;These show up as {@link BeanRecursionException BeanRecursionException} with the message &lt;js&gt;"Depth too deep. Stack overflow occurred."&lt;/js&gt;.<a name="line.119"></a>
<span class="sourceLineNo">120</span> *<a name="line.120"></a>
<span class="sourceLineNo">121</span> * &lt;ul class='notes'&gt;<a name="line.121"></a>
<span class="sourceLineNo">122</span> * &lt;li class='note'&gt;<a name="line.122"></a>
<span class="sourceLineNo">123</span> * Checking for recursion can cause a small performance penalty.<a name="line.123"></a>
<span class="sourceLineNo">124</span> * &lt;/ul&gt;<a name="line.124"></a>
<span class="sourceLineNo">125</span> *<a name="line.125"></a>
<span class="sourceLineNo">126</span> * &lt;h5 class='section'&gt;Example:&lt;/h5&gt;<a name="line.126"></a>
<span class="sourceLineNo">127</span> * &lt;p class='bjava'&gt;<a name="line.127"></a>
<span class="sourceLineNo">128</span> * &lt;jc&gt;// Create a serializer that automatically checks for recursions.&lt;/jc&gt;<a name="line.128"></a>
<span class="sourceLineNo">129</span> * WriterSerializer &lt;jv&gt;serializer&lt;/jv&gt; = JsonSerializer<a name="line.129"></a>
<span class="sourceLineNo">130</span> * .&lt;jsm&gt;create&lt;/jsm&gt;()<a name="line.130"></a>
<span class="sourceLineNo">131</span> * .detectRecursions()<a name="line.131"></a>
<span class="sourceLineNo">132</span> * .build();<a name="line.132"></a>
<span class="sourceLineNo">133</span> *<a name="line.133"></a>
<span class="sourceLineNo">134</span> * &lt;jc&gt;// Create a POJO model with a recursive loop.&lt;/jc&gt;<a name="line.134"></a>
<span class="sourceLineNo">135</span> * &lt;jk&gt;public class&lt;/jk&gt; MyBean {<a name="line.135"></a>
<span class="sourceLineNo">136</span> * &lt;jk&gt;public&lt;/jk&gt; Object &lt;jf&gt;f&lt;/jf&gt;;<a name="line.136"></a>
<span class="sourceLineNo">137</span> * }<a name="line.137"></a>
<span class="sourceLineNo">138</span> * MyBean &lt;jv&gt;bean&lt;/jv&gt; = &lt;jk&gt;new&lt;/jk&gt; MyBean();<a name="line.138"></a>
<span class="sourceLineNo">139</span> * &lt;jv&gt;bean&lt;/jv&gt;.&lt;jf&gt;f&lt;/jf&gt; = &lt;jv&gt;bean&lt;/jv&gt;;<a name="line.139"></a>
<span class="sourceLineNo">140</span> *<a name="line.140"></a>
<span class="sourceLineNo">141</span> * &lt;jc&gt;// Throws a SerializeException and not a StackOverflowError&lt;/jc&gt;<a name="line.141"></a>
<span class="sourceLineNo">142</span> * String &lt;jv&gt;json&lt;/jv&gt; = &lt;jv&gt;serializer&lt;/jv&gt;.serialize(&lt;jv&gt;bean&lt;/jv&gt;);<a name="line.142"></a>
<span class="sourceLineNo">143</span> * &lt;/p&gt;<a name="line.143"></a>
<span class="sourceLineNo">144</span> *<a name="line.144"></a>
<span class="sourceLineNo">145</span> * @return This object.<a name="line.145"></a>
<span class="sourceLineNo">146</span> */<a name="line.146"></a>
<span class="sourceLineNo">147</span> @FluentSetter<a name="line.147"></a>
<span class="sourceLineNo">148</span> public Builder detectRecursions() {<a name="line.148"></a>
<span class="sourceLineNo">149</span> return detectRecursions(true);<a name="line.149"></a>
<span class="sourceLineNo">150</span> }<a name="line.150"></a>
<span class="sourceLineNo">151</span><a name="line.151"></a>
<span class="sourceLineNo">152</span> /**<a name="line.152"></a>
<span class="sourceLineNo">153</span> * Same as {@link #detectRecursions()} but allows you to explicitly specify the value.<a name="line.153"></a>
<span class="sourceLineNo">154</span> *<a name="line.154"></a>
<span class="sourceLineNo">155</span> * @param value The value for this setting.<a name="line.155"></a>
<span class="sourceLineNo">156</span> * @return This object.<a name="line.156"></a>
<span class="sourceLineNo">157</span> */<a name="line.157"></a>
<span class="sourceLineNo">158</span> @FluentSetter<a name="line.158"></a>
<span class="sourceLineNo">159</span> public Builder detectRecursions(boolean value) {<a name="line.159"></a>
<span class="sourceLineNo">160</span> detectRecursions = value;<a name="line.160"></a>
<span class="sourceLineNo">161</span> return this;<a name="line.161"></a>
<span class="sourceLineNo">162</span> }<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span> /**<a name="line.164"></a>
<span class="sourceLineNo">165</span> * Ignore recursion errors.<a name="line.165"></a>
<span class="sourceLineNo">166</span> *<a name="line.166"></a>
<span class="sourceLineNo">167</span> * &lt;p&gt;<a name="line.167"></a>
<span class="sourceLineNo">168</span> * When enabled, when we encounter the same object when traversing a tree, we set the value to &lt;jk&gt;null&lt;/jk&gt;.<a name="line.168"></a>
<span class="sourceLineNo">169</span> *<a name="line.169"></a>
<span class="sourceLineNo">170</span> * &lt;p&gt;<a name="line.170"></a>
<span class="sourceLineNo">171</span> * For example, if a model contains the links A-&amp;gt;B-&amp;gt;C-&amp;gt;A, then the JSON generated will look like<a name="line.171"></a>
<span class="sourceLineNo">172</span> * the following when this setting is &lt;jk&gt;true&lt;/jk&gt;...<a name="line.172"></a>
<span class="sourceLineNo">173</span> *<a name="line.173"></a>
<span class="sourceLineNo">174</span> * &lt;p class='bjson'&gt;<a name="line.174"></a>
<span class="sourceLineNo">175</span> * {A:{B:{C:&lt;jk&gt;null&lt;/jk&gt;}}}<a name="line.175"></a>
<span class="sourceLineNo">176</span> * &lt;/p&gt;<a name="line.176"></a>
<span class="sourceLineNo">177</span> *<a name="line.177"></a>
<span class="sourceLineNo">178</span> * &lt;ul class='notes'&gt;<a name="line.178"></a>
<span class="sourceLineNo">179</span> * &lt;li class='note'&gt;<a name="line.179"></a>
<span class="sourceLineNo">180</span> * Checking for recursion can cause a small performance penalty.<a name="line.180"></a>
<span class="sourceLineNo">181</span> * &lt;/ul&gt;<a name="line.181"></a>
<span class="sourceLineNo">182</span> *<a name="line.182"></a>
<span class="sourceLineNo">183</span> * &lt;h5 class='section'&gt;Example:&lt;/h5&gt;<a name="line.183"></a>
<span class="sourceLineNo">184</span> * &lt;p class='bjava'&gt;<a name="line.184"></a>
<span class="sourceLineNo">185</span> * &lt;jc&gt;// Create a serializer ignores recursions.&lt;/jc&gt;<a name="line.185"></a>
<span class="sourceLineNo">186</span> * WriterSerializer &lt;jv&gt;serializer&lt;/jv&gt; = JsonSerializer<a name="line.186"></a>
<span class="sourceLineNo">187</span> * .&lt;jsm&gt;create&lt;/jsm&gt;()<a name="line.187"></a>
<span class="sourceLineNo">188</span> * .ignoreRecursions()<a name="line.188"></a>
<span class="sourceLineNo">189</span> * .build();<a name="line.189"></a>
<span class="sourceLineNo">190</span> *<a name="line.190"></a>
<span class="sourceLineNo">191</span> * &lt;jc&gt;// Create a POJO model with a recursive loop.&lt;/jc&gt;<a name="line.191"></a>
<span class="sourceLineNo">192</span> * &lt;jk&gt;public class&lt;/jk&gt; MyBean {<a name="line.192"></a>
<span class="sourceLineNo">193</span> * &lt;jk&gt;public&lt;/jk&gt; Object &lt;jf&gt;f&lt;/jf&gt;;<a name="line.193"></a>
<span class="sourceLineNo">194</span> * }<a name="line.194"></a>
<span class="sourceLineNo">195</span> * MyBean &lt;jv&gt;bean&lt;/jv&gt; = &lt;jk&gt;new&lt;/jk&gt; MyBean();<a name="line.195"></a>
<span class="sourceLineNo">196</span> * &lt;jv&gt;bean&lt;/jv&gt;.&lt;jf&gt;f&lt;/jf&gt; = &lt;jv&gt;bean&lt;/jv&gt;;<a name="line.196"></a>
<span class="sourceLineNo">197</span> *<a name="line.197"></a>
<span class="sourceLineNo">198</span> * &lt;jc&gt;// Produces "{f:null}"&lt;/jc&gt;<a name="line.198"></a>
<span class="sourceLineNo">199</span> * String &lt;jv&gt;json&lt;/jv&gt; = &lt;jv&gt;serializer&lt;/jv&gt;.serialize(&lt;jv&gt;bean&lt;/jv&gt;);<a name="line.199"></a>
<span class="sourceLineNo">200</span> * &lt;/p&gt;<a name="line.200"></a>
<span class="sourceLineNo">201</span> *<a name="line.201"></a>
<span class="sourceLineNo">202</span> * @return This object.<a name="line.202"></a>
<span class="sourceLineNo">203</span> */<a name="line.203"></a>
<span class="sourceLineNo">204</span> @FluentSetter<a name="line.204"></a>
<span class="sourceLineNo">205</span> public Builder ignoreRecursions() {<a name="line.205"></a>
<span class="sourceLineNo">206</span> return ignoreRecursions(true);<a name="line.206"></a>
<span class="sourceLineNo">207</span> }<a name="line.207"></a>
<span class="sourceLineNo">208</span><a name="line.208"></a>
<span class="sourceLineNo">209</span> /**<a name="line.209"></a>
<span class="sourceLineNo">210</span> * Same as {@link #ignoreRecursions()} but allows you to explicitly specify the value.<a name="line.210"></a>
<span class="sourceLineNo">211</span> *<a name="line.211"></a>
<span class="sourceLineNo">212</span> * @param value The value for this setting.<a name="line.212"></a>
<span class="sourceLineNo">213</span> * @return This object.<a name="line.213"></a>
<span class="sourceLineNo">214</span> */<a name="line.214"></a>
<span class="sourceLineNo">215</span> @FluentSetter<a name="line.215"></a>
<span class="sourceLineNo">216</span> public Builder ignoreRecursions(boolean value) {<a name="line.216"></a>
<span class="sourceLineNo">217</span> ignoreRecursions = value;<a name="line.217"></a>
<span class="sourceLineNo">218</span> return this;<a name="line.218"></a>
<span class="sourceLineNo">219</span> }<a name="line.219"></a>
<span class="sourceLineNo">220</span><a name="line.220"></a>
<span class="sourceLineNo">221</span> /**<a name="line.221"></a>
<span class="sourceLineNo">222</span> * Initial depth.<a name="line.222"></a>
<span class="sourceLineNo">223</span> *<a name="line.223"></a>
<span class="sourceLineNo">224</span> * &lt;p&gt;<a name="line.224"></a>
<span class="sourceLineNo">225</span> * The initial indentation level at the root.<a name="line.225"></a>
<span class="sourceLineNo">226</span> *<a name="line.226"></a>
<span class="sourceLineNo">227</span> * &lt;p&gt;<a name="line.227"></a>
<span class="sourceLineNo">228</span> * Useful when constructing document fragments that need to be indented at a certain level when whitespace is enabled.<a name="line.228"></a>
<span class="sourceLineNo">229</span> *<a name="line.229"></a>
<span class="sourceLineNo">230</span> * &lt;h5 class='section'&gt;Example:&lt;/h5&gt;<a name="line.230"></a>
<span class="sourceLineNo">231</span> * &lt;p class='bjava'&gt;<a name="line.231"></a>
<span class="sourceLineNo">232</span> * &lt;jc&gt;// Create a serializer with whitespace enabled and an initial depth of 2.&lt;/jc&gt;<a name="line.232"></a>
<span class="sourceLineNo">233</span> * WriterSerializer &lt;jv&gt;serializer&lt;/jv&gt; = JsonSerializer<a name="line.233"></a>
<span class="sourceLineNo">234</span> * .&lt;jsm&gt;create&lt;/jsm&gt;()<a name="line.234"></a>
<span class="sourceLineNo">235</span> * .ws()<a name="line.235"></a>
<span class="sourceLineNo">236</span> * .initialDepth(2)<a name="line.236"></a>
<span class="sourceLineNo">237</span> * .build();<a name="line.237"></a>
<span class="sourceLineNo">238</span> *<a name="line.238"></a>
<span class="sourceLineNo">239</span> * &lt;jc&gt;// Produces "\t\t{\n\t\t\t'foo':'bar'\n\t\t}\n"&lt;/jc&gt;<a name="line.239"></a>
<span class="sourceLineNo">240</span> * String &lt;jv&gt;json&lt;/jv&gt; = &lt;jv&gt;serializer&lt;/jv&gt;.serialize(&lt;jk&gt;new&lt;/jk&gt; MyBean());<a name="line.240"></a>
<span class="sourceLineNo">241</span> * &lt;/p&gt;<a name="line.241"></a>
<span class="sourceLineNo">242</span> *<a name="line.242"></a>
<span class="sourceLineNo">243</span> * @param value<a name="line.243"></a>
<span class="sourceLineNo">244</span> * The new value for this setting.<a name="line.244"></a>
<span class="sourceLineNo">245</span> * &lt;br&gt;The default is &lt;c&gt;0&lt;/c&gt;.<a name="line.245"></a>
<span class="sourceLineNo">246</span> * @return This object.<a name="line.246"></a>
<span class="sourceLineNo">247</span> */<a name="line.247"></a>
<span class="sourceLineNo">248</span> @FluentSetter<a name="line.248"></a>
<span class="sourceLineNo">249</span> public Builder initialDepth(int value) {<a name="line.249"></a>
<span class="sourceLineNo">250</span> initialDepth = value;<a name="line.250"></a>
<span class="sourceLineNo">251</span> return this;<a name="line.251"></a>
<span class="sourceLineNo">252</span> }<a name="line.252"></a>
<span class="sourceLineNo">253</span><a name="line.253"></a>
<span class="sourceLineNo">254</span> /**<a name="line.254"></a>
<span class="sourceLineNo">255</span> * Max traversal depth.<a name="line.255"></a>
<span class="sourceLineNo">256</span> *<a name="line.256"></a>
<span class="sourceLineNo">257</span> * &lt;p&gt;<a name="line.257"></a>
<span class="sourceLineNo">258</span> * When enabled, abort traversal if specified depth is reached in the POJO tree.<a name="line.258"></a>
<span class="sourceLineNo">259</span> *<a name="line.259"></a>
<span class="sourceLineNo">260</span> * &lt;p&gt;<a name="line.260"></a>
<span class="sourceLineNo">261</span> * If this depth is exceeded, an exception is thrown.<a name="line.261"></a>
<span class="sourceLineNo">262</span> *<a name="line.262"></a>
<span class="sourceLineNo">263</span> * &lt;p&gt;<a name="line.263"></a>
<span class="sourceLineNo">264</span> * This prevents stack overflows from occurring when trying to traverse models with recursive references.<a name="line.264"></a>
<span class="sourceLineNo">265</span> *<a name="line.265"></a>
<span class="sourceLineNo">266</span> * &lt;h5 class='section'&gt;Example:&lt;/h5&gt;<a name="line.266"></a>
<span class="sourceLineNo">267</span> * &lt;p class='bjava'&gt;<a name="line.267"></a>
<span class="sourceLineNo">268</span> * &lt;jc&gt;// Create a serializer that throws an exception if the depth reaches greater than 20.&lt;/jc&gt;<a name="line.268"></a>
<span class="sourceLineNo">269</span> * WriterSerializer &lt;jv&gt;serializer&lt;/jv&gt; = JsonSerializer<a name="line.269"></a>
<span class="sourceLineNo">270</span> * .&lt;jsm&gt;create&lt;/jsm&gt;()<a name="line.270"></a>
<span class="sourceLineNo">271</span> * .maxDepth(20)<a name="line.271"></a>
<span class="sourceLineNo">272</span> * .build();<a name="line.272"></a>
<span class="sourceLineNo">273</span> * &lt;/p&gt;<a name="line.273"></a>
<span class="sourceLineNo">274</span> *<a name="line.274"></a>
<span class="sourceLineNo">275</span> * &lt;ul class='seealso'&gt;<a name="line.275"></a>
<span class="sourceLineNo">276</span> * &lt;li class='jm'&gt;{@link Builder#maxDepth(int)}<a name="line.276"></a>
<span class="sourceLineNo">277</span> * &lt;/ul&gt;<a name="line.277"></a>
<span class="sourceLineNo">278</span> *<a name="line.278"></a>
<span class="sourceLineNo">279</span> * @param value<a name="line.279"></a>
<span class="sourceLineNo">280</span> * The new value for this setting.<a name="line.280"></a>
<span class="sourceLineNo">281</span> * &lt;br&gt;The default is &lt;c&gt;100&lt;/c&gt;.<a name="line.281"></a>
<span class="sourceLineNo">282</span> * @return This object.<a name="line.282"></a>
<span class="sourceLineNo">283</span> */<a name="line.283"></a>
<span class="sourceLineNo">284</span> @FluentSetter<a name="line.284"></a>
<span class="sourceLineNo">285</span> public Builder maxDepth(int value) {<a name="line.285"></a>
<span class="sourceLineNo">286</span> maxDepth = value;<a name="line.286"></a>
<span class="sourceLineNo">287</span> return this;<a name="line.287"></a>
<span class="sourceLineNo">288</span> }<a name="line.288"></a>
<span class="sourceLineNo">289</span><a name="line.289"></a>
<span class="sourceLineNo">290</span> // &lt;FluentSetters&gt;<a name="line.290"></a>
<span class="sourceLineNo">291</span><a name="line.291"></a>
<span class="sourceLineNo">292</span> @Override /* GENERATED - org.apache.juneau.Context.Builder */<a name="line.292"></a>
<span class="sourceLineNo">293</span> public Builder annotations(Annotation...values) {<a name="line.293"></a>
<span class="sourceLineNo">294</span> super.annotations(values);<a name="line.294"></a>
<span class="sourceLineNo">295</span> return this;<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> @Override /* GENERATED - org.apache.juneau.Context.Builder */<a name="line.298"></a>
<span class="sourceLineNo">299</span> public Builder apply(AnnotationWorkList work) {<a name="line.299"></a>
<span class="sourceLineNo">300</span> super.apply(work);<a name="line.300"></a>
<span class="sourceLineNo">301</span> return this;<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> @Override /* GENERATED - org.apache.juneau.Context.Builder */<a name="line.304"></a>
<span class="sourceLineNo">305</span> public Builder applyAnnotations(java.lang.Class&lt;?&gt;...fromClasses) {<a name="line.305"></a>
<span class="sourceLineNo">306</span> super.applyAnnotations(fromClasses);<a name="line.306"></a>
<span class="sourceLineNo">307</span> return this;<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> @Override /* GENERATED - org.apache.juneau.Context.Builder */<a name="line.310"></a>
<span class="sourceLineNo">311</span> public Builder applyAnnotations(Method...fromMethods) {<a name="line.311"></a>
<span class="sourceLineNo">312</span> super.applyAnnotations(fromMethods);<a name="line.312"></a>
<span class="sourceLineNo">313</span> return this;<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> @Override /* GENERATED - org.apache.juneau.Context.Builder */<a name="line.316"></a>
<span class="sourceLineNo">317</span> public Builder cache(Cache&lt;HashKey,? extends org.apache.juneau.Context&gt; value) {<a name="line.317"></a>
<span class="sourceLineNo">318</span> super.cache(value);<a name="line.318"></a>
<span class="sourceLineNo">319</span> return this;<a name="line.319"></a>
<span class="sourceLineNo">320</span> }<a name="line.320"></a>
<span class="sourceLineNo">321</span><a name="line.321"></a>
<span class="sourceLineNo">322</span> @Override /* GENERATED - org.apache.juneau.Context.Builder */<a name="line.322"></a>
<span class="sourceLineNo">323</span> public Builder debug() {<a name="line.323"></a>
<span class="sourceLineNo">324</span> super.debug();<a name="line.324"></a>
<span class="sourceLineNo">325</span> return this;<a name="line.325"></a>
<span class="sourceLineNo">326</span> }<a name="line.326"></a>
<span class="sourceLineNo">327</span><a name="line.327"></a>
<span class="sourceLineNo">328</span> @Override /* GENERATED - org.apache.juneau.Context.Builder */<a name="line.328"></a>
<span class="sourceLineNo">329</span> public Builder debug(boolean value) {<a name="line.329"></a>
<span class="sourceLineNo">330</span> super.debug(value);<a name="line.330"></a>
<span class="sourceLineNo">331</span> return this;<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> @Override /* GENERATED - org.apache.juneau.Context.Builder */<a name="line.334"></a>
<span class="sourceLineNo">335</span> public Builder impl(Context value) {<a name="line.335"></a>
<span class="sourceLineNo">336</span> super.impl(value);<a name="line.336"></a>
<span class="sourceLineNo">337</span> return this;<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> @Override /* GENERATED - org.apache.juneau.Context.Builder */<a name="line.340"></a>
<span class="sourceLineNo">341</span> public Builder type(Class&lt;? extends org.apache.juneau.Context&gt; value) {<a name="line.341"></a>
<span class="sourceLineNo">342</span> super.type(value);<a name="line.342"></a>
<span class="sourceLineNo">343</span> return this;<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> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.346"></a>
<span class="sourceLineNo">347</span> public Builder beanClassVisibility(Visibility value) {<a name="line.347"></a>
<span class="sourceLineNo">348</span> super.beanClassVisibility(value);<a name="line.348"></a>
<span class="sourceLineNo">349</span> return this;<a name="line.349"></a>
<span class="sourceLineNo">350</span> }<a name="line.350"></a>
<span class="sourceLineNo">351</span><a name="line.351"></a>
<span class="sourceLineNo">352</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.352"></a>
<span class="sourceLineNo">353</span> public Builder beanConstructorVisibility(Visibility value) {<a name="line.353"></a>
<span class="sourceLineNo">354</span> super.beanConstructorVisibility(value);<a name="line.354"></a>
<span class="sourceLineNo">355</span> return this;<a name="line.355"></a>
<span class="sourceLineNo">356</span> }<a name="line.356"></a>
<span class="sourceLineNo">357</span><a name="line.357"></a>
<span class="sourceLineNo">358</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.358"></a>
<span class="sourceLineNo">359</span> public Builder beanContext(BeanContext value) {<a name="line.359"></a>
<span class="sourceLineNo">360</span> super.beanContext(value);<a name="line.360"></a>
<span class="sourceLineNo">361</span> return this;<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> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.364"></a>
<span class="sourceLineNo">365</span> public Builder beanContext(BeanContext.Builder value) {<a name="line.365"></a>
<span class="sourceLineNo">366</span> super.beanContext(value);<a name="line.366"></a>
<span class="sourceLineNo">367</span> return this;<a name="line.367"></a>
<span class="sourceLineNo">368</span> }<a name="line.368"></a>
<span class="sourceLineNo">369</span><a name="line.369"></a>
<span class="sourceLineNo">370</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.370"></a>
<span class="sourceLineNo">371</span> public Builder beanDictionary(java.lang.Class&lt;?&gt;...values) {<a name="line.371"></a>
<span class="sourceLineNo">372</span> super.beanDictionary(values);<a name="line.372"></a>
<span class="sourceLineNo">373</span> return this;<a name="line.373"></a>
<span class="sourceLineNo">374</span> }<a name="line.374"></a>
<span class="sourceLineNo">375</span><a name="line.375"></a>
<span class="sourceLineNo">376</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.376"></a>
<span class="sourceLineNo">377</span> public Builder beanFieldVisibility(Visibility value) {<a name="line.377"></a>
<span class="sourceLineNo">378</span> super.beanFieldVisibility(value);<a name="line.378"></a>
<span class="sourceLineNo">379</span> return this;<a name="line.379"></a>
<span class="sourceLineNo">380</span> }<a name="line.380"></a>
<span class="sourceLineNo">381</span><a name="line.381"></a>
<span class="sourceLineNo">382</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.382"></a>
<span class="sourceLineNo">383</span> public Builder beanInterceptor(Class&lt;?&gt; on, Class&lt;? extends org.apache.juneau.swap.BeanInterceptor&lt;?&gt;&gt; value) {<a name="line.383"></a>
<span class="sourceLineNo">384</span> super.beanInterceptor(on, value);<a name="line.384"></a>
<span class="sourceLineNo">385</span> return this;<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> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.388"></a>
<span class="sourceLineNo">389</span> public Builder beanMapPutReturnsOldValue() {<a name="line.389"></a>
<span class="sourceLineNo">390</span> super.beanMapPutReturnsOldValue();<a name="line.390"></a>
<span class="sourceLineNo">391</span> return this;<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> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.394"></a>
<span class="sourceLineNo">395</span> public Builder beanMethodVisibility(Visibility value) {<a name="line.395"></a>
<span class="sourceLineNo">396</span> super.beanMethodVisibility(value);<a name="line.396"></a>
<span class="sourceLineNo">397</span> return this;<a name="line.397"></a>
<span class="sourceLineNo">398</span> }<a name="line.398"></a>
<span class="sourceLineNo">399</span><a name="line.399"></a>
<span class="sourceLineNo">400</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.400"></a>
<span class="sourceLineNo">401</span> public Builder beanProperties(Map&lt;String,Object&gt; values) {<a name="line.401"></a>
<span class="sourceLineNo">402</span> super.beanProperties(values);<a name="line.402"></a>
<span class="sourceLineNo">403</span> return this;<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> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.406"></a>
<span class="sourceLineNo">407</span> public Builder beanProperties(Class&lt;?&gt; beanClass, String properties) {<a name="line.407"></a>
<span class="sourceLineNo">408</span> super.beanProperties(beanClass, properties);<a name="line.408"></a>
<span class="sourceLineNo">409</span> return this;<a name="line.409"></a>
<span class="sourceLineNo">410</span> }<a name="line.410"></a>
<span class="sourceLineNo">411</span><a name="line.411"></a>
<span class="sourceLineNo">412</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.412"></a>
<span class="sourceLineNo">413</span> public Builder beanProperties(String beanClassName, String properties) {<a name="line.413"></a>
<span class="sourceLineNo">414</span> super.beanProperties(beanClassName, properties);<a name="line.414"></a>
<span class="sourceLineNo">415</span> return this;<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> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.418"></a>
<span class="sourceLineNo">419</span> public Builder beanPropertiesExcludes(Map&lt;String,Object&gt; values) {<a name="line.419"></a>
<span class="sourceLineNo">420</span> super.beanPropertiesExcludes(values);<a name="line.420"></a>
<span class="sourceLineNo">421</span> return this;<a name="line.421"></a>
<span class="sourceLineNo">422</span> }<a name="line.422"></a>
<span class="sourceLineNo">423</span><a name="line.423"></a>
<span class="sourceLineNo">424</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.424"></a>
<span class="sourceLineNo">425</span> public Builder beanPropertiesExcludes(Class&lt;?&gt; beanClass, String properties) {<a name="line.425"></a>
<span class="sourceLineNo">426</span> super.beanPropertiesExcludes(beanClass, properties);<a name="line.426"></a>
<span class="sourceLineNo">427</span> return this;<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> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.430"></a>
<span class="sourceLineNo">431</span> public Builder beanPropertiesExcludes(String beanClassName, String properties) {<a name="line.431"></a>
<span class="sourceLineNo">432</span> super.beanPropertiesExcludes(beanClassName, properties);<a name="line.432"></a>
<span class="sourceLineNo">433</span> return this;<a name="line.433"></a>
<span class="sourceLineNo">434</span> }<a name="line.434"></a>
<span class="sourceLineNo">435</span><a name="line.435"></a>
<span class="sourceLineNo">436</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.436"></a>
<span class="sourceLineNo">437</span> public Builder beanPropertiesReadOnly(Map&lt;String,Object&gt; values) {<a name="line.437"></a>
<span class="sourceLineNo">438</span> super.beanPropertiesReadOnly(values);<a name="line.438"></a>
<span class="sourceLineNo">439</span> return this;<a name="line.439"></a>
<span class="sourceLineNo">440</span> }<a name="line.440"></a>
<span class="sourceLineNo">441</span><a name="line.441"></a>
<span class="sourceLineNo">442</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.442"></a>
<span class="sourceLineNo">443</span> public Builder beanPropertiesReadOnly(Class&lt;?&gt; beanClass, String properties) {<a name="line.443"></a>
<span class="sourceLineNo">444</span> super.beanPropertiesReadOnly(beanClass, properties);<a name="line.444"></a>
<span class="sourceLineNo">445</span> return this;<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> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.448"></a>
<span class="sourceLineNo">449</span> public Builder beanPropertiesReadOnly(String beanClassName, String properties) {<a name="line.449"></a>
<span class="sourceLineNo">450</span> super.beanPropertiesReadOnly(beanClassName, properties);<a name="line.450"></a>
<span class="sourceLineNo">451</span> return this;<a name="line.451"></a>
<span class="sourceLineNo">452</span> }<a name="line.452"></a>
<span class="sourceLineNo">453</span><a name="line.453"></a>
<span class="sourceLineNo">454</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.454"></a>
<span class="sourceLineNo">455</span> public Builder beanPropertiesWriteOnly(Map&lt;String,Object&gt; values) {<a name="line.455"></a>
<span class="sourceLineNo">456</span> super.beanPropertiesWriteOnly(values);<a name="line.456"></a>
<span class="sourceLineNo">457</span> return this;<a name="line.457"></a>
<span class="sourceLineNo">458</span> }<a name="line.458"></a>
<span class="sourceLineNo">459</span><a name="line.459"></a>
<span class="sourceLineNo">460</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.460"></a>
<span class="sourceLineNo">461</span> public Builder beanPropertiesWriteOnly(Class&lt;?&gt; beanClass, String properties) {<a name="line.461"></a>
<span class="sourceLineNo">462</span> super.beanPropertiesWriteOnly(beanClass, properties);<a name="line.462"></a>
<span class="sourceLineNo">463</span> return this;<a name="line.463"></a>
<span class="sourceLineNo">464</span> }<a name="line.464"></a>
<span class="sourceLineNo">465</span><a name="line.465"></a>
<span class="sourceLineNo">466</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.466"></a>
<span class="sourceLineNo">467</span> public Builder beanPropertiesWriteOnly(String beanClassName, String properties) {<a name="line.467"></a>
<span class="sourceLineNo">468</span> super.beanPropertiesWriteOnly(beanClassName, properties);<a name="line.468"></a>
<span class="sourceLineNo">469</span> return this;<a name="line.469"></a>
<span class="sourceLineNo">470</span> }<a name="line.470"></a>
<span class="sourceLineNo">471</span><a name="line.471"></a>
<span class="sourceLineNo">472</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.472"></a>
<span class="sourceLineNo">473</span> public Builder beansRequireDefaultConstructor() {<a name="line.473"></a>
<span class="sourceLineNo">474</span> super.beansRequireDefaultConstructor();<a name="line.474"></a>
<span class="sourceLineNo">475</span> return this;<a name="line.475"></a>
<span class="sourceLineNo">476</span> }<a name="line.476"></a>
<span class="sourceLineNo">477</span><a name="line.477"></a>
<span class="sourceLineNo">478</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.478"></a>
<span class="sourceLineNo">479</span> public Builder beansRequireSerializable() {<a name="line.479"></a>
<span class="sourceLineNo">480</span> super.beansRequireSerializable();<a name="line.480"></a>
<span class="sourceLineNo">481</span> return this;<a name="line.481"></a>
<span class="sourceLineNo">482</span> }<a name="line.482"></a>
<span class="sourceLineNo">483</span><a name="line.483"></a>
<span class="sourceLineNo">484</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.484"></a>
<span class="sourceLineNo">485</span> public Builder beansRequireSettersForGetters() {<a name="line.485"></a>
<span class="sourceLineNo">486</span> super.beansRequireSettersForGetters();<a name="line.486"></a>
<span class="sourceLineNo">487</span> return this;<a name="line.487"></a>
<span class="sourceLineNo">488</span> }<a name="line.488"></a>
<span class="sourceLineNo">489</span><a name="line.489"></a>
<span class="sourceLineNo">490</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.490"></a>
<span class="sourceLineNo">491</span> public Builder dictionaryOn(Class&lt;?&gt; on, java.lang.Class&lt;?&gt;...values) {<a name="line.491"></a>
<span class="sourceLineNo">492</span> super.dictionaryOn(on, values);<a name="line.492"></a>
<span class="sourceLineNo">493</span> return this;<a name="line.493"></a>
<span class="sourceLineNo">494</span> }<a name="line.494"></a>
<span class="sourceLineNo">495</span><a name="line.495"></a>
<span class="sourceLineNo">496</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.496"></a>
<span class="sourceLineNo">497</span> public Builder disableBeansRequireSomeProperties() {<a name="line.497"></a>
<span class="sourceLineNo">498</span> super.disableBeansRequireSomeProperties();<a name="line.498"></a>
<span class="sourceLineNo">499</span> return this;<a name="line.499"></a>
<span class="sourceLineNo">500</span> }<a name="line.500"></a>
<span class="sourceLineNo">501</span><a name="line.501"></a>
<span class="sourceLineNo">502</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.502"></a>
<span class="sourceLineNo">503</span> public Builder disableIgnoreMissingSetters() {<a name="line.503"></a>
<span class="sourceLineNo">504</span> super.disableIgnoreMissingSetters();<a name="line.504"></a>
<span class="sourceLineNo">505</span> return this;<a name="line.505"></a>
<span class="sourceLineNo">506</span> }<a name="line.506"></a>
<span class="sourceLineNo">507</span><a name="line.507"></a>
<span class="sourceLineNo">508</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.508"></a>
<span class="sourceLineNo">509</span> public Builder disableIgnoreTransientFields() {<a name="line.509"></a>
<span class="sourceLineNo">510</span> super.disableIgnoreTransientFields();<a name="line.510"></a>
<span class="sourceLineNo">511</span> return this;<a name="line.511"></a>
<span class="sourceLineNo">512</span> }<a name="line.512"></a>
<span class="sourceLineNo">513</span><a name="line.513"></a>
<span class="sourceLineNo">514</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.514"></a>
<span class="sourceLineNo">515</span> public Builder disableIgnoreUnknownNullBeanProperties() {<a name="line.515"></a>
<span class="sourceLineNo">516</span> super.disableIgnoreUnknownNullBeanProperties();<a name="line.516"></a>
<span class="sourceLineNo">517</span> return this;<a name="line.517"></a>
<span class="sourceLineNo">518</span> }<a name="line.518"></a>
<span class="sourceLineNo">519</span><a name="line.519"></a>
<span class="sourceLineNo">520</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.520"></a>
<span class="sourceLineNo">521</span> public Builder disableInterfaceProxies() {<a name="line.521"></a>
<span class="sourceLineNo">522</span> super.disableInterfaceProxies();<a name="line.522"></a>
<span class="sourceLineNo">523</span> return this;<a name="line.523"></a>
<span class="sourceLineNo">524</span> }<a name="line.524"></a>
<span class="sourceLineNo">525</span><a name="line.525"></a>
<span class="sourceLineNo">526</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.526"></a>
<span class="sourceLineNo">527</span> public &lt;T&gt; Builder example(Class&lt;T&gt; pojoClass, T o) {<a name="line.527"></a>
<span class="sourceLineNo">528</span> super.example(pojoClass, o);<a name="line.528"></a>
<span class="sourceLineNo">529</span> return this;<a name="line.529"></a>
<span class="sourceLineNo">530</span> }<a name="line.530"></a>
<span class="sourceLineNo">531</span><a name="line.531"></a>
<span class="sourceLineNo">532</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.532"></a>
<span class="sourceLineNo">533</span> public &lt;T&gt; Builder example(Class&lt;T&gt; pojoClass, String json) {<a name="line.533"></a>
<span class="sourceLineNo">534</span> super.example(pojoClass, json);<a name="line.534"></a>
<span class="sourceLineNo">535</span> return this;<a name="line.535"></a>
<span class="sourceLineNo">536</span> }<a name="line.536"></a>
<span class="sourceLineNo">537</span><a name="line.537"></a>
<span class="sourceLineNo">538</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.538"></a>
<span class="sourceLineNo">539</span> public Builder findFluentSetters() {<a name="line.539"></a>
<span class="sourceLineNo">540</span> super.findFluentSetters();<a name="line.540"></a>
<span class="sourceLineNo">541</span> return this;<a name="line.541"></a>
<span class="sourceLineNo">542</span> }<a name="line.542"></a>
<span class="sourceLineNo">543</span><a name="line.543"></a>
<span class="sourceLineNo">544</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.544"></a>
<span class="sourceLineNo">545</span> public Builder findFluentSetters(Class&lt;?&gt; on) {<a name="line.545"></a>
<span class="sourceLineNo">546</span> super.findFluentSetters(on);<a name="line.546"></a>
<span class="sourceLineNo">547</span> return this;<a name="line.547"></a>
<span class="sourceLineNo">548</span> }<a name="line.548"></a>
<span class="sourceLineNo">549</span><a name="line.549"></a>
<span class="sourceLineNo">550</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.550"></a>
<span class="sourceLineNo">551</span> public Builder ignoreInvocationExceptionsOnGetters() {<a name="line.551"></a>
<span class="sourceLineNo">552</span> super.ignoreInvocationExceptionsOnGetters();<a name="line.552"></a>
<span class="sourceLineNo">553</span> return this;<a name="line.553"></a>
<span class="sourceLineNo">554</span> }<a name="line.554"></a>
<span class="sourceLineNo">555</span><a name="line.555"></a>
<span class="sourceLineNo">556</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.556"></a>
<span class="sourceLineNo">557</span> public Builder ignoreInvocationExceptionsOnSetters() {<a name="line.557"></a>
<span class="sourceLineNo">558</span> super.ignoreInvocationExceptionsOnSetters();<a name="line.558"></a>
<span class="sourceLineNo">559</span> return this;<a name="line.559"></a>
<span class="sourceLineNo">560</span> }<a name="line.560"></a>
<span class="sourceLineNo">561</span><a name="line.561"></a>
<span class="sourceLineNo">562</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.562"></a>
<span class="sourceLineNo">563</span> public Builder ignoreUnknownBeanProperties() {<a name="line.563"></a>
<span class="sourceLineNo">564</span> super.ignoreUnknownBeanProperties();<a name="line.564"></a>
<span class="sourceLineNo">565</span> return this;<a name="line.565"></a>
<span class="sourceLineNo">566</span> }<a name="line.566"></a>
<span class="sourceLineNo">567</span><a name="line.567"></a>
<span class="sourceLineNo">568</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.568"></a>
<span class="sourceLineNo">569</span> public Builder ignoreUnknownEnumValues() {<a name="line.569"></a>
<span class="sourceLineNo">570</span> super.ignoreUnknownEnumValues();<a name="line.570"></a>
<span class="sourceLineNo">571</span> return this;<a name="line.571"></a>
<span class="sourceLineNo">572</span> }<a name="line.572"></a>
<span class="sourceLineNo">573</span><a name="line.573"></a>
<span class="sourceLineNo">574</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.574"></a>
<span class="sourceLineNo">575</span> public Builder implClass(Class&lt;?&gt; interfaceClass, Class&lt;?&gt; implClass) {<a name="line.575"></a>
<span class="sourceLineNo">576</span> super.implClass(interfaceClass, implClass);<a name="line.576"></a>
<span class="sourceLineNo">577</span> return this;<a name="line.577"></a>
<span class="sourceLineNo">578</span> }<a name="line.578"></a>
<span class="sourceLineNo">579</span><a name="line.579"></a>
<span class="sourceLineNo">580</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.580"></a>
<span class="sourceLineNo">581</span> public Builder implClasses(Map&lt;Class&lt;?&gt;,Class&lt;?&gt;&gt; values) {<a name="line.581"></a>
<span class="sourceLineNo">582</span> super.implClasses(values);<a name="line.582"></a>
<span class="sourceLineNo">583</span> return this;<a name="line.583"></a>
<span class="sourceLineNo">584</span> }<a name="line.584"></a>
<span class="sourceLineNo">585</span><a name="line.585"></a>
<span class="sourceLineNo">586</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.586"></a>
<span class="sourceLineNo">587</span> public Builder interfaceClass(Class&lt;?&gt; on, Class&lt;?&gt; value) {<a name="line.587"></a>
<span class="sourceLineNo">588</span> super.interfaceClass(on, value);<a name="line.588"></a>
<span class="sourceLineNo">589</span> return this;<a name="line.589"></a>
<span class="sourceLineNo">590</span> }<a name="line.590"></a>
<span class="sourceLineNo">591</span><a name="line.591"></a>
<span class="sourceLineNo">592</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.592"></a>
<span class="sourceLineNo">593</span> public Builder interfaces(java.lang.Class&lt;?&gt;...value) {<a name="line.593"></a>
<span class="sourceLineNo">594</span> super.interfaces(value);<a name="line.594"></a>
<span class="sourceLineNo">595</span> return this;<a name="line.595"></a>
<span class="sourceLineNo">596</span> }<a name="line.596"></a>
<span class="sourceLineNo">597</span><a name="line.597"></a>
<span class="sourceLineNo">598</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.598"></a>
<span class="sourceLineNo">599</span> public Builder locale(Locale value) {<a name="line.599"></a>
<span class="sourceLineNo">600</span> super.locale(value);<a name="line.600"></a>
<span class="sourceLineNo">601</span> return this;<a name="line.601"></a>
<span class="sourceLineNo">602</span> }<a name="line.602"></a>
<span class="sourceLineNo">603</span><a name="line.603"></a>
<span class="sourceLineNo">604</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.604"></a>
<span class="sourceLineNo">605</span> public Builder mediaType(MediaType value) {<a name="line.605"></a>
<span class="sourceLineNo">606</span> super.mediaType(value);<a name="line.606"></a>
<span class="sourceLineNo">607</span> return this;<a name="line.607"></a>
<span class="sourceLineNo">608</span> }<a name="line.608"></a>
<span class="sourceLineNo">609</span><a name="line.609"></a>
<span class="sourceLineNo">610</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.610"></a>
<span class="sourceLineNo">611</span> public Builder notBeanClasses(java.lang.Class&lt;?&gt;...values) {<a name="line.611"></a>
<span class="sourceLineNo">612</span> super.notBeanClasses(values);<a name="line.612"></a>
<span class="sourceLineNo">613</span> return this;<a name="line.613"></a>
<span class="sourceLineNo">614</span> }<a name="line.614"></a>
<span class="sourceLineNo">615</span><a name="line.615"></a>
<span class="sourceLineNo">616</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.616"></a>
<span class="sourceLineNo">617</span> public Builder notBeanPackages(String...values) {<a name="line.617"></a>
<span class="sourceLineNo">618</span> super.notBeanPackages(values);<a name="line.618"></a>
<span class="sourceLineNo">619</span> return this;<a name="line.619"></a>
<span class="sourceLineNo">620</span> }<a name="line.620"></a>
<span class="sourceLineNo">621</span><a name="line.621"></a>
<span class="sourceLineNo">622</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.622"></a>
<span class="sourceLineNo">623</span> public Builder propertyNamer(Class&lt;? extends org.apache.juneau.PropertyNamer&gt; value) {<a name="line.623"></a>
<span class="sourceLineNo">624</span> super.propertyNamer(value);<a name="line.624"></a>
<span class="sourceLineNo">625</span> return this;<a name="line.625"></a>
<span class="sourceLineNo">626</span> }<a name="line.626"></a>
<span class="sourceLineNo">627</span><a name="line.627"></a>
<span class="sourceLineNo">628</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.628"></a>
<span class="sourceLineNo">629</span> public Builder propertyNamer(Class&lt;?&gt; on, Class&lt;? extends org.apache.juneau.PropertyNamer&gt; value) {<a name="line.629"></a>
<span class="sourceLineNo">630</span> super.propertyNamer(on, value);<a name="line.630"></a>
<span class="sourceLineNo">631</span> return this;<a name="line.631"></a>
<span class="sourceLineNo">632</span> }<a name="line.632"></a>
<span class="sourceLineNo">633</span><a name="line.633"></a>
<span class="sourceLineNo">634</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.634"></a>
<span class="sourceLineNo">635</span> public Builder sortProperties() {<a name="line.635"></a>
<span class="sourceLineNo">636</span> super.sortProperties();<a name="line.636"></a>
<span class="sourceLineNo">637</span> return this;<a name="line.637"></a>
<span class="sourceLineNo">638</span> }<a name="line.638"></a>
<span class="sourceLineNo">639</span><a name="line.639"></a>
<span class="sourceLineNo">640</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.640"></a>
<span class="sourceLineNo">641</span> public Builder sortProperties(java.lang.Class&lt;?&gt;...on) {<a name="line.641"></a>
<span class="sourceLineNo">642</span> super.sortProperties(on);<a name="line.642"></a>
<span class="sourceLineNo">643</span> return this;<a name="line.643"></a>
<span class="sourceLineNo">644</span> }<a name="line.644"></a>
<span class="sourceLineNo">645</span><a name="line.645"></a>
<span class="sourceLineNo">646</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.646"></a>
<span class="sourceLineNo">647</span> public Builder stopClass(Class&lt;?&gt; on, Class&lt;?&gt; value) {<a name="line.647"></a>
<span class="sourceLineNo">648</span> super.stopClass(on, value);<a name="line.648"></a>
<span class="sourceLineNo">649</span> return this;<a name="line.649"></a>
<span class="sourceLineNo">650</span> }<a name="line.650"></a>
<span class="sourceLineNo">651</span><a name="line.651"></a>
<span class="sourceLineNo">652</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.652"></a>
<span class="sourceLineNo">653</span> public &lt;T, S&gt; Builder swap(Class&lt;T&gt; normalClass, Class&lt;S&gt; swappedClass, ThrowingFunction&lt;T,S&gt; swapFunction) {<a name="line.653"></a>
<span class="sourceLineNo">654</span> super.swap(normalClass, swappedClass, swapFunction);<a name="line.654"></a>
<span class="sourceLineNo">655</span> return this;<a name="line.655"></a>
<span class="sourceLineNo">656</span> }<a name="line.656"></a>
<span class="sourceLineNo">657</span><a name="line.657"></a>
<span class="sourceLineNo">658</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.658"></a>
<span class="sourceLineNo">659</span> public &lt;T, S&gt; Builder swap(Class&lt;T&gt; normalClass, Class&lt;S&gt; swappedClass, ThrowingFunction&lt;T,S&gt; swapFunction, ThrowingFunction&lt;S,T&gt; unswapFunction) {<a name="line.659"></a>
<span class="sourceLineNo">660</span> super.swap(normalClass, swappedClass, swapFunction, unswapFunction);<a name="line.660"></a>
<span class="sourceLineNo">661</span> return this;<a name="line.661"></a>
<span class="sourceLineNo">662</span> }<a name="line.662"></a>
<span class="sourceLineNo">663</span><a name="line.663"></a>
<span class="sourceLineNo">664</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.664"></a>
<span class="sourceLineNo">665</span> public Builder swaps(java.lang.Class&lt;?&gt;...values) {<a name="line.665"></a>
<span class="sourceLineNo">666</span> super.swaps(values);<a name="line.666"></a>
<span class="sourceLineNo">667</span> return this;<a name="line.667"></a>
<span class="sourceLineNo">668</span> }<a name="line.668"></a>
<span class="sourceLineNo">669</span><a name="line.669"></a>
<span class="sourceLineNo">670</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.670"></a>
<span class="sourceLineNo">671</span> public Builder timeZone(TimeZone value) {<a name="line.671"></a>
<span class="sourceLineNo">672</span> super.timeZone(value);<a name="line.672"></a>
<span class="sourceLineNo">673</span> return this;<a name="line.673"></a>
<span class="sourceLineNo">674</span> }<a name="line.674"></a>
<span class="sourceLineNo">675</span><a name="line.675"></a>
<span class="sourceLineNo">676</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.676"></a>
<span class="sourceLineNo">677</span> public Builder typeName(Class&lt;?&gt; on, String value) {<a name="line.677"></a>
<span class="sourceLineNo">678</span> super.typeName(on, value);<a name="line.678"></a>
<span class="sourceLineNo">679</span> return this;<a name="line.679"></a>
<span class="sourceLineNo">680</span> }<a name="line.680"></a>
<span class="sourceLineNo">681</span><a name="line.681"></a>
<span class="sourceLineNo">682</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.682"></a>
<span class="sourceLineNo">683</span> public Builder typePropertyName(String value) {<a name="line.683"></a>
<span class="sourceLineNo">684</span> super.typePropertyName(value);<a name="line.684"></a>
<span class="sourceLineNo">685</span> return this;<a name="line.685"></a>
<span class="sourceLineNo">686</span> }<a name="line.686"></a>
<span class="sourceLineNo">687</span><a name="line.687"></a>
<span class="sourceLineNo">688</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.688"></a>
<span class="sourceLineNo">689</span> public Builder typePropertyName(Class&lt;?&gt; on, String value) {<a name="line.689"></a>
<span class="sourceLineNo">690</span> super.typePropertyName(on, value);<a name="line.690"></a>
<span class="sourceLineNo">691</span> return this;<a name="line.691"></a>
<span class="sourceLineNo">692</span> }<a name="line.692"></a>
<span class="sourceLineNo">693</span><a name="line.693"></a>
<span class="sourceLineNo">694</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.694"></a>
<span class="sourceLineNo">695</span> public Builder useEnumNames() {<a name="line.695"></a>
<span class="sourceLineNo">696</span> super.useEnumNames();<a name="line.696"></a>
<span class="sourceLineNo">697</span> return this;<a name="line.697"></a>
<span class="sourceLineNo">698</span> }<a name="line.698"></a>
<span class="sourceLineNo">699</span><a name="line.699"></a>
<span class="sourceLineNo">700</span> @Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */<a name="line.700"></a>
<span class="sourceLineNo">701</span> public Builder useJavaBeanIntrospector() {<a name="line.701"></a>
<span class="sourceLineNo">702</span> super.useJavaBeanIntrospector();<a name="line.702"></a>
<span class="sourceLineNo">703</span> return this;<a name="line.703"></a>
<span class="sourceLineNo">704</span> }<a name="line.704"></a>
<span class="sourceLineNo">705</span><a name="line.705"></a>
<span class="sourceLineNo">706</span> // &lt;/FluentSetters&gt;<a name="line.706"></a>
<span class="sourceLineNo">707</span> }<a name="line.707"></a>
<span class="sourceLineNo">708</span><a name="line.708"></a>
<span class="sourceLineNo">709</span> //-------------------------------------------------------------------------------------------------------------------<a name="line.709"></a>
<span class="sourceLineNo">710</span> // Instance<a name="line.710"></a>
<span class="sourceLineNo">711</span> //-------------------------------------------------------------------------------------------------------------------<a name="line.711"></a>
<span class="sourceLineNo">712</span><a name="line.712"></a>
<span class="sourceLineNo">713</span> final int initialDepth, maxDepth;<a name="line.713"></a>
<span class="sourceLineNo">714</span> final boolean<a name="line.714"></a>
<span class="sourceLineNo">715</span> detectRecursions,<a name="line.715"></a>
<span class="sourceLineNo">716</span> ignoreRecursions;<a name="line.716"></a>
<span class="sourceLineNo">717</span><a name="line.717"></a>
<span class="sourceLineNo">718</span> private final boolean actualDetectRecursions;<a name="line.718"></a>
<span class="sourceLineNo">719</span><a name="line.719"></a>
<span class="sourceLineNo">720</span> /**<a name="line.720"></a>
<span class="sourceLineNo">721</span> * Constructor<a name="line.721"></a>
<span class="sourceLineNo">722</span> *<a name="line.722"></a>
<span class="sourceLineNo">723</span> * @param builder The builder for this object.<a name="line.723"></a>
<span class="sourceLineNo">724</span> */<a name="line.724"></a>
<span class="sourceLineNo">725</span> protected BeanTraverseContext(Builder builder) {<a name="line.725"></a>
<span class="sourceLineNo">726</span> super(builder);<a name="line.726"></a>
<span class="sourceLineNo">727</span><a name="line.727"></a>
<span class="sourceLineNo">728</span> maxDepth = builder.maxDepth;<a name="line.728"></a>
<span class="sourceLineNo">729</span> initialDepth = builder.initialDepth;<a name="line.729"></a>
<span class="sourceLineNo">730</span> ignoreRecursions = builder.ignoreRecursions;<a name="line.730"></a>
<span class="sourceLineNo">731</span> detectRecursions = builder.detectRecursions;<a name="line.731"></a>
<span class="sourceLineNo">732</span><a name="line.732"></a>
<span class="sourceLineNo">733</span> actualDetectRecursions = detectRecursions || ignoreRecursions || super.isDebug();<a name="line.733"></a>
<span class="sourceLineNo">734</span> }<a name="line.734"></a>
<span class="sourceLineNo">735</span><a name="line.735"></a>
<span class="sourceLineNo">736</span> @Override /* Context */<a name="line.736"></a>
<span class="sourceLineNo">737</span> public abstract Builder copy();<a name="line.737"></a>
<span class="sourceLineNo">738</span><a name="line.738"></a>
<span class="sourceLineNo">739</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.739"></a>
<span class="sourceLineNo">740</span> // Properties<a name="line.740"></a>
<span class="sourceLineNo">741</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.741"></a>
<span class="sourceLineNo">742</span><a name="line.742"></a>
<span class="sourceLineNo">743</span> /**<a name="line.743"></a>
<span class="sourceLineNo">744</span> * Automatically detect POJO recursions.<a name="line.744"></a>
<span class="sourceLineNo">745</span> *<a name="line.745"></a>
<span class="sourceLineNo">746</span> * @see Builder#detectRecursions()<a name="line.746"></a>
<span class="sourceLineNo">747</span> * @return<a name="line.747"></a>
<span class="sourceLineNo">748</span> * &lt;jk&gt;true&lt;/jk&gt; if recursions should be checked for during traversal.<a name="line.748"></a>
<span class="sourceLineNo">749</span> */<a name="line.749"></a>
<span class="sourceLineNo">750</span> public final boolean isDetectRecursions() {<a name="line.750"></a>
<span class="sourceLineNo">751</span> return actualDetectRecursions;<a name="line.751"></a>
<span class="sourceLineNo">752</span> }<a name="line.752"></a>
<span class="sourceLineNo">753</span><a name="line.753"></a>
<span class="sourceLineNo">754</span> /**<a name="line.754"></a>
<span class="sourceLineNo">755</span> * Ignore recursion errors.<a name="line.755"></a>
<span class="sourceLineNo">756</span> *<a name="line.756"></a>
<span class="sourceLineNo">757</span> * @see Builder#ignoreRecursions()<a name="line.757"></a>
<span class="sourceLineNo">758</span> * @return<a name="line.758"></a>
<span class="sourceLineNo">759</span> * &lt;jk&gt;true&lt;/jk&gt; if when we encounter the same object when traversing a tree, we set the value to &lt;jk&gt;null&lt;/jk&gt;.<a name="line.759"></a>
<span class="sourceLineNo">760</span> * &lt;br&gt;Otherwise, an exception is thrown with the message &lt;js&gt;"Recursion occurred, stack=..."&lt;/js&gt;.<a name="line.760"></a>
<span class="sourceLineNo">761</span> */<a name="line.761"></a>
<span class="sourceLineNo">762</span> public final boolean isIgnoreRecursions() {<a name="line.762"></a>
<span class="sourceLineNo">763</span> return ignoreRecursions;<a name="line.763"></a>
<span class="sourceLineNo">764</span> }<a name="line.764"></a>
<span class="sourceLineNo">765</span><a name="line.765"></a>
<span class="sourceLineNo">766</span> /**<a name="line.766"></a>
<span class="sourceLineNo">767</span> * Initial depth.<a name="line.767"></a>
<span class="sourceLineNo">768</span> *<a name="line.768"></a>
<span class="sourceLineNo">769</span> * @see Builder#initialDepth(int)<a name="line.769"></a>
<span class="sourceLineNo">770</span> * @return<a name="line.770"></a>
<span class="sourceLineNo">771</span> * The initial indentation level at the root.<a name="line.771"></a>
<span class="sourceLineNo">772</span> */<a name="line.772"></a>
<span class="sourceLineNo">773</span> public final int getInitialDepth() {<a name="line.773"></a>
<span class="sourceLineNo">774</span> return initialDepth;<a name="line.774"></a>
<span class="sourceLineNo">775</span> }<a name="line.775"></a>
<span class="sourceLineNo">776</span><a name="line.776"></a>
<span class="sourceLineNo">777</span> /**<a name="line.777"></a>
<span class="sourceLineNo">778</span> * Max traversal depth.<a name="line.778"></a>
<span class="sourceLineNo">779</span> *<a name="line.779"></a>
<span class="sourceLineNo">780</span> * @see Builder#maxDepth(int)<a name="line.780"></a>
<span class="sourceLineNo">781</span> * @return<a name="line.781"></a>
<span class="sourceLineNo">782</span> * The depth at which traversal is aborted if depth is reached in the POJO tree.<a name="line.782"></a>
<span class="sourceLineNo">783</span> * &lt;br&gt;If this depth is exceeded, an exception is thrown.<a name="line.783"></a>
<span class="sourceLineNo">784</span> */<a name="line.784"></a>
<span class="sourceLineNo">785</span> public final int getMaxDepth() {<a name="line.785"></a>
<span class="sourceLineNo">786</span> return maxDepth;<a name="line.786"></a>
<span class="sourceLineNo">787</span> }<a name="line.787"></a>
<span class="sourceLineNo">788</span><a name="line.788"></a>
<span class="sourceLineNo">789</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.789"></a>
<span class="sourceLineNo">790</span> // Other methods<a name="line.790"></a>
<span class="sourceLineNo">791</span> //-----------------------------------------------------------------------------------------------------------------<a name="line.791"></a>
<span class="sourceLineNo">792</span><a name="line.792"></a>
<span class="sourceLineNo">793</span> @Override /* Context */<a name="line.793"></a>
<span class="sourceLineNo">794</span> protected JsonMap properties() {<a name="line.794"></a>
<span class="sourceLineNo">795</span> return filteredMap("detectRecursions", detectRecursions, "maxDepth", maxDepth, "ignoreRecursions", ignoreRecursions, "initialDepth", initialDepth);<a name="line.795"></a>
<span class="sourceLineNo">796</span> }<a name="line.796"></a>
<span class="sourceLineNo">797</span>}<a name="line.797"></a>
</pre>
</div>
</body>
</html>