http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/436334e6/content/site/apidocs/src-html/org/apache/juneau/BeanContext.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/BeanContext.html b/content/site/apidocs/src-html/org/apache/juneau/BeanContext.html index fa01b57..6ca48ed 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/BeanContext.html +++ b/content/site/apidocs/src-html/org/apache/juneau/BeanContext.html @@ -32,1542 +32,1649 @@ <span class="sourceLineNo">024</span><a name="line.24"></a> <span class="sourceLineNo">025</span>import org.apache.juneau.annotation.*;<a name="line.25"></a> <span class="sourceLineNo">026</span>import org.apache.juneau.http.*;<a name="line.26"></a> -<span class="sourceLineNo">027</span>import org.apache.juneau.json.*;<a name="line.27"></a> -<span class="sourceLineNo">028</span>import org.apache.juneau.parser.*;<a name="line.28"></a> -<span class="sourceLineNo">029</span>import org.apache.juneau.serializer.*;<a name="line.29"></a> -<span class="sourceLineNo">030</span>import org.apache.juneau.transform.*;<a name="line.30"></a> -<span class="sourceLineNo">031</span><a name="line.31"></a> -<span class="sourceLineNo">032</span>/**<a name="line.32"></a> -<span class="sourceLineNo">033</span> * Core class of the Juneau architecture.<a name="line.33"></a> -<span class="sourceLineNo">034</span> * <p><a name="line.34"></a> -<span class="sourceLineNo">035</span> * This class servers multiple purposes:<a name="line.35"></a> -<span class="sourceLineNo">036</span> * <ul class='spaced-list'><a name="line.36"></a> -<span class="sourceLineNo">037</span> * <li>Provides the ability to wrap beans inside {@link Map} interfaces.<a name="line.37"></a> -<span class="sourceLineNo">038</span> * <li>Serves as a repository for metadata on POJOs, such as associated {@link BeanFilter beanFilters}, {@link PropertyNamer property namers}, etc...<a name="line.38"></a> -<span class="sourceLineNo">039</span> * which are used to tailor how POJOs are serialized and parsed.<a name="line.39"></a> -<span class="sourceLineNo">040</span> * <li>Serves as a common utility class for all {@link Serializer Serializers} and {@link Parser Parsers}<a name="line.40"></a> -<span class="sourceLineNo">041</span> * for serializing and parsing Java beans.<a name="line.41"></a> -<span class="sourceLineNo">042</span> * </ul><a name="line.42"></a> -<span class="sourceLineNo">043</span> * <p><a name="line.43"></a> -<span class="sourceLineNo">044</span> * All serializer and parser contexts extend from this context.<a name="line.44"></a> -<span class="sourceLineNo">045</span> *<a name="line.45"></a> -<span class="sourceLineNo">046</span> * <h5 class='topic'>Bean Contexts</h5><a name="line.46"></a> -<span class="sourceLineNo">047</span> * Bean contexts are created through the {@link PropertyStore#getContext(Class)} method.<a name="line.47"></a> -<span class="sourceLineNo">048</span> * These context objects are read-only, reusable, and thread-safe.<a name="line.48"></a> -<span class="sourceLineNo">049</span> * The {@link PropertyStore} class will typically cache copies of <code>Context</code> objects based on<a name="line.49"></a> -<span class="sourceLineNo">050</span> * the current settings on the factory.<a name="line.50"></a> -<span class="sourceLineNo">051</span> * <p><a name="line.51"></a> -<span class="sourceLineNo">052</span> * Each bean context maintains a cache of {@link ClassMeta} objects that describe information about classes encountered.<a name="line.52"></a> -<span class="sourceLineNo">053</span> * These <code>ClassMeta</code> objects are time-consuming to construct.<a name="line.53"></a> -<span class="sourceLineNo">054</span> * Therefore, instances of {@link BeanContext} that share the same <js>"BeanContext.*"</js> property values share<a name="line.54"></a> -<span class="sourceLineNo">055</span> * the same cache. This allows for efficient reuse of <code>ClassMeta</code> objects so that the information about<a name="line.55"></a> -<span class="sourceLineNo">056</span> * classes only needs to be calculated once.<a name="line.56"></a> -<span class="sourceLineNo">057</span> * Because of this, many of the properties defined on the {@link BeanContext} class cannot be overridden on the session.<a name="line.57"></a> -<span class="sourceLineNo">058</span> *<a name="line.58"></a> -<span class="sourceLineNo">059</span> * <h5 class='topic'>Bean Sessions</h5><a name="line.59"></a> -<span class="sourceLineNo">060</span> * <p><a name="line.60"></a> -<span class="sourceLineNo">061</span> * Whereas <code>BeanContext</code> objects are permanent, unchangeable, cached, and thread-safe,<a name="line.61"></a> -<span class="sourceLineNo">062</span> * {@link BeanSession} objects are ephemeral and not thread-safe.<a name="line.62"></a> -<span class="sourceLineNo">063</span> * They are meant to be used as quickly-constructed scratchpads for creating bean maps.<a name="line.63"></a> -<span class="sourceLineNo">064</span> * {@link BeanMap} objects can only be created through the session.<a name="line.64"></a> -<span class="sourceLineNo">065</span> *<a name="line.65"></a> -<span class="sourceLineNo">066</span> * <h5 class='topic'>BeanContext configuration properties</h5><a name="line.66"></a> -<span class="sourceLineNo">067</span> * <code>BeanContexts</code> have several configuration properties that can be used to tweak behavior on how beans are handled.<a name="line.67"></a> -<span class="sourceLineNo">068</span> * These are denoted as the static <jsf>BEAN_*</jsf> fields on this class.<a name="line.68"></a> -<span class="sourceLineNo">069</span> * <p><a name="line.69"></a> -<span class="sourceLineNo">070</span> * Some settings (e.g. {@link BeanContext#BEAN_beansRequireDefaultConstructor}) are used to differentiate between bean and non-bean classes.<a name="line.70"></a> -<span class="sourceLineNo">071</span> * Attempting to create a bean map around one of these objects will throw a {@link BeanRuntimeException}.<a name="line.71"></a> -<span class="sourceLineNo">072</span> * The purpose for this behavior is so that the serializers can identify these non-bean classes and convert them to plain strings using the {@link Object#toString()} method.<a name="line.72"></a> -<span class="sourceLineNo">073</span> * <p><a name="line.73"></a> -<span class="sourceLineNo">074</span> * Some settings (e.g. {@link BeanContext#BEAN_beanFieldVisibility}) are used to determine what kinds of properties are detected on beans.<a name="line.74"></a> -<span class="sourceLineNo">075</span> * <p><a name="line.75"></a> -<span class="sourceLineNo">076</span> * Some settings (e.g. {@link BeanContext#BEAN_beanMapPutReturnsOldValue}) change the runtime behavior of bean maps.<a name="line.76"></a> -<span class="sourceLineNo">077</span> * <p><a name="line.77"></a> -<span class="sourceLineNo">078</span> * Settings are specified using the {@link PropertyStore#setProperty(String, Object)} method and related convenience methods.<a name="line.78"></a> -<span class="sourceLineNo">079</span> *<a name="line.79"></a> -<span class="sourceLineNo">080</span> * <h5 class='section'>Example:</h5><a name="line.80"></a> -<span class="sourceLineNo">081</span> * <p class='bcode'><a name="line.81"></a> -<span class="sourceLineNo">082</span> * <jc>// Construct a context from scratch.</jc><a name="line.82"></a> -<span class="sourceLineNo">083</span> * BeanContext beanContext = PropertyStore.<jsm>create</jsm>()<a name="line.83"></a> -<span class="sourceLineNo">084</span> * .property(BeanContext.<jsf>BEAN_beansRequireDefaultConstructor</jsf>, <jk>true</jk>)<a name="line.84"></a> -<span class="sourceLineNo">085</span> * .notBeanClasses(Foo.<jk>class</jk>)<a name="line.85"></a> -<span class="sourceLineNo">086</span> * .getBeanContext();<a name="line.86"></a> -<span class="sourceLineNo">087</span> *<a name="line.87"></a> -<span class="sourceLineNo">088</span> * <jc>// Clone an existing property store.</jc><a name="line.88"></a> -<span class="sourceLineNo">089</span> * BeanContext beanContext = PropertyStore.<jsm>create</jsm>(otherConfig)<a name="line.89"></a> -<span class="sourceLineNo">090</span> * .property(BeanContext.<jsf>BEAN_beansRequireDefaultConstructor</jsf>, <jk>true</jk>)<a name="line.90"></a> -<span class="sourceLineNo">091</span> * .notBeanClasses(Foo.<jk>class</jk>)<a name="line.91"></a> -<span class="sourceLineNo">092</span> * .getBeanContext();<a name="line.92"></a> -<span class="sourceLineNo">093</span> * </p><a name="line.93"></a> -<span class="sourceLineNo">094</span> *<a name="line.94"></a> -<span class="sourceLineNo">095</span> * <h5 class='topic'>Bean Maps</h5><a name="line.95"></a> -<span class="sourceLineNo">096</span> * <p><a name="line.96"></a> -<span class="sourceLineNo">097</span> * {@link BeanMap BeanMaps} are wrappers around Java beans that allow properties to be retrieved and<a name="line.97"></a> -<span class="sourceLineNo">098</span> * set using the common {@link Map#put(Object,Object)} and {@link Map#get(Object)} methods.<br><a name="line.98"></a> -<span class="sourceLineNo">099</span> * <br><a name="line.99"></a> -<span class="sourceLineNo">100</span> * Bean maps are created in two ways...<a name="line.100"></a> -<span class="sourceLineNo">101</span> * <ol><a name="line.101"></a> -<span class="sourceLineNo">102</span> * <li> {@link BeanSession#toBeanMap(Object) BeanSession.toBeanMap()} - Wraps an existing bean inside a {@code Map} wrapper.<a name="line.102"></a> -<span class="sourceLineNo">103</span> * <li> {@link BeanSession#newBeanMap(Class) BeanSession.newBeanMap()} - Create a new bean instance wrapped in a {@code Map} wrapper.<a name="line.103"></a> -<span class="sourceLineNo">104</span> * </ol><a name="line.104"></a> -<span class="sourceLineNo">105</span> *<a name="line.105"></a> -<span class="sourceLineNo">106</span> * <h5 class='section'>Example:</h5><a name="line.106"></a> -<span class="sourceLineNo">107</span> * <p class='bcode'><a name="line.107"></a> -<span class="sourceLineNo">108</span> * <jc>// A sample bean class</jc><a name="line.108"></a> -<span class="sourceLineNo">109</span> * <jk>public class</jk> Person {<a name="line.109"></a> -<span class="sourceLineNo">110</span> * <jk>public</jk> String getName();<a name="line.110"></a> -<span class="sourceLineNo">111</span> * <jk>public void</jk> setName(String name);<a name="line.111"></a> -<span class="sourceLineNo">112</span> * <jk>public int</jk> getAge();<a name="line.112"></a> -<span class="sourceLineNo">113</span> * <jk>public void</jk> setAge(<jk>int</jk> age);<a name="line.113"></a> -<span class="sourceLineNo">114</span> * }<a name="line.114"></a> -<span class="sourceLineNo">115</span> *<a name="line.115"></a> -<span class="sourceLineNo">116</span> * <jc>// Create a new bean session</jc><a name="line.116"></a> -<span class="sourceLineNo">117</span> * BeanSession session = BeanContext.<jsf>DEFAULT</jsf>.createSession();<a name="line.117"></a> -<span class="sourceLineNo">118</span> *<a name="line.118"></a> -<span class="sourceLineNo">119</span> * <jc>// Wrap an existing bean in a new bean map</jc><a name="line.119"></a> -<span class="sourceLineNo">120</span> * BeanMap&lt;Person&gt; m1 = session.toBeanMap(<jk>new</jk> Person());<a name="line.120"></a> -<span class="sourceLineNo">121</span> * m1.put(<js>"name"</js>, <js>"John Smith"</js>);<a name="line.121"></a> -<span class="sourceLineNo">122</span> * m1.put(<js>"age"</js>, 45);<a name="line.122"></a> -<span class="sourceLineNo">123</span> *<a name="line.123"></a> -<span class="sourceLineNo">124</span> * <jc>// Create a new bean instance wrapped in a new bean map</jc><a name="line.124"></a> -<span class="sourceLineNo">125</span> * BeanMap&lt;Person&gt; m2 = session.newBeanMap(Person.<jk>class</jk>);<a name="line.125"></a> -<span class="sourceLineNo">126</span> * m2.put(<js>"name"</js>, <js>"John Smith"</js>);<a name="line.126"></a> -<span class="sourceLineNo">127</span> * m2.put(<js>"age"</js>, 45);<a name="line.127"></a> -<span class="sourceLineNo">128</span> * Person p = m2.getBean(); <jc>// Get the bean instance that was created.</jc><a name="line.128"></a> -<span class="sourceLineNo">129</span> * </p><a name="line.129"></a> -<span class="sourceLineNo">130</span> *<a name="line.130"></a> -<span class="sourceLineNo">131</span> * <h5 class='topic'>Bean Annotations</h5><a name="line.131"></a> -<span class="sourceLineNo">132</span> * <p><a name="line.132"></a> -<span class="sourceLineNo">133</span> * This package contains annotations that can be applied to<a name="line.133"></a> -<span class="sourceLineNo">134</span> * class definitions to override what properties are detected on a bean.<a name="line.134"></a> -<span class="sourceLineNo">135</span> * <h5 class='section'>Example:</h5><a name="line.135"></a> -<span class="sourceLineNo">136</span> * <p class='bcode'><a name="line.136"></a> -<span class="sourceLineNo">137</span> * <jc>// Bean class definition where only property 'name' is detected.</jc><a name="line.137"></a> -<span class="sourceLineNo">138</span> * <ja>&#64;Bean</ja>(properties=<js>"name"</js>)<a name="line.138"></a> -<span class="sourceLineNo">139</span> * <jk>public class</jk> Person {<a name="line.139"></a> -<span class="sourceLineNo">140</span> * <jk>public</jk> String getName();<a name="line.140"></a> -<span class="sourceLineNo">141</span> * <jk>public void</jk> setName(String name);<a name="line.141"></a> -<span class="sourceLineNo">142</span> * <jk>public int</jk> getAge();<a name="line.142"></a> -<span class="sourceLineNo">143</span> * <jk>public void</jk> setAge(<jk>int</jk> age);<a name="line.143"></a> -<span class="sourceLineNo">144</span> * }<a name="line.144"></a> -<span class="sourceLineNo">145</span> * <p><a name="line.145"></a> -<span class="sourceLineNo">146</span> * See {@link Bean @Bean} and {@link BeanProperty @BeanProperty} for more information.<a name="line.146"></a> -<span class="sourceLineNo">147</span> *<a name="line.147"></a> -<span class="sourceLineNo">148</span> * <h5 class='topic'>Beans with read-only properties</h5><a name="line.148"></a> -<span class="sourceLineNo">149</span> * <p><a name="line.149"></a> -<span class="sourceLineNo">150</span> * Bean maps can also be defined on top of beans with read-only properties by adding a<a name="line.150"></a> -<span class="sourceLineNo">151</span> * {@link BeanConstructor @BeanConstructor} annotation to one of the constructors on the<a name="line.151"></a> -<span class="sourceLineNo">152</span> * bean class. This will allow read-only properties to be set through constructor arguments.<a name="line.152"></a> -<span class="sourceLineNo">153</span> * <p><a name="line.153"></a> -<span class="sourceLineNo">154</span> * When the <code>@BeanConstructor</code> annotation is present, bean instantiation is delayed until the call to {@link BeanMap#getBean()}.<a name="line.154"></a> -<span class="sourceLineNo">155</span> * Until then, bean property values are stored in a local cache until <code>getBean()</code> is called.<a name="line.155"></a> -<span class="sourceLineNo">156</span> * Because of this additional caching step, parsing into read-only beans tends to be slower and use<a name="line.156"></a> -<span class="sourceLineNo">157</span> * more memory than parsing into beans with writable properties.<a name="line.157"></a> -<span class="sourceLineNo">158</span> * <p><a name="line.158"></a> -<span class="sourceLineNo">159</span> * Attempting to call {@link BeanMap#put(String,Object)} on a read-only property after calling {@link BeanMap#getBean()}<a name="line.159"></a> -<span class="sourceLineNo">160</span> * will result in a {@link BeanRuntimeException} being thrown.<a name="line.160"></a> -<span class="sourceLineNo">161</span> * Multiple calls to {@link BeanMap#getBean()} will return the same bean instance.<a name="line.161"></a> -<span class="sourceLineNo">162</span> * <p><a name="line.162"></a> -<span class="sourceLineNo">163</span> * Beans can be defined with a combination of read-only and read-write properties.<a name="line.163"></a> -<span class="sourceLineNo">164</span> * <p><a name="line.164"></a> -<span class="sourceLineNo">165</span> * See {@link BeanConstructor @BeanConstructor} for more information.<a name="line.165"></a> -<span class="sourceLineNo">166</span> *<a name="line.166"></a> -<span class="sourceLineNo">167</span> * <h5 class='topic'>BeanFilters and PojoSwaps</h5><a name="line.167"></a> -<span class="sourceLineNo">168</span> * <p><a name="line.168"></a> -<span class="sourceLineNo">169</span> * {@link BeanFilter BeanFilters} and {@link PojoSwap PojoSwaps} are used to tailor how beans and POJOs are handled.<br><a name="line.169"></a> -<span class="sourceLineNo">170</span> * <ol class='spaced-list'><a name="line.170"></a> -<span class="sourceLineNo">171</span> * <li>{@link BeanFilter} - Allows you to tailor handling of bean classes.<a name="line.171"></a> -<span class="sourceLineNo">172</span> * This class can be considered a programmatic equivalent to the {@link Bean} annotation when<a name="line.172"></a> -<span class="sourceLineNo">173</span> * annotating classes are not possible (e.g. you don't have access to the source).<a name="line.173"></a> -<span class="sourceLineNo">174</span> * This includes specifying which properties are visible and the ability to programmatically override the execution of properties.<a name="line.174"></a> -<span class="sourceLineNo">175</span> * <li>{@link PojoSwap} - Allows you to swap out non-serializable objects with serializable replacements.<a name="line.175"></a> -<span class="sourceLineNo">176</span> * </ol><a name="line.176"></a> -<span class="sourceLineNo">177</span> * <p><a name="line.177"></a> -<span class="sourceLineNo">178</span> * See <a class='doclink' href='transform/package-summary.html#TOC'>org.apache.juneau.transform</a> for more information.<a name="line.178"></a> -<span class="sourceLineNo">179</span> *<a name="line.179"></a> -<span class="sourceLineNo">180</span> * <h5 class='topic'>ClassMetas</h5><a name="line.180"></a> -<span class="sourceLineNo">181</span> * <p><a name="line.181"></a> -<span class="sourceLineNo">182</span> * The {@link ClassMeta} class is a wrapper around {@link Class} object that provides cached information<a name="line.182"></a> -<span class="sourceLineNo">183</span> * about that class (e.g. whether it's a {@link Map} or {@link Collection} or bean).<a name="line.183"></a> -<span class="sourceLineNo">184</span> * <p><a name="line.184"></a> -<span class="sourceLineNo">185</span> * As a general rule, it's best to reuse bean contexts (and therefore serializers and parsers too)<a name="line.185"></a> -<span class="sourceLineNo">186</span> * whenever possible since it takes some time to populate the internal {@code ClassMeta} object cache.<a name="line.186"></a> -<span class="sourceLineNo">187</span> * By reusing bean contexts, the class type metadata only needs to be calculated once which significantly<a name="line.187"></a> -<span class="sourceLineNo">188</span> * improves performance.<a name="line.188"></a> -<span class="sourceLineNo">189</span> * <p><a name="line.189"></a> -<span class="sourceLineNo">190</span> * See {@link ClassMeta} for more information.<a name="line.190"></a> -<span class="sourceLineNo">191</span> */<a name="line.191"></a> -<span class="sourceLineNo">192</span>@SuppressWarnings({"unchecked","rawtypes","hiding"})<a name="line.192"></a> -<span class="sourceLineNo">193</span>public class BeanContext extends Context {<a name="line.193"></a> -<span class="sourceLineNo">194</span><a name="line.194"></a> -<span class="sourceLineNo">195</span> /**<a name="line.195"></a> -<span class="sourceLineNo">196</span> * <b>Configuration property:</b> Beans require no-arg constructors.<a name="line.196"></a> -<span class="sourceLineNo">197</span> * <p><a name="line.197"></a> -<span class="sourceLineNo">198</span> * <ul><a name="line.198"></a> -<span class="sourceLineNo">199</span> * <li><b>Name:</b> <js>"BeanContext.beansRequireDefaultConstructor"</js><a name="line.199"></a> -<span class="sourceLineNo">200</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.200"></a> -<span class="sourceLineNo">201</span> * <li><b>Default:</b> <jk>false</jk><a name="line.201"></a> -<span class="sourceLineNo">202</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.202"></a> -<span class="sourceLineNo">203</span> * </ul><a name="line.203"></a> -<span class="sourceLineNo">204</span> * <p><a name="line.204"></a> -<span class="sourceLineNo">205</span> * If <jk>true</jk>, a Java class must implement a default no-arg constructor to be considered a bean.<a name="line.205"></a> -<span class="sourceLineNo">206</span> * <p><a name="line.206"></a> -<span class="sourceLineNo">207</span> * The {@link Bean @Bean} annotation can be used on a class to override this setting when <jk>true</jk>.<a name="line.207"></a> -<span class="sourceLineNo">208</span> */<a name="line.208"></a> -<span class="sourceLineNo">209</span> public static final String BEAN_beansRequireDefaultConstructor = "BeanContext.beansRequireDefaultConstructor";<a name="line.209"></a> -<span class="sourceLineNo">210</span><a name="line.210"></a> -<span class="sourceLineNo">211</span> /**<a name="line.211"></a> -<span class="sourceLineNo">212</span> * <b>Configuration property:</b> Beans require {@link Serializable} interface.<a name="line.212"></a> -<span class="sourceLineNo">213</span> * <p><a name="line.213"></a> -<span class="sourceLineNo">214</span> * <ul><a name="line.214"></a> -<span class="sourceLineNo">215</span> * <li><b>Name:</b> <js>"BeanContext.beansRequireSerializable"</js><a name="line.215"></a> -<span class="sourceLineNo">216</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.216"></a> -<span class="sourceLineNo">217</span> * <li><b>Default:</b> <jk>false</jk><a name="line.217"></a> -<span class="sourceLineNo">218</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.218"></a> -<span class="sourceLineNo">219</span> * </ul><a name="line.219"></a> -<span class="sourceLineNo">220</span> * <p><a name="line.220"></a> -<span class="sourceLineNo">221</span> * If <jk>true</jk>, a Java class must implement the {@link Serializable} interface to be considered a bean.<a name="line.221"></a> -<span class="sourceLineNo">222</span> * <p><a name="line.222"></a> -<span class="sourceLineNo">223</span> * The {@link Bean @Bean} annotation can be used on a class to override this setting when <jk>true</jk>.<a name="line.223"></a> -<span class="sourceLineNo">224</span> */<a name="line.224"></a> -<span class="sourceLineNo">225</span> public static final String BEAN_beansRequireSerializable = "BeanContext.beansRequireSerializable";<a name="line.225"></a> -<span class="sourceLineNo">226</span><a name="line.226"></a> -<span class="sourceLineNo">227</span> /**<a name="line.227"></a> -<span class="sourceLineNo">228</span> * <b>Configuration property:</b> Beans require setters for getters.<a name="line.228"></a> -<span class="sourceLineNo">229</span> * <p><a name="line.229"></a> -<span class="sourceLineNo">230</span> * <ul><a name="line.230"></a> -<span class="sourceLineNo">231</span> * <li><b>Name:</b> <js>"BeanContext.beansRequireSettersForGetters"</js><a name="line.231"></a> -<span class="sourceLineNo">232</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.232"></a> -<span class="sourceLineNo">233</span> * <li><b>Default:</b> <jk>false</jk><a name="line.233"></a> -<span class="sourceLineNo">234</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.234"></a> -<span class="sourceLineNo">235</span> * </ul><a name="line.235"></a> -<span class="sourceLineNo">236</span> * <p><a name="line.236"></a> -<span class="sourceLineNo">237</span> * If <jk>true</jk>, only getters that have equivalent setters will be considered as properties on a bean.<a name="line.237"></a> -<span class="sourceLineNo">238</span> * Otherwise, they will be ignored.<a name="line.238"></a> -<span class="sourceLineNo">239</span> */<a name="line.239"></a> -<span class="sourceLineNo">240</span> public static final String BEAN_beansRequireSettersForGetters = "BeanContext.beansRequireSettersForGetters";<a name="line.240"></a> -<span class="sourceLineNo">241</span><a name="line.241"></a> -<span class="sourceLineNo">242</span> /**<a name="line.242"></a> -<span class="sourceLineNo">243</span> * <b>Configuration property:</b> Beans require at least one property.<a name="line.243"></a> -<span class="sourceLineNo">244</span> * <p><a name="line.244"></a> -<span class="sourceLineNo">245</span> * <ul><a name="line.245"></a> -<span class="sourceLineNo">246</span> * <li><b>Name:</b> <js>"BeanContext.beansRequireSomeProperties"</js><a name="line.246"></a> -<span class="sourceLineNo">247</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.247"></a> -<span class="sourceLineNo">248</span> * <li><b>Default:</b> <jk>true</jk><a name="line.248"></a> -<span class="sourceLineNo">249</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.249"></a> -<span class="sourceLineNo">250</span> * </ul><a name="line.250"></a> -<span class="sourceLineNo">251</span> * <p><a name="line.251"></a> -<span class="sourceLineNo">252</span> * If <jk>true</jk>, then a Java class must contain at least 1 property to be considered a bean.<a name="line.252"></a> -<span class="sourceLineNo">253</span> * <p><a name="line.253"></a> -<span class="sourceLineNo">254</span> * The {@link Bean @Bean} annotation can be used on a class to override this setting when <jk>true</jk>.<a name="line.254"></a> -<span class="sourceLineNo">255</span> */<a name="line.255"></a> -<span class="sourceLineNo">256</span> public static final String BEAN_beansRequireSomeProperties = "BeanContext.beansRequireSomeProperties";<a name="line.256"></a> -<span class="sourceLineNo">257</span><a name="line.257"></a> -<span class="sourceLineNo">258</span> /**<a name="line.258"></a> -<span class="sourceLineNo">259</span> * <b>Configuration property:</b> {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property value.<a name="line.259"></a> -<span class="sourceLineNo">260</span> * <p><a name="line.260"></a> -<span class="sourceLineNo">261</span> * <ul><a name="line.261"></a> -<span class="sourceLineNo">262</span> * <li><b>Name:</b> <js>"BeanContext.beanMapPutReturnsOldValue"</js><a name="line.262"></a> -<span class="sourceLineNo">263</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.263"></a> -<span class="sourceLineNo">264</span> * <li><b>Default:</b> <jk>false</jk><a name="line.264"></a> -<span class="sourceLineNo">265</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.265"></a> -<span class="sourceLineNo">266</span> * </ul><a name="line.266"></a> -<span class="sourceLineNo">267</span> * <p><a name="line.267"></a> -<span class="sourceLineNo">268</span> * If <jk>true</jk>, then the {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property values.<a name="line.268"></a> -<span class="sourceLineNo">269</span> * <p><a name="line.269"></a> -<span class="sourceLineNo">270</span> * Disabled by default because it introduces a slight performance penalty.<a name="line.270"></a> -<span class="sourceLineNo">271</span> */<a name="line.271"></a> -<span class="sourceLineNo">272</span> public static final String BEAN_beanMapPutReturnsOldValue = "BeanContext.beanMapPutReturnsOldValue";<a name="line.272"></a> -<span class="sourceLineNo">273</span><a name="line.273"></a> -<span class="sourceLineNo">274</span> /**<a name="line.274"></a> -<span class="sourceLineNo">275</span> * <b>Configuration property:</b> Look for bean constructors with the specified minimum visibility.<a name="line.275"></a> -<span class="sourceLineNo">276</span> * <p><a name="line.276"></a> -<span class="sourceLineNo">277</span> * <ul><a name="line.277"></a> -<span class="sourceLineNo">278</span> * <li><b>Name:</b> <js>"BeanContext.beanConstructorVisibility"</js><a name="line.278"></a> -<span class="sourceLineNo">279</span> * <li><b>Data type:</b> {@link Visibility}<a name="line.279"></a> -<span class="sourceLineNo">280</span> * <li><b>Default:</b> {@link Visibility#PUBLIC}<a name="line.280"></a> -<span class="sourceLineNo">281</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.281"></a> -<span class="sourceLineNo">282</span> * </ul><a name="line.282"></a> -<span class="sourceLineNo">283</span> * <p><a name="line.283"></a> -<span class="sourceLineNo">284</span> */<a name="line.284"></a> -<span class="sourceLineNo">285</span> public static final String BEAN_beanConstructorVisibility = "BeanContext.beanConstructorVisibility";<a name="line.285"></a> -<span class="sourceLineNo">286</span><a name="line.286"></a> -<span class="sourceLineNo">287</span> /**<a name="line.287"></a> -<span class="sourceLineNo">288</span> * <b>Configuration property:</b> Look for bean classes with the specified minimum visibility.<a name="line.288"></a> -<span class="sourceLineNo">289</span> * <p><a name="line.289"></a> -<span class="sourceLineNo">290</span> * <ul><a name="line.290"></a> -<span class="sourceLineNo">291</span> * <li><b>Name:</b> <js>"BeanContext.beanClassVisibility"</js><a name="line.291"></a> -<span class="sourceLineNo">292</span> * <li><b>Data type:</b> {@link Visibility}<a name="line.292"></a> -<span class="sourceLineNo">293</span> * <li><b>Default:</b> {@link Visibility#PUBLIC}<a name="line.293"></a> -<span class="sourceLineNo">294</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.294"></a> -<span class="sourceLineNo">295</span> * </ul><a name="line.295"></a> -<span class="sourceLineNo">296</span> * <p><a name="line.296"></a> -<span class="sourceLineNo">297</span> * Classes are not considered beans unless they meet the minimum visibility requirements.<a name="line.297"></a> -<span class="sourceLineNo">298</span> * For example, if the visibility is <code>PUBLIC</code> and the bean class is <jk>protected</jk>, then<a name="line.298"></a> -<span class="sourceLineNo">299</span> * the class will not be interpreted as a bean class.<a name="line.299"></a> -<span class="sourceLineNo">300</span> */<a name="line.300"></a> -<span class="sourceLineNo">301</span> public static final String BEAN_beanClassVisibility = "BeanContext.beanClassVisibility";<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> * <b>Configuration property:</b> Look for bean fields with the specified minimum visibility.<a name="line.304"></a> -<span class="sourceLineNo">305</span> * <p><a name="line.305"></a> -<span class="sourceLineNo">306</span> * <ul><a name="line.306"></a> -<span class="sourceLineNo">307</span> * <li><b>Name:</b> <js>"BeanContext.beanFieldVisibility"</js><a name="line.307"></a> -<span class="sourceLineNo">308</span> * <li><b>Data type:</b> {@link Visibility}<a name="line.308"></a> -<span class="sourceLineNo">309</span> * <li><b>Default:</b> {@link Visibility#PUBLIC}<a name="line.309"></a> -<span class="sourceLineNo">310</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.310"></a> -<span class="sourceLineNo">311</span> * </ul><a name="line.311"></a> -<span class="sourceLineNo">312</span> * <p><a name="line.312"></a> -<span class="sourceLineNo">313</span> * Fields are not considered bean properties unless they meet the minimum visibility requirements.<a name="line.313"></a> -<span class="sourceLineNo">314</span> * For example, if the visibility is <code>PUBLIC</code> and the bean field is <jk>protected</jk>, then<a name="line.314"></a> -<span class="sourceLineNo">315</span> * the field will not be interpreted as a bean property.<a name="line.315"></a> -<span class="sourceLineNo">316</span> * <p><a name="line.316"></a> -<span class="sourceLineNo">317</span> * Use {@link Visibility#NONE} to prevent bean fields from being interpreted as bean properties altogether.<a name="line.317"></a> -<span class="sourceLineNo">318</span> */<a name="line.318"></a> -<span class="sourceLineNo">319</span> public static final String BEAN_beanFieldVisibility = "BeanContext.beanFieldVisibility";<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> * <b>Configuration property:</b> Look for bean methods with the specified minimum visibility.<a name="line.322"></a> -<span class="sourceLineNo">323</span> * <p><a name="line.323"></a> -<span class="sourceLineNo">324</span> * <ul><a name="line.324"></a> -<span class="sourceLineNo">325</span> * <li><b>Name:</b> <js>"BeanContext.methodVisibility"</js><a name="line.325"></a> -<span class="sourceLineNo">326</span> * <li><b>Data type:</b> {@link Visibility}<a name="line.326"></a> -<span class="sourceLineNo">327</span> * <li><b>Default:</b> {@link Visibility#PUBLIC}<a name="line.327"></a> -<span class="sourceLineNo">328</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.328"></a> -<span class="sourceLineNo">329</span> * </ul><a name="line.329"></a> -<span class="sourceLineNo">330</span> * <p><a name="line.330"></a> -<span class="sourceLineNo">331</span> * Methods are not considered bean getters/setters unless they meet the minimum visibility requirements.<a name="line.331"></a> -<span class="sourceLineNo">332</span> * For example, if the visibility is <code>PUBLIC</code> and the bean method is <jk>protected</jk>, then<a name="line.332"></a> -<span class="sourceLineNo">333</span> * the method will not be interpreted as a bean getter or setter.<a name="line.333"></a> -<span class="sourceLineNo">334</span> */<a name="line.334"></a> -<span class="sourceLineNo">335</span> public static final String BEAN_methodVisibility = "BeanContext.methodVisibility";<a name="line.335"></a> -<span class="sourceLineNo">336</span><a name="line.336"></a> -<span class="sourceLineNo">337</span> /**<a name="line.337"></a> -<span class="sourceLineNo">338</span> * <b>Configuration property:</b> Use Java {@link Introspector} for determining bean properties.<a name="line.338"></a> -<span class="sourceLineNo">339</span> * <p><a name="line.339"></a> -<span class="sourceLineNo">340</span> * <ul><a name="line.340"></a> -<span class="sourceLineNo">341</span> * <li><b>Name:</b> <js>"BeanContext.useJavaBeanIntrospector"</js><a name="line.341"></a> -<span class="sourceLineNo">342</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.342"></a> -<span class="sourceLineNo">343</span> * <li><b>Default:</b> <jk>false</jk><a name="line.343"></a> -<span class="sourceLineNo">344</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.344"></a> -<span class="sourceLineNo">345</span> * </ul><a name="line.345"></a> -<span class="sourceLineNo">346</span> * <p><a name="line.346"></a> -<span class="sourceLineNo">347</span> * Using the built-in Java bean introspector will not pick up fields or non-standard getters/setters.<a name="line.347"></a> -<span class="sourceLineNo">348</span> * Most {@link Bean @Bean} annotations will be ignored.<a name="line.348"></a> -<span class="sourceLineNo">349</span> */<a name="line.349"></a> -<span class="sourceLineNo">350</span> public static final String BEAN_useJavaBeanIntrospector = "BeanContext.useJavaBeanIntrospector";<a name="line.350"></a> -<span class="sourceLineNo">351</span><a name="line.351"></a> -<span class="sourceLineNo">352</span> /**<a name="line.352"></a> -<span class="sourceLineNo">353</span> * <b>Configuration property:</b> Use interface proxies.<a name="line.353"></a> -<span class="sourceLineNo">354</span> * <p><a name="line.354"></a> -<span class="sourceLineNo">355</span> * <ul><a name="line.355"></a> -<span class="sourceLineNo">356</span> * <li><b>Name:</b> <js>"BeanContext.useInterfaceProxies"</js><a name="line.356"></a> -<span class="sourceLineNo">357</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.357"></a> -<span class="sourceLineNo">358</span> * <li><b>Default:</b> <jk>true</jk><a name="line.358"></a> -<span class="sourceLineNo">359</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.359"></a> -<span class="sourceLineNo">360</span> * </ul><a name="line.360"></a> -<span class="sourceLineNo">361</span> * <p><a name="line.361"></a> -<span class="sourceLineNo">362</span> * If <jk>true</jk>, then interfaces will be instantiated as proxy classes through the use of an {@link InvocationHandler}<a name="line.362"></a> -<span class="sourceLineNo">363</span> * if there is no other way of instantiating them.<a name="line.363"></a> -<span class="sourceLineNo">364</span> */<a name="line.364"></a> -<span class="sourceLineNo">365</span> public static final String BEAN_useInterfaceProxies = "BeanContext.useInterfaceProxies";<a name="line.365"></a> -<span class="sourceLineNo">366</span><a name="line.366"></a> -<span class="sourceLineNo">367</span> /**<a name="line.367"></a> -<span class="sourceLineNo">368</span> * <b>Configuration property:</b> Ignore unknown properties.<a name="line.368"></a> -<span class="sourceLineNo">369</span> * <p><a name="line.369"></a> -<span class="sourceLineNo">370</span> * <ul><a name="line.370"></a> -<span class="sourceLineNo">371</span> * <li><b>Name:</b> <js>"BeanContext.ignoreUnknownBeanProperties"</js><a name="line.371"></a> -<span class="sourceLineNo">372</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.372"></a> -<span class="sourceLineNo">373</span> * <li><b>Default:</b> <jk>false</jk><a name="line.373"></a> -<span class="sourceLineNo">374</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.374"></a> -<span class="sourceLineNo">375</span> * </ul><a name="line.375"></a> -<span class="sourceLineNo">376</span> * <p><a name="line.376"></a> -<span class="sourceLineNo">377</span> * If <jk>true</jk>, trying to set a value on a non-existent bean property will silently be ignored.<a name="line.377"></a> -<span class="sourceLineNo">378</span> * Otherwise, a {@code RuntimeException} is thrown.<a name="line.378"></a> -<span class="sourceLineNo">379</span> */<a name="line.379"></a> -<span class="sourceLineNo">380</span> public static final String BEAN_ignoreUnknownBeanProperties = "BeanContext.ignoreUnknownBeanProperties";<a name="line.380"></a> -<span class="sourceLineNo">381</span><a name="line.381"></a> -<span class="sourceLineNo">382</span> /**<a name="line.382"></a> -<span class="sourceLineNo">383</span> * <b>Configuration property:</b> Ignore unknown properties with null values.<a name="line.383"></a> -<span class="sourceLineNo">384</span> * <p><a name="line.384"></a> -<span class="sourceLineNo">385</span> * <ul><a name="line.385"></a> -<span class="sourceLineNo">386</span> * <li><b>Name:</b> <js>"BeanContext.ignoreUnknownNullBeanProperties"</js><a name="line.386"></a> -<span class="sourceLineNo">387</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.387"></a> -<span class="sourceLineNo">388</span> * <li><b>Default:</b> <jk>true</jk><a name="line.388"></a> -<span class="sourceLineNo">389</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.389"></a> -<span class="sourceLineNo">390</span> * </ul><a name="line.390"></a> -<span class="sourceLineNo">391</span> * <p><a name="line.391"></a> -<span class="sourceLineNo">392</span> * If <jk>true</jk>, trying to set a <jk>null</jk> value on a non-existent bean property will silently be ignored.<a name="line.392"></a> -<span class="sourceLineNo">393</span> * Otherwise, a {@code RuntimeException} is thrown.<a name="line.393"></a> -<span class="sourceLineNo">394</span> */<a name="line.394"></a> -<span class="sourceLineNo">395</span> public static final String BEAN_ignoreUnknownNullBeanProperties = "BeanContext.ignoreUnknownNullBeanProperties";<a name="line.395"></a> -<span class="sourceLineNo">396</span><a name="line.396"></a> -<span class="sourceLineNo">397</span> /**<a name="line.397"></a> -<span class="sourceLineNo">398</span> * <b>Configuration property:</b> Ignore properties without setters.<a name="line.398"></a> -<span class="sourceLineNo">399</span> * <p><a name="line.399"></a> -<span class="sourceLineNo">400</span> * <ul><a name="line.400"></a> -<span class="sourceLineNo">401</span> * <li><b>Name:</b> <js>"BeanContext.ignorePropertiesWithoutSetters"</js><a name="line.401"></a> -<span class="sourceLineNo">402</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.402"></a> -<span class="sourceLineNo">403</span> * <li><b>Default:</b> <jk>true</jk><a name="line.403"></a> -<span class="sourceLineNo">404</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.404"></a> -<span class="sourceLineNo">405</span> * </ul><a name="line.405"></a> -<span class="sourceLineNo">406</span> * <p><a name="line.406"></a> -<span class="sourceLineNo">407</span> * If <jk>true</jk>, trying to set a value on a bean property without a setter will silently be ignored.<a name="line.407"></a> -<span class="sourceLineNo">408</span> * Otherwise, a {@code RuntimeException} is thrown.<a name="line.408"></a> -<span class="sourceLineNo">409</span> */<a name="line.409"></a> -<span class="sourceLineNo">410</span> public static final String BEAN_ignorePropertiesWithoutSetters = "BeanContext.ignorePropertiesWithoutSetters";<a name="line.410"></a> -<span class="sourceLineNo">411</span><a name="line.411"></a> -<span class="sourceLineNo">412</span> /**<a name="line.412"></a> -<span class="sourceLineNo">413</span> * <b>Configuration property:</b> Ignore invocation errors on getters.<a name="line.413"></a> -<span class="sourceLineNo">414</span> * <p><a name="line.414"></a> -<span class="sourceLineNo">415</span> * <ul><a name="line.415"></a> -<span class="sourceLineNo">416</span> * <li><b>Name:</b> <js>"BeanContext.ignoreInvocationExceptionsOnGetters"</js><a name="line.416"></a> -<span class="sourceLineNo">417</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.417"></a> -<span class="sourceLineNo">418</span> * <li><b>Default:</b> <jk>false</jk><a name="line.418"></a> -<span class="sourceLineNo">419</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.419"></a> -<span class="sourceLineNo">420</span> * </ul><a name="line.420"></a> -<span class="sourceLineNo">421</span> * <p><a name="line.421"></a> -<span class="sourceLineNo">422</span> * If <jk>true</jk>, errors thrown when calling bean getter methods will silently be ignored.<a name="line.422"></a> -<span class="sourceLineNo">423</span> * Otherwise, a {@code BeanRuntimeException} is thrown.<a name="line.423"></a> -<span class="sourceLineNo">424</span> */<a name="line.424"></a> -<span class="sourceLineNo">425</span> public static final String BEAN_ignoreInvocationExceptionsOnGetters = "BeanContext.ignoreInvocationExceptionsOnGetters";<a name="line.425"></a> -<span class="sourceLineNo">426</span><a name="line.426"></a> -<span class="sourceLineNo">427</span> /**<a name="line.427"></a> -<span class="sourceLineNo">428</span> * <b>Configuration property:</b> Ignore invocation errors on setters.<a name="line.428"></a> -<span class="sourceLineNo">429</span> * <p><a name="line.429"></a> -<span class="sourceLineNo">430</span> * <ul><a name="line.430"></a> -<span class="sourceLineNo">431</span> * <li><b>Name:</b> <js>"BeanContext.ignoreInvocationExceptionsOnSetters"</js><a name="line.431"></a> -<span class="sourceLineNo">432</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.432"></a> -<span class="sourceLineNo">433</span> * <li><b>Default:</b> <jk>false</jk><a name="line.433"></a> -<span class="sourceLineNo">434</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.434"></a> -<span class="sourceLineNo">435</span> * </ul><a name="line.435"></a> -<span class="sourceLineNo">436</span> * <p><a name="line.436"></a> -<span class="sourceLineNo">437</span> * If <jk>true</jk>, errors thrown when calling bean setter methods will silently be ignored.<a name="line.437"></a> -<span class="sourceLineNo">438</span> * Otherwise, a {@code BeanRuntimeException} is thrown.<a name="line.438"></a> -<span class="sourceLineNo">439</span> */<a name="line.439"></a> -<span class="sourceLineNo">440</span> public static final String BEAN_ignoreInvocationExceptionsOnSetters = "BeanContext.ignoreInvocationExceptionsOnSetters";<a name="line.440"></a> -<span class="sourceLineNo">441</span><a name="line.441"></a> -<span class="sourceLineNo">442</span> /**<a name="line.442"></a> -<span class="sourceLineNo">443</span> * <b>Configuration property:</b> Sort bean properties in alphabetical order.<a name="line.443"></a> -<span class="sourceLineNo">444</span> * <p><a name="line.444"></a> -<span class="sourceLineNo">445</span> * <ul><a name="line.445"></a> -<span class="sourceLineNo">446</span> * <li><b>Name:</b> <js>"BeanContext.sortProperties"</js><a name="line.446"></a> -<span class="sourceLineNo">447</span> * <li><b>Data type:</b> <code>Boolean</code><a name="line.447"></a> -<span class="sourceLineNo">448</span> * <li><b>Default:</b> <jk>false</jk><a name="line.448"></a> -<span class="sourceLineNo">449</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.449"></a> -<span class="sourceLineNo">450</span> * </ul><a name="line.450"></a> -<span class="sourceLineNo">451</span> * <p><a name="line.451"></a> -<span class="sourceLineNo">452</span> * When <jk>true</jk>, all bean properties will be serialized and access in alphabetical order.<a name="line.452"></a> -<span class="sourceLineNo">453</span> * Otherwise, the natural order of the bean properties is used which is dependent on the<a name="line.453"></a> -<span class="sourceLineNo">454</span> * JVM vendor.<a name="line.454"></a> -<span class="sourceLineNo">455</span> * On IBM JVMs, the bean properties are ordered based on their ordering in the Java file.<a name="line.455"></a> -<span class="sourceLineNo">456</span> * On Oracle JVMs, the bean properties are not ordered (which follows the offical JVM specs).<a name="line.456"></a> -<span class="sourceLineNo">457</span> * <p><a name="line.457"></a> -<span class="sourceLineNo">458</span> * This property is disabled by default so that IBM JVM users don't have to use {@link Bean @Bean} annotations<a name="line.458"></a> -<span class="sourceLineNo">459</span> * to force bean properties to be in a particular order and can just alter the order of the fields/methods<a name="line.459"></a> -<span class="sourceLineNo">460</span> * in the Java file.<a name="line.460"></a> -<span class="sourceLineNo">461</span> */<a name="line.461"></a> -<span class="sourceLineNo">462</span> public static final String BEAN_sortProperties = "BeanContext.sortProperties";<a name="line.462"></a> -<span class="sourceLineNo">463</span><a name="line.463"></a> -<span class="sourceLineNo">464</span> /**<a name="line.464"></a> -<span class="sourceLineNo">465</span> * <b>Configuration property:</b> Packages whose classes should not be considered beans.<a name="line.465"></a> -<span class="sourceLineNo">466</span> * <p><a name="line.466"></a> -<span class="sourceLineNo">467</span> * <ul><a name="line.467"></a> -<span class="sourceLineNo">468</span> * <li><b>Name:</b> <js>"BeanContext.notBeanPackages.set"</js><a name="line.468"></a> -<span class="sourceLineNo">469</span> * <li><b>Data type:</b> <code>Set&lt;String&gt;</code><a name="line.469"></a> -<span class="sourceLineNo">470</span> * <li><b>Default:</b><a name="line.470"></a> -<span class="sourceLineNo">471</span> * <ul><a name="line.471"></a> -<span class="sourceLineNo">472</span> * <li><code>java.lang</code><a name="line.472"></a> -<span class="sourceLineNo">473</span> * <li><code>java.lang.annotation</code><a name="line.473"></a> -<span class="sourceLineNo">474</span> * <li><code>java.lang.ref</code><a name="line.474"></a> -<span class="sourceLineNo">475</span> * <li><code>java.lang.reflect</code><a name="line.475"></a> -<span class="sourceLineNo">476</span> * <li><code>java.io</code><a name="line.476"></a> -<span class="sourceLineNo">477</span> * <li><code>java.net</code><a name="line.477"></a> -<span class="sourceLineNo">478</span> * <li><code>java.nio.*</code><a name="line.478"></a> -<span class="sourceLineNo">479</span> * <li><code>java.util.*</code><a name="line.479"></a> -<span class="sourceLineNo">480</span> * </ul><a name="line.480"></a> -<span class="sourceLineNo">481</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.481"></a> -<span class="sourceLineNo">482</span> * </ul><a name="line.482"></a> -<span class="sourceLineNo">483</span> * <p><a name="line.483"></a> -<span class="sourceLineNo">484</span> * When specified, the current list of ignore packages are appended to.<a name="line.484"></a> -<span class="sourceLineNo">485</span> * <p><a name="line.485"></a> -<span class="sourceLineNo">486</span> * Any classes within these packages will be serialized to strings using {@link Object#toString()}.<a name="line.486"></a> -<span class="sourceLineNo">487</span> * <p><a name="line.487"></a> -<span class="sourceLineNo">488</span> * Note that you can specify prefix patterns to include all subpackages.<a name="line.488"></a> -<span class="sourceLineNo">489</span> */<a name="line.489"></a> -<span class="sourceLineNo">490</span> public static final String BEAN_notBeanPackages = "BeanContext.notBeanPackages.set";<a name="line.490"></a> -<span class="sourceLineNo">491</span><a name="line.491"></a> -<span class="sourceLineNo">492</span> /**<a name="line.492"></a> -<span class="sourceLineNo">493</span> * <b>Configuration property:</b> Add to packages whose classes should not be considered beans.<a name="line.493"></a> -<span class="sourceLineNo">494</span> */<a name="line.494"></a> -<span class="sourceLineNo">495</span> public static final String BEAN_notBeanPackages_add = "BeanContext.notBeanPackages.set.add";<a name="line.495"></a> -<span class="sourceLineNo">496</span><a name="line.496"></a> -<span class="sourceLineNo">497</span> /**<a name="line.497"></a> -<span class="sourceLineNo">498</span> * <b>Configuration property:</b> Remove from packages whose classes should not be considered beans.<a name="line.498"></a> -<span class="sourceLineNo">499</span> */<a name="line.499"></a> -<span class="sourceLineNo">500</span> public static final String BEAN_notBeanPackages_remove = "BeanContext.notBeanPackages.set.remove";<a name="line.500"></a> -<span class="sourceLineNo">501</span><a name="line.501"></a> -<span class="sourceLineNo">502</span> /**<a name="line.502"></a> -<span class="sourceLineNo">503</span> * <b>Configuration property:</b> Classes to be excluded from consideration as being beans.<a name="line.503"></a> -<span class="sourceLineNo">504</span> * <p><a name="line.504"></a> -<span class="sourceLineNo">505</span> * <ul><a name="line.505"></a> -<span class="sourceLineNo">506</span> * <li><b>Name:</b> <js>"BeanContext.notBeanClasses.set"</js><a name="line.506"></a> -<span class="sourceLineNo">507</span> * <li><b>Data type:</b> <code>Set&lt;Class&gt;</code><a name="line.507"></a> -<span class="sourceLineNo">508</span> * <li><b>Default:</b> empty set<a name="line.508"></a> -<span class="sourceLineNo">509</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.509"></a> -<span class="sourceLineNo">510</span> * </ul><a name="line.510"></a> -<span class="sourceLineNo">511</span> * <p><a name="line.511"></a> -<span class="sourceLineNo">512</span> * Not-bean classes are typically converted to <code>Strings</code> during serialization even if they<a name="line.512"></a> -<span class="sourceLineNo">513</span> * appear to be bean-like.<a name="line.513"></a> -<span class="sourceLineNo">514</span> */<a name="line.514"></a> -<span class="sourceLineNo">515</span> public static final String BEAN_notBeanClasses = "BeanContext.notBeanClasses.set";<a name="line.515"></a> -<span class="sourceLineNo">516</span><a name="line.516"></a> -<span class="sourceLineNo">517</span> /**<a name="line.517"></a> -<span class="sourceLineNo">518</span> * <b>Configuration property:</b> Add to classes that should not be considered beans.<a name="line.518"></a> -<span class="sourceLineNo">519</span> */<a name="line.519"></a> -<span class="sourceLineNo">520</span> public static final String BEAN_notBeanClasses_add = "BeanContext.notBeanClasses.set.add";<a name="line.520"></a> -<span class="sourceLineNo">521</span><a name="line.521"></a> -<span class="sourceLineNo">522</span> /**<a name="line.522"></a> -<span class="sourceLineNo">523</span> * <b>Configuration property:</b> Remove from classes that should not be considered beans.<a name="line.523"></a> -<span class="sourceLineNo">524</span> */<a name="line.524"></a> -<span class="sourceLineNo">525</span> public static final String BEAN_notBeanClasses_remove = "BeanContext.notBeanClasses.set.remove";<a name="line.525"></a> -<span class="sourceLineNo">526</span><a name="line.526"></a> -<span class="sourceLineNo">527</span> /**<a name="line.527"></a> -<span class="sourceLineNo">528</span> * <b>Configuration property:</b> Bean filters to apply to beans.<a name="line.528"></a> -<span class="sourceLineNo">529</span> * <p><a name="line.529"></a> -<span class="sourceLineNo">530</span> * <ul><a name="line.530"></a> -<span class="sourceLineNo">531</span> * <li><b>Name:</b> <js>"BeanContext.beanFilters.list"</js><a name="line.531"></a> -<span class="sourceLineNo">532</span> * <li><b>Data type:</b> <code>List&lt;Class&gt;</code><a name="line.532"></a> -<span class="sourceLineNo">533</span> * <li><b>Default:</b> empty list<a name="line.533"></a> -<span class="sourceLineNo">534</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.534"></a> -<span class="sourceLineNo">535</span> * </ul><a name="line.535"></a> -<span class="sourceLineNo">536</span> * <p><a name="line.536"></a> -<span class="sourceLineNo">537</span> * This is a programmatic equivalent to the {@link Bean @Bean} annotation.<a name="line.537"></a> -<span class="sourceLineNo">538</span> * It's useful when you want to use the Bean annotation functionality, but you don't have the ability<a name="line.538"></a> -<span class="sourceLineNo">539</span> * to alter the bean classes.<a name="line.539"></a> -<span class="sourceLineNo">540</span> * <p><a name="line.540"></a> -<span class="sourceLineNo">541</span> * There are two category of classes that can be passed in through this method:<a name="line.541"></a> -<span class="sourceLineNo">542</span> * <ul class='spaced-list'><a name="line.542"></a> -<span class="sourceLineNo">543</span> * <li>Subclasses of {@link BeanFilterBuilder}.<a name="line.543"></a> -<span class="sourceLineNo">544</span> * These must have a public no-arg constructor.<a name="line.544"></a> -<span class="sourceLineNo">545</span> * <li>Bean interface classes.<a name="line.545"></a> -<span class="sourceLineNo">546</span> * A shortcut for defining a {@link InterfaceBeanFilterBuilder}.<a name="line.546"></a> -<span class="sourceLineNo">547</span> * Any subclasses of an interface class will only have properties defined on the interface.<a name="line.547"></a> -<span class="sourceLineNo">548</span> * All other bean properties will be ignored.<a name="line.548"></a> -<span class="sourceLineNo">549</span> * </ul><a name="line.549"></a> -<span class="sourceLineNo">550</span> */<a name="line.550"></a> -<span class="sourceLineNo">551</span> public static final String BEAN_beanFilters = "BeanContext.beanFilters.list";<a name="line.551"></a> -<span class="sourceLineNo">552</span><a name="line.552"></a> -<span class="sourceLineNo">553</span> /**<a name="line.553"></a> -<span class="sourceLineNo">554</span> * <b>Configuration property:</b> Add to bean filters.<a name="line.554"></a> -<span class="sourceLineNo">555</span> */<a name="line.555"></a> -<span class="sourceLineNo">556</span> public static final String BEAN_beanFilters_add = "BeanContext.beanFilters.list.add";<a name="line.556"></a> -<span class="sourceLineNo">557</span><a name="line.557"></a> -<span class="sourceLineNo">558</span> /**<a name="line.558"></a> -<span class="sourceLineNo">559</span> * <b>Configuration property:</b> Remove from bean filters.<a name="line.559"></a> -<span class="sourceLineNo">560</span> */<a name="line.560"></a> -<span class="sourceLineNo">561</span> public static final String BEAN_beanFilters_remove = "BeanContext.beanFilters.list.remove";<a name="line.561"></a> -<span class="sourceLineNo">562</span><a name="line.562"></a> -<span class="sourceLineNo">563</span> /**<a name="line.563"></a> -<span class="sourceLineNo">564</span> * <b>Configuration property:</b> POJO swaps to apply to Java objects.<a name="line.564"></a> -<span class="sourceLineNo">565</span> * <p><a name="line.565"></a> -<span class="sourceLineNo">566</span> * <ul><a name="line.566"></a> -<span class="sourceLineNo">567</span> * <li><b>Name:</b> <js>"BeanContext.pojoSwaps.list"</js><a name="line.567"></a> -<span class="sourceLineNo">568</span> * <li><b>Data type:</b> <code>List&lt;Class&gt;</code><a name="line.568"></a> -<span class="sourceLineNo">569</span> * <li><b>Default:</b> empty list<a name="line.569"></a> -<span class="sourceLineNo">570</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.570"></a> -<span class="sourceLineNo">571</span> * </ul><a name="line.571"></a> -<span class="sourceLineNo">572</span> * <p><a name="line.572"></a> -<span class="sourceLineNo">573</span> * There are two category of classes that can be passed in through this method:<a name="line.573"></a> -<span class="sourceLineNo">574</span> * <ul><a name="line.574"></a> -<span class="sourceLineNo">575</span> * <li>Subclasses of {@link PojoSwap}.<a name="line.575"></a> -<span class="sourceLineNo">576</span> * <li>Surrogate classes. A shortcut for defining a {@link SurrogateSwap}.<a name="line.576"></a> -<span class="sourceLineNo">577</span> * </ul><a name="line.577"></a> -<span class="sourceLineNo">578</span> */<a name="line.578"></a> -<span class="sourceLineNo">579</span> public static final String BEAN_pojoSwaps = "BeanContext.pojoSwaps.list";<a name="line.579"></a> -<span class="sourceLineNo">580</span><a name="line.580"></a> -<span class="sourceLineNo">581</span> /**<a name="line.581"></a> -<span class="sourceLineNo">582</span> * <b>Configuration property:</b> Add to POJO swap classes.<a name="line.582"></a> -<span class="sourceLineNo">583</span> */<a name="line.583"></a> -<span class="sourceLineNo">584</span> public static final String BEAN_pojoSwaps_add = "BeanContext.pojoSwaps.list.add";<a name="line.584"></a> -<span class="sourceLineNo">585</span><a name="line.585"></a> -<span class="sourceLineNo">586</span> /**<a name="line.586"></a> -<span class="sourceLineNo">587</span> * <b>Configuration property:</b> Remove from POJO swap classes.<a name="line.587"></a> -<span class="sourceLineNo">588</span> */<a name="line.588"></a> -<span class="sourceLineNo">589</span> public static final String BEAN_pojoSwaps_remove = "BeanContext.pojoSwaps.list.remove";<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> * <b>Configuration property:</b> Implementation classes for interfaces and abstract classes.<a name="line.592"></a> -<span class="sourceLineNo">593</span> * <p><a name="line.593"></a> -<span class="sourceLineNo">594</span> * <ul><a name="line.594"></a> -<span class="sourceLineNo">595</span> * <li><b>Name:</b> <js>"BeanContext.implClasses.map"</js><a name="line.595"></a> -<span class="sourceLineNo">596</span> * <li><b>Data type:</b> <code>Map&lt;Class,Class&gt;</code><a name="line.596"></a> -<span class="sourceLineNo">597</span> * <li><b>Default:</b> empty map<a name="line.597"></a> -<span class="sourceLineNo">598</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.598"></a> -<span class="sourceLineNo">599</span> * </ul><a name="line.599"></a> -<span class="sourceLineNo">600</span> * <p><a name="line.600"></a> -<span class="sourceLineNo">601</span> * For interfaces and abstract classes this method can be used to specify an implementation<a name="line.601"></a> -<span class="sourceLineNo">602</span> * class for the interface/abstract class so that instances of the implementation<a name="line.602"></a> -<span class="sourceLineNo">603</span> * class are used when instantiated (e.g. during a parse).<a name="line.603"></a> -<span class="sourceLineNo">604</span> */<a name="line.604"></a> -<span class="sourceLineNo">605</span> public static final String BEAN_implClasses = "BeanContext.implClasses.map";<a name="line.605"></a> -<span class="sourceLineNo">606</span><a name="line.606"></a> -<span class="sourceLineNo">607</span> /**<a name="line.607"></a> -<span class="sourceLineNo">608</span> * <b>Configuration property:</b> Add an implementation class.<a name="line.608"></a> -<span class="sourceLineNo">609</span> */<a name="line.609"></a> -<span class="sourceLineNo">610</span> public static final String BEAN_implClasses_put = "BeanContext.implClasses.map.put";<a name="line.610"></a> -<span class="sourceLineNo">611</span><a name="line.611"></a> -<span class="sourceLineNo">612</span> /**<a name="line.612"></a> -<span class="sourceLineNo">613</span> * <b>Configuration property:</b> Bean lookup dictionary.<a name="line.613"></a> -<span class="sourceLineNo">614</span> * <p><a name="line.614"></a> -<span class="sourceLineNo">615</span> * <ul><a name="line.615"></a> -<span class="sourceLineNo">616</span> * <li><b>Name:</b> <js>"BeanContext.beanDictionary.list"</js><a name="line.616"></a> -<span class="sourceLineNo">617</span> * <li><b>Data type:</b> <code>List&lt;Class&gt;</code><a name="line.617"></a> -<span class="sourceLineNo">618</span> * <li><b>Default:</b> empty list<a name="line.618"></a> -<span class="sourceLineNo">619</span> * <li><b>Session-overridable:</b> <jk>false</jk><a name="line.619"></a> -<span class="sourceLineNo">620</span> * </ul><a name="line.620"></a> -<span class="sourceLineNo">621</span> * <p><a name="line.621"></a> -<span class="sourceLineNo">622</span> * This list can consist of the following class types:<a name="line.622"></a> -<span class="sourceLineNo">623</span> * <ul><a name="line.623"></a> -<span class="sourceLineNo">624</span> * <li>Any bean class that specifies a value for {@link Bean#typeName() @Bean.typeName()}.<a name="line.624"></a> -<span class="sourceLineNo">625</span> * <li>Any subclass of {@link BeanDictionaryList} containing a collection of bean classes with type name annotations.<a name="line.625"></a> -<span class="sourceLineNo">626</span> * <li>Any subclass of {@link BeanDictionaryMap} containing a mapping of type names to classes without type name annotations.<a name="line.626"></a> -<span class="sourceLineNo">627</span> * </ul><a name="line.627"></a> -<span class="sourceLineNo">628</span> */<a name="line.628"></a> -<span class="sourceLineNo">629</span> public static final String BEAN_beanDictionary = "BeanContext.beanDictionary.list";<a name="line.629"></a> -<span class="sourceLineNo">630</span><a name="line.630"></a> -<span class="sourceLineNo">631</span> /**<a name="line.631"></a> -<span class="sourceLineNo">632</span> * <b>Configuration property:</b> Add to bean dictionary.<a name="line.632"></a> +<span class="sourceLineNo">027</span>import org.apache.juneau.internal.*;<a name="line.27"></a> +<span class="sourceLineNo">028</span>import org.apache.juneau.json.*;<a name="line.28"></a> +<span class="sourceLineNo">029</span>import org.apache.juneau.parser.*;<a name="line.29"></a> +<span class="sourceLineNo">030</span>import org.apache.juneau.serializer.*;<a name="line.30"></a> +<span class="sourceLineNo">031</span>import org.apache.juneau.transform.*;<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> * Core class of the Juneau architecture.<a name="line.34"></a> +<span class="sourceLineNo">035</span> * <p><a name="line.35"></a> +<span class="sourceLineNo">036</span> * This class servers multiple purposes:<a name="line.36"></a> +<span class="sourceLineNo">037</span> * <ul class='spaced-list'><a name="line.37"></a> +<span class="sourceLineNo">038</span> * <li>Provides the ability to wrap beans inside {@link Map} interfaces.<a name="line.38"></a> +<span class="sourceLineNo">039</span> * <li>Serves as a repository for metadata on POJOs, such as associated {@link BeanFilter beanFilters}, {@link PropertyNamer property namers}, etc...<a name="line.39"></a> +<span class="sourceLineNo">040</span> * which are used to tailor how POJOs are serialized and parsed.<a name="line.40"></a> +<span class="sourceLineNo">041</span> * <li>Serves as a common utility class for all {@link Serializer Serializers} and {@link Parser Parsers}<a name="line.41"></a> +<span class="sourceLineNo">042</span> * for serializing and parsing Java beans.<a name="line.42"></a> +<span class="sourceLineNo">043</span> * </ul><a name="line.43"></a> +<span class="sourceLineNo">044</span> * <p><a name="line.44"></a> +<span class="sourceLineNo">045</span> * All serializer and parser contexts extend from this context.<a name="line.45"></a> +<span class="sourceLineNo">046</span> *<a name="line.46"></a> +<span class="sourceLineNo">047</span> * <h5 class='topic'>Bean Contexts</h5><a name="line.47"></a> +<span class="sourceLineNo">048</span> * Bean contexts are created through the {@link PropertyStore#getContext(Class)} method.<a name="line.48"></a> +<span class="sourceLineNo">049</span> * These context objects are read-only, reusable, and thread-safe.<a name="line.49"></a> +<span class="sourceLineNo">050</span> * The {@link PropertyStore} class will typically cache copies of <code>Context</code> objects based on<a name="line.50"></a> +<span class="sourceLineNo">051</span> * the current settings on the factory.<a name="line.51"></a> +<span class="sourceLineNo">052</span> * <p><a name="line.52"></a> +<span class="sourceLineNo">053</span> * Each bean context maintains a cache of {@link ClassMeta} objects that describe information about classes encountered.<a name="line.53"></a> +<span class="sourceLineNo">054</span> * These <code>ClassMeta</code> objects are time-consuming to construct.<a name="line.54"></a> +<span class="sourceLineNo">055</span> * Therefore, instances of {@link BeanContext} that share the same <js>"BeanContext.*"</js> property values share<a name="line.55"></a> +<span class="sourceLineNo">056</span> * the same cache. This allows for efficient reuse of <code>ClassMeta</code> objects so that the information about<a name="line.56"></a> +<span class="sourceLineNo">057</span> * classes only needs to be calculated once.<a name="line.57"></a> +<span class="sourceLineNo">058</span> * Because of this, many of the properties defined on the {@link BeanContext} class cannot be overridden on the session.<a name="line.58"></a> +<span class="sourceLineNo">059</span> *<a name="line.59"></a> +<span class="sourceLineNo">060</span> * <h5 class='topic'>Bean Sessions</h5><a name="line.60"></a> +<span class="sourceLineNo">061</span> * <p><a name="line.61"></a> +<span class="sourceLineNo">062</span> * Whereas <code>BeanContext</code> objects are permanent, unchangeable, cached, and thread-safe,<a name="line.62"></a> +<span class="sourceLineNo">063</span> * {@link BeanSession} objects are ephemeral and not thread-safe.<a name="line.63"></a> +<span class="sourceLineNo">064</span> * They are meant to be used as quickly-constructed scratchpads for creating bean maps.<a name="line.64"></a> +<span class="sourceLineNo">065</span> * {@link BeanMap} objects can only be created through the session.<a name="line.65"></a> +<span class="sourceLineNo">066</span> *<a name="line.66"></a> +<span class="sourceLineNo">067</span> * <h5 class='topic'>BeanContext configuration properties</h5><a name="line.67"></a> +<span class="sourceLineNo">068</span> * <code>BeanContexts</code> have several configuration properties that can be used to tweak behavior on how beans are handled.<a name="line.68"></a> +<span class="sourceLineNo">069</span> * These are denoted as the static <jsf>BEAN_*</jsf> fields on this class.<a name="line.69"></a> +<span class="sourceLineNo">070</span> * <p><a name="line.70"></a> +<span class="sourceLineNo">071</span> * Some settings (e.g. {@link BeanContext#BEAN_beansRequireDefaultConstructor}) are used to differentiate between bean and non-bean classes.<a name="line.71"></a> +<span class="sourceLineNo">072</span> * Attempting to create a bean map around one of these objects will throw a {@link BeanRuntimeException}.<a name="line.72"></a> +<span class="sourceLineNo">073</span> * The purpose for this behavior is so that the serializers can identify these non-bean classes and convert them to plain strings using the {@link Object#toString()} method.<a name="line.73"></a> +<span class="sourceLineNo">074</span> * <p><a name="line.74"></a> +<span class="sourceLineNo">075</span> * Some settings (e.g. {@link BeanContext#BEAN_beanFieldVisibility}) are used to determine what kinds of properties are detected on beans.<a name="line.75"></a> +<span class="sourceLineNo">076</span> * <p><a name="line.76"></a> +<span class="sourceLineNo">077</span> * Some settings (e.g. {@link BeanContext#BEAN_beanMapPutReturnsOldValue}) change the runtime behavior of bean maps.<a name="line.77"></a> +<span class="sourceLineNo">078</span> * <p><a name="line.78"></a> +<span class="sourceLineNo">079</span> * Settings are specified using the {@link PropertyStore#setProperty(String, Object)} method and related convenience methods.<a name="line.79"></a> +<span class="sourceLineNo">080</span> *<a name="line.80"></a> +<span class="sourceLineNo">081</span> * <h5 class='section'>Example:</h5><a name="line.81"></a> +<span class="sourceLineNo">082</span> * <p class='bcode'><a name="line.82"></a> +<span class="sourceLineNo">083</span> * <jc>// Construct a context from scratch.</jc><a name="line.83"></a> +<span class="sourceLineNo">084</span> * BeanContext beanContext = PropertyStore.<jsm>create</jsm>()<a name="line.84"></a> +<span class="sourceLineNo">085</span> * .property(BeanContext.<jsf>BEAN_beansRequireDefaultConstructor</jsf>, <jk>true</jk>)<a name="line.85"></a> +<span class="sourceLineNo">086</span> * .notBeanClasses(Foo.<jk>class</jk>)<a name="line.86"></a> +<span class="sourceLineNo">087</span> * .getBeanContext();<a name="line.87"></a> +<span class="sourceLineNo">088</span> *<a name="line.88"></a> +<span class="sourceLineNo">089</span> * <jc>// Clone an existing property store.</jc><a name="line.89"></a> +<span class="sourceLineNo">090</span> * BeanContext beanContext = PropertyStore.<jsm>create</jsm>(otherConfig)<a name="line.90"></a> +<span class="sourceLineNo">091</span> * .property(BeanContext.<jsf>BEAN_beansRequireDefaultConstructor</jsf>, <jk>true</jk>)<a name="line.91"></a> +<span class="sourceLineNo">092</span> * .notBeanClasses(Foo.<jk>class</jk>)<a name="line.92"></a> +<span class="sourceLineNo">093</span> * .getBeanContext();<a name="line.93"></a> +<span class="sourceLineNo">094</span> * </p><a name="line.94"></a> +<span class="sourceLineNo">095</span> *<a name="line.95"></a> +<span class="sourceLineNo">096</span> * <h5 class='topic'>Bean Maps</h5><a name="line.96"></a> +<span class="sourceLineNo">097</span> * <p><a name="line.97"></a> +<span class="sourceLineNo">098</span> * {@link BeanMap BeanMaps} are wrappers around Java beans that allow properties to be retrieved and<a name="line.98"></a> +<span class="sourceLineNo">099</span> * set using the common {@link Map#put(Object,Object)} and {@link Map#get(Object)} methods.<br><a name="line.99"></a> +<span class="sourceLineNo">100</span> * <br><a name="line.100"></a> +<span class="sourceLineNo">101</span> * Bean maps are created in two ways...<a name="line.101"></a> +<span class="sourceLineNo">102</span> * <ol><a name="line.102"></a> +<span class="sourceLineNo">103</span> * <li> {@link BeanSession#toBeanMap(Object) BeanSession.toBeanMap()} - Wraps an existing bean inside a {@code Map} wrapper.<a name="line.103"></a> +<span class="sourceLineNo">104</span> * <li> {@link BeanSession#newBeanMap(Class) BeanSession.newBeanMap()} - Create a new bean instance wrapped in a {@code Map} wrapper.<a name="line.104"></a> +<span class="sourceLineNo">105</span> * </ol><a name="line.105"></a> +<span class="sourceLineNo">106</span> *<a name="line.106"></a> +<span class="sourceLineNo">107</span> * <h5 class='section'>Example:</h5><a name="line.107"></a> +<span class="sourceLineNo">108</span> * <p class='bcode'><a name="line.108"></a> +<span class="sourceLineNo">109</span> * <jc>// A sample bean class</jc><a name="line.109"></a> +<span class="sourceLineNo">110</span> * <jk>public class</jk> Person {<a name="line.110"></a> +<span class="sourceLineNo">111</span> * <jk>public</jk> String getName();<a name="line.111"></a> +<span class="sourceLineNo">112</span> * <jk>public void</jk> setName(String name);<a name="line.112"></a> +<span class="sourceLineNo">113</span> * <jk>public int</jk> getAge();<a name="line.113"></a> +<span class="sourceLineNo">114</span> * <jk>public void</jk> setAge(<jk>int</jk> age);<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> * <jc>// Create a new bean session</jc><a name="line.117"></a> +<span class="sourceLineNo">118</span> * BeanSession session = BeanContext.<jsf>DEFAULT</jsf>.createSession();<a name="line.118"></a> +<span class="sourceLineNo">119</span> *<a name="line.119"></a> +<span class="sourceLineNo">120</span> * <jc>// Wrap an existing bean in a new bean map</jc><a name="line.120"></a> +<span class="sourceLineNo">121</span> * BeanMap&lt;Person&gt; m1 = session.toBeanMap(<jk>new</jk> Person());<a name="line.121"></a> +<span class="sourceLineNo">122</span> * m1.put(<js>"name"</js>, <js>"John Smith"</js>);<a name="line.122"></a> +<span class="sourceLineNo">123</span> * m1.put(<js>"age"</js>, 45);<a name="line.123"></a> +<span class="sourceLineNo">124</span> *<a name="line.124"></a> +<span class="sourceLineNo">125</span> * <jc>// Create a new bean instance wrapped in a new bean map</jc><a name="line.125"></a> +<span class="sourceLineNo">126</span> * BeanMap&lt;Person&gt; m2 = session.newBeanMap(Person.<jk>class</jk>);<a name="line.126"></a> +<span class="sourceLineNo">127</span> * m2.put(<js>"name"</js>, <js>"John Smith"</js>);<a name="line.127"></a> +<span class="sourceLineNo">128</span> * m2.put(<js>"age"</js>, 45);<a name="line.128"></a> +<span class="sourceLineNo">129</span> * Person p = m2.getBean(); <jc>// Get the bean instance that was created.</jc><a name="line.129"></a> +<span class="sourceLineNo">130</span> * </p><a name="line.130"></a> +<span class="sourceLineNo">131</span> *<a name="line.131"></a> +<span class="sourceLineNo">132</span> * <h5 class='topic'>Bean Annotations</h5><a name="line.132"></a> +<span class="sourceLineNo">133</span> * <p><a name="line.133"></a> +<span class="sourceLineNo">134</span> * This package contains annotations that can be applied to<a name="line.134"></a> +<span class="sourceLineNo">135</span> * class definitions to override what properties are detected on a bean.<a name="line.135"></a> +<span class="sourceLineNo">136</span> * <h5 class='section'>Example:</h5><a name="line.136"></a> +<span class="sourceLineNo">137</span> * <p class='bcode'><a name="line.137"></a> +<span class="sourceLineNo">138</span> * <jc>// Bean class definition where only property 'name' is detected.</jc><a name="line.138"></a> +<span class="sourceLineNo">139</span> * <ja>&#64;Bean</ja>(properties=<js>"name"</js>)<a name="line.139"></a> +<span class="sourceLineNo">140</span> * <jk>public class</jk> Person {<a name="line.140"></a> +<span class="sourceLineNo">141</span> * <jk>public</jk> String getName();<a name="line.141"></a> +<span class="sourceLineNo">142</span> * <jk>public void</jk> setName(String name);<a name="line.142"></a> +<span class="sourceLineNo">143</span> * <jk>public int</jk> getAge();<a name="line.143"></a> +<span class="sourceLineNo">144</span> * <jk>public void</jk> setAge(<jk>int</jk> age);<a name="line.144"></a> +<span class="sourceLineNo">145</span> * }<a name="line.145"></a> +<span class="sourceLineNo">146</span> * <p><a name="line.146"></a> +<span class="sourceLineNo">147</span> * See {@link Bean @Bean} and {@link BeanProperty @BeanProperty} for more information.<a name="line.147"></a> +<span class="sourceLineNo">148</span> *<a name="line.148"></a> +<span class="sourceLineNo">149</span> * <h5 class='topic'>Beans with read-only properties</h5><a name="line.149"></a> +<span class="sourceLineNo">150</span> * <p><a name="line.150"></a> +<span class="sourceLineNo">151</span> * Bean maps can also be defined on top of beans with read-only properties by adding a<a name="line.151"></a> +<span class="sourceLineNo">152</span> * {@link BeanConstructor @BeanConstructor} annotation to one of the constructors on the<a name="line.152"></a> +<span class="sourceLineNo">153</span> * bean class. This will allow read-only properties to be set through constructor arguments.<a name="line.153"></a> +<span class="sourceLineNo">154</span> * <p><a name="line.154"></a> +<span class="sourceLineNo">155</span> * When the <code>@BeanConstructor</code> annotation is present, bean instantiation is delayed until the call to {@link BeanMap#getBean()}.<a name="line.155"></a> +<span class="sourceLineNo">156</span> * Until then, bean property values are stored in a local cache until <code>getBean()</code> is called.<a name="line.156"></a> +<span class="sourceLineNo">157</span> * Because of this additional caching step, parsing into read-only beans tends to be slower and use<a name="line.157"></a> +<span class="sourceLineNo">158</span> * more memory than parsing into beans with writable properties.<a name="line.158"></a> +<span class="sourceLineNo">159</span> * <p><a name="line.159"></a> +<span class="sourceLineNo">160</span> * Attempting to call {@link BeanMap#put(String,Object)} on a read-only property after calling {@link BeanMap#getBean()}<a name="line.160"></a> +<span class="sourceLineNo">161</span> * will result in a {@link BeanRuntimeException} being thrown.<a name="line.161"></a> +<span class="sourceLineNo">162</span> * Multiple calls to {@link BeanMap#getBean()} will return the same bean instance.<a name="line.162"></a> +<span class="sourceLineNo">163</span> * <p><a name="line.163"></a> +<span class="sourceLineNo">164</span> * Beans can be defined with a combination of read-only and read-write properties.<a name="line.164"></a> +<span class="sourceLineNo">165</span> * <p><a name="line.165"></a> +<span class="sourceLineNo">166</span> * See {@link BeanConstructor @BeanConstructor} for more information.<a name="line.166"></a> +<span class="sourceLineNo">167</span> *<a name="line.167"></a> +<span class="sourceLineNo">168</span> * <h5 class='topic'>BeanFilters and PojoSwaps</h5><a name="line.168"></a> +<span class="sourceLineNo">169</span> * <p><a name="line.169"></a> +<span class="sourceLineNo">170</span> * {@link BeanFilter BeanFilters} and {@link PojoSwap PojoSwaps} are used to tailor how beans and POJOs are handled.<br><a name="line.170"></a> +<span class="sourceLineNo">171</span> * <ol class='spaced-list'><a name="line.171"></a> +<span class="sourceLineNo">172</span> * <li>{@link BeanFilter} - Allows you to tailor handling of bean classes.<a name="line.172"></a> +<span class="sourceLineNo">173</span> * This class can be considered a programmatic equivalent to the {@link Bean} annotation when<a name="line.173"></a> +<span class="sourceLineNo">174</span> * annotating classes are not possible (e.g. you don't have access to the source).<a name="line.174"></a> +<span class="sourceLineNo">175</span> * This includes specifying which properties are visible and the ability to programmatically override the execution of properties.<a name="line.175"></a> +<span class="sourceLineNo">176</span> * <li>{@link PojoSwap} - Allows you to swap out non-serializable objects with serializable replacements.<a name="line.176"></a> +<span class="sourceLineNo">177</span> * </ol><a name="line.177"></a> +<span class="sourceLineNo">178</span> * <p><a name="line.178"></a> +<span class="sourceLineNo">179</span> * See <a class='doclink' href='transform/package-summary.html#TOC'>org.apache.juneau.transform</a> for more information.<a name="line.179"></a> +<span class="sourceLineNo">180</span> *<a name="line.180"></a> +<span class="sourceLineNo">181</span> * <h5 class='topic'>ClassMetas</h5><a name="line.181"></a> +<span class="sourceLineNo">182</span> * <p><a name="line.182"></a> +<span class="sourceLineNo">183</span> * The {@link ClassMeta} class is a wrapper around {@link Class} object t
<TRUNCATED>
