content/site/apidocs-7.1.0/src-html/org/apache/juneau/BeanContext.html

<!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>001// ***************************************************************************************************************************<a name="line.1"></a> 002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *<a name="line.2"></a> 003// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a> 004// * 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> 005// * with the License. You may obtain a copy of the License at *<a name="line.5"></a> 006// * *<a name="line.6"></a> 007// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a> 008// * *<a name="line.8"></a> 009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a> 010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a> 011// * specific language governing permissions and limitations under the License. *<a name="line.11"></a> 012// ***************************************************************************************************************************<a name="line.12"></a> 013package org.apache.juneau;<a name="line.13"></a> 014<a name="line.14"></a> 015import static org.apache.juneau.Visibility.*;<a name="line.15"></a> 016import static org.apache.juneau.internal.ClassUtils.*;<a name="line.16"></a> 017import static org.apache.juneau.internal.CollectionUtils.*;<a name="line.17"></a> 018import static org.apache.juneau.internal.StringUtils.*;<a name="line.18"></a> 019<a name="line.19"></a> 020import java.io.*;<a name="line.20"></a> 021import java.lang.reflect.*;<a name="line.21"></a> 022import java.util.*;<a name="line.22"></a> 023import java.util.concurrent.*;<a name="line.23"></a> 024<a name="line.24"></a> 025import org.apache.juneau.annotation.*;<a name="line.25"></a> 026import org.apache.juneau.http.*;<a name="line.26"></a> 027import org.apache.juneau.internal.*;<a name="line.27"></a> 028import org.apache.juneau.json.*;<a name="line.28"></a> 029import org.apache.juneau.serializer.*;<a name="line.29"></a> 030import org.apache.juneau.transform.*;<a name="line.30"></a> 031<a name="line.31"></a> 032/**<a name="line.32"></a> 033 * Core class of the Juneau architecture.<a name="line.33"></a> 034 * <a name="line.34"></a> 035 * <a name="line.35"></a> 036 * This class servers multiple purposes:<a name="line.36"></a> 037 * <ul class='spaced-list'><a name="line.37"></a> 038 * <li><a name="line.38"></a> 039 * Provides the ability to wrap beans inside {@link Map} interfaces.<a name="line.39"></a> 040 * <li><a name="line.40"></a> 041 * Serves as a repository for metadata on POJOs, such as associated {@link BeanFilter BeanFilters},<a name="line.41"></a> 042 * {@link PropertyNamer PropertyNamers}, etc... which are used to tailor how POJOs are serialized and parsed.<a name="line.42"></a> 043 * </ul><a name="line.43"></a> 044 * <a name="line.44"></a> 045 * <a name="line.45"></a> 046 * All serializers and parsers extend from this context so that they can handle POJOs using a common framework.<a name="line.46"></a> 047 * <a name="line.47"></a> 048 * <h5 class='topic'>Bean Contexts</h5><a name="line.48"></a> 049 * <a name="line.49"></a> 050 * Bean contexts are created through the {@link BeanContext#create() BeanContext.create()} and {@link BeanContextBuilder#build()} methods.<a name="line.50"></a> 051 * These context objects are read-only, reusable, and thread-safe.<a name="line.51"></a> 052 * <a name="line.52"></a> 053 * <a name="line.53"></a> 054 * Each bean context maintains a cache of {@link ClassMeta} objects that describe information about classes encountered.<a name="line.54"></a> 055 * These <code>ClassMeta</code> objects are time-consuming to construct.<a name="line.55"></a> 056 * Therefore, instances of {@link BeanContext} that share the same <js>"BeanContext.*"</js> property values share<a name="line.56"></a> 057 * the same cache. This allows for efficient reuse of <code>ClassMeta</code> objects so that the information about<a name="line.57"></a> 058 * classes only needs to be calculated once.<a name="line.58"></a> 059 * Because of this, many of the properties defined on the {@link BeanContext} class cannot be overridden on the session.<a name="line.59"></a> 060 * <a name="line.60"></a> 061 * <h5 class='topic'>Bean Sessions</h5><a name="line.61"></a> 062 * <a name="line.62"></a> 063 * Whereas <code>BeanContext</code> objects are permanent, unchangeable, cached, and thread-safe,<a name="line.63"></a> 064 * {@link BeanSession} objects are ephemeral and not thread-safe.<a name="line.64"></a> 065 * They are meant to be used as quickly-constructed scratchpads for creating bean maps.<a name="line.65"></a> 066 * {@link BeanMap} objects can only be created through the session.<a name="line.66"></a> 067 * <a name="line.67"></a> 068 * <h5 class='topic'>BeanContext configuration properties</h5><a name="line.68"></a> 069 * <a name="line.69"></a> 070 * <code>BeanContexts</code> have several configuration properties that can be used to tweak behavior on how beans are<a name="line.70"></a> 071 * handled. These are denoted as the static <jsf>BEAN_*</jsf> fields on this class.<a name="line.71"></a> 072 * <a name="line.72"></a> 073 * <a name="line.73"></a> 074 * Some settings (e.g. {@link #BEAN_beansRequireDefaultConstructor}) are used to differentiate between bean<a name="line.74"></a> 075 * and non-bean classes.<a name="line.75"></a> 076 * Attempting to create a bean map around one of these objects will throw a {@link BeanRuntimeException}.<a name="line.76"></a> 077 * The purpose for this behavior is so that the serializers can identify these non-bean classes and convert them to<a name="line.77"></a> 078 * plain strings using the {@link Object#toString()} method.<a name="line.78"></a> 079 * <a name="line.79"></a> 080 * <a name="line.80"></a> 081 * Some settings (e.g. {@link #BEAN_beanFieldVisibility}) are used to determine what kinds of properties are<a name="line.81"></a> 082 * detected on beans.<a name="line.82"></a> 083 * <a name="line.83"></a> 084 * <a name="line.84"></a> 085 * Some settings (e.g. {@link #BEAN_beanMapPutReturnsOldValue}) change the runtime behavior of bean maps.<a name="line.85"></a> 086 * <a name="line.86"></a> 087 * <a name="line.87"></a> 088 * Settings are specified using the {@link BeanContextBuilder#set(String, Object)} method and related convenience<a name="line.88"></a> 089 * methods.<a name="line.89"></a> 090 * <a name="line.90"></a> 091 * <h5 class='section'>Example:</h5><a name="line.91"></a> 092 * <a name="line.92"></a> 093 * <a name="line.93"></a> 094 * <jc>// Construct a context from scratch.</jc><a name="line.94"></a> 095 * BeanContext beanContext = BeanContext<a name="line.95"></a> 096 * .<jsm>create</jsm>()<a name="line.96"></a> 097 * .set(BeanContext.<jsf>BEAN_beansRequireDefaultConstructor</jsf>, <jk>true</jk>)<a name="line.97"></a> 098 * .notBeanClasses(Foo.<jk>class</jk>)<a name="line.98"></a> 099 * .build();<a name="line.99"></a> 100 * <a name="line.100"></a> 101 * <a name="line.101"></a> 102 * <h5 class='topic'>Bean Maps</h5><a name="line.102"></a> 103 * <a name="line.103"></a> 104 * {@link BeanMap BeanMaps} are wrappers around Java beans that allow properties to be retrieved and<a name="line.104"></a> 105 * set using the common {@link Map#put(Object,Object)} and {@link Map#get(Object)} methods.<a name="line.105"></a> 106 * <a name="line.106"></a> 107 * <a name="line.107"></a> 108 * Bean maps are created in two ways...<a name="line.108"></a> 109 * <ol><a name="line.109"></a> 110 * <li>{@link BeanSession#toBeanMap(Object) BeanSession.toBeanMap()} - Wraps an existing bean inside a {@code Map}<a name="line.110"></a> 111 * wrapper.<a name="line.111"></a> 112 * <li>{@link BeanSession#newBeanMap(Class) BeanSession.newBeanMap()} - Create a new bean instance wrapped in a<a name="line.112"></a> 113 * {@code Map} wrapper.<a name="line.113"></a> 114 * </ol><a name="line.114"></a> 115 * <a name="line.115"></a> 116 * <h5 class='section'>Example:</h5><a name="line.116"></a> 117 * <a name="line.117"></a> 118 * <a name="line.118"></a> 119 * <jc>// A sample bean class</jc><a name="line.119"></a> 120 * <jk>public class</jk> Person {<a name="line.120"></a> 121 * <jk>public</jk> String getName();<a name="line.121"></a> 122 * <jk>public void</jk> setName(String name);<a name="line.122"></a> 123 * <jk>public int</jk> getAge();<a name="line.123"></a> 124 * <jk>public void</jk> setAge(<jk>int</jk> age);<a name="line.124"></a> 125 * }<a name="line.125"></a> 126 * <a name="line.126"></a> 127 * <jc>// Create a new bean session</jc><a name="line.127"></a> 128 * BeanSession session = BeanContext.<jsf>DEFAULT</jsf>.createSession();<a name="line.128"></a> 129 * <a name="line.129"></a> 130 * <jc>// Wrap an existing bean in a new bean map</jc><a name="line.130"></a> 131 * BeanMap&lt;Person&gt; m1 = session.toBeanMap(<jk>new</jk> Person());<a name="line.131"></a> 132 * m1.put(<js>"name"</js>, <js>"John Smith"</js>);<a name="line.132"></a> 133 * m1.put(<js>"age"</js>, 45);<a name="line.133"></a> 134 * <a name="line.134"></a> 135 * <jc>// Create a new bean instance wrapped in a new bean map</jc><a name="line.135"></a> 136 * BeanMap&lt;Person&gt; m2 = session.newBeanMap(Person.<jk>class</jk>);<a name="line.136"></a> 137 * m2.put(<js>"name"</js>, <js>"John Smith"</js>);<a name="line.137"></a> 138 * m2.put(<js>"age"</js>, 45);<a name="line.138"></a> 139 * Person p = m2.getBean(); <jc>// Get the bean instance that was created.</jc><a name="line.139"></a> 140 * <a name="line.140"></a> 141 * <a name="line.141"></a> 142 * <h5 class='section'>See Also:</h5><a name="line.142"></a> 143 * <ul><a name="line.143"></a> 144 * <li class='link'><a class="doclink" href="../../../overview-summary.html#juneau-marshall.ContextsBuildersSessionsPropertyStores">Overview &gt; juneau-marshall &gt; Contexts, Builders, Sessions, and PropertyStores</a><a name="line.144"></a> 145 * </ul><a name="line.145"></a> 146 */<a name="line.146"></a> 147@SuppressWarnings({"unchecked","rawtypes"})<a name="line.147"></a> 148public class BeanContext extends Context {<a name="line.148"></a> 149<a name="line.149"></a> 150 static final String PREFIX = "BeanContext.";<a name="line.150"></a> 151<a name="line.151"></a> 152 /**<a name="line.152"></a> 153 * Configuration property: Minimum bean class visibility.<a name="line.153"></a> 154 * <a name="line.154"></a> 155 * <h5 class='section'>Property:</h5><a name="line.155"></a> 156 * <ul><a name="line.156"></a> 157 * <li>Name: <js>"BeanContext.beanClassVisibility.s"</js><a name="line.157"></a> 158 * <li>Data type: <code>String</code> ({@link Visibility})<a name="line.158"></a> 159 * <li>Default: <js>"PUBLIC"</js><a name="line.159"></a> 160 * <li>Session-overridable: <jk>false</jk><a name="line.160"></a> 161 * <li>Methods: <a name="line.161"></a> 162 * <ul><a name="line.162"></a> 163 * <li class='jm'>{@link BeanContextBuilder#beanClassVisibility(Visibility)}<a name="line.163"></a> 164 * </ul><a name="line.164"></a> 165 * </ul><a name="line.165"></a> 166 * <a name="line.166"></a> 167 * <h5 class='section'>Description:</h5><a name="line.167"></a> 168 * <a name="line.168"></a> 169 * Classes are not considered beans unless they meet the minimum visibility requirements.<a name="line.169"></a> 170 * <a name="line.170"></a> 171 * <a name="line.171"></a> 172 * For example, if the visibility is <code>PUBLIC</code> and the bean class is <jk>protected</jk>, then the class<a name="line.172"></a> 173 * will not be interpreted as a bean class and be serialized as a string.<a name="line.173"></a> 174 * Use this setting to reduce the visibility requirement.<a name="line.174"></a> 175 * <a name="line.175"></a> 176 * <h5 class='section'>Example:</h5><a name="line.176"></a> 177 * <a name="line.177"></a> 178 * <jc>// Create a serializer that serializes protected classes.</jc><a name="line.178"></a> 179 * WriterSerializer s = JsonSerializer<a name="line.179"></a> 180 * .<jsm>create</jsm>()<a name="line.180"></a> 181 * .beanClassVisibility(<jsf>PROTECTED</jsf>)<a name="line.181"></a> 182 * .build();<a name="line.182"></a> 183 * <a name="line.183"></a> 184 * <jc>// Same, but use property.</jc><a name="line.184"></a> 185 * WriterSerializer s = JsonSerializer<a name="line.185"></a> 186 * .<jsm>create</jsm>()<a name="line.186"></a> 187 * .set(<jsf>BEAN_beanClassVisibility</jsf>, <js>"PROTECTED"</js>)<a name="line.187"></a> 188 * .build();<a name="line.188"></a> 189 * <a name="line.189"></a> 190 */<a name="line.190"></a> 191 public static final String BEAN_beanClassVisibility = PREFIX + "beanClassVisibility.s";<a name="line.191"></a> 192<a name="line.192"></a> 193 /**<a name="line.193"></a> 194 * Configuration property: Minimum bean constructor visibility.<a name="line.194"></a> 195 * <a name="line.195"></a> 196 * <h5 class='section'>Property:</h5><a name="line.196"></a> 197 * <ul><a name="line.197"></a> 198 * <li>Name: <js>"BeanContext.beanConstructorVisibility.s"</js><a name="line.198"></a> 199 * <li>Data type: <code>String</code> ({@link Visibility})<a name="line.199"></a> 200 * <li>Default: <js>"PUBLIC"</js><a name="line.200"></a> 201 * <li>Session-overridable: <jk>false</jk><a name="line.201"></a> 202 * <li>Methods: <a name="line.202"></a> 203 * <ul><a name="line.203"></a> 204 * <li class='jm'>{@link BeanContextBuilder#beanConstructorVisibility(Visibility)}<a name="line.204"></a> 205 * </ul><a name="line.205"></a> 206 * </ul><a name="line.206"></a> 207 * <a name="line.207"></a> 208 * <h5 class='section'>Description:</h5><a name="line.208"></a> 209 * <a name="line.209"></a> 210 * Only look for constructors with the specified minimum visibility.<a name="line.210"></a> 211 * <a name="line.211"></a> 212 * <a name="line.212"></a> 213 * This setting affects the logic for finding no-arg constructors for bean. <a name="line.213"></a> 214 * Normally, only <jk>public</jk> no-arg constructors are used.<a name="line.214"></a> 215 * Use this setting if you want to reduce the visibility requirement.<a name="line.215"></a> 216 * <a name="line.216"></a> 217 * <h5 class='section'>Example:</h5><a name="line.217"></a> 218 * <a name="line.218"></a> 219 * <jc>// Create a serializer that looks for protected no-arg constructors.</jc><a name="line.219"></a> 220 * WriterSerializer s = JsonSerializer<a name="line.220"></a> 221 * .<jsm>create</jsm>()<a name="line.221"></a> 222 * .beanConstructorVisibility(<jsf>PROTECTED</jsf>)<a name="line.222"></a> 223 * .build();<a name="line.223"></a> 224 * <a name="line.224"></a> 225 * <jc>// Same, but use property.</jc><a name="line.225"></a> 226 * WriterSerializer s = JsonSerializer<a name="line.226"></a> 227 * .<jsm>create</jsm>()<a name="line.227"></a> 228 * .set(<jsf>BEAN_beanConstructorVisibility</jsf>, <js>"PROTECTED"</js>)<a name="line.228"></a> 229 * .build();<a name="line.229"></a> 230 * <a name="line.230"></a> 231 */<a name="line.231"></a> 232 public static final String BEAN_beanConstructorVisibility = PREFIX + "beanConstructorVisibility.s";<a name="line.232"></a> 233<a name="line.233"></a> 234 /**<a name="line.234"></a> 235 * Configuration property: Bean dictionary.<a name="line.235"></a> 236 * <a name="line.236"></a> 237 * <h5 class='section'>Property:</h5><a name="line.237"></a> 238 * <ul><a name="line.238"></a> 239 * <li>Name: <js>"BeanContext.beanDictionary.lc"</js><a name="line.239"></a> 240 * <li>Data type: <code>List&lt;Class&gt;</code><a name="line.240"></a> 241 * <li>Default: empty list<a name="line.241"></a> 242 * <li>Session-overridable: <jk>false</jk><a name="line.242"></a> 243 * <li>Annotations: <a name="line.243"></a> 244 * <ul><a name="line.244"></a> 245 * <li class='ja'>{@link Bean#beanDictionary()} <a name="line.245"></a> 246 * <li class='ja'>{@link BeanProperty#beanDictionary()} <a name="line.246"></a> 247 * </ul><a name="line.247"></a> 248 * <li>Methods: <a name="line.248"></a> 249 * <ul><a name="line.249"></a> 250 * <li class='jm'>{@link BeanContextBuilder#beanDictionary(Object...)}<a name="line.250"></a> 251 * <li class='jm'>{@link BeanContextBuilder#beanDictionary(Class...)}<a name="line.251"></a> 252 * <li class='jm'>{@link BeanContextBuilder#beanDictionary(boolean,Object...)}<a name="line.252"></a> 253 * <li class='jm'>{@link BeanContextBuilder#beanDictionaryRemove(Object...)}<a name="line.253"></a> 254 * <li class='jm'>{@link BeanFilterBuilder#beanDictionary(Class...)}<a name="line.254"></a> 255 * </ul><a name="line.255"></a> 256 * </ul><a name="line.256"></a> 257 * <a name="line.257"></a> 258 * <h5 class='section'>Description:</h5><a name="line.258"></a> 259 * <a name="line.259"></a> 260 * The list of classes that make up the bean dictionary in this bean context.<a name="line.260"></a> 261 * <a name="line.261"></a> 262 * <a name="line.262"></a> 263 * A dictionary is a name/class mapping used to find class types during parsing when they cannot be inferred<a name="line.263"></a> 264 * through reflection.<a name="line.264"></a> 265 * The names are defined through the {@link Bean#typeName() @Bean.typeName()} annotation defined on the bean class.<a name="line.265"></a> 266 * For example, if a class <code>Foo</code> has a type-name of <js>"myfoo"</js>, then it would end up serialized<a name="line.266"></a> 267 * as <js>"{_type:'myfoo',...}"</js>.<a name="line.267"></a> 268 * <a name="line.268"></a> 269 * <a name="line.269"></a> 270 * This setting tells the parsers which classes to look for when resolving <js>"_type"</js> attributes.<a name="line.270"></a> 271 * <a name="line.271"></a> 272 * <a name="line.272"></a> 273 * Values can consist of any of the following types:<a name="line.273"></a> 274 * <ul><a name="line.274"></a> 275 * <li>Any bean class that specifies a value for {@link Bean#typeName() @Bean.typeName()}.<a name="line.275"></a> 276 * <li>Any subclass of {@link BeanDictionaryList} containing a collection of bean classes with type name annotations.<a name="line.276"></a> 277 * <li>Any subclass of {@link BeanDictionaryMap} containing a mapping of type names to classes without type name annotations.<a name="line.277"></a> 278 * <li>Any array or collection of the objects above.<a name="line.278"></a> 279 * </ul><a name="line.279"></a> 280 * <a name="line.280"></a> 281 * <h5 class='section'>Example:</h5><a name="line.281"></a> 282 * <a name="line.282"></a> 283 * <jc>// Create a parser and tell it which classes to try to resolve.</jc><a name="line.283"></a> 284 * ReaderParser p = JsonParser<a name="line.284"></a> 285 * .<jsm>create</jsm>()<a name="line.285"></a> 286 * .beanDictionary(Foo.<jk>class</jk>, Bar.<jk>class</jk>)<a name="line.286"></a> 287 * .build();<a name="line.287"></a> 288 * <a name="line.288"></a> 289 * <jc>// Same, but use property.</jc><a name="line.289"></a> 290 * ReaderParser p = JsonParser<a name="line.290"></a> 291 * .<jsm>create</jsm>()<a name="line.291"></a> 292 * .addTo(<jsf>BEAN_beanDictionary</jsf>, Foo.<jk>class</jk>)<a name="line.292"></a> 293 * .addTo(<jsf>BEAN_beanDictionary</jsf>, Bar.<jk>class</jk>)<a name="line.293"></a> 294 * .build();<a name="line.294"></a> 295 * <a name="line.295"></a> 296 * <jc>// Instead of by parser, define a bean dictionary on a class through an annotation.</jc><a name="line.296"></a> 297 * <jc>// This applies to all properties on this class and all subclasses.</jc><a name="line.297"></a> 298 * <ja>@Bean</ja>(beanDictionary={Foo.<jk>class</jk>,Bar.<jk>class</jk>})<a name="line.298"></a> 299 * <jk>public class</jk> MyBean {...}<a name="line.299"></a> 300 * <a name="line.300"></a> 301 * <jc>// Use the predefined HTML5 bean dictionary which is a BeanDictionaryList.</jc><a name="line.301"></a> 302 * ReaderParser p = HtmlParser<a name="line.302"></a> 303 * .<jsm>create</jsm>()<a name="line.303"></a> 304 * .beanDictionary(HtmlBeanDictionary.<jk>class</jk>)<a name="line.304"></a> 305 * .build();<a name="line.305"></a> 306 * <a name="line.306"></a> 307 * <a name="line.307"></a> 308 * <h5 class='section'>See Also:</h5><a name="line.308"></a> 309 * <ul><a name="line.309"></a> 310 * <li class='link'><a class="doclink" href="../../../overview-summary.html#juneau-marshall.BeanDictionaries">Overview &gt; juneau-marshall &gt; Bean Names and Dictionaries</a><a name="line.310"></a> 311 * </ul><a name="line.311"></a> 312 */<a name="line.312"></a> 313 public static final String BEAN_beanDictionary = PREFIX + "beanDictionary.lc";<a name="line.313"></a> 314<a name="line.314"></a> 315 /**<a name="line.315"></a> 316 * Configuration property: Add to bean dictionary.<a name="line.316"></a> 317 */<a name="line.317"></a> 318 public static final String BEAN_beanDictionary_add = PREFIX + "beanDictionary.lc/add";<a name="line.318"></a> 319<a name="line.319"></a> 320 /**<a name="line.320"></a> 321 * Configuration property: Remove from bean dictionary.<a name="line.321"></a> 322 */<a name="line.322"></a> 323 public static final String BEAN_beanDictionary_remove = PREFIX + "beanDictionary.lc/remove";<a name="line.323"></a> 324<a name="line.324"></a> 325 /**<a name="line.325"></a> 326 * Configuration property: Minimum bean field visibility.<a name="line.326"></a> 327 * <a name="line.327"></a> 328 * <h5 class='section'>Property:</h5><a name="line.328"></a> 329 * <ul><a name="line.329"></a> 330 * <li>Name: <js>"BeanContext.beanFieldVisibility.s"</js><a name="line.330"></a> 331 * <li>Data type: <code>String</code> ({@link Visibility})<a name="line.331"></a> 332 * <li>Default: <js>"PUBLIC"</js><a name="line.332"></a> 333 * <li>Session-overridable: <jk>false</jk><a name="line.333"></a> 334 * <li>Methods: <a name="line.334"></a> 335 * <ul><a name="line.335"></a> 336 * <li class='jm'>{@link BeanContextBuilder#beanFieldVisibility(Visibility)}<a name="line.336"></a> 337 * </ul><a name="line.337"></a> 338 * </ul><a name="line.338"></a> 339 * <a name="line.339"></a> 340 * <h5 class='section'>Description:</h5><a name="line.340"></a> 341 * <a name="line.341"></a> 342 * Only look for bean fields with the specified minimum visibility.<a name="line.342"></a> 343 * <a name="line.343"></a> 344 * <a name="line.344"></a> 345 * This affects which fields on a bean class are considered bean properties.<a name="line.345"></a> 346 * Normally only <jk>public</jk> fields are considered.<a name="line.346"></a> 347 * Use this setting if you want to reduce the visibility requirement.<a name="line.347"></a> 348 * <a name="line.348"></a> 349 * <h5 class='section'>Example:</h5><a name="line.349"></a> 350 * <a name="line.350"></a> 351 * <jc>// Create a serializer that looks for protected fields.</jc><a name="line.351"></a> 352 * WriterSerializer s = JsonSerializer<a name="line.352"></a> 353 * .<jsm>create</jsm>()<a name="line.353"></a> 354 * .beanFieldVisibility(<jsf>PROTECTED</jsf>)<a name="line.354"></a> 355 * .build();<a name="line.355"></a> 356 * <a name="line.356"></a> 357 * <jc>// Same, but use property.</jc><a name="line.357"></a> 358 * WriterSerializer s = JsonSerializer<a name="line.358"></a> 359 * .<jsm>create</jsm>()<a name="line.359"></a> 360 * .set(<jsf>BEAN_beanFieldVisibility</jsf>, <js>"PROTECTED"</js>)<a name="line.360"></a> 361 * .build();<a name="line.361"></a> 362 * <a name="line.362"></a> 363 * <jc>// Disable using fields as properties entirely.</jc><a name="line.363"></a> 364 * WriterSerializer s = JsonSerializer<a name="line.364"></a> 365 * .<jsm>create</jsm>()<a name="line.365"></a> 366 * .beanFieldVisibility(<jsf>NONE</jsf>)<a name="line.366"></a> 367 * .build();<a name="line.367"></a> 368 * <a name="line.368"></a> 369 */<a name="line.369"></a> 370 public static final String BEAN_beanFieldVisibility = PREFIX + "beanFieldVisibility.s";<a name="line.370"></a> 371<a name="line.371"></a> 372 /**<a name="line.372"></a> 373 * Configuration property: Bean filters.<a name="line.373"></a> 374 * <a name="line.374"></a> 375 * <h5 class='section'>Property:</h5><a name="line.375"></a> 376 * <ul><a name="line.376"></a> 377 * <li>Name: <js>"BeanContext.beanFilters.lc"</js><a name="line.377"></a> 378 * <li>Data type: <code>List&lt;Class&gt;</code><a name="line.378"></a> 379 * <li>Default: empty list<a name="line.379"></a> 380 * <li>Session-overridable: <jk>false</jk><a name="line.380"></a> 381 * <li>Methods: <a name="line.381"></a> 382 * <ul><a name="line.382"></a> 383 * <li class='jm'>{@link BeanContextBuilder#beanFilters(Object...)}<a name="line.383"></a> 384 * <li class='jm'>{@link BeanContextBuilder#beanFilters(Class...)}<a name="line.384"></a> 385 * <li class='jm'>{@link BeanContextBuilder#beanFilters(boolean,Object...)}<a name="line.385"></a> 386 * <li class='jm'>{@link BeanContextBuilder#beanFiltersRemove(Object...)}<a name="line.386"></a> 387 * </ul><a name="line.387"></a> 388 * </ul><a name="line.388"></a> 389 * <a name="line.389"></a> 390 * <h5 class='section'>Description:</h5><a name="line.390"></a> 391 * <a name="line.391"></a> 392 * This is a programmatic equivalent to the {@link Bean @Bean} annotation.<a name="line.392"></a> 393 * It's useful when you want to use the <code>@Bean</code> annotation functionality, but you don't have the ability to alter <a name="line.393"></a> 394 * the bean classes.<a name="line.394"></a> 395 * <a name="line.395"></a> 396 * <a name="line.396"></a> 397 * Values can consist of any of the following types:<a name="line.397"></a> 398 * <ul class='spaced-list'><a name="line.398"></a> 399 * <li>Any subclass of {@link BeanFilterBuilder}.<a name="line.399"></a> 400 * These must have a public no-arg constructor.<a name="line.400"></a> 401 * <li>Any bean interfaces.<a name="line.401"></a> 402 * A shortcut for defining a {@link InterfaceBeanFilterBuilder}.<a name="line.402"></a> 403 * Any subclasses of an interface class will only have properties defined on the interface.<a name="line.403"></a> 404 * All other bean properties will be ignored.<a name="line.404"></a> 405 * <li>Any array or collection of the objects above.<a name="line.405"></a> 406 * </ul><a name="line.406"></a> 407 * <a name="line.407"></a> 408 * <h5 class='section'>Example:</h5><a name="line.408"></a> 409 * <a name="line.409"></a> 410 * <jc>// Create a bean filter for the MyBean class.</jc><a name="line.410"></a> 411 * <jk>public class</jk> MyBeanFilter <jk>extends</jk> BeanFilterBuilder&lt;MyBean&gt; {<a name="line.411"></a> 412 * <a name="line.412"></a> 413 * <jc>// Must provide a no-arg constructor!</jc><a name="line.413"></a> 414 * <jk>public</jk> MyBeanFilter() {<a name="line.414"></a> 415 * includeProperties(<js>"foo,bar,baz"</js>); <jc>// The properties we want exposed.</jc><a name="line.415"></a> 416 * }<a name="line.416"></a> 417 * } <a name="line.417"></a> 418 * <a name="line.418"></a> 419 * <jc>// Associate our bean filter with a serializer.</jc><a name="line.419"></a> 420 * WriterSerializer s = JsonSerializer<a name="line.420"></a> 421 * .<jsm>create</jsm>()<a name="line.421"></a> 422 * .beanFilters(MyBeanFilter.<jk>class</jk>)<a name="line.422"></a> 423 * .build();<a name="line.423"></a> 424 * <a name="line.424"></a> 425 * <jc>// Same, but use property.</jc><a name="line.425"></a> 426 * WriterSerializer s = JsonSerializer<a name="line.426"></a> 427 * .<jsm>create</jsm>()<a name="line.427"></a> 428 * .addTo(<jsf>BEAN_beanFilters</jsf>, MyBeanFilter.<jk>class</jk>)<a name="line.428"></a> 429 * .build();<a name="line.429"></a> 430 * <a name="line.430"></a> 431 * <a name="line.431"></a> 432 * <h5 class='section'>See Also:</h5><a name="line.432"></a> 433 * <ul><a name="line.433"></a> 434 * <li class='link'><a class="doclink" href="../../../overview-summary.html#juneau-marshall.BeanFilters">Overview &gt; juneau-marshall &gt; BeanFilters</a><a name="line.434"></a> 435 * <li class='link'><a class="doclink" href="../../../overview-summary.html#juneau-marshall.InterfaceFilters">Overview &gt; juneau-marshall &gt; Interface Filters</a><a name="line.435"></a> 436 * </ul><a name="line.436"></a> 437 */<a name="line.437"></a> 438 public static final String BEAN_beanFilters = PREFIX + "beanFilters.lc";<a name="line.438"></a> 439<a name="line.439"></a> 440 /**<a name="line.440"></a> 441 * Configuration property: Add to bean filters.<a name="line.441"></a> 442 */<a name="line.442"></a> 443 public static final String BEAN_beanFilters_add = PREFIX + "beanFilters.lc/add";<a name="line.443"></a> 444<a name="line.444"></a> 445 /**<a name="line.445"></a> 446 * Configuration property: Remove from bean filters.<a name="line.446"></a> 447 */<a name="line.447"></a> 448 public static final String BEAN_beanFilters_remove = PREFIX + "beanFilters.lc/remove";<a name="line.448"></a> 449<a name="line.449"></a> 450 /**<a name="line.450"></a> 451 * Configuration property: BeanMap.put() returns old property value.<a name="line.451"></a> 452 * <a name="line.452"></a> 453 * <h5 class='section'>Property:</h5><a name="line.453"></a> 454 * <ul><a name="line.454"></a> 455 * <li>Name: <js>"BeanContext.beanMapPutReturnsOldValue.b"</js><a name="line.455"></a> 456 * <li>Data type: <code>Boolean</code><a name="line.456"></a> 457 * <li>Default: <jk>false</jk><a name="line.457"></a> 458 * <li>Session-overridable: <jk>false</jk><a name="line.458"></a> 459 * <li>Methods: <a name="line.459"></a> 460 * <ul><a name="line.460"></a> 461 * <li class='jm'>{@link BeanContextBuilder#beanMapPutReturnsOldValue(boolean)}<a name="line.461"></a> 462 * <li class='jm'>{@link BeanContextBuilder#beanMapPutReturnsOldValue()}<a name="line.462"></a> 463 * </ul><a name="line.463"></a> 464 * </ul><a name="line.464"></a> 465 * <a name="line.465"></a> 466 * <h5 class='section'>Description:</h5><a name="line.466"></a> 467 * <a name="line.467"></a> 468 * <a name="line.468"></a> 469 * If <jk>true</jk>, then the {@link BeanMap#put(String,Object) BeanMap.put()} method will return old property<a name="line.469"></a> 470 * values.<a name="line.470"></a> 471 * Otherwise, it returns <jk>null</jk>.<a name="line.471"></a> 472 * <a name="line.472"></a> 473 * <a name="line.473"></a> 474 * Disabled by default because it introduces a slight performance penalty during serialization.<a name="line.474"></a> 475 * <a name="line.475"></a> 476 * <h5 class='section'>Example:</h5><a name="line.476"></a> 477 * <a name="line.477"></a> 478 * <jc>// Create a serializer that creates BeanMaps with normal put() behavior.</jc><a name="line.478"></a> 479 * WriterSerializer s = JsonSerializer<a name="line.479"></a> 480 * .<jsm>create</jsm>()<a name="line.480"></a> 481 * .beanMapPutReturnsOldValue()<a name="line.481"></a> 482 * .build();<a name="line.482"></a> 483 * <a name="line.483"></a> 484 * <jc>// Same, but use property.</jc><a name="line.484"></a> 485 * WriterSerializer s = JsonSerializer<a name="line.485"></a> 486 * .<jsm>create</jsm>()<a name="line.486"></a> 487 * .set(<jsf>BEAN_beanMapPutReturnsOldValue</jsf>, <jk>true</jk>)<a name="line.487"></a> 488 * .build();<a name="line.488"></a> 489 * <a name="line.489"></a> 490 * BeanMap&lt;MyBean&gt; bm = s.createSession().toBeanMap(<jk>new</jk> MyBean());<a name="line.490"></a> 491 * bm.put(<js>"foo"</js>, <js>"bar"</js>);<a name="line.491"></a> 492 * Object oldValue = bm.put(<js>"foo"</js>, <js>"baz"</js>); <jc>// oldValue == "bar"</jc><a name="line.492"></a> 493 * <a name="line.493"></a> 494 */<a name="line.494"></a> 495 public static final String BEAN_beanMapPutReturnsOldValue = PREFIX + "beanMapPutReturnsOldValue.b";<a name="line.495"></a> 496<a name="line.496"></a> 497 /**<a name="line.497"></a> 498 * Configuration property: Minimum bean method visibility.<a name="line.498"></a> 499 * <a name="line.499"></a> 500 * <h5 class='section'>Property:</h5><a name="line.500"></a> 501 * <ul><a name="line.501"></a> 502 * <li>Name: <js>"BeanContext.beanMethodVisibility.s"</js><a name="line.502"></a> 503 * <li>Data type: <code>String</code> ({@link Visibility})<a name="line.503"></a> 504 * <li>Default: <js>"PUBLIC"</js><a name="line.504"></a> 505 * <li>Session-overridable: <jk>false</jk><a name="line.505"></a> 506 * <li>Methods: <a name="line.506"></a> 507 * <ul><a name="line.507"></a> 508 * <li class='jm'>{@link BeanContextBuilder#beanMethodVisibility(Visibility)}<a name="line.508"></a> 509 * </ul><a name="line.509"></a> 510 * </ul><a name="line.510"></a> 511 * <a name="line.511"></a> 512 * <h5 class='section'>Description:</h5><a name="line.512"></a> 513 * <a name="line.513"></a> 514 * Only look for bean methods with the specified minimum visibility.<a name="line.514"></a> 515 * <a name="line.515"></a> 516 * <a name="line.516"></a> 517 * This affects which methods are detected as getters and setters on a bean class.<a name="line.517"></a> 518 * Normally only <jk>public</jk> getters and setters are considered.<a name="line.518"></a> 519 * Use this setting if you want to reduce the visibility requirement.<a name="line.519"></a> 520 * <a name="line.520"></a> 521 * <h5 class='section'>Example:</h5><a name="line.521"></a> 522 * <a name="line.522"></a> 523 * <jc>// Create a serializer that looks for protected getters and setters.</jc><a name="line.523"></a> 524 * WriterSerializer s = JsonSerializer<a name="line.524"></a> 525 * .<jsm>create</jsm>()<a name="line.525"></a> 526 * .beanMethodVisibility(<jsf>PROTECTED</jsf>)<a name="line.526"></a> 527 * .build();<a name="line.527"></a> 528 * <a name="line.528"></a> 529 * <jc>// Same, but use property.</jc><a name="line.529"></a> 530 * WriterSerializer s = JsonSerializer<a name="line.530"></a> 531 * .<jsm>create</jsm>()<a name="line.531"></a> 532 * .set(<jsf>BEAN_beanMethodVisibility</jsf>, <js>"PROTECTED"</js>)<a name="line.532"></a> 533 * .build();<a name="line.533"></a> 534 * <a name="line.534"></a> 535 */<a name="line.535"></a> 536 public static final String BEAN_beanMethodVisibility = PREFIX + "beanMethodVisibility.s";<a name="line.536"></a> 537<a name="line.537"></a> 538 /**<a name="line.538"></a> 539 * Configuration property: Beans require no-arg constructors.<a name="line.539"></a> 540 * <a name="line.540"></a> 541 * <h5 class='section'>Property:</h5><a name="line.541"></a> 542 * <ul><a name="line.542"></a> 543 * <li>Name: <js>"BeanContext.beansRequireDefaultConstructor.b"</js><a name="line.543"></a> 544 * <li>Data type: <code>Boolean</code><a name="line.544"></a> 545 * <li>Default: <jk>false</jk><a name="line.545"></a> 546 * <li>Session-overridable: <jk>false</jk><a name="line.546"></a> 547 * <li>Methods: <a name="line.547"></a> 548 * <ul><a name="line.548"></a> 549 * <li class='jm'>{@link BeanContextBuilder#beansRequireDefaultConstructor(boolean)}<a name="line.549"></a> 550 * <li class='jm'>{@link BeanContextBuilder#beansRequireDefaultConstructor()}<a name="line.550"></a> 551 * </ul><a name="line.551"></a> 552 * </ul><a name="line.552"></a> 553 * <a name="line.553"></a> 554 * <h5 class='section'>Description:</h5><a name="line.554"></a> 555 * <a name="line.555"></a> 556 * If <jk>true</jk>, a Java class must implement a default no-arg constructor to be considered a bean.<a name="line.556"></a> 557 * Otherwise, the bean will be serialized as a string using the {@link Object#toString()} method.<a name="line.557"></a> 558 * <a name="line.558"></a> 559 * <a name="line.559"></a> 560 * The {@link Bean @Bean} annotation can be used on a class to override this setting when <jk>true</jk>.<a name="line.560"></a> 561 * <a name="line.561"></a> 562 * <h5 class='section'>Example:</h5><a name="line.562"></a> 563 * <a name="line.563"></a> 564 * <jc>// Create a serializer that ignores beans without default constructors.</jc><a name="line.564"></a> 565 * WriterSerializer s = JsonSerializer<a name="line.565"></a> 566 * .<jsm>create</jsm>()<a name="line.566"></a> 567 * .beansRequireDefaultConstructor()<a name="line.567"></a> 568 * .build();<a name="line.568"></a> 569 * <a name="line.569"></a> 570 * <jc>// Same, but use property.</jc><a name="line.570"></a> 571 * WriterSerializer s = JsonSerializer<a name="line.571"></a> 572 * .<jsm>create</jsm>()<a name="line.572"></a> 573 * .set(<jsf>BEAN_beansRequireDefaultConstructor</jsf>, <jk>true</jk>)<a name="line.573"></a> 574 * .build();<a name="line.574"></a> 575 * <a name="line.575"></a> 576 */<a name="line.576"></a> 577 public static final String BEAN_beansRequireDefaultConstructor = PREFIX + "beansRequireDefaultConstructor.b";<a name="line.577"></a> 578<a name="line.578"></a> 579 /**<a name="line.579"></a> 580 * Configuration property: Beans require Serializable interface.<a name="line.580"></a> 581 * <a name="line.581"></a> 582 * <h5 class='section'>Property:</h5><a name="line.582"></a> 583 * <ul><a name="line.583"></a> 584 * <li>Name: <js>"BeanContext.beansRequireSerializable.b"</js><a name="line.584"></a> 585 * <li>Data type: <code>Boolean</code><a name="line.585"></a> 586 * <li>Default: <jk>false</jk><a name="line.586"></a> 587 * <li>Session-overridable: <jk>false</jk><a name="line.587"></a> 588 * <li>Methods: <a name="line.588"></a> 589 * <ul><a name="line.589"></a> 590 * <li class='jm'>{@link BeanContextBuilder#beansRequireSerializable(boolean)}<a name="line.590"></a> 591 * <li class='jm'>{@link BeanContextBuilder#beansRequireSerializable()}<a name="line.591"></a> 592 * </ul><a name="line.592"></a> 593 * </ul><a name="line.593"></a> 594 * <a name="line.594"></a> 595 * <h5 class='section'>Description:</h5><a name="line.595"></a> 596 * <a name="line.596"></a> 597 * If <jk>true</jk>, a Java class must implement the {@link Serializable} interface to be considered a bean.<a name="line.597"></a> 598 * Otherwise, the bean will be serialized as a string using the {@link Object#toString()} method.<a name="line.598"></a> 599 * <a name="line.599"></a> 600 * <a name="line.600"></a> 601 * The {@link Bean @Bean} annotation can be used on a class to override this setting when <jk>true</jk>.<a name="line.601"></a> 602 * <a name="line.602"></a> 603 * <h5 class='section'>Example:</h5><a name="line.603"></a> 604 * <a name="line.604"></a> 605 * <jc>// Create a serializer that ignores beans not implementing Serializable.</jc><a name="line.605"></a> 606 * WriterSerializer s = JsonSerializer<a name="line.606"></a> 607 * .<jsm>create</jsm>()<a name="line.607"></a> 608 * .beansRequireSerializable()<a name="line.608"></a> 609 * .build();<a name="line.609"></a> 610 * <a name="line.610"></a> 611 * <jc>// Same, but use property.</jc><a name="line.611"></a> 612 * WriterSerializer s = JsonSerializer<a name="line.612"></a> 613 * .<jsm>create</jsm>()<a name="line.613"></a> 614 * .set(<jsf>BEAN_beansRequireSerializable</jsf>, <jk>true</jk>)<a name="line.614"></a> 615 * .build();<a name="line.615"></a> 616 * <a name="line.616"></a> 617 */<a name="line.617"></a> 618 public static final String BEAN_beansRequireSerializable = PREFIX + "beansRequireSerializable.b";<a name="line.618"></a> 619<a name="line.619"></a> 620 /**<a name="line.620"></a> 621 * Configuration property: Beans require setters for getters.<a name="line.621"></a> 622 * <a name="line.622"></a> 623 * <h5 class='section'>Property:</h5><a name="line.623"></a> 624 * <ul><a name="line.624"></a> 625 * <li>Name: <js>"BeanContext.beansRequireSettersForGetters.b"</js><a name="line.625"></a> 626 * <li>Data type: <code>Boolean</code><a name="line.626"></a> 627 * <li>Default: <jk>false</jk><a name="line.627"></a> 628 * <li>Session-overridable: <jk>false</jk><a name="line.628"></a> 629 * <li>Methods: <a name="line.629"></a> 630 * <ul><a name="line.630"></a> 631 * <li class='jm'>{@link BeanContextBuilder#beansRequireSettersForGetters(boolean)}<a name="line.631"></a> 632 * <li class='jm'>{@link BeanContextBuilder#beansRequireSettersForGetters()}<a name="line.632"></a> 633 * </ul><a name="line.633"></a> 634 * </ul><a name="line.634"></a> 635 * <a name="line.635"></a> 636 * <h5 class='section'>Description:</h5><a name="line.636"></a> 637 * <a name="line.637"></a> 638 * If <jk>true</jk>, only getters that have equivalent setters will be considered as properties on a bean.<a name="line.638"></a> 639 * Otherwise, they will be ignored.<a name="line.639"></a> 640 * <a name="line.640"></a> 641 * <h5 class='section'>Example:</h5><a name="line.641"></a> 642 * <a name="line.642"></a> 643 * <jc>// Create a serializer that ignores bean properties without setters.</jc><a name="line.643"></a> 644 * WriterSerializer s = JsonSerializer<a name="line.644"></a> 645 * .<jsm>create</jsm>()<a name="line.645"></a> 646 * .beansRequireSettersForGetter()<a name="line.646"></a> 647 * .build();<a name="line.647"></a> 648 * <a name="line.648"></a> 649 * <jc>// Same, but use property.</jc><a name="line.649"></a> 650 * WriterSerializer s = JsonSerializer<a name="line.650"></a> 651 * .<jsm>create</jsm>()<a name="line.651"></a> 652 * .set(<jsf>BEAN_beansRequireSettersForGetters</jsf>, <jk>true</jk>)<a name="line.652"></a> 653 * .build();<a name="line.653"></a> 654 * <a name="line.654"></a> 655 */<a name="line.655"></a> 656 public static final String BEAN_beansRequireSettersForGetters = PREFIX + "beansRequireSettersForGetters.b";<a name="line.656"></a> 657<a name="line.657"></a> 658 /**<a name="line.658"></a> 659 * Configuration property: Beans require at least one property.<a name="line.659"></a> 660 * <a name="line.660"></a> 661 * <h5 class='section'>Property:</h5><a name="line.661"></a> 662 * <ul><a name="line.662"></a> 663 * <li>Name: <js>"BeanContext.beansRequireSomeProperties.b"</js><a name="line.663"></a> 664 * <li>Data type: <code>Boolean</code><a name="line.664"></a> 665 * <li>Default: <jk>true</jk><a name="line.665"></a> 666 * <li>Session-overridable: <jk>false</jk><a name="line.666"></a> 667 * <li>Methods: <a name="line.667"></a> 668 * <ul><a name="line.668"></a> 669 * <li class='jm'>{@link BeanContextBuilder#beansRequireSomeProperties(boolean)}<a name="line.669"></a> 670 * </ul><a name="line.670"></a> 671 * </ul><a name="line.671"></a> 672 * <a name="line.672"></a> 673 * <h5 class='section'>Description:</h5><a name="line.673"></a> 674 * <a name="line.674"></a> 675 * If <jk>true</jk>, then a Java class must contain at least 1 property to be considered a bean.<a name="line.675"></a> 676 * Otherwise, the bean will be serialized as a string using the {@link Object#toString()} method.<a name="line.676"></a> 677 * <a name="line.677"></a> 678 * <a name="line.678"></a> 679 * The {@link Bean @Bean} annotation can be used on a class to override this setting when <jk>true</jk>.<a name="line.679"></a> 680 * <a name="line.680"></a> 681 * <h5 class='section'>Example:</h5><a name="line.681"></a> 682 * <a name="line.682"></a> 683 * <jc>// Create a serializer that serializes beans even if they have zero properties.</jc><a name="line.683"></a> 684 * WriterSerializer s = JsonSerializer<a name="line.684"></a> 685 * .<jsm>create</jsm>()<a name="line.685"></a> 686 * .beansRequireSomeProperties(<jk>false</jk>)<a name="line.686"></a> 687 * .build();<a name="line.687"></a> 688 * <a name="line.688"></a> 689 * <jc>// Same, but use property.</jc><a name="line.689"></a> 690 * WriterSerializer s = JsonSerializer<a name="line.690"></a> 691 * .<jsm>create</jsm>()<a name="line.691"></a> 692 * .set(<jsf>BEAN_beansRequireSomeProperties</jsf>, <jk>false</jk>)<a name="line.692"></a> 693 * .build();<a name="line.693"></a> 694 * <a name="line.694"></a> 695 */<a name="line.695"></a> 696 public static final String BEAN_beansRequireSomeProperties = PREFIX + "beansRequireSomeProperties.b";<a name="line.696"></a> 697<a name="line.697"></a> 698 /**<a name="line.698"></a> 699 * Configuration property: Bean type property name.<a name="line.699"></a> 700 * <a name="line.700"></a> 701 * <h5 class='section'>Property:</h5><a name="line.701"></a> 702 * <ul><a name="line.702"></a> 703 * <li>Name: <js>"BeanContext.beanTypePropertyName.s"</js><a name="line.703"></a> 704 * <li>Data type: <code>String</code><a name="line.704"></a> 705 * <li>Default: <js>"_type"</js><a name="line.705"></a> 706 * <li>Session-overridable: <jk>false</jk><a name="line.706"></a> 707 * <li>Annotations: <a name="line.707"></a> 708 * <ul><a name="line.708"></a> 709 * <li class='ja'>{@link Bean#typePropertyName()}<a name="line.709"></a> 710 * </ul><a name="line.710"></a> 711 * <li>Methods: <a name="line.711"></a> 712 * <ul><a name="line.712"></a> 713 * <li class='jm'>{@link BeanContextBuilder#beanTypePropertyName(String)}<a name="line.713"></a> 714 * </ul><a name="line.714"></a> 715 * </ul><a name="line.715"></a> 716 * <a name="line.716"></a> 717 * <a name="line.717"></a> 718 * This specifies the name of the bean property used to store the dictionary name of a bean type so that the<a name="line.718"></a> 719 * parser knows the data type to reconstruct.<a name="line.719"></a> 720 * <a name="line.720"></a> 721 * <h5 class='section'>Example:</h5><a name="line.721"></a> 722 * <a name="line.722"></a> 723 * <jc>// Create a serializer that uses 'type' instead of '_type' for dictionary names.</jc><a name="line.723"></a> 724 * WriterSerializer s = JsonSerializer<a name="line.724"></a> 725 * .<jsm>create</jsm>()<a name="line.725"></a> 726 * .beanTypePropertyName(<js>"type"</js>)<a name="line.726"></a> 727 * .build();<a name="line.727"></a> 728 * <a name="line.728"></a> 729 * <jc>// Same, but use property.</jc><a name="line.729"></a> 730 * WriterSerializer s = JsonSerializer<a name="line.730"></a> 731 * .<jsm>create</jsm>()<a name="line.731"></a> 732 * .set(<jsf>BEAN_beanTypePropertyName</jsf>, <js>"type"</js>)<a name="line.732"></a> 733 * .build();<a name="line.733"></a> 734 * <a name="line.734"></a> 735 * <a name="line.735"></a> 736 * <h5 class='section'>See Also:</h5><a name="line.736"></a> 737 * <ul><a name="line.737"></a> 738 * <li class='link'><a class="doclink" href="../../../overview-summary.html#juneau-marshall.BeanDictionaries">Overview &gt; juneau-marshall &gt; Bean Names and Dictionaries</a><a name="line.738"></a> 739 * </ul><a name="line.739"></a> 740 */<a name="line.740"></a> 741 public static final String BEAN_beanTypePropertyName = PREFIX + "beanTypePropertyName.s";<a name="line.741"></a> 742<a name="line.742"></a> 743 /**<a name="line.743"></a> 744 * Configuration property: Debug mode.<a name="line.744"></a> 745 * <a name="line.745"></a> 746 * <h5 class='section'>Property:</h5><a name="line.746"></a> 747 * <ul><a name="line.747"></a> 748 * <li>Name: <js>"BeanContext.debug.b"</js><a name="line.748"></a> 749 * <li>Data type: <code>Boolean</code><a name="line.749"></a> 750 * <li>Default: <jk>false</jk><a name="line.750"></a> 751 * <li>Session-overridable: <jk>true</jk><a name="line.751"></a> 752 * <li>Methods: <a name="line.752"></a> 753 * <ul><a name="line.753"></a> 754 * <li class='jm'>{@link BeanContextBuilder#debug(boolean)}<a name="line.754"></a> 755 * <li class='jm'>{@link BeanContextBuilder#debug()}<a name="line.755"></a> 756 * </ul><a name="line.756"></a> 757 * </ul><a name="line.757"></a> 758 * <a name="line.758"></a> 759 * <h5 class='section'>Description:</h5><a name="line.759"></a> 760 * <a name="line.760"></a> 761 * Enables the following additional information during serialization:<a name="line.761"></a> 762 * <ul class='spaced-list'><a name="line.762"></a> 763 * <li><a name="line.763"></a> 764 * When bean getters throws exceptions, the exception includes the object stack information<a name="line.764"></a> 765 * in order to determine how that method was invoked.<a name="line.765"></a> 766 * <li><a name="line.766"></a> 767 * Enables {@link Serializer#SERIALIZER_detectRecursions}.<a name="line.767"></a> 768 * </ul><a name="line.768"></a> 769 * <a name="line.769"></a> 770 * <a name="line.770"></a> 771 * Enables the following additional information during parsing:<a name="line.771"></a> 772 * <ul class='spaced-list'><a name="line.772"></a> 773 * <li><a name="line.773"></a> 774 * When bean setters throws exceptions, the exception includes the object stack information<a name="line.774"></a> 775 * in order to determine how that method was invoked.<a name="line.775"></a> 776 * </ul><a name="line.776"></a> 777 * <a name="line.777"></a> 778 * <h5 class='section'>Example:</h5><a name="line.778"></a> 779 * <a name="line.779"></a> 780 * <jc>// Create a serializer with debug enabled.</jc><a name="line.780"></a> 781 * WriterSerializer s = JsonSerializer<a name="line.781"></a> 782 * .<jsm>create</jsm>()<a name="line.782"></a> 783 * .debug()<a name="line.783"></a> 784 * .build();<a name="line.784"></a> 785 * <a name="line.785"></a> 786 * <jc>// Same, but use property.</jc><a name="line.786"></a> 787 * WriterSerializer s = JsonSerializer<a name="line.787"></a> 788 * .<jsm>create</jsm>()<a name="line.788"></a> 789 * .set(<jsf>BEAN_debug</jsf>, <jk>true</jk>)<a name="line.789"></a> 790 * .build();<a name="line.790"></a> 791 * <a name="line.791"></a> 792 */<a name="line.792"></a> 793 public static final String BEAN_debug = PREFIX + "debug.b";<a name="line.793"></a> 794<a name="line.794"></a> 795 /**<a name="line.795"></a> 796 * Configuration property: Bean property excludes.<a name="line.796"></a> 797 * <a name="line.797"></a> 798 * <h5 class='section'>Property:</h5><a name="line.798"></a> 799 * <ul><a name="line.799"></a> 800 * <li>Name: <js>"BeanContext.excludeProperties.sms"</js><a name="line.800"></a> 801 * <li>Data type: <code>Map&lt;String,String&gt;</code><a name="line.801"></a> 802 * <li>Default: <code>{}</code><a name="line.802"></a> 803 * <li>Session-overridable: <jk>false</jk><a name="line.803"></a> 804 * <li>Annotations: <a name="line.804"></a> 805 * <ul><a name="line.805"></a> 806 * <li class='ja'>{@link Bean#excludeProperties()} <a name="line.806"></a> 807 * </ul><a name="line.807"></a> 808 * <li>Methods: <a name="line.808"></a> 809 * <ul><a name="line.809"></a> 810 * <li class='jm'>{@link BeanContextBuilder#excludeProperties(Class, String)}<a name="line.810"></a> 811 * <li class='jm'>{@link BeanContextBuilder#excludeProperties(String, String)}<a name="line.811"></a> 812 * <li class='jm'>{@link BeanContextBuilder#excludeProperties(Map)}<a name="line.812"></a> 813 * <li class='jm'>{@link BeanFilterBuilder#excludeProperties(String...)}<a name="line.813"></a> 814 * </ul><a name="line.814"></a> 815 * </ul><a name="line.815"></a> 816 * <a name="line.816"></a> 817 * <h5 class='section'>Description:</h5><a name="line.817"></a> 818 * <a name="line.818"></a> 819 * Specifies to exclude the specified list of properties for the specified bean class.<a name="line.819"></a> 820 * <a name="line.820"></a> 821 * <a name="line.821"></a> 822 * The keys are either fully-qualified or simple class names, and the values are comma-delimited lists of property<a name="line.822"></a> 823 * names.<a name="line.823"></a> 824 * The key <js>"*"</js> means all bean classes.<a name="line.824"></a> 825 * <a name="line.825"></a> 826 * <a name="line.826"></a> 827 * For example, <code>{Bean1:<js>'foo,bar'</js>}</code> means don't serialize the <code>foo</code> and<a name="line.827"></a> 828 * <code>bar</code> properties on any beans whose simple class name is <code>Bean1</code>.<a name="line.828"></a> 829 * <a name="line.829"></a> 830 * <a name="line.830"></a> 831 * Setting applies to specified class and all subclasses.<a name="line.831"></a> 832 * <a name="line.832"></a> 833 * <h5 class='section'>Example:</h5><a name="line.833"></a> 834 * <a name="line.834"></a> 835 * <jc>// Create a serializer that excludes the 'foo' and 'bar' properties on the MyBean class.</jc><a name="line.835"></a> 836 * WriterSerializer s = JsonSerializer<a name="line.836"></a> 837 * .<jsm>create</jsm>()<a name="line.837"></a> 838 * .excludeProperties(MyBean.<jk>class</jk>, <js>"foo,bar"</js>)<a name="line.838"></a> 839 * .build();<a name="line.839"></a> 840 * <a name="line.840"></a> 841 * <jc>// Same, but use property.</jc><a name="line.841"></a> 842 * WriterSerializer s = JsonSerializer<a name="line.842"></a> 843 * .<jsm>create</jsm>()<a name="line.843"></a> 844 * .addTo(<jsf>BEAN_excludeProperties</jsf>, MyBean.<jk>class</jk>.getName(), <js>"foo,bar"</js>)<a name="line.844"></a> 845 * .build();<a name="line.845"></a> 846 * <a name="line.846"></a> 847 * <jc>// Alternate using JSON object.</jc><a name="line.847"></a> 848 * WriterSerializer s = JsonSerializer<a name="line.848"></a> 849 * .<jsm>create</jsm>()<a name="line.849"></a> 850 * .addTo(<jsf>BEAN_excludeProperties</jsf>, <js>"{'org.apache.MyBean':'foo,bar'}"</js>)<a name="line.850"></a> 851 * .build();<a name="line.851"></a> 852 * <a name="line.852"></a> 853 */<a name="line.853"></a> 854 public static final String BEAN_excludeProperties = PREFIX + "excludeProperties.sms";<a name="line.854"></a> 855<a name="line.855"></a> 856 /**<a name="line.856"></a> 857 * Configuration property: Ignore invocation errors on getters.<a name="line.857"></a> 858 * <a name="line.858"></a> 859 * <h5 class='section'>Property:</h5><a name="line.859"></a> 860 * <ul><a name="line.860"></a> 861 * <li>Name: <js>"BeanContext.ignoreInvocationExceptionsOnGetters.b"</js><a name="line.861"></a> 862 * <li>Data type: <code>Boolean</code><a name="line.862"></a> 863 * <li>Default: <jk>false</jk><a name="line.863"></a> 864 * <li>Session-overridable: <jk>false</jk><a name="line.864"></a> 865 * <li>Methods: <a name="line.865"></a> 866 * <ul><a name="line.866"></a> 867 * <li class='jm'>{@link BeanContextBuilder#ignoreInvocationExceptionsOnGetters(boolean)}<a name="line.867"></a> 868 * <li class='jm'>{@link BeanContextBuilder#ignoreInvocationExceptionsOnGetters()}<a name="line.868"></a> 869 * </ul><a name="line.869"></a> 870 * </ul><a name="line.870"></a> 871 * <a name="line.871"></a> 872 * <h5 class='section'>Description:</h5><a name="line.872"></a> 873 * <a name="line.873"></a> 874 * If <jk>true</jk>, errors thrown when calling bean getter methods will silently be ignored.<a name="line.874"></a> 875 * Otherwise, a {@code BeanRuntimeException} is thrown.<a name="line.875"></a> 876 * <a name="line.876"></a> 877 * <h5 class='section'>Example:</h5><a name="line.877"></a> 878 * <a name="line.878"></a> 879 * <jc>// Create a serializer that ignores bean getter exceptions.</jc><a name="line.879"></a> 880 * WriterSerializer s = JsonSerializer<a name="line.880"></a> 881 * .<jsm>create</jsm>()<a name="line.881"></a> 882 * .ingoreInvocationExceptionsOnGetters()<a name="line.882"></a> 883 * .build();<a name="line.883"></a> 884 * <a name="line.884"></a> 885 * <jc>// Same, but use property.</jc><a name="line.885"></a> 886 * WriterSerializer s = JsonSerializer<a name="line.886"></a> 887 * .<jsm>create</jsm>()<a name="line.887"></a> 888 * .set(<jsf>BEAN_ignoreInvocationExceptionsOnGetters</jsf>, <jk>true</jk>)<a name="line.888"></a> 889 * .build();<a name="line.889"></a> 890 * <a name="line.890"></a> 891 */<a name="line.891"></a> 892 public static final String BEAN_ignoreInvocationExceptionsOnGetters = PREFIX + "ignoreInvocationExceptionsOnGetters.b";<a name="line.892"></a> 893<a name="line.893"></a> 894 /**<a name="line.894"></a> 895 * Configuration property: Ignore invocation errors on setters.<a name="line.895"></a> 896 * <a name="line.896"></a> 897 * <h5 class='section'>Property:</h5><a name="line.897"></a> 898 * <ul><a name="line.898"></a> 899 * <li>Name: <js>"BeanContext.ignoreInvocationExceptionsOnSetters.b"</js><a name="line.899"></a> 900 * <li>Data type: <code>Boolean</code><a name="line.900"></a> 901 * <li>Default: <jk>false</jk><a name="line.901"></a> 902 * <li>Session-overridable: <jk>false</jk><a name="line.902"></a> 903 * <li>Methods: <a name="line.903"></a> 904 * <ul><a name="line.904"></a> 905 * <li class='jm'>{@link BeanContextBuilder#ignoreInvocationExceptionsOnSetters(boolean)}<a name="line.905"></a> 906 * <li class='jm'>{@link BeanContextBuilder#ignoreInvocationExceptionsOnSetters()}<a name="line.906"></a> 907 * </ul><a name="line.907"></a> 908 * </ul><a name="line.908"></a> 909 * <a name="line.909"></a> 910 * <h5 class='section'>Description:</h5><a name="line.910"></a> 911 * <a name="line.911"></a> 912 * If <jk>true</jk>, errors thrown when calling bean setter methods will silently be ignored.<a name="line.912"></a> 913 * Otherwise, a {@code BeanRuntimeException} is thrown.<a name="line.913"></a> 914 * <a name="line.914"></a> 915 * <h5 class='section'>Example:</h5><a name="line.915"></a> 916 * <a name="line.916"></a> 917 * <jc>// Create a parser that ignores bean setter exceptions.</jc><a name="line.917"></a> 918 * ReaderParser p = JsonParser<a name="line.918"></a> 919 * .<jsm>create</jsm>()<a name="line.919"></a> 920 * .ignoreInvocationExceptionsOnSetters()<a name="line.920"></a> 921 * .build();<a name="line.921"></a> 922 * <a name="line.922"></a> 923 * <jc>// Same, but use property.</jc><a name="line.923"></a> 924 * ReaderParser p = JsonParser<a name="line.924"></a> 925 * .<jsm>create</jsm>()<a name="line.925"></a> 926 * .set(<jsf>BEAN_ignoreInvocationExceptionsOnSetters</jsf>, <jk>true</jk>)<a name="line.926"></a> 927 * .build();<a name="line.927"></a> 928 * <a name="line.928"></a> 929 */<a name="line.929"></a> 930 public static final String BEAN_ignoreInvocationExceptionsOnSetters = PREFIX + "ignoreInvocationExceptionsOnSetters.b";<a name="line.930"></a> 931<a name="line.931"></a> 932 /**<a name="line.932"></a> 933 * Configuration property: Ignore properties without setters.<a name="line.933"></a> 934 * <a name="line.934"></a> 935 * <h5 class='section'>Property:</h5><a name="line.935"></a> 936 * <ul><a name="line.936"></a> 937 * <li>Name: <js>"BeanContext.ignorePropertiesWithoutSetters.b"</js><a name="line.937"></a> 938 * <li>Data type: <code>Boolean</code><a name="line.938"></a> 939 * <li>Default: <jk>true</jk><a name="line.939"></a> 940 * <li>Session-overridable: <jk>false</jk><a name="line.940"></a> 941 * <li>Methods: <a name="line.941"></a> 942 * <ul><a name="line.942"></a> 943 * <li class='jm'>{@link BeanContextBuilder#ignorePropertiesWithoutSetters(boolean)}<a name="line.943"></a> 944 * </ul><a name="line.944"></a> 945 * </ul><a name="line.945"></a> 946 * <a name="line.946"></a> 947 * <h5 class='section'>Description:</h5><a name="line.947"></a> 948 * <a name="line.948"></a> 949 * If <jk>true</jk>, trying to set a value on a bean property without a setter will silently be ignored.<a name="line.949"></a> 950 * Otherwise, a {@code RuntimeException} is thrown.<a name="line.950"></a> 951 * <a name="line.951"></a> 952 * <h5 class='section'>Example:</h5><a name="line.952"></a> 953 * <a name="line.953"></a> 954 * <jc>// Create a parser that throws an exception if a setter is not found but a getter is.</jc><a name="line.954"></a> 955 * ReaderParser p = JsonParser<a name="line.955"></a> 956 * .<jsm>create</jsm>()<a name="line.956"></a> 957 * .ignorePropertiesWithoutSetters(<jk>false</jk>)<a name="line.957"></a> 958 * .build();<a name="line.958"></a> 959 * <a name="line.959"></a> 960 * <jc>// Same, but use property.</jc><a name="line.960"></a> 961 * ReaderParser p = JsonParser<a name="line.961"></a> 962 * .<jsm>create</jsm>()<a name="line.962"></a> 963 * .set(<jsf>BEAN_ignorePropertiesWithoutSetters</jsf>, <jk>false</jk>)<a name="line.963"></a> 964 * .build();<a name="line.964"></a> 965 * <a name="line.965"></a> 966 */<a name="line.966"></a> 967 public static final String BEAN_ignorePropertiesWithoutSetters = PREFIX + "ignorePropertiesWithoutSetters.b";<a name="line.967"></a> 968<a name="line.968"></a> 969 /**<a name="line.969"></a> 970 * Configuration property: Ignore unknown properties.<a name="line.970"></a> 971 * <a name="line.971"></a> 972 * <h5 class='section'>Property:</h5><a name="line.972"></a> 973 * <ul><a name="line.973"></a> 974 * <li>Name: <js>"BeanContext.ignoreUnknownBeanProperties.b"</js><a name="line.974"></a> 975 * <li>Data type: <code>Boolean</code><a name="line.975"></a> 976 * <li>Default: <jk>false</jk><a name="line.976"></a> 977 * <li>Session-overridable: <jk>false</jk><a name="line.977"></a> 978 * <li>Methods: <a name="line.978"></a> 979 * <ul><a name="line.979"></a> 980 * <li class='jm'>{@link BeanContextBuilder#ignoreUnknownBeanProperties(boolean)}<a name="line.980"></a> 981 * <li class='jm'>{@link BeanContextBuilder#ignoreUnknownBeanProperties()}<a name="line.981"></a> 982 * </ul><a name="line.982"></a> 983 * </ul><a name="line.983"></a> 984 * <a name="line.984"></a> 985 * <h5 class='section'>Description:</h5><a name="line.985"></a> 986 * <a name="line.986"></a> 987 * If <jk>true</jk>, trying to set a value on a non-existent bean property will silently be ignored.<a name="line.987"></a> 988 * Otherwise, a {@code RuntimeException} is thrown.<a name="line.988"></a> 989 * <a name="line.989"></a> 990 * <h5 class='section'>Example:</h5><a name="line.990"></a> 991 * <a name="line.991"></a> 992 * <jc>// Create a parser that ignores missing bean properties.</jc><a name="line.992"></a> 993 * ReaderParser p = JsonParser<a name="line.993"></a> 994 * .<jsm>create</jsm>()<a name="line.994"></a> 995 * .ignoreUnknownBeanProperties()<a name="line.995"></a> 996 * .build();<a name="line.996"></a> 997 * <a name="line.997"></a> 998 * <jc>// Same, but use property.</jc><a name="line.998"></a> 999 * ReaderParser p = JsonParser<a name="line.999"></a> 1000 * .<jsm>create</jsm>()<a name="line.1000"></a> 1001 * .set(<jsf>BEAN_ignoreUnknownBeanProperties</jsf>, <jk>true</jk>)<a name="line.1001"></a> 1002 * .build();<a name="line.1002"></a> 1003 * <a name="line.1003"></a> 1004 */<a name="line.1004"></a> 1005 public static final String BEAN_ignoreUnknownBeanProperties = PREFIX + "ignoreUnknownBeanProperties.b";<a name="line.1005"></a> 1006<a name="line.1006"></a> 1007 /**<a name="line.1007"></a> 1008 * Configuration property: Ignore unknown properties with null values.<a name="line.1008"></a> 1009 * <a name="line.1009"></a> 1010 * <h5 class='section'>Property:</h5><a name="line.1010"></a> 1011 * <ul><a name="line.1011"></a> 1012 * <li>Name: <js>"BeanContext.ignoreUnknownNullBeanProperties.b"</js><a name="line.1012"></a> 1013 * <li>Data type: <code>Boolean</code><a name="line.1013"></a> 1014 * <li>Default: <jk>true</jk><a name="line.1014"></a> 1015 * <li>Session-overridable: <jk>false</jk><a name="line.1015"></a> 1016 * <li>Methods: <a name="line.1016"></a> 1017 * <ul><a name="line.1017"></a> 1018 * <li class='jm'>{@link BeanContextBuilder#ignoreUnknownNullBeanProperties(boolean)}<a name="line.1018"></a> 1019 * </ul><a name="line.1019"></a> 1020 * </ul><a name="line.1020"></a> 1021 * <a name="line.1021"></a> 1022 * <h5 class='section'>Description:</h5><a name="line.1022"></a> 1023 * <a name="line.1023"></a> 1024 * 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.1024"></a> 1025 * Otherwise, a {@code RuntimeException} is thrown.<a name="line.1025"></a> 1026 * <a name="line.1026"></a> 1027 * <h5 class='section'>Example:</h5><a name="line.1027"></a> 1028 * <a name="line.1028"></a> 1029 * <jc>// Create a parser that throws an exception on an unknown property even if the value being set is null.</jc><a name="line.1029"></a> 1030 * ReaderParser p = JsonParser<a name="line.1030"></a> 1031 * .<jsm>create</jsm>()<a name="line.1031"></a> 1032 * .ignoreUnknownNullBeanProperties(<jk>false</jk>)<a name="line.1032"></a> 1033 * .build();<a name="line.1033"></a> 1034 * <a name="line.1034"></a> 1035 * <jc>// Same, but use property.</jc><a name="line.1035"></a> 1036 * ReaderParser p = JsonParser<a name="line.1036"></a> 1037 * .<jsm>create</jsm>()<a name="line.1037"></a> 1038 * .set(<jsf>BEAN_ignoreUnknownNullBeanProperties</jsf>, <jk>false</jk>)<a name="line.1038"></a> 1039 * .build();<a name="line.1039"></a> 1040 * <a name="line.1040"></a> 1041 */<a name="line.1041"></a> 1042 public static final String BEAN_ignoreUnknownNullBeanProperties = PREFIX + "ignoreUnknownNullBeanProperties.b";<a name="line.1042"></a> 1043<a name="line.1043"></a> 1044 /**<a name="line.1044"></a> 1045 * Configuration property: Implementation classes.<a name="line.1045"></a> 1046 * <a name="line.1046"></a> 1047 * <h5 class='section'>Property:</h5><a name="line.1047"></a> 1048 * <ul><a name="line.1048"></a> 1049 * <li>Name: <js>"BeanContext.implClasses.smc"</js><a name="line.1049"></a> 1050 * <li>Data type: <code>Map&lt;String,Class&gt;</code><a name="line.1050"></a> 1051 * <li>Default: empty map<a name="line.1051"></a> 1052 * <li>Session-overridable: <jk>false</jk><a name="line.1052"></a> 1053 * <li>Methods: <a name="line.1053"></a> 1054 * <ul><a name="line.1054"></a> 1055 * <li class='jm'>{@link BeanContextBuilder#implClasses(Map)}<a name="line.1055"></a> 1056 * <li class='jm'>{@link BeanContextBuilder#implClass(Class, Class)}<a name="line.1056"></a> 1057 * </ul><a name="line.1057"></a> 1058 * </ul><a name="line.1058"></a> 1059 * <a name="line.1059"></a> 1060 * <h5 class='section'>Description:</h5><a name="line.1060"></a> 1061 * <a name="line.1061"></a> 1062 * For interfaces and abstract classes this method can be used to specify an implementation class for the<a name="line.1062"></a> 1063 * interface/abstract class so that instances of the implementation class are used when instantiated (e.g. during a<a name="line.1063"></a> 1064 * parse).<a name="line.1064"></a> 1065 * <a name="line.1065"></a> 1066 * <h5 class='section'>Example:</h5><a name="line.1066"></a> 1067 * <a name="line.1067"></a> 1068 * <jc>// Create a parser that instantiates MyBeanImpls when parsing MyBeanInterfaces.</jc><a name="line.1068"></a> 1069 * ReaderParser p = JsonParser<a name="line.1069"></a> 1070 * .<jsm>create</jsm>()<a name="line.1070"></a> 1071 * .implClass(MyBeanInterface.<jk>class</jk>, MyBeanImpl.<jk>class</jk>)<a name="line.1071"></a> 1072 * .build();<a name="line.1072"></a> 1073 * <a name="line.1073"></a> 1074 * <jc>// Same, but use property.</jc><a name="line.1074"></a> 1075 * ReaderParser p = JsonParser<a name="line.1075"></a> 1076 * .<jsm>create</jsm>()<a name="line.1076"></a> 1077 * .addTo(<jsf>BEAN_implClasses</jsf>, MyBeanInterface.<jk>class</jk>.getName(), MyBeanImpl.<jk>class</jk>)<a name="line.1077"></a> 1078 * .build();<a name="line.1078"></a> 1079 * <a name="line.1079"></a> 1080 */<a name="line.1080"></a> 1081 public static final String BEAN_implClasses = PREFIX + "implClasses.smc";<a name="line.1081"></a> 1082<a name="line.1082"></a> 1083 /**<a name="line.1083"></a> 1084 * Configuration property: Bean property includes.<a name="line.1084"></a> 1085 * <a name="line.1085"></a> 1086 * <h5 class='section'>Property:</h5><a name="line.1086"></a> 1087 * <ul><a name="line.1087"></a> 1088 * <li>Name: <js>"BeanContext.properties.sms"</js><a name="line.1088"></a> 1089 * <li>Data type: <code>Map&lt;String,String&gt;</code><a name="line.1089"></a> 1090 * <li>Default: <code>{}</code><a name="line.1090"></a> 1091 * <li>Session-overridable: <jk>false</jk><a name="line.1091"></a> 1092 * <li>Annotations: <a name="line.1092"></a> 1093 * <ul><a name="line.1093"></a> 1094 * <li class='ja'>{@link Bean#properties()} <a name="line.1094"></a> 1095 * <li class='ja'>{@link BeanProperty#properties()} <a name="line.1095"></a> 1096 * </ul><a name="line.1096"></a> 1097 * <li>Methods: <a name="line.1097"></a> 1098 * <ul><a name="line.1098"></a> 1099 * <li class='jm'>{@link BeanContextBuilder#includeProperties(Class, String)}<a name="line.1099"></a> 1100 * <li class='jm'>{@link BeanContextBuilder#includeProperties(String, String)}<a name="line.1100"></a> 1101 * <li class='jm'>{@link BeanContextBuilder#includeProperties(Map)}<a name="line.1101"></a> 1102 * <li class='jm'>{@link BeanFilterBuilder#properties(String...)}<a name="line.1102"></a> 1103 * </ul><a name="line.1103"></a> 1104 * </ul><a name="line.1104"></a> 1105 * <a name="line.1105"></a> 1106 * <h5 class='section'>Description:</h5><a name="line.1106"></a> 1107 * <a name="line.1107"></a> 1108 * Specifies the set and order of names of properties associated with the bean class.<a name="line.1108"></a> 1109 * <a name="line.1109"></a> 1110 * <a name="line.1110"></a> 1111 * The keys are either fully-qualified or simple class names, and the values are comma-delimited lists of property<a name="line.1111"></a> 1112 * names.<a name="line.1112"></a> 1113 * The key <js>"*"</js> means all bean classes.<a name="line.1113"></a> 1114 * <a name="line.1114"></a> 1115 * <a name="line.1115"></a> 1116 * For example, <code>{Bean1:<js>'foo,bar'</js>}</code> means only serialize the <code>foo</code> and<a name="line.1116"></a> 1117 * <code>bar</code> properties on the specified bean.<a name="line.1117"></a> 1118 * <a name="line.1118"></a> 1119 * <a name="line.1119"></a> 1120 * Setting applies to specified class and all subclasses.<a name="line.1120"></a> 1121 * <a name="line.1121"></a> 1122 * <h5 class='section'>Example:</h5><a name="line.1122"></a> 1123 * <a name="line.1123"></a> 1124 * <jc>// Create a serializer that includes only the 'foo' and 'bar' properties on the MyBean class.</jc><a name="line.1124"></a> 1125 * WriterSerializer s = JsonSerializer<a name="line.1125"></a> 1126 * .<jsm>create</jsm>()<a name="line.1126"></a> 1127 * .includeProperties(MyBean.<jk>class</jk>, <js>"foo,bar"</js>)<a name="line.1127"></a> 1128 * .build();<a name="line.1128"></a> 1129 * <a name="line.1129"></a> 1130 * <jc>// Same, but use property.</jc><a name="line.1130"></a> 1131 * WriterSerializer s = JsonSerializer<a name="line.1131"></a> 1132 * .<jsm>create</jsm>()<a name="line.1132"></a> 1133 * .addTo(<jsf>BEAN_includeProperties</jsf>, MyBean.<jk>class</jk>.getName(), <js>"foo,bar"</js>)<a name="line.1133"></a> 1134 * .build();<a name="line.1134"></a> 1135 * <a name="line.1135"></a> 1136 * <jc>// Alternate using JSON object.</jc><a name="line.1136"></a> 1137 * WriterSerializer s = JsonSerializer<a name="line.1137"></a> 1138 * .<jsm>create</jsm>()<a name="line.1138"></a> 1139 * .addTo(<jsf>BEAN_includeProperties</jsf>, <js>"{'org.apache.MyBean':'foo,bar'}"</js>)<a name="line.1139"></a> 1140 * .build();<a name="line.1140"></a> 1141 * <a name="line.1141"></a> 1142 */<a name="line.1142"></a> 1143 public static final String BEAN_includeProperties = PREFIX + "includeProperties.sms";<a name="line.1143"></a> 1144<a name="line.1144"></a> 1145 /**<a name="line.1145"></a> 1146 * Configuration property: Locale.<a name="line.1146"></a> 1147 * <a name="line.1147"></a> 1148 * <h5 class='section'>Property:</h5><a name="line.1148"></a> 1149 * <ul><a name="line.1149"></a> 1150 * <li>Name: <js>"BeanContext.locale.s"</js><a name="line.1150"></a> 1151 * <li>Data type: <code>String</code> ({@link Locale})<a name="line.1151"></a> 1152 * <li>Default: <jk>null</jk> (defaults to {@link Locale#getDefault()})<a name="line.1152"></a> 1153 * <li>Session-overridable: <jk>true</jk><a name="line.1153"></a> 1154 * <li>Methods: <a name="line.1154"></a> 1155 * <ul><a name="line.1155"></a> 1156 * <li class='jm'>{@link BeanContextBuilder#locale(Locale)}<a name="line.1156"></a> 1157 * <li class='jm'>{@link BeanSessionArgs#locale(Locale)}<a name="line.1157"></a> 1158 * </ul><a name="line.1158"></a> 1159 * </ul><a name="line.1159"></a> 1160 * <a name="line.1160"></a> 1161 * <h5 class='section'>Example:</h5><a name="line.1161"></a> 1162 * <a name="line.1162"></a> 1163 * <jc>// Create a serializer that uses the specified locale if it's not passed in through session args.</jc><a name="line.1163"></a> 1164 * WriterSerializer s = JsonSerializer<a name="line.1164"></a> 1165 * .<jsm>create</jsm>()<a name="line.1165"></a> 1166 * .locale(Locale.<jsf>UK</jsf>)<a name="line.1166"></a> 1167 * .build();<a name="line.1167"></a> 1168 * <a name="line.1168"></a> 1169 * <jc>// Same, but use property.</jc><a name="line.1169"></a> 1170 * WriterSerializer s = JsonSerializer<a name="line.1170"></a> 1171 * .<jsm>create</jsm>()<a name="line.1171"></a> 1172 * .set(<jsf>BEAN_locale</jsf>, Locale.<jsf>UK</jsf>)<a name="line.1172"></a> 1173 * .build();<a name="line.1173"></a> 1174 * <a name="line.1174"></a> 1175 * <jc>// Define on session-args instead.</jc><a name="line.1175"></a> 1176 * SerializerSessionArgs sessionArgs = <jk>new</jk> SerializerSessionArgs().locale(Locale.<jsf>UK</jsf>);<a name="line.1176"></a> 1177 * <jk>try</jk> (WriterSerializerSession session = s.createSession(sessionArgs)) {<a name="line.1177"></a> 1178 * ...<a name="line.1178"></a> 1179 * }<a name="line.1179"></a> 1180 * <a name="line.1180"></a> 1181 */<a name="line.1181"></a> 1182 public static final String BEAN_locale = PREFIX + "locale.s";<a name="line.1182"></a> 1183<a name="line.1183"></a> 1184 /**<a name="line.1184"></a> 1185 * Configuration property: Media type.<a name="line.1185"></a> 1186 * <a name="line.1186"></a> 1187 * <h5 class='section'>Property:</h5><a name="line.1187"></a> 1188 * <ul><a name="line.1188"></a> 1189 * <li>Name: <js>"BeanContext.mediaType.s"</js><a name="line.1189"></a> 1190 * <li>Data type: <code>String</code> ({@link MediaType})<a name="line.1190"></a> 1191 * <li>Default: <jk>null</jk><a name="line.1191"></a> 1192 * <li>Session-overridable: <jk>true</jk><a name="line.1192"></a> 1193 * <li>Methods: <a name="line.1193"></a> 1194 * <ul><a name="line.1194"></a> 1195 * <li class='jm'>{@link BeanContextBuilder#mediaType(MediaType)}<a name="line.1195"></a> 1196 * <li class='jm'>{@link BeanSessionArgs#mediaType(MediaType)}<a name="line.1196"></a> 1197 * </ul><a name="line.1197"></a> 1198 * </ul><a name="line.1198"></a> 1199 * <a name="line.1199"></a> 1200 * <h5 class='section'>Description:</h5><a name="line.1200"></a> 1201 * <a name="line.1201"></a> 1202 * Specifies a default media type value for serializer and parser sessions.<a name="line.1202"></a> 1203 * <a name="line.1203"></a> 1204 * <h5 class='section'>Example:</h5><a name="line.1204"></a> 1205 * <a name="line.1205"></a> 1206 * <jc>// Create a serializer that uses the specified media type if it's not passed in through session args.</jc><a name="line.1206"></a> 1207 * WriterSerializer s = JsonSerializer<a name="line.1207"></a> 1208 * .<jsm>create</jsm>()<a name="line.1208"></a> 1209 * .mediaType(MediaType.<jsf>JSON</jsf>)<a name="line.1209"></a> 1210 * .build();<a name="line.1210"></a> 1211 * <a name="line.1211"></a> 1212 * <jc>// Same, but use property.</jc><a name="line.1212"></a> 1213 * WriterSerializer s = JsonSerializer<a name="line.1213"></a> 1214 * .<jsm>create</jsm>()<a name="line.1214"></a> 1215 * .set(<jsf>BEAN_mediaType</jsf>, MediaType.<jsf>JSON</jsf>)<a name="line.1215"></a> 1216 * .build();<a name="line.1216"></a> 1217 * <a name="line.1217"></a> 1218 * <jc>// Define on session-args instead.</jc><a name="line.1218"></a> 1219 * SerializerSessionArgs sessionArgs = <jk>new</jk> SerializerSessionArgs().mediaType(MediaType.<jsf>JSON</jsf>);<a name="line.1219"></a> 1220 * <jk>try</jk> (WriterSerializerSession session = s.createSession(sessionArgs)) {<a name="line.1220"></a> 1221 * ...<a name="line.1221"></a> 1222 * }<a name="line.1222"></a> 1223 * <a name="line.1223"></a> 1224 */<a name="line.1224"></a> 1225 public static final String BEAN_mediaType = PREFIX + "mediaType.s";<a name="line.1225"></a> 1226<a name="line.1226"></a> 1227 /**<a name="line.1227"></a> 1228 * Configuration property: Bean class exclusions.<a name="line.1228"></a> 1229 * <a name="line.1229"></a> 1230 * <h5 class='section'>Property:</h5><a name="line.1230"></a> 1231 * <ul><a name="line.1231"></a> 1232 * <li>Name: <js>"BeanContext.notBeanClasses.sc"</js><a name="line.1232"></a> 1233 * <li>Data type: <code>Set&lt;Class&gt;</code><a name="line.1233"></a> 1234 * <li>Default: empty set<a name="line.1234"></a> 1235 * <li>Session-overridable: <jk>false</jk><a name="line.1235"></a> 1236 * <li>Annotations: <a name="line.1236"></a> 1237 * <ul><a name="line.1237"></a> 1238 * <li class='ja'>{@link BeanIgnore} <a name="line.1238"></a> 1239 * </ul><a name="line.1239"></a> 1240 * <li>Methods: <a name="line.1240"></a> 1241 * <ul><a name="line.1241"></a> 1242 * <li class='jm'>{@link BeanContextBuilder#notBeanClasses(Class...)}<a name="line.1242"></a> 1243 * <li class='jm'>{@link BeanContextBuilder#notBeanClasses(Object...)}<a name="line.1243"></a> 1244 * <li class='jm'>{@link BeanContextBuilder#notBeanClasses(boolean, Object...)}<a name="line.1244"></a> 1245 * <li class='jm'>{@link BeanContextBuilder#notBeanClassesRemove(Object...)}<a name="line.1245"></a> 1246 * </ul><a name="line.1246"></a> 1247 * </ul><a name="line.1247"></a> 1248 * <a name="line.1248"></a> 1249 * <h5 class='section'>Description:</h5><a name="line.1249"></a> 1250 * <a name="line.1250"></a> 1251 * List of classes that should not be treated as beans even if they appear to be bean-like.<a name="line.1251"></a> 1252 * Not-bean classes are converted to <code>Strings</code> during serialization.<a name="line.1252"></a> 1253 * <a name="line.1253"></a> 1254 * <a name="line.1254"></a> 1255 * Values can consist of any of the following types:<a name="line.1255"></a> 1256 * <ul><a name="line.1256"></a> 1257 * <li>Classes.<a name="line.1257"></a> 1258 * <li>Arrays and collections of classes.<a name="line.1258"></a> 1259 * </ul><a name="line.1259"></a> 1260 * <a name="line.1260"></a> 1261 * <h5 class='section'>Example:</h5><a name="line.1261"></a> 1262 * <a name="line.1262"></a> 1263 * <jc>// Create a serializer that doesn't treat MyBean as a bean class.</jc><a name="line.1263"></a> 1264 * WriterSerializer s = JsonSerializer<a name="line.1264"></a> 1265 * .<jsm>create</jsm>()<a name="line.1265"></a> 1266 * .notBeanClasses(MyBean.<jk>class</jk>)<a name="line.1266"></a> 1267 * .build();<a name="line.1267"></a> 1268 * <a name="line.1268"></a> 1269 * <jc>// Same, but use property.</jc><a name="line.1269"></a> 1270 * WriterSerializer s = JsonSerializer<a name="line.1270"></a> 1271 * .<jsm>create</jsm>()<a name="line.1271"></a> 1272 * .addTo(<jsf>BEAN_notBeanClasses</jsf>, MyBean.<jk>class</jk>)<a name="line.1272"></a> 1273 * .build();<a name="line.1273"></a> 1274 * <a name="line.1274"></a> 1275 */<a name="line.1275"></a> 1276 public static final String BEAN_notBeanClasses = PREFIX + "notBeanClasses.sc";<a name="line.1276"></a> 1277<a name="line.1277"></a> 1278 /**<a name="line.1278"></a> 1279 * Configuration property: Add to classes that should not be considered beans.<a name="line.1279"></a> 1280 */<a name="line.1280"></a> 1281 public static final String BEAN_notBeanClasses_add = PREFIX + "notBeanClasses.sc/add";<a name="line.1281"></a> 1282<a name="line.1282"></a> 1283 /**<a name="line.1283"></a> 1284 * Configuration property: Remove from classes that should not be considered beans.<a name="line.1284"></a> 1285 */<a name="line.1285"></a> 1286 public static final String BEAN_notBeanClasses_remove = PREFIX + "notBeanClasses.sc/remove";<a name="line.1286"></a> 1287<a name="line.1287"></a> 1288 /**<a name="line.1288"></a> 1289 * Configuration property: Bean package exclusions.<a name="line.1289"></a> 1290 * <a name="line.1290"></a> 1291 * <h5 class='section'>Property:</h5><a name="line.1291"></a> 1292 * <ul><a name="line.1292"></a> 1293 * <li>Name: <js>"BeanContext.notBeanPackages.ss"</js><a name="line.1293"></a> 1294 * <li>Data type: <code>Set&lt;String&gt;</code><a name="line.1294"></a> 1295 * <li>Default:<a name="line.1295"></a> 1296 * <ul><a name="line.1296"></a> 1297 * <li><code>java.lang</code><a name="line.1297"></a> 1298 * <li><code>java.lang.annotation</code><a name="line.1298"></a> 1299 * <li><code>java.lang.ref</code><a name="line.1299"></a> 1300 * <li><code>java.lang.reflect</code><a name="line.1300"></a> 1301 * <li><code>java.io</code><a name="line.1301"></a> 1302 * <li><code>java.net</code><a name="line.1302"></a> 1303 * <li><code>java.nio.*</code><a name="line.1303"></a> 1304 * <li><code>java.util.*</code><a name="line.1304"></a> 1305 * </ul><a name="line.1305"></a> 1306 * <li>Session-overridable: <jk>false</jk><a name="line.1306"></a> 1307 * <li>Methods: <a name="line.1307"></a> 1308 * <ul><a name="line.1308"></a> 1309 * <li class='jm'>{@link BeanContextBuilder#notBeanPackages(Object...)}<a name="line.1309"></a> 1310 * <li class='jm'>{@link BeanContextBuilder#notBeanPackages(String...)}<a name="line.1310"></a> 1311 * <li class='jm'>{@link BeanContextBuilder#notBeanPackages(boolean, Object...)}<a name="line.1311"></a> 1312 * <li class='jm'>{@link BeanContextBuilder#notBeanPackagesRemove(Object...)}<a name="line.1312"></a> 1313 * </ul><a name="line.1313"></a> 1314 * </ul><a name="line.1314"></a> 1315 * <a name="line.1315"></a> 1316 * <h5 class='section'>Description:</h5><a name="line.1316"></a> 1317 * <a name="line.1317"></a> 1318 * When specified, the current list of ignore packages are appended to.<a name="line.1318"></a> 1319 * <a name="line.1319"></a> 1320 * <a name="line.1320"></a> 1321 * Any classes within these packages will be serialized to strings using {@link Object#toString()}.<a name="line.1321"></a> 1322 * <a name="line.1322"></a> 1323 * <a name="line.1323"></a> 1324 * Note that you can specify suffix patterns to include all subpackages.<a name="line.1324"></a> 1325 * <a name="line.1325"></a> 1326 * <a name="line.1326"></a> 1327 * Values can consist of any of the following types:<a name="line.1327"></a> 1328 * <ul><a name="line.1328"></a> 1329 * <li>Strings.<a name="line.1329"></a> 1330 * <li>Arrays and collections of strings.<a name="line.1330"></a> 1331 * </ul><a name="line.1331"></a> 1332 * <a name="line.1332"></a> 1333 * <h5 class='section'>Example:</h5><a name="line.1333"></a> 1334 * <a name="line.1334"></a> 1335 * <jc>// Create a serializer that ignores beans in the specified packages.</jc><a name="line.1335"></a> 1336 * WriterSerializer s = JsonSerializer<a name="line.1336"></a> 1337 * .<jsm>create</jsm>()<a name="line.1337"></a> 1338 * .notBeanPackages(<js>"org.apache.foo"</js>, <js>"org.apache.bar.*"</js>)<a name="line.1338"></a> 1339 * .build();<a name="line.1339"></a> 1340 * <a name="line.1340"></a> 1341 * <jc>// Same, but use property.</jc><a name="line.1341"></a> 1342 * WriterSerializer s = JsonSerializer<a name="line.1342"></a> 1343 * .<jsm>create</jsm>()<a name="line.1343"></a> 1344 * .addTo(<jsf>BEAN_notBeanPackages</jsf>, <js>"org.apache.foo"</js>)<a name="line.1344"></a> 1345 * .addTo(<jsf>BEAN_notBeanPackages</jsf>, <js>"org.apache.bar.*"</js>)<a name="line.1345"></a> 1346 * .build();<a name="line.1346"></a> 1347 * <a name="line.1347"></a> 1348 */<a name="line.1348"></a> 1349 public static final String BEAN_notBeanPackages = PREFIX + "notBeanPackages.ss";<a name="line.1349"></a> 1350<a name="line.1350"></a> 1351 /**<a name="line.1351"></a> 1352 * Configuration property: Add to packages whose classes should not be considered beans.<a name="line.1352"></a> 1353 */<a name="line.1353"></a> 1354 public static final String BEAN_notBeanPackages_add = PREFIX + "notBeanPackages.ss/add";<a name="line.1354"></a> 1355<a name="line.1355"></a> 1356 /**<a name="line.1356"></a> 1357 * Configuration property: Remove from packages whose classes should not be considered beans.<a name="line.1357"></a> 1358 */<a name="line.1358"></a> 1359 public static final String BEAN_notBeanPackages_remove = PREFIX + "notBeanPackages.ss/remove";<a name="line.1359"></a> 1360<a name="line.1360"></a> 1361 /**<a name="line.1361"></a> 1362 * Configuration property: POJO swaps.<a name="line.1362"></a> 1363 * <a name="line.1363"></a> 1364 * <h5 class='section'>Property:</h5><a name="line.1364"></a> 1365 * <ul><a name="line.1365"></a> 1366 * <li>Name: <js>"BeanContext.pojoSwaps.lc"</js><a name="line.1366"></a> 1367 * <li>Data type: <code>List&lt;Class&gt;</code><a name="line.1367"></a> 1368 * <li>Default: empty list<a name="line.1368"></a> 1369 * <li>Session-overridable: <jk>false</jk><a name="line.1369"></a> 1370 * <li>Annotations: <a name="line.1370"></a> 1371 * <ul><a name="line.1371"></a> 1372 * <li class='ja'>{@link Swap} <a name="line.1372"></a> 1373 * <li class='ja'>{@link Swaps} <a name="line.1373"></a> 1374 * </ul><a name="line.1374"></a> 1375 * <li>Methods: <a name="line.1375"></a> 1376 * <ul><a name="line.1376"></a> 1377 * <li class='jm'>{@link BeanContextBuilder#pojoSwaps(Object...)}<a name="line.1377"></a> 1378 * <li class='jm'>{@link BeanContextBuilder#pojoSwaps(Class...)}<a name="line.1378"></a> 1379 * <li class='jm'>{@link BeanContextBuilder#pojoSwaps(boolean, Object...)}<a name="line.1379"></a> 1380 * <li class='jm'>{@link BeanContextBuilder#pojoSwapsRemove(Object...)}<a name="line.1380"></a> 1381 * </ul><a name="line.1381"></a> 1382 * </ul><a name="line.1382"></a> 1383 * <a name="line.1383"></a> 1384 * <h5 class='section'>Description:</h5><a name="line.1384"></a> 1385 * <a name="line.1385"></a> 1386 * POJO swaps are used to "swap out" non-serializable classes with serializable equivalents during serialization,<a name="line.1386"></a> 1387 * and "swap in" the non-serializable class during parsing.<a name="line.1387"></a> 1388 * <a name="line.1388"></a> 1389 * <a name="line.1389"></a> 1390 * An example of a POJO swap would be a <code>Calendar</code> object that gets swapped out for an ISO8601 string.<a name="line.1390"></a> 1391 * <a name="line.1391"></a> 1392 * <a name="line.1392"></a> 1393 * Multiple POJO swaps can be associated with a single class.<a name="line.1393"></a> 1394 * When multiple swaps are applicable to the same class, the media type pattern defined by<a name="line.1394"></a> 1395 * {@link PojoSwap#forMediaTypes()} or {@link Swap#mediaTypes() @Swap.mediaTypes()} are used to come up with the best match.<a name="line.1395"></a> 1396 * <a name="line.1396"></a> 1397 * <a name="line.1397"></a> 1398 * Values can consist of any of the following types:<a name="line.1398"></a> 1399 * <ul><a name="line.1399"></a> 1400 * <li>Any subclass of {@link PojoSwap}.<a name="line.1400"></a> 1401 * <li>Any surrogate class. A shortcut for defining a {@link SurrogateSwap}.<a name="line.1401"></a> 1402 * <li>Any array or collection of the objects above.<a name="line.1402"></a> 1403 * </ul><a name="line.1403"></a> 1404 * <a name="line.1404"></a> 1405 * <h5 class='section'>Example:</h5><a name="line.1405"></a> 1406 * <a name="line.1406"></a> 1407 * <jc>// Sample swap for converting Dates to ISO8601 strings.</jc><a name="line.1407"></a> 1408 * <jk>public class</jk> MyDateSwap <jk>extends</jk> StringSwap&lt;Date&gt; {<a name="line.1408"></a> 1409 * <jc>// ISO8601 formatter.</jc><a name="line.1409"></a> 1410 * <jk>private</jk> DateFormat <jf>format</jf> = <jk>new</jk> SimpleDateFormat(<js>"yyyy-MM-dd'T'HH:mm:ssZ"</js>);<a name="line.1410"></a> 1411 * <a name="line.1411"></a> 1412 * <ja>@Override</ja><a name="line.1412"></a> 1413 * <jk>public</jk> String swap(BeanSession session, Date o) {<a name="line.1413"></a> 1414 * <jk>return</jk> <jf>format</jf>.format(o);<a name="line.1414"></a> 1415 * }<a name="line.1415"></a> 1416 * <a name="line.1416"></a> 1417 * <ja>@Override</ja><a name="line.1417"></a> 1418 * <jk>public</jk> Date unswap(BeanSession session, String o, ClassMeta hint) <jk>throws</jk> Exception {<a name="line.1418"></a> 1419 * <jk>return</jk> <jf>format</jf>.parse(o);<a name="line.1419"></a> 1420 * }<a name="line.1420"></a> 1421 * }<a name="line.1421"></a> 1422 * <a name="line.1422"></a> 1423 * <jc>// Sample bean with a Date field.</jc><a name="line.1423"></a> 1424 * <jk>public class</jk> MyBean {<a name="line.1424"></a> 1425 * <jk>public</jk> Date <jf>date</jf> = <jk>new</jk> Date(112, 2, 3, 4, 5, 6);<a name="line.1425"></a> 1426 * }<a name="line.1426"></a> 1427 * <a name="line.1427"></a> 1428 * <jc>// Create a serializer that uses our date swap.</jc><a name="line.1428"></a> 1429 * WriterSerializer s = JsonSerializer<a name="line.1429"></a> 1430 * .<jsm>create</jsm>()<a name="line.1430"></a> 1431 * .pojoSwaps(MyDateSwap.<jk>class</jk>)<a name="line.1431"></a> 1432 * .build();<a name="line.1432"></a> 1433 * <a name="line.1433"></a> 1434 * <jc>// Same, but use property.</jc><a name="line.1434"></a> 1435 * WriterSerializer s = JsonSerializer<a name="line.1435"></a> 1436 * .<jsm>create</jsm>()<a name="line.1436"></a> 1437 * .addTo(<jsf>BEAN_pojoSwaps</jsf>, MyDateSwap.<jk>class</jk>)<a name="line.1437"></a> 1438 * .build();<a name="line.1438"></a> 1439 * <a name="line.1439"></a> 1440 * <jc>// Produces "{date:'2012-03-03T04:05:06-0500'}"</jc><a name="line.1440"></a> 1441 * String json = s.serialize(<jk>new</jk> MyBean()); <a name="line.1441"></a> 1442 * <a name="line.1442"></a> 1443 * <jc>// Create a serializer that uses our date swap.</jc><a name="line.1443"></a> 1444 * ReaderParser p = JsonParser<a name="line.1444"></a> 1445 * .<jsm>create</jsm>()<a name="line.1445"></a> 1446 * .pojoSwaps(MyDateSwap.<jk>class</jk>)<a name="line.1446"></a> 1447 * .build();<a name="line.1447"></a> 1448 * <a name="line.1448"></a> 1449 * <jc>// Use our parser to parse a bean.</jc><a name="line.1449"></a> 1450 * MyBean bean = p.parse(json, MyBean.<jk>class</jk>);<a name="line.1450"></a> 1451 * <a name="line.1451"></a> 1452 * <a name="line.1452"></a> 1453 * <h5 class='section'>See Also:</h5><a name="line.1453"></a> 1454 * <ul><a name="line.1454"></a> 1455 * <li class='link'><a class="doclink" href="../../../overview-summary.html#juneau-marshall.PojoSwaps">Overview &gt; juneau-marshall &gt; PojoSwaps</a><a name="line.1455"></a> 1456 * <li class='link'><a class="doclink" href="../../../overview-summary.html#juneau-marshall.PerMediaTypePojoSwaps">Overview &gt; juneau-marshall &gt; Per-media-type PojoSwaps</a><a name="line.1456"></a> 1457 * <li class='link'><a class="doclink" href="../../../overview-summary.html#juneau-marshall.OneWayPojoSwaps">Overview &gt; juneau-marshall &gt; One-way PojoSwaps</a><a name="line.1457"></a> 1458 * <li class='link'><a class="doclink" href="../../../overview-summary.html#juneau-marshall.SwapAnnotation">Overview &gt; juneau-marshall &gt; @Swap Annotation</a><a name="line.1458"></a> 1459 * <li class='link'><a class="doclink" href="../../../overview-summary.html#juneau-marshall.SwapMethods">Overview &gt; juneau-marshall &gt; Swap Methods</a><a name="line.1459"></a> 1460 * <li class='link'><a class="doclink" href="../../../overview-summary.html#juneau-marshall.SurrogateClasses">Overview &gt; juneau-marshall &gt; Surrogate Classes</a><a name="line.1460"></a> 1461 * </ul><a name="line.1461"></a> 1462 */<a name="line.1462"></a> 1463 public static final String BEAN_pojoSwaps = PREFIX + "pojoSwaps.lc";<a name="line.1463"></a> 1464<a name="line.1464"></a> 1465 /**<a name="line.1465"></a> 1466 * Configuration property: Add to POJO swap classes.<a name="line.1466"></a> 1467 */<a name="line.1467"></a> 1468 public static final String BEAN_pojoSwaps_add = PREFIX + "pojoSwaps.lc/add";<a name="line.1468"></a> 1469<a name="line.1469"></a> 1470 /**<a name="line.1470"></a> 1471 * Configuration property: Remove from POJO swap classes.<a name="line.1471"></a> 1472 */<a name="line.1472"></a> 1473 public static final String BEAN_pojoSwaps_remove = PREFIX + "pojoSwaps.lc/remove";<a name="line.1473"></a> 1474<a name="line.1474"></a> 1475 /**<a name="line.1475"></a> 1476 * Configuration property: Bean property namer.<a name="line.1476"></a> 1477 * <a name="line.1477"></a> 1478 * <h5 class='section'>Property:</h5><a name="line.1478"></a> 1479 * <ul><a name="line.1479"></a> 1480 * <li>Name: <js>"BeanContext.propertyNamer.c"</js><a name="line.1480"></a> 1481 * <li>Data type: <code>Class&lt;? <jk>implements</jk> {@link PropertyNamer}&gt;</code><a name="line.1481"></a> 1482 * <li>Default: {@link PropertyNamerDefault}<a name="line.1482"></a> 1483 * <li>Session-overridable: <jk>false</jk><a name="line.1483"></a> 1484 * <li>Annotations: <a name="line.1484"></a> 1485 * <ul><a name="line.1485"></a> 1486 * <li class='ja'>{@link Bean#propertyNamer()}<a name="line.1486"></a> 1487 * </ul><a name="line.1487"></a> 1488 * <li>Methods: <a name="line.1488"></a> 1489 * <ul><a name="line.1489"></a> 1490 * <li class='jm'>{@link BeanContextBuilder#propertyNamer(Class)}<a name="line.1490"></a> 1491 * <li class='jm'>{@link BeanFilterBuilder#propertyNamer(Class)}<a name="line.1491"></a> 1492 * </ul><a name="line.1492"></a> 1493 * </ul><a name="line.1493"></a> 1494 * <a name="line.1494"></a> 1495 * <h5 class='section'>Description:</h5><a name="line.1495"></a> 1496 * <a name="line.1496"></a> 1497 * The class to use for calculating bean property names.<a name="line.1497"></a> 1498 * <a name="line.1498"></a> 1499 * <a name="line.1499"></a> 1500 * Predefined classes:<a name="line.1500"></a> 1501 * <ul><a name="line.1501"></a> 1502 * <li>{@link PropertyNamerDefault} - Default.<a name="line.1502"></a> 1503 * <li>{@link PropertyNamerDLC} - Dashed-lower-case names.<a name="line.1503"></a> 1504 * <li>{@link PropertyNamerULC} - Dashed-upper-case names.<a name="line.1504"></a> 1505 * </ul><a name="line.1505"></a> 1506 * <a name="line.1506"></a> 1507 * <h5 class='section'>Example:</h5><a name="line.1507"></a> 1508 * <a name="line.1508"></a> 1509 * <jc>// Create a serializer that uses Dashed-Lower-Case property names.</jc><a name="line.1509"></a> 1510 * <jc>// (e.g. "foo-bar-url" instead of "fooBarURL")</jc><a name="line.1510"></a> 1511 * WriterSerializer s = JsonSerializer<a name="line.1511"></a> 1512 * .<jsm>create</jsm>()<a name="line.1512"></a> 1513 * .propertyNamer(PropertyNamerDLC.<jk>class</jk>)<a name="line.1513"></a> 1514 * .build();<a name="line.1514"></a> 1515 * <a name="line.1515"></a> 1516 * <jc>// Same, but use property.</jc><a name="line.1516"></a> 1517 * WriterSerializer s = JsonSerializer<a name="line.1517"></a> 1518 * .<jsm>create</jsm>()<a name="line.1518"></a> 1519 * .set(<jsf>BEAN_propertyNamer</jsf>, PropertyNamerDLC.<jk>class</jk>)<a name="line.1519"></a> 1520 * .build();<a name="line.1520"></a> 1521 * <a name="line.1521"></a> 1522 */<a name="line.1522"></a> 1523 public static final String BEAN_propertyNamer = PREFIX + "propertyNamer.c";<a name="line.1523"></a> 1524<a name="line.1524"></a> 1525 /**<a name="line.1525"></a> 1526 * Configuration property: Sort bean properties.<a name="line.1526"></a> 1527 * <a name="line.1527"></a> 1528 * <h5 class='section'>Property:</h5><a name="line.1528"></a> 1529 * <ul><a name="line.1529"></a> 1530 * <li>Name: <js>"BeanContext.sortProperties.b"</js><a name="line.1530"></a> 1531 * <li>Data type: <code>Boolean</code><a name="line.1531"></a> 1532 * <li>Default: <jk>false</jk><a name="line.1532"></a> 1533 * <li>Session-overridable: <jk>false</jk><a name="line.1533"></a> 1534 * <li>Annotations: <a name="line.1534"></a> 1535 * <ul><a name="line.1535"></a> 1536 * <li class='ja'>{@link Bean#sort()} <a name="line.1536"></a> 1537 * </ul><a name="line.1537"></a> 1538 * <li>Methods: <a name="line.1538"></a> 1539 * <ul><a name="line.1539"></a> 1540 * <li class='jm'>{@link BeanContextBuilder#sortProperties(boolean)}<a name="line.1540"></a> 1541 * <li class='jm'>{@link BeanContextBuilder#sortProperties()}<a name="line.1541"></a> 1542 * <li class='jm'>{@link BeanFilterBuilder#sortProperties(boolean)}<a name="line.1542"></a> 1543 * <li class='jm'>{@link BeanFilterBuilder#sortProperties()}<a name="line.1543"></a> 1544 * </ul><a name="line.1544"></a> 1545 * </ul><a name="line.1545"></a> 1546 * <a name="line.1546"></a> 1547 * <h5 class='section'>Description:</h5><a name="line.1547"></a> 1548 * <a name="line.1548"></a> 1549 * When <jk>true</jk>, all bean properties will be serialized and access in alphabetical order.<a name="line.1549"></a> 1550 * Otherwise, the natural order of the bean properties is used which is dependent on the JVM vendor.<a name="line.1550"></a> 1551 * On IBM JVMs, the bean properties are ordered based on their ordering in the Java file.<a name="line.1551"></a> 1552 * On Oracle JVMs, the bean properties are not ordered (which follows the official JVM specs).<a name="line.1552"></a> 1553 * <a name="line.1553"></a> 1554 * <a name="line.1554"></a> 1555 * This property is disabled by default so that IBM JVM users don't have to use {@link Bean @Bean} annotations<a name="line.1555"></a> 1556 * to force bean properties to be in a particular order and can just alter the order of the fields/methods<a name="line.1556"></a> 1557 * in the Java file.<a name="line.1557"></a> 1558 * <a name="line.1558"></a> 1559 * <h5 class='section'>Example:</h5><a name="line.1559"></a> 1560 * <a name="line.1560"></a> 1561 * <jc>// Create a serializer that sorts bean properties.</jc><a name="line.1561"></a> 1562 * WriterSerializer s = JsonSerializer<a name="line.1562"></a> 1563 * .<jsm>create</jsm>()<a name="line.1563"></a> 1564 * .sortProperties()<a name="line.1564"></a> 1565 * .build();<a name="line.1565"></a> 1566 * <a name="line.1566"></a> 1567 * <jc>// Same, but use property.</jc><a name="line.1567"></a> 1568 * WriterSerializer s = JsonSerializer<a name="line.1568"></a> 1569 * .<jsm>create</jsm>()<a name="line.1569"></a> 1570 * .set(<jsf>BEAN_sortProperties</jsf>, <jk>true</jk>)<a name="line.1570"></a> 1571 * .build();<a name="line.1571"></a> 1572 * <a name="line.1572"></a> 1573 */<a name="line.1573"></a> 1574 public static final String BEAN_sortProperties = PREFIX + "sortProperties.b";<a name="line.1574"></a> 1575<a name="line.1575"></a> 1576 /**<a name="line.1576"></a> 1577 * Configuration property: TimeZone.<a name="line.1577"></a> 1578 * <a name="line.1578"></a> 1579 * <h5 class='section'>Property:</h5><a name="line.1579"></a> 1580 * <ul><a name="line.1580"></a> 1581 * <li>Name: <js>"BeanContext.timeZone.s"</js><a name="line.1581"></a> 1582 * <li>Data type: <code>String</code> ({@link TimeZone})<a name="line.1582"></a> 1583 * <li>Default: <jk>null</jk><a name="line.1583"></a> 1584 * <li>Session-overridable: <jk>true</jk><a name="line.1584"></a> 1585 * <li>Methods: <a name="line.1585"></a> 1586 * <ul><a name="line.1586"></a> 1587 * <li class='jm'>{@link BeanContextBuilder#timeZone(TimeZone)}<a name="line.1587"></a> 1588 * <li class='jm'>{@link BeanSessionArgs#timeZone(TimeZone)}<a name="line.1588"></a> 1589 * </ul><a name="line.1589"></a> 1590 * </ul><a name="line.1590"></a> 1591 * <a name="line.1591"></a> 1592 * <h5 class='section'>Example:</h5><a name="line.1592"></a> 1593 * <a name="line.1593"></a> 1594 * <jc>// Create a serializer that uses GMT if the timezone is not specified in the session args.</jc><a name="line.1594"></a> 1595 * WriterSerializer s = JsonSerializer<a name="line.1595"></a> 1596 * .<jsm>create</jsm>()<a name="line.1596"></a> 1597 * .timeZone(TimeZone.<jsf>GMT</jsf>)<a name="line.1597"></a> 1598 * .build();<a name="line.1598"></a> 1599 * <a name="line.1599"></a> 1600 * <jc>// Same, but use property.</jc><a name="line.1600"></a> 1601 * WriterSerializer s = JsonSerializer<a name="line.1601"></a> 1602 * .<jsm>create</jsm>()<a name="line.1602"></a> 1603 * .set(<jsf>BEAN_timeZone</jsf>, TimeZone.<jsf>GMT</jsf>)<a name="line.1603"></a> 1604 * .build();<a name="line.1604"></a> 1605 * <a name="line.1605"></a> 1606 * <jc>// Define on session-args instead.</jc><a name="line.1606"></a> 1607 * SerializerSessionArgs sessionArgs = <jk>new</jk> SerializerSessionArgs().timeZone(TimeZone.<jsf>GMT</jsf>);<a name="line.1607"></a> 1608 * <jk>try</jk> (WriterSerializerSession ss = JsonSerializer.<jsf>DEFAULT</jsf>.createSession(sessionArgs)) {<a name="line.1608"></a> 1609 * String json = s.serialize(<jk>new</jk> MyBean());<a name="line.1609"></a> 1610 * }<a name="line.1610"></a> 1611 * <a name="line.1611"></a> 1612 */<a name="line.1612"></a> 1613 public static final String BEAN_timeZone = PREFIX + "timeZone.s";<a name="line.1613"></a> 1614<a name="line.1614"></a> 1615 /**<a name="line.1615"></a> 1616 * Configuration property: Use interface proxies.<a name="line.1616"></a> 1617 * <a name="line.1617"></a> 1618 * <h5 class='section'>Property:</h5><a name="line.1618"></a> 1619 * <ul><a name="line.1619"></a> 1620 * <li>Name: <js>"BeanContext.useInterfaceProxies.b"</js><a name="line.1620"></a> 1621 * <li>Data type: <code>Boolean</code><a name="line.1621"></a> 1622 * <li>Default: <jk>true</jk><a name="line.1622"></a> 1623 * <li>Session-overridable: <jk>false</jk><a name="line.1623"></a> 1624 * <li>Methods: <a name="line.1624"></a> 1625 * <ul><a name="line.1625"></a> 1626 * <li class='jm'>{@link BeanContextBuilder#useInterfaceProxies(boolean)}<a name="line.1626"></a> 1627 * </ul><a name="line.1627"></a> 1628 * </ul><a name="line.1628"></a> 1629 * <a name="line.1629"></a> 1630 * <h5 class='section'>Description:</h5><a name="line.1630"></a> 1631 * <a name="line.1631"></a> 1632 * If <jk>true</jk>, then interfaces will be instantiated as proxy classes through the use of an<a name="line.1632"></a> 1633 * {@link InvocationHandler} if there is no other way of instantiating them.<a name="line.1633"></a> 1634 * Otherwise, throws a {@link BeanRuntimeException}.<a name="line.1634"></a> 1635 * <a name="line.1635"></a> 1636 * <h5 class='section'>Example:</h5><a name="line.1636"></a> 1637 * <a name="line.1637"></a> 1638 * <jc>// Create a parser that doesn't try to make interface proxies.</jc><a name="line.1638"></a> 1639 * ReaderParser p = JsonParser<a name="line.1639"></a> 1640 * .<jsm>create</jsm>()<a name="line.1640"></a> 1641 * .useInterfaceProxies(<jk>false</jk>)<a name="line.1641"></a> 1642 * .build();<a name="line.1642"></a> 1643 * <a name="line.1643"></a> 1644 * <jc>// Same, but use property.</jc><a name="line.1644"></a> 1645 * ReaderParser p = JsonParser<a name="line.1645"></a> 1646 * .<jsm>create</jsm>()<a name="line.1646"></a> 1647 * .set(<jsf>BEAN_useInterfaceProxies</jsf>, <jk>false</jk>)<a name="line.1647"></a> 1648 * .build();<a name="line.1648"></a> 1649 * <a name="line.1649"></a> 1650 */<a name="line.1650"></a> 1651 public static final String BEAN_useInterfaceProxies = PREFIX + "useInterfaceProxies.b";<a name="line.1651"></a> 1652<a name="line.1652"></a> 1653 /**<a name="line.1653"></a> 1654 * Configuration property: Use Java Introspector.<a name="line.1654"></a> 1655 * <a name="line.1655"></a> 1656 * <h5 class='section'>Property:</h5><a name="line.1656"></a> 1657 * <ul><a name="line.1657"></a> 1658 * <li>Name: <js>"BeanContext.useJavaBeanIntrospector.b"</js><a name="line.1658"></a> 1659 * <li>Data type: <code>Boolean</code><a name="line.1659"></a> 1660 * <li>Default: <jk>false</jk><a name="line.1660"></a> 1661 * <li>Session-overridable: <jk>false</jk><a name="line.1661"></a> 1662 * <li>Methods: <a name="line.1662"></a> 1663 * <ul><a name="line.1663"></a> 1664 * <li class='jm'>{@link BeanContextBuilder#useJavaBeanIntrospector(boolean)}<a name="line.1664"></a> 1665 * <li class='jm'>{@link BeanContextBuilder#useJavaBeanIntrospector()}<a name="line.1665"></a> 1666 * </ul><a name="line.1666"></a> 1667 * </ul><a name="line.1667"></a> 1668 * <a name="line.1668"></a> 1669 * <h5 class='section'>Description:</h5><a name="line.1669"></a> 1670 * <a name="line.1670"></a> 1671 * Using the built-in Java bean introspector will not pick up fields or non-standard getters/setters.<a name="line.1671"></a> 1672 * Most {@link Bean @Bean} annotations will be ignored.<a name="line.1672"></a> 1673 * <a name="line.1673"></a> 1674 * <h5 class='section'>Example:</h5><a name="line.1674"></a> 1675 * <a name="line.1675"></a> 1676 * <jc>// Create a serializer that only uses the built-in java bean introspector for finding properties.</jc><a name="line.1676"></a> 1677 * WriterSerializer s = JsonSerializer<a name="line.1677"></a> 1678 * .<jsm>create</jsm>()<a name="line.1678"></a> 1679 * .useJavaBeanIntrospector(<jk>false</jk>)<a name="line.1679"></a> 1680 * .build();<a name="line.1680"></a> 1681 * <a name="line.1681"></a> 1682 * <jc>// Same, but use property.</jc><a name="line.1682"></a> 1683 * WriterSerializer s = JsonSerializer<a name="line.1683"></a> 1684 * .<jsm>create</jsm>()<a name="line.1684"></a> 1685 * .set(<jsf>BEAN_useJavaBeanIntrospector</jsf>, <jk>false</jk>)<a name="line.1685"></a> 1686 * .build();<a name="line.1686"></a> 1687 * <a name="line.1687"></a> 1688 */<a name="line.1688"></a> 1689 public static final String BEAN_useJavaBeanIntrospector = PREFIX + "useJavaBeanIntrospector.b";<a name="line.1689"></a> 1690<a name="line.1690"></a> 1691 /*<a name="line.1691"></a> 1692 * The default package pattern exclusion list.<a name="line.1692"></a> 1693 * Any beans in packages in this list will not be considered beans.<a name="line.1693"></a> 1694 */<a name="line.1694"></a> 1695 private static final String[] DEFAULT_NOTBEAN_PACKAGES = {<a name="line.1695"></a> 1696 "java.lang",<a name="line.1696"></a> 1697 "java.lang.annotation",<a name="line.1697"></a> 1698 "java.lang.ref",<a name="line.1698"></a> 1699 "java.lang.reflect",<a name="line.1699"></a> 1700 "java.io",<a name="line.1700"></a> 1701 "java.net",<a name="line.1701"></a> 1702 "java.nio.*",<a name="line.1702"></a> 1703 "java.util.*"<a name="line.1703"></a> 1704 };<a name="line.1704"></a> 1705<a name="line.1705"></a> 1706 /*<a name="line.1706"></a> 1707 * The default bean class exclusion list.<a name="line.1707"></a> 1708 * Anything in this list will not be considered beans.<a name="line.1708"></a> 1709 */<a name="line.1709"></a> 1710 private static final Class<?>[] DEFAULT_NOTBEAN_CLASSES = {<a name="line.1710"></a> 1711 Map.class,<a name="line.1711"></a> 1712 Collection.class,<a name="line.1712"></a> 1713 Reader.class,<a name="line.1713"></a> 1714 Writer.class,<a name="line.1714"></a> 1715 InputStream.class,<a name="line.1715"></a> 1716 OutputStream.class,<a name="line.1716"></a> 1717 Throwable.class<a name="line.1717"></a> 1718 };<a name="line.1718"></a> 1719<a name="line.1719"></a> 1720<a name="line.1720"></a> 1721 // This map is important!<a name="line.1721"></a> 1722 // We may have many Context objects that have identical BeanContext properties.<a name="line.1722"></a> 1723 // This map ensures that if the BeanContext properties in the Context are the same,<a name="line.1723"></a> 1724 // then we reuse the same Class->ClassMeta cache map.<a name="line.1724"></a> 1725 // This significantly reduces the number of times we need to construct ClassMeta objects which can be expensive.<a name="line.1725"></a> 1726 private static final ConcurrentHashMap<Integer,Map<Class,ClassMeta>> cmCacheCache<a name="line.1726"></a> 1727 = new ConcurrentHashMap<>();<a name="line.1727"></a> 1728<a name="line.1728"></a> 1729 /** Default config. All default settings. */<a name="line.1729"></a> 1730 public static final BeanContext DEFAULT = BeanContext.create().build();<a name="line.1730"></a> 1731<a name="line.1731"></a> 1732 /** Default config. All default settings except sort bean properties. */<a name="line.1732"></a> 1733 public static final BeanContext DEFAULT_SORTED = BeanContext.create().sortProperties().build();<a name="line.1733"></a> 1734<a name="line.1734"></a> 1735 final boolean<a name="line.1735"></a> 1736 beansRequireDefaultConstructor,<a name="line.1736"></a> 1737 beansRequireSerializable,<a name="line.1737"></a> 1738 beansRequireSettersForGetters,<a name="line.1738"></a> 1739 beansRequireSomeProperties,<a name="line.1739"></a> 1740 beanMapPutReturnsOldValue,<a name="line.1740"></a> 1741 useInterfaceProxies,<a name="line.1741"></a> 1742 ignoreUnknownBeanProperties,<a name="line.1742"></a> 1743 ignoreUnknownNullBeanProperties,<a name="line.1743"></a> 1744 ignorePropertiesWithoutSetters,<a name="line.1744"></a> 1745 ignoreInvocationExceptionsOnGetters,<a name="line.1745"></a> 1746 ignoreInvocationExceptionsOnSetters,<a name="line.1746"></a> 1747 useJavaBeanIntrospector,<a name="line.1747"></a> 1748 sortProperties,<a name="line.1748"></a> 1749 debug;<a name="line.1749"></a> 1750<a name="line.1750"></a> 1751 final Visibility<a name="line.1751"></a> 1752 beanConstructorVisibility,<a name="line.1752"></a> 1753 beanClassVisibility,<a name="line.1753"></a> 1754 beanMethodVisibility,<a name="line.1754"></a> 1755 beanFieldVisibility;<a name="line.1755"></a> 1756<a name="line.1756"></a> 1757 final Class<?>[] notBeanClasses, beanDictionaryClasses;<a name="line.1757"></a> 1758 final String[] notBeanPackageNames, notBeanPackagePrefixes;<a name="line.1758"></a> 1759 final BeanFilter[] beanFilters;<a name="line.1759"></a> 1760 final PojoSwap<?,?>[] pojoSwaps;<a name="line.1760"></a> 1761 final BeanRegistry beanRegistry;<a name="line.1761"></a> 1762 final Map<String,Class<?>> implClasses;<a name="line.1762"></a> 1763 final Locale locale;<a name="line.1763"></a> 1764 final TimeZone timeZone;<a name="line.1764"></a> 1765 final MediaType mediaType;<a name="line.1765"></a> 1766 final Map<String,String[]> includeProperties, excludeProperties;<a name="line.1766"></a> 1767 final PropertyNamer propertyNamer;<a name="line.1767"></a> 1768<a name="line.1768"></a> 1769 final Map<Class,ClassMeta> cmCache;<a name="line.1769"></a> 1770 final ClassMeta<Object> cmObject; // Reusable ClassMeta that represents general Objects.<a name="line.1770"></a> 1771 final ClassMeta<String> cmString; // Reusable ClassMeta that represents general Strings.<a name="line.1771"></a> 1772 final ClassMeta<Class> cmClass; // Reusable ClassMeta that represents general Classes.<a name="line.1772"></a> 1773<a name="line.1773"></a> 1774 final String beanTypePropertyName;<a name="line.1774"></a> 1775<a name="line.1775"></a> 1776 final int beanHashCode;<a name="line.1776"></a> 1777<a name="line.1777"></a> 1778 /**<a name="line.1778"></a> 1779 * Constructor.<a name="line.1779"></a> 1780 * <a name="line.1780"></a> 1781 * <a name="line.1781"></a> 1782 * Typically only called from {@link ContextBuilder#build(Class)} method.<a name="line.1782"></a> 1783 * <a name="line.1783"></a> 1784 * @param ps The property store containing the unmodifiable configuration for this bean context.<a name="line.1784"></a> 1785 */<a name="line.1785"></a> 1786 public BeanContext(PropertyStore ps) {<a name="line.1786"></a> 1787 super(ps);<a name="line.1787"></a> 1788<a name="line.1788"></a> 1789 beanHashCode = ps.hashCode("BeanContext");<a name="line.1789"></a> 1790<a name="line.1790"></a> 1791 beansRequireDefaultConstructor = getBooleanProperty(BEAN_beansRequireDefaultConstructor, false);<a name="line.1791"></a> 1792 beansRequireSerializable = getBooleanProperty(BEAN_beansRequireSerializable, false);<a name="line.1792"></a> 1793 beansRequireSettersForGetters = getBooleanProperty(BEAN_beansRequireSettersForGetters, false);<a name="line.1793"></a> 1794 beansRequireSomeProperties = getBooleanProperty(BEAN_beansRequireSomeProperties, true);<a name="line.1794"></a> 1795 beanMapPutReturnsOldValue = getBooleanProperty(BEAN_beanMapPutReturnsOldValue, false);<a name="line.1795"></a> 1796 useInterfaceProxies = getBooleanProperty(BEAN_useInterfaceProxies, true);<a name="line.1796"></a> 1797 ignoreUnknownBeanProperties = getBooleanProperty(BEAN_ignoreUnknownBeanProperties, false);<a name="line.1797"></a> 1798 ignoreUnknownNullBeanProperties = getBooleanProperty(BEAN_ignoreUnknownNullBeanProperties, true);<a name="line.1798"></a> 1799 ignorePropertiesWithoutSetters = getBooleanProperty(BEAN_ignorePropertiesWithoutSetters, true);<a name="line.1799"></a> 1800 ignoreInvocationExceptionsOnGetters = getBooleanProperty(BEAN_ignoreInvocationExceptionsOnGetters, false);<a name="line.1800"></a> 1801 ignoreInvocationExceptionsOnSetters = getBooleanProperty(BEAN_ignoreInvocationExceptionsOnSetters, false);<a name="line.1801"></a> 1802 useJavaBeanIntrospector = getBooleanProperty(BEAN_useJavaBeanIntrospector, false);<a name="line.1802"></a> 1803 sortProperties = getBooleanProperty(BEAN_sortProperties, false);<a name="line.1803"></a> 1804 beanTypePropertyName = getStringProperty(BEAN_beanTypePropertyName, "_type");<a name="line.1804"></a> 1805 debug = getBooleanProperty(BEAN_debug, false);<a name="line.1805"></a> 1806<a name="line.1806"></a> 1807 beanConstructorVisibility = getProperty(BEAN_beanConstructorVisibility, Visibility.class, PUBLIC);<a name="line.1807"></a> 1808 beanClassVisibility = getProperty(BEAN_beanClassVisibility, Visibility.class, PUBLIC);<a name="line.1808"></a> 1809 beanMethodVisibility = getProperty(BEAN_beanMethodVisibility, Visibility.class, PUBLIC);<a name="line.1809"></a> 1810 beanFieldVisibility = getProperty(BEAN_beanFieldVisibility, Visibility.class, PUBLIC);<a name="line.1810"></a> 1811<a name="line.1811"></a> 1812 notBeanClasses = getClassArrayProperty(BEAN_notBeanClasses, DEFAULT_NOTBEAN_CLASSES);<a name="line.1812"></a> 1813 <a name="line.1813"></a> 1814 propertyNamer = getInstanceProperty(BEAN_propertyNamer, PropertyNamer.class, PropertyNamerDefault.class);<a name="line.1814"></a> 1815<a name="line.1815"></a> 1816 List<String> l1 = new LinkedList<>();<a name="line.1816"></a> 1817 List<String> l2 = new LinkedList<>();<a name="line.1817"></a> 1818 for (String s : getArrayProperty(BEAN_notBeanPackages, String.class, DEFAULT_NOTBEAN_PACKAGES)) {<a name="line.1818"></a> 1819 if (s.endsWith(".*"))<a name="line.1819"></a> 1820 l2.add(s.substring(0, s.length()-2));<a name="line.1820"></a> 1821 else<a name="line.1821"></a> 1822 l1.add(s);<a name="line.1822"></a> 1823 }<a name="line.1823"></a> 1824 notBeanPackageNames = l1.toArray(new String[l1.size()]);<a name="line.1824"></a> 1825 notBeanPackagePrefixes = l2.toArray(new String[l2.size()]);<a name="line.1825"></a> 1826<a name="line.1826"></a> 1827 LinkedList<BeanFilter> lbf = new LinkedList<>();<a name="line.1827"></a> 1828 for (Class<?> c : getClassListProperty(BEAN_beanFilters)) {<a name="line.1828"></a> 1829 if (isParentClass(BeanFilter.class, c))<a name="line.1829"></a> 1830 lbf.add(newInstance(BeanFilter.class, c));<a name="line.1830"></a> 1831 else if (isParentClass(BeanFilterBuilder.class, c))<a name="line.1831"></a> 1832 lbf.add(newInstance(BeanFilterBuilder.class, c).build());<a name="line.1832"></a> 1833 else<a name="line.1833"></a> 1834 lbf.add(new InterfaceBeanFilterBuilder(c).build());<a name="line.1834"></a> 1835 }<a name="line.1835"></a> 1836 beanFilters = lbf.toArray(new BeanFilter[0]);<a name="line.1836"></a> 1837<a name="line.1837"></a> 1838 LinkedList<PojoSwap<?,?>> lpf = new LinkedList<>();<a name="line.1838"></a> 1839 for (Class<?> c : getClassListProperty(BEAN_pojoSwaps)) {<a name="line.1839"></a> 1840 if (isParentClass(PojoSwap.class, c))<a name="line.1840"></a> 1841 lpf.add(newInstance(PojoSwap.class, c));<a name="line.1841"></a> 1842 else if (isParentClass(Surrogate.class, c))<a name="line.1842"></a> 1843 lpf.addAll(SurrogateSwap.findPojoSwaps(c));<a name="line.1843"></a> 1844 else<a name="line.1844"></a> 1845 throw new FormattedRuntimeException("Invalid class {0} specified in BeanContext.pojoSwaps property. Must be a subclass of PojoSwap or Surrogate.", c);<a name="line.1845"></a> 1846 }<a name="line.1846"></a> 1847 pojoSwaps = lpf.toArray(new PojoSwap[lpf.size()]);<a name="line.1847"></a> 1848 <a name="line.1848"></a> 1849 implClasses = getClassMapProperty(BEAN_implClasses);<a name="line.1849"></a> 1850 <a name="line.1850"></a> 1851 Map<String,String[]> m2 = new HashMap<>();<a name="line.1851"></a> 1852 for (Map.Entry<String,String> e : getMapProperty(BEAN_includeProperties, String.class).entrySet())<a name="line.1852"></a> 1853 m2.put(e.getKey(), StringUtils.split(e.getValue()));<a name="line.1853"></a> 1854 includeProperties = unmodifiableMap(m2);<a name="line.1854"></a> 1855<a name="line.1855"></a> 1856 m2 = new HashMap<>();<a name="line.1856"></a> 1857 for (Map.Entry<String,String> e : getMapProperty(BEAN_excludeProperties, String.class).entrySet())<a name="line.1857"></a> 1858 m2.put(e.getKey(), StringUtils.split(e.getValue()));<a name="line.1858"></a> 1859 excludeProperties = unmodifiableMap(m2);<a name="line.1859"></a> 1860<a name="line.1860"></a> 1861 locale = getInstanceProperty(BEAN_locale, Locale.class, null);<a name="line.1861"></a> 1862 timeZone = getInstanceProperty(BEAN_timeZone, TimeZone.class, null);<a name="line.1862"></a> 1863 mediaType = getInstanceProperty(BEAN_mediaType, MediaType.class, null);<a name="line.1863"></a> 1864 <a name="line.1864"></a> 1865 if (! cmCacheCache.containsKey(beanHashCode)) {<a name="line.1865"></a> 1866 ConcurrentHashMap<Class,ClassMeta> cm = new ConcurrentHashMap<>();<a name="line.1866"></a> 1867 cm.putIfAbsent(String.class, new ClassMeta(String.class, this, null, null, findPojoSwaps(String.class), findChildPojoSwaps(String.class)));<a name="line.1867"></a> 1868 cm.putIfAbsent(Object.class, new ClassMeta(Object.class, this, null, null, findPojoSwaps(Object.class), findChildPojoSwaps(Object.class)));<a name="line.1868"></a> 1869 cmCacheCache.putIfAbsent(beanHashCode, cm);<a name="line.1869"></a> 1870 }<a name="line.1870"></a> 1871 cmCache = cmCacheCache.get(beanHashCode);<a name="line.1871"></a> 1872 cmString = cmCache.get(String.class);<a name="line.1872"></a> 1873 cmObject = cmCache.get(Object.class);<a name="line.1873"></a> 1874 cmClass = cmCache.get(Class.class);<a name="line.1874"></a> 1875<a name="line.1875"></a> 1876 beanDictionaryClasses = getClassArrayProperty(BEAN_beanDictionary);<a name="line.1876"></a> 1877 beanRegistry = new BeanRegistry(this, null);<a name="line.1877"></a> 1878 }<a name="line.1878"></a> 1879<a name="line.1879"></a> 1880 @Override /* Context */<a name="line.1880"></a> 1881 public BeanContextBuilder builder() {<a name="line.1881"></a> 1882 return new BeanContextBuilder(getPropertyStore());<a name="line.1882"></a> 1883 }<a name="line.1883"></a> 1884 <a name="line.1884"></a> 1885 /**<a name="line.1885"></a> 1886 * Instantiates a new clean-slate {@link BeanContextBuilder} object.<a name="line.1886"></a> 1887 * <a name="line.1887"></a> 1888 * <a name="line.1888"></a> 1889 * This is equivalent to simply calling <code><jk>new</jk> BeanContextBuilder()</code>.<a name="line.1889"></a> 1890 * <a name="line.1890"></a> 1891 * @return A new {@link JsonSerializerBuilder} object.<a name="line.1891"></a> 1892 */<a name="line.1892"></a> 1893 public static BeanContextBuilder create() {<a name="line.1893"></a> 1894 return new BeanContextBuilder();<a name="line.1894"></a> 1895 }<a name="line.1895"></a> 1896<a name="line.1896"></a> 1897 /**<a name="line.1897"></a> 1898 * Create a new bean session based on the properties defined on this context.<a name="line.1898"></a> 1899 * <a name="line.1899"></a> 1900 * <a name="line.1900"></a> 1901 * Use this method for creating sessions if you don't need to override any<a name="line.1901"></a> 1902 * properties or locale/timezone currently set on this context.<a name="line.1902"></a> 1903 * <a name="line.1903"></a> 1904 * @return A new session object.<a name="line.1904"></a> 1905 */<a name="line.1905"></a> 1906 @Override /* Context */<a name="line.1906"></a> 1907 public BeanSession createSession() {<a name="line.1907"></a> 1908 return createBeanSession(createDefaultSessionArgs());<a name="line.1908"></a> 1909 }<a name="line.1909"></a> 1910<a name="line.1910"></a> 1911 /**<a name="line.1911"></a> 1912 * Create a new bean session based on the properties defined on this context combined with the specified<a name="line.1912"></a> 1913 * runtime args.<a name="line.1913"></a> 1914 * <a name="line.1914"></a> 1915 * <a name="line.1915"></a> 1916 * Use this method for creating sessions if you don't need to override any<a name="line.1916"></a> 1917 * properties or locale/timezone currently set on this context.<a name="line.1917"></a> 1918 * <a name="line.1918"></a> 1919 * @param args <a name="line.1919"></a> 1920 * The session arguments.<a name="line.1920"></a> 1921 * @return A new session object.<a name="line.1921"></a> 1922 */<a name="line.1922"></a> 1923 public BeanSession createSession(BeanSessionArgs args) {<a name="line.1923"></a> 1924 return createBeanSession(args);<a name="line.1924"></a> 1925 }<a name="line.1925"></a> 1926<a name="line.1926"></a> 1927 @Override /* Context */<a name="line.1927"></a> 1928 public final Session createSession(SessionArgs args) {<a name="line.1928"></a> 1929 throw new NoSuchMethodError();<a name="line.1929"></a> 1930 }<a name="line.1930"></a> 1931 <a name="line.1931"></a> 1932 /**<a name="line.1932"></a> 1933 * Same as {@link #createSession(BeanSessionArgs)} except always returns a {@link BeanSession} object unlike {@link #createSession(BeanSessionArgs)} <a name="line.1933"></a> 1934 * which is meant to be overridden by subclasses.<a name="line.1934"></a> 1935 * <a name="line.1935"></a> 1936 * @param args The session arguments.<a name="line.1936"></a> 1937 * @return A new session object.<a name="line.1937"></a> 1938 */<a name="line.1938"></a> 1939 public final BeanSession createBeanSession(BeanSessionArgs args) {<a name="line.1939"></a> 1940 return new BeanSession(this, args);<a name="line.1940"></a> 1941 }<a name="line.1941"></a> 1942 <a name="line.1942"></a> 1943 /**<a name="line.1943"></a> 1944 * Same as {@link #createSession()} except always returns a {@link BeanSession} object unlike {@link #createSession()} <a name="line.1944"></a> 1945 * which is meant to be overridden by subclasses.<a name="line.1945"></a> 1946 * <a name="line.1946"></a> 1947 * @return A new session object.<a name="line.1947"></a> 1948 */<a name="line.1948"></a> 1949 public final BeanSession createBeanSession() {<a name="line.1949"></a> 1950 return new BeanSession(this, createDefaultBeanSessionArgs());<a name="line.1950"></a> 1951 }<a name="line.1951"></a> 1952 <a name="line.1952"></a> 1953 @Override /* Context */<a name="line.1953"></a> 1954 public BeanSessionArgs createDefaultSessionArgs() {<a name="line.1954"></a> 1955 return createDefaultBeanSessionArgs();<a name="line.1955"></a> 1956 }<a name="line.1956"></a> 1957 <a name="line.1957"></a> 1958 /**<a name="line.1958"></a> 1959 * Same as {@link #createDefaultSessionArgs()} except always returns a {@link BeanSessionArgs} unlike<a name="line.1959"></a> 1960 * {@link #createDefaultBeanSessionArgs()} which is meant to be overridden by subclasses.<a name="line.1960"></a> 1961 * <a name="line.1961"></a> 1962 * @return A new session arguments object.<a name="line.1962"></a> 1963 */<a name="line.1963"></a> 1964 public final BeanSessionArgs createDefaultBeanSessionArgs() {<a name="line.1964"></a> 1965 return new BeanSessionArgs(null, null, null, null);<a name="line.1965"></a> 1966 }<a name="line.1966"></a> 1967 <a name="line.1967"></a> 1968 /**<a name="line.1968"></a> 1969 * Returns <jk>true</jk> if the specified bean context shares the same cache as this bean context.<a name="line.1969"></a> 1970 * <a name="line.1970"></a> 1971 * <a name="line.1971"></a> 1972 * Useful for testing purposes.<a name="line.1972"></a> 1973 * <a name="line.1973"></a> 1974 * @param bc The bean context to compare to.<a name="line.1974"></a> 1975 * @return <jk>true</jk> if the bean contexts have equivalent settings and thus share caches.<a name="line.1975"></a> 1976 */<a name="line.1976"></a> 1977 public final boolean hasSameCache(BeanContext bc) {<a name="line.1977"></a> 1978 return bc.cmCache == this.cmCache;<a name="line.1978"></a> 1979 }<a name="line.1979"></a> 1980<a name="line.1980"></a> 1981 /**<a name="line.1981"></a> 1982 * Determines whether the specified class is ignored as a bean class based on the various exclusion parameters<a name="line.1982"></a> 1983 * specified on this context class.<a name="line.1983"></a> 1984 * <a name="line.1984"></a> 1985 * @param c The class type being tested.<a name="line.1985"></a> 1986 * @return <jk>true</jk> if the specified class matches any of the exclusion parameters.<a name="line.1986"></a> 1987 */<a name="line.1987"></a> 1988 protected final boolean isNotABean(Class<?> c) {<a name="line.1988"></a> 1989 if (c.isArray() || c.isPrimitive() || c.isEnum() || c.isAnnotation())<a name="line.1989"></a> 1990 return true;<a name="line.1990"></a> 1991 Package p = c.getPackage();<a name="line.1991"></a> 1992 if (p != null) {<a name="line.1992"></a> 1993 for (String p2 : notBeanPackageNames)<a name="line.1993"></a> 1994 if (p.getName().equals(p2))<a name="line.1994"></a> 1995 return true;<a name="line.1995"></a> 1996 for (String p2 : notBeanPackagePrefixes)<a name="line.1996"></a> 1997 if (p.getName().startsWith(p2))<a name="line.1997"></a> 1998 return true;<a name="line.1998"></a> 1999 }<a name="line.1999"></a> 2000 for (Class exclude : notBeanClasses)<a name="line.2000"></a> 2001 if (isParentClass(exclude, c))<a name="line.2001"></a> 2002 return true;<a name="line.2002"></a> 2003 return false;<a name="line.2003"></a> 2004 }<a name="line.2004"></a> 2005<a name="line.2005"></a> 2006 /**<a name="line.2006"></a> 2007 * Returns <jk>true</jk> if the specified object is a bean.<a name="line.2007"></a> 2008 * <a name="line.2008"></a> 2009 * @param o The object to test.<a name="line.2009"></a> 2010 * @return <jk>true</jk> if the specified object is a bean. <jk>false</jk> if the bean is <jk>null</jk>.<a name="line.2010"></a> 2011 */<a name="line.2011"></a> 2012 public boolean isBean(Object o) {<a name="line.2012"></a> 2013 if (o == null)<a name="line.2013"></a> 2014 return false;<a name="line.2014"></a> 2015 return getClassMetaForObject(o).isBean();<a name="line.2015"></a> 2016 }<a name="line.2016"></a> 2017<a name="line.2017"></a> 2018 /**<a name="line.2018"></a> 2019 * Prints meta cache statistics to <code>System.out</code>.<a name="line.2019"></a> 2020 */<a name="line.2020"></a> 2021 protected static void dumpCacheStats() {<a name="line.2021"></a> 2022 try {<a name="line.2022"></a> 2023 int ctCount = 0;<a name="line.2023"></a> 2024 for (Map<Class,ClassMeta> cm : cmCacheCache.values())<a name="line.2024"></a> 2025 ctCount += cm.size();<a name="line.2025"></a> 2026 System.out.println(format("ClassMeta cache: {0} instances in {1} caches", ctCount, cmCacheCache.size())); // NOT DEBUG<a name="line.2026"></a> 2027 } catch (Exception e) {<a name="line.2027"></a> 2028 e.printStackTrace();<a name="line.2028"></a> 2029 }<a name="line.2029"></a> 2030 }<a name="line.2030"></a> 2031<a name="line.2031"></a> 2032 /**<a name="line.2032"></a> 2033 * Returns the {@link BeanMeta} class for the specified class.<a name="line.2033"></a> 2034 * <a name="line.2034"></a> 2035 * @param <T> The class type to get the meta-data on.<a name="line.2035"></a> 2036 * @param c The class to get the meta-data on.<a name="line.2036"></a> 2037 * @return<a name="line.2037"></a> 2038 * The {@link BeanMeta} for the specified class, or <jk>null</jk> if the class is not a bean per the settings on<a name="line.2038"></a> 2039 * this context.<a name="line.2039"></a> 2040 */<a name="line.2040"></a> 2041 public final <T> BeanMeta<T> getBeanMeta(Class<T> c) {<a name="line.2041"></a> 2042 if (c == null)<a name="line.2042"></a> 2043 return null;<a name="line.2043"></a> 2044 return getClassMeta(c).getBeanMeta();<a name="line.2044"></a> 2045 }<a name="line.2045"></a> 2046<a name="line.2046"></a> 2047 /**<a name="line.2047"></a> 2048 * Construct a {@code ClassMeta} wrapper around a {@link Class} object.<a name="line.2048"></a> 2049 * <a name="line.2049"></a> 2050 * @param <T> The class type being wrapped.<a name="line.2050"></a> 2051 * @param type The class to resolve.<a name="line.2051"></a> 2052 * @return<a name="line.2052"></a> 2053 * If the class is not an array, returns a cached {@link ClassMeta} object.<a name="line.2053"></a> 2054 * Otherwise, returns a new {@link ClassMeta} object every time.<a name="line.2054"></a> 2055 */<a name="line.2055"></a> 2056 public final <T> ClassMeta<T> getClassMeta(Class<T> type) {<a name="line.2056"></a> 2057 return getClassMeta(type, true);<a name="line.2057"></a> 2058 }<a name="line.2058"></a> 2059<a name="line.2059"></a> 2060 /**<a name="line.2060"></a> 2061 * Construct a {@code ClassMeta} wrapper around a {@link Class} object.<a name="line.2061"></a> 2062 * <a name="line.2062"></a> 2063 * @param <T> The class type being wrapped.<a name="line.2063"></a> 2064 * @param type The class to resolve.<a name="line.2064"></a> 2065 * @param waitForInit<a name="line.2065"></a> 2066 * If <jk>true</jk>, wait for the ClassMeta constructor to finish before returning.<a name="line.2066"></a> 2067 * @return<a name="line.2067"></a> 2068 * If the class is not an array, returns a cached {@link ClassMeta} object.<a name="line.2068"></a> 2069 * Otherwise, returns a new {@link ClassMeta} object every time.<a name="line.2069"></a> 2070 */<a name="line.2070"></a> 2071 final <T> ClassMeta<T> getClassMeta(Class<T> type, boolean waitForInit) {<a name="line.2071"></a> 2072<a name="line.2072"></a> 2073 // If this is an array, then we want it wrapped in an uncached ClassMeta object.<a name="line.2073"></a> 2074 // Note that if it has a pojo swap, we still want to cache it so that<a name="line.2074"></a> 2075 // we can cache something like byte[] with ByteArrayBase64Swap.<a name="line.2075"></a> 2076 if (type.isArray() && findPojoSwaps(type) == null)<a name="line.2076"></a> 2077 return new ClassMeta(type, this, findImplClass(type), findBeanFilter(type), findPojoSwaps(type), findChildPojoSwaps(type));<a name="line.2077"></a> 2078<a name="line.2078"></a> 2079 // This can happen if we have transforms defined against String or Object.<a name="line.2079"></a> 2080 if (cmCache == null)<a name="line.2080"></a> 2081 return null;<a name="line.2081"></a> 2082<a name="line.2082"></a> 2083 ClassMeta<T> cm = cmCache.get(type);<a name="line.2083"></a> 2084 if (cm == null) {<a name="line.2084"></a> 2085<a name="line.2085"></a> 2086 synchronized (this) {<a name="line.2086"></a> 2087 // Make sure someone didn't already set it while this thread was blocked.<a name="line.2087"></a> 2088 cm = cmCache.get(type);<a name="line.2088"></a> 2089 if (cm == null)<a name="line.2089"></a> 2090 cm = new ClassMeta<>(type, this, findImplClass(type), findBeanFilter(type), findPojoSwaps(type), findChildPojoSwaps(type));<a name="line.2090"></a> 2091 }<a name="line.2091"></a> 2092 }<a name="line.2092"></a> 2093 if (waitForInit)<a name="line.2093"></a> 2094 cm.waitForInit();<a name="line.2094"></a> 2095 return cm;<a name="line.2095"></a> 2096 }<a name="line.2096"></a> 2097<a name="line.2097"></a> 2098 /**<a name="line.2098"></a> 2099 * Used to resolve <code>ClassMetas</code> of type <code>Collection</code> and <code>Map</code> that have<a name="line.2099"></a> 2100 * <code>ClassMeta</code> values that themselves could be collections or maps.<a name="line.2100"></a> 2101 * <a name="line.2101"></a> 2102 * <a name="line.2102"></a> 2103 * <code>Collection</code> meta objects are assumed to be followed by zero or one meta objects indicating the element type.<a name="line.2103"></a> 2104 * <a name="line.2104"></a> 2105 * <a name="line.2105"></a> 2106 * <code>Map</code> meta objects are assumed to be followed by zero or two meta objects indicating the key and value types.<a name="line.2106"></a> 2107 * <a name="line.2107"></a> 2108 * <a name="line.2108"></a> 2109 * The array can be arbitrarily long to indicate arbitrarily complex data structures.<a name="line.2109"></a> 2110 * <a name="line.2110"></a> 2111 * <h5 class='section'>Examples:</h5><a name="line.2111"></a> 2112 * <ul><a name="line.2112"></a> 2113 * <li><code>getClassMeta(String.<jk>class</jk>);</code> - A normal type.<a name="line.2113"></a> 2114 * <li><code>getClassMeta(List.<jk>class</jk>);</code> - A list containing objects.<a name="line.2114"></a> 2115 * <li><code>getClassMeta(List.<jk>class</jk>, String.<jk>class</jk>);</code> - A list containing strings.<a name="line.2115"></a> 2116 * <li><code>getClassMeta(LinkedList.<jk>class</jk>, String.<jk>class</jk>);</code> - A linked-list containing<a name="line.2116"></a> 2117 * strings.<a name="line.2117"></a> 2118 * <li><code>getClassMeta(LinkedList.<jk>class</jk>, LinkedList.<jk>class</jk>, String.<jk>class</jk>);</code> -<a name="line.2118"></a> 2119 * A linked-list containing linked-lists of strings.<a name="line.2119"></a> 2120 * <li><code>getClassMeta(Map.<jk>class</jk>);</code> - A map containing object keys/values.<a name="line.2120"></a> 2121 * <li><code>getClassMeta(Map.<jk>class</jk>, String.<jk>class</jk>, String.<jk>class</jk>);</code> - A map<a name="line.2121"></a> 2122 * containing string keys/values.<a name="line.2122"></a> 2123 * <li><code>getClassMeta(Map.<jk>class</jk>, String.<jk>class</jk>, List.<jk>class</jk>, MyBean.<jk>class</jk>);</code> -<a name="line.2123"></a> 2124 * A map containing string keys and values of lists containing beans.<a name="line.2124"></a> 2125 * </ul><a name="line.2125"></a> 2126 * <a name="line.2126"></a> 2127 * @param type<a name="line.2127"></a> 2128 * The class to resolve.<a name="line.2128"></a> 2129 * Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}<a name="line.2129"></a> 2130 * @param args<a name="line.2130"></a> 2131 * The type arguments of the class if it's a collection or map.<a name="line.2131"></a> 2132 * Can be any of the following: {@link ClassMeta}, {@link Class}, {@link ParameterizedType}, {@link GenericArrayType}<a name="line.2132"></a> 2133 * Ignored if the main type is not a map or collection.<a name="line.2133"></a> 2134 * @return The resolved class meta.<a name="line.2134"></a> 2135 */<a name="line.2135"></a> 2136 public final <T> ClassMeta<T> getClassMeta(Type type, Type...args) {<a name="line.2136"></a> 2137 if (type == null)<a name="line.2137"></a> 2138 return null;<a name="line.2138"></a> 2139 ClassMeta<T> cm = type instanceof Class ? getClassMeta((Class)type) : resolveClassMeta(type, null);<a name="line.2139"></a> 2140 if (args.length == 0)<a name="line.2140"></a> 2141 return cm;<a name="line.2141"></a> 2142 ClassMeta<?>[] cma = new ClassMeta[args.length+1];<a name="line.2142"></a> 2143 cma[0] = cm;<a name="line.2143"></a> 2144 for (int i = 0; i < Array.getLength(args); i++) {<a name="line.2144"></a> 2145 Type arg = (Type)Array.get(args, i);<a name="line.2145"></a> 2146 cma[i+1] = arg instanceof Class ? getClassMeta((Class)arg) : resolveClassMeta(arg, null);<a name="line.2146"></a> 2147 }<a name="line.2147"></a> 2148 return (ClassMeta<T>) getTypedClassMeta(cma, 0);<a name="line.2148"></a> 2149 }<a name="line.2149"></a> 2150<a name="line.2150"></a> 2151 /*<a name="line.2151"></a> 2152 * Resolves the 'genericized' class meta at the specified position in the ClassMeta array.<a name="line.2152"></a> 2153 */<a name="line.2153"></a> 2154 private ClassMeta<?> getTypedClassMeta(ClassMeta<?>[] c, int pos) {<a name="line.2154"></a> 2155 ClassMeta<?> cm = c[pos++];<a name="line.2155"></a> 2156 if (cm.isCollection()) {<a name="line.2156"></a> 2157 ClassMeta<?> ce = c.length == pos ? object() : getTypedClassMeta(c, pos);<a name="line.2157"></a> 2158 return (ce.isObject() ? cm : new ClassMeta(cm, null, null, ce));<a name="line.2158"></a> 2159 } else if (cm.isMap()) {<a name="line.2159"></a> 2160 ClassMeta<?> ck = c.length == pos ? object() : c[pos++];<a name="line.2160"></a> 2161 ClassMeta<?> cv = c.length == pos ? object() : getTypedClassMeta(c, pos);<a name="line.2161"></a> 2162 return (ck.isObject() && cv.isObject() ? cm : new ClassMeta(cm, ck, cv, null));<a name="line.2162"></a> 2163 }<a name="line.2163"></a> 2164 return cm;<a name="line.2164"></a> 2165 }<a name="line.2165"></a> 2166<a name="line.2166"></a> 2167 final ClassMeta resolveClassMeta(Type o, Map<Class<?>,Class<?>[]> typeVarImpls) {<a name="line.2167"></a> 2168 if (o == null)<a name="line.2168"></a> 2169 return null;<a name="line.2169"></a> 2170<a name="line.2170"></a> 2171 if (o instanceof ClassMeta) {<a name="line.2171"></a> 2172 ClassMeta<?> cm = (ClassMeta)o;<a name="line.2172"></a> 2173<a name="line.2173"></a> 2174 // This classmeta could have been created by a different context.<a name="line.2174"></a> 2175 // Need to re-resolve it to pick up PojoSwaps and stuff on this context.<a name="line.2175"></a> 2176 if (cm.getBeanContext() == this)<a name="line.2176"></a> 2177 return cm;<a name="line.2177"></a> 2178 if (cm.isMap())<a name="line.2178"></a> 2179 return getClassMeta(cm.innerClass, cm.getKeyType(), cm.getValueType());<a name="line.2179"></a> 2180 if (cm.isCollection())<a name="line.2180"></a> 2181 return getClassMeta(cm.innerClass, cm.getElementType());<a name="line.2181"></a> 2182 return getClassMeta(cm.innerClass);<a name="line.2182"></a> 2183 }<a name="line.2183"></a> 2184<a name="line.2184"></a> 2185 Class c = resolve(o, typeVarImpls);<a name="line.2185"></a> 2186<a name="line.2186"></a> 2187 // This can happen when trying to resolve the "E getFirst()" method on LinkedList, whose type is a TypeVariable<a name="line.2187"></a> 2188 // These should just resolve to Object.<a name="line.2188"></a> 2189 if (c == null)<a name="line.2189"></a> 2190 return object();<a name="line.2190"></a> 2191<a name="line.2191"></a> 2192 ClassMeta rawType = getClassMeta(c);<a name="line.2192"></a> 2193<a name="line.2193"></a> 2194 // If this is a Map or Collection, and the parameter types aren't part<a name="line.2194"></a> 2195 // of the class definition itself (e.g. class AddressBook extends List<Person>),<a name="line.2195"></a> 2196 // then we need to figure out the parameters.<a name="line.2196"></a> 2197 if (rawType.isMap() || rawType.isCollection()) {<a name="line.2197"></a> 2198 ClassMeta[] params = findParameters(o, c);<a name="line.2198"></a> 2199 if (params == null)<a name="line.2199"></a> 2200 return rawType;<a name="line.2200"></a> 2201 if (rawType.isMap()) {<a name="line.2201"></a> 2202 if (params.length != 2)<a name="line.2202"></a> 2203 return rawType;<a name="line.2203"></a> 2204 if (params[0].isObject() && params[1].isObject())<a name="line.2204"></a> 2205 return rawType;<a name="line.2205"></a> 2206 return new ClassMeta(rawType, params[0], params[1], null);<a name="line.2206"></a> 2207 }<a name="line.2207"></a> 2208 if (rawType.isCollection()) {<a name="line.2208"></a> 2209 if (params.length != 1)<a name="line.2209"></a> 2210 return rawType;<a name="line.2210"></a> 2211 if (params[0].isObject())<a name="line.2211"></a> 2212 return rawType;<a name="line.2212"></a> 2213 return new ClassMeta(rawType, null, null, params[0]);<a name="line.2213"></a> 2214 }<a name="line.2214"></a> 2215 }<a name="line.2215"></a> 2216<a name="line.2216"></a> 2217 return rawType;<a name="line.2217"></a> 2218 }<a name="line.2218"></a> 2219<a name="line.2219"></a> 2220 /**<a name="line.2220"></a> 2221 * Convert a Type to a Class if possible.<a name="line.2221"></a> 2222 * Return null if not possible.<a name="line.2222"></a> 2223 */<a name="line.2223"></a> 2224 final Class resolve(Type t, Map<Class<?>,Class<?>[]> typeVarImpls) {<a name="line.2224"></a> 2225<a name="line.2225"></a> 2226 if (t instanceof Class)<a name="line.2226"></a> 2227 return (Class)t;<a name="line.2227"></a> 2228<a name="line.2228"></a> 2229 if (t instanceof ParameterizedType)<a name="line.2229"></a> 2230 // A parameter (e.g. <String>.<a name="line.2230"></a> 2231 return (Class)((ParameterizedType)t).getRawType();<a name="line.2231"></a> 2232<a name="line.2232"></a> 2233 if (t instanceof GenericArrayType) {<a name="line.2233"></a> 2234 // An array parameter (e.g. <byte[]>).<a name="line.2234"></a> 2235 Type gatct = ((GenericArrayType)t).getGenericComponentType();<a name="line.2235"></a> 2236<a name="line.2236"></a> 2237 if (gatct instanceof Class)<a name="line.2237"></a> 2238 return Array.newInstance((Class)gatct, 0).getClass();<a name="line.2238"></a> 2239<a name="line.2239"></a> 2240 if (gatct instanceof ParameterizedType)<a name="line.2240"></a> 2241 return Array.newInstance((Class)((ParameterizedType)gatct).getRawType(), 0).getClass();<a name="line.2241"></a> 2242<a name="line.2242"></a> 2243 if (gatct instanceof GenericArrayType)<a name="line.2243"></a> 2244 return Array.newInstance(resolve(gatct, typeVarImpls), 0).getClass();<a name="line.2244"></a> 2245<a name="line.2245"></a> 2246 return null;<a name="line.2246"></a> 2247<a name="line.2247"></a> 2248 } else if (t instanceof TypeVariable) {<a name="line.2248"></a> 2249 if (typeVarImpls != null) {<a name="line.2249"></a> 2250 TypeVariable tv = (TypeVariable)t;<a name="line.2250"></a> 2251 String varName = tv.getName();<a name="line.2251"></a> 2252 int varIndex = -1;<a name="line.2252"></a> 2253 Class gc = (Class)tv.getGenericDeclaration();<a name="line.2253"></a> 2254 TypeVariable[] tvv = gc.getTypeParameters();<a name="line.2254"></a> 2255 for (int i = 0; i < tvv.length; i++) {<a name="line.2255"></a> 2256 if (tvv[i].getName().equals(varName)) {<a name="line.2256"></a> 2257 varIndex = i;<a name="line.2257"></a> 2258 }<a name="line.2258"></a> 2259 }<a name="line.2259"></a> 2260 if (varIndex != -1) {<a name="line.2260"></a> 2261<a name="line.2261"></a> 2262 // If we couldn't find a type variable implementation, that means<a name="line.2262"></a> 2263 // the type was defined at runtime (e.g. Bean b = new Bean<Foo>();)<a name="line.2263"></a> 2264 // in which case the type is lost through erasure.<a name="line.2264"></a> 2265 // Assume java.lang.Object as the type.<a name="line.2265"></a> 2266 if (! typeVarImpls.containsKey(gc))<a name="line.2266"></a> 2267 return null;<a name="line.2267"></a> 2268<a name="line.2268"></a> 2269 return typeVarImpls.get(gc)[varIndex];<a name="line.2269"></a> 2270 }<a name="line.2270"></a> 2271 }<a name="line.2271"></a> 2272 }<a name="line.2272"></a> 2273 return null;<a name="line.2273"></a> 2274 }<a name="line.2274"></a> 2275<a name="line.2275"></a> 2276 final ClassMeta[] findParameters(Type o, Class c) {<a name="line.2276"></a> 2277 if (o == null)<a name="line.2277"></a> 2278 o = c;<a name="line.2278"></a> 2279<a name="line.2279"></a> 2280 // Loop until we find a ParameterizedType<a name="line.2280"></a> 2281 if (! (o instanceof ParameterizedType)) {<a name="line.2281"></a> 2282 loop: do {<a name="line.2282"></a> 2283 o = c.getGenericSuperclass();<a name="line.2283"></a> 2284 if (o instanceof ParameterizedType)<a name="line.2284"></a> 2285 break loop;<a name="line.2285"></a> 2286 for (Type t : c.getGenericInterfaces()) {<a name="line.2286"></a> 2287 o = t;<a name="line.2287"></a> 2288 if (o instanceof ParameterizedType)<a name="line.2288"></a> 2289 break loop;<a name="line.2289"></a> 2290 }<a name="line.2290"></a> 2291 c = c.getSuperclass();<a name="line.2291"></a> 2292 } while (c != null);<a name="line.2292"></a> 2293 }<a name="line.2293"></a> 2294<a name="line.2294"></a> 2295 if (o instanceof ParameterizedType) {<a name="line.2295"></a> 2296 ParameterizedType pt = (ParameterizedType)o;<a name="line.2296"></a> 2297 if (! pt.getRawType().equals(Enum.class)) {<a name="line.2297"></a> 2298 List<ClassMeta<?>> l = new LinkedList<>();<a name="line.2298"></a> 2299 for (Type pt2 : pt.getActualTypeArguments()) {<a name="line.2299"></a> 2300 if (pt2 instanceof WildcardType || pt2 instanceof TypeVariable)<a name="line.2300"></a> 2301 return null;<a name="line.2301"></a> 2302 l.add(resolveClassMeta(pt2, null));<a name="line.2302"></a> 2303 }<a name="line.2303"></a> 2304 if (l.isEmpty())<a name="line.2304"></a> 2305 return null;<a name="line.2305"></a> 2306 return l.toArray(new ClassMeta[l.size()]);<a name="line.2306"></a> 2307 }<a name="line.2307"></a> 2308 }<a name="line.2308"></a> 2309<a name="line.2309"></a> 2310 return null;<a name="line.2310"></a> 2311 }<a name="line.2311"></a> 2312<a name="line.2312"></a> 2313 /**<a name="line.2313"></a> 2314 * Shortcut for calling {@code getClassMeta(o.getClass())}.<a name="line.2314"></a> 2315 * <a name="line.2315"></a> 2316 * @param <T> The class of the object being passed in.<a name="line.2316"></a> 2317 * @param o The class to find the class type for.<a name="line.2317"></a> 2318 * @return The ClassMeta object, or <jk>null</jk> if {@code o} is <jk>null</jk>.<a name="line.2318"></a> 2319 */<a name="line.2319"></a> 2320 public final <T> ClassMeta<T> getClassMetaForObject(T o) {<a name="line.2320"></a> 2321 if (o == null)<a name="line.2321"></a> 2322 return null;<a name="line.2322"></a> 2323 return (ClassMeta<T>)getClassMeta(o.getClass());<a name="line.2323"></a> 2324 }<a name="line.2324"></a> 2325<a name="line.2325"></a> 2326<a name="line.2326"></a> 2327 /**<a name="line.2327"></a> 2328 * Used for determining the class type on a method or field where a {@code @BeanProperty} annotation may be present.<a name="line.2328"></a> 2329 * <a name="line.2329"></a> 2330 * @param <T> The class type we're wrapping.<a name="line.2330"></a> 2331 * @param p The property annotation on the type if there is one.<a name="line.2331"></a> 2332 * @param t The type.<a name="line.2332"></a> 2333 * @param typeVarImpls<a name="line.2333"></a> 2334 * Contains known resolved type parameters on the specified class so that we can result<a name="line.2334"></a> 2335 * {@code ParameterizedTypes} and {@code TypeVariables}.<a name="line.2335"></a> 2336 * Can be <jk>null</jk> if the information is not known.<a name="line.2336"></a> 2337 * @return The new {@code ClassMeta} object wrapped around the {@code Type} object.<a name="line.2337"></a> 2338 */<a name="line.2338"></a> 2339 protected final <T> ClassMeta<T> resolveClassMeta(BeanProperty p, Type t, Map<Class<?>,Class<?>[]> typeVarImpls) {<a name="line.2339"></a> 2340 ClassMeta<T> cm = resolveClassMeta(t, typeVarImpls);<a name="line.2340"></a> 2341 ClassMeta<T> cm2 = cm;<a name="line.2341"></a> 2342 if (p != null) {<a name="line.2342"></a> 2343<a name="line.2343"></a> 2344 if (p.type() != Object.class)<a name="line.2344"></a> 2345 cm2 = resolveClassMeta(p.type(), typeVarImpls);<a name="line.2345"></a> 2346<a name="line.2346"></a> 2347 if (cm2.isMap()) {<a name="line.2347"></a> 2348 Class<?>[] pParams = (p.params().length == 0 ? new Class[]{Object.class, Object.class} : p.params());<a name="line.2348"></a> 2349 if (pParams.length != 2)<a name="line.2349"></a> 2350 throw new FormattedRuntimeException("Invalid number of parameters specified for Map (must be 2): {0}", pParams.length);<a name="line.2350"></a> 2351 ClassMeta<?> keyType = resolveType(pParams[0], cm2.getKeyType(), cm.getKeyType());<a name="line.2351"></a> 2352 ClassMeta<?> valueType = resolveType(pParams[1], cm2.getValueType(), cm.getValueType());<a name="line.2352"></a> 2353 if (keyType.isObject() && valueType.isObject())<a name="line.2353"></a> 2354 return cm2;<a name="line.2354"></a> 2355 return new ClassMeta<>(cm2, keyType, valueType, null);<a name="line.2355"></a> 2356 }<a name="line.2356"></a> 2357<a name="line.2357"></a> 2358 if (cm2.isCollection()) {<a name="line.2358"></a> 2359 Class<?>[] pParams = (p.params().length == 0 ? new Class[]{Object.class} : p.params());<a name="line.2359"></a> 2360 if (pParams.length != 1)<a name="line.2360"></a> 2361 throw new FormattedRuntimeException("Invalid number of parameters specified for Collection (must be 1): {0}", pParams.length);<a name="line.2361"></a> 2362 ClassMeta<?> elementType = resolveType(pParams[0], cm2.getElementType(), cm.getElementType());<a name="line.2362"></a> 2363 if (elementType.isObject())<a name="line.2363"></a> 2364 return cm2;<a name="line.2364"></a> 2365 return new ClassMeta<>(cm2, null, null, elementType);<a name="line.2365"></a> 2366 }<a name="line.2366"></a> 2367<a name="line.2367"></a> 2368 return cm2;<a name="line.2368"></a> 2369 }<a name="line.2369"></a> 2370<a name="line.2370"></a> 2371 return cm;<a name="line.2371"></a> 2372 }<a name="line.2372"></a> 2373<a name="line.2373"></a> 2374 private ClassMeta<?> resolveType(Type...t) {<a name="line.2374"></a> 2375 for (Type tt : t) {<a name="line.2375"></a> 2376 if (tt != null) {<a name="line.2376"></a> 2377 ClassMeta<?> cm = getClassMeta(tt);<a name="line.2377"></a> 2378 if (tt != cmObject)<a name="line.2378"></a> 2379 return cm;<a name="line.2379"></a> 2380 }<a name="line.2380"></a> 2381 }<a name="line.2381"></a> 2382 return cmObject;<a name="line.2382"></a> 2383 }<a name="line.2383"></a> 2384<a name="line.2384"></a> 2385 /**<a name="line.2385"></a> 2386 * Returns the {@link PojoSwap} associated with the specified class, or <jk>null</jk> if there is no POJO swap<a name="line.2386"></a> 2387 * associated with the class.<a name="line.2387"></a> 2388 * <a name="line.2388"></a> 2389 * @param <T> The class associated with the swap.<a name="line.2389"></a> 2390 * @param c The class associated with the swap.<a name="line.2390"></a> 2391 * @return The swap associated with the class, or null if there is no association.<a name="line.2391"></a> 2392 */<a name="line.2392"></a> 2393 private final <T> PojoSwap[] findPojoSwaps(Class<T> c) {<a name="line.2393"></a> 2394 // Note: On first<a name="line.2394"></a> 2395 if (c != null) {<a name="line.2395"></a> 2396 List<PojoSwap> l = new ArrayList<>();<a name="line.2396"></a> 2397 for (PojoSwap f : pojoSwaps)<a name="line.2397"></a> 2398 if (isParentClass(f.getNormalClass(), c))<a name="line.2398"></a> 2399 l.add(f);<a name="line.2399"></a> 2400 return l.size() == 0 ? null : l.toArray(new PojoSwap[l.size()]);<a name="line.2400"></a> 2401 }<a name="line.2401"></a> 2402 return null;<a name="line.2402"></a> 2403 }<a name="line.2403"></a> 2404<a name="line.2404"></a> 2405 /**<a name="line.2405"></a> 2406 * Checks whether a class has a {@link PojoSwap} associated with it in this bean context.<a name="line.2406"></a> 2407 * <a name="line.2407"></a> 2408 * @param c The class to check.<a name="line.2408"></a> 2409 * @return <jk>true</jk> if the specified class or one of its subclasses has a {@link PojoSwap} associated with it.<a name="line.2409"></a> 2410 */<a name="line.2410"></a> 2411 private final PojoSwap[] findChildPojoSwaps(Class<?> c) {<a name="line.2411"></a> 2412 if (c == null || pojoSwaps.length == 0)<a name="line.2412"></a> 2413 return null;<a name="line.2413"></a> 2414 List<PojoSwap> l = null;<a name="line.2414"></a> 2415 for (PojoSwap f : pojoSwaps) {<a name="line.2415"></a> 2416 if (isParentClass(c, f.getNormalClass())) {<a name="line.2416"></a> 2417 if (l == null)<a name="line.2417"></a> 2418 l = new ArrayList<>();<a name="line.2418"></a> 2419 l.add(f);<a name="line.2419"></a> 2420 }<a name="line.2420"></a> 2421 }<a name="line.2421"></a> 2422 return l == null ? null : l.toArray(new PojoSwap[l.size()]);<a name="line.2422"></a> 2423 }<a name="line.2423"></a> 2424<a name="line.2424"></a> 2425 /**<a name="line.2425"></a> 2426 * Returns the {@link BeanFilter} associated with the specified class, or <jk>null</jk> if there is no bean filter<a name="line.2426"></a> 2427 * associated with the class.<a name="line.2427"></a> 2428 * <a name="line.2428"></a> 2429 * @param <T> The class associated with the bean filter.<a name="line.2429"></a> 2430 * @param c The class associated with the bean filter.<a name="line.2430"></a> 2431 * @return The bean filter associated with the class, or null if there is no association.<a name="line.2431"></a> 2432 */<a name="line.2432"></a> 2433 private final <T> BeanFilter findBeanFilter(Class<T> c) {<a name="line.2433"></a> 2434 if (c != null)<a name="line.2434"></a> 2435 for (BeanFilter f : beanFilters)<a name="line.2435"></a> 2436 if (isParentClass(f.getBeanClass(), c))<a name="line.2436"></a> 2437 return f;<a name="line.2437"></a> 2438 return null;<a name="line.2438"></a> 2439 }<a name="line.2439"></a> 2440<a name="line.2440"></a> 2441 /**<a name="line.2441"></a> 2442 * Returns the type property name as defined by {@link #BEAN_beanTypePropertyName}.<a name="line.2442"></a> 2443 * <a name="line.2443"></a> 2444 * @return The type property name. Never <jk>null</jk>.<a name="line.2444"></a> 2445 */<a name="line.2445"></a> 2446 protected final String getBeanTypePropertyName() {<a name="line.2446"></a> 2447 return beanTypePropertyName;<a name="line.2447"></a> 2448 }<a name="line.2448"></a> 2449<a name="line.2449"></a> 2450 /**<a name="line.2450"></a> 2451 * Returns the bean registry defined in this bean context defined by {@link #BEAN_beanDictionary}.<a name="line.2451"></a> 2452 * <a name="line.2452"></a> 2453 * @return The bean registry defined in this bean context. Never <jk>null</jk>.<a name="line.2453"></a> 2454 */<a name="line.2454"></a> 2455 protected final BeanRegistry getBeanRegistry() {<a name="line.2455"></a> 2456 return beanRegistry;<a name="line.2456"></a> 2457 }<a name="line.2457"></a> 2458<a name="line.2458"></a> 2459 /**<a name="line.2459"></a> 2460 * Gets the no-arg constructor for the specified class.<a name="line.2460"></a> 2461 * <a name="line.2461"></a> 2462 * @param <T> The class to check.<a name="line.2462"></a> 2463 * @param c The class to check.<a name="line.2463"></a> 2464 * @param v The minimum visibility for the constructor.<a name="line.2464"></a> 2465 * @return The no arg constructor, or <jk>null</jk> if the class has no no-arg constructor.<a name="line.2465"></a> 2466 */<a name="line.2466"></a> 2467 protected final <T> Constructor<? extends T> getImplClassConstructor(Class<T> c, Visibility v) {<a name="line.2467"></a> 2468 if (implClasses.isEmpty())<a name="line.2468"></a> 2469 return null;<a name="line.2469"></a> 2470 Class cc = c;<a name="line.2470"></a> 2471 while (cc != null) {<a name="line.2471"></a> 2472 Class implClass = implClasses.get(cc.getName());<a name="line.2472"></a> 2473 if (implClass != null)<a name="line.2473"></a> 2474 return findNoArgConstructor(implClass, v);<a name="line.2474"></a> 2475 for (Class ic : cc.getInterfaces()) {<a name="line.2475"></a> 2476 implClass = implClasses.get(ic.getName());<a name="line.2476"></a> 2477 if (implClass != null)<a name="line.2477"></a> 2478 return findNoArgConstructor(implClass, v);<a name="line.2478"></a> 2479 }<a name="line.2479"></a> 2480 cc = cc.getSuperclass();<a name="line.2480"></a> 2481 }<a name="line.2481"></a> 2482 return null;<a name="line.2482"></a> 2483 }<a name="line.2483"></a> 2484<a name="line.2484"></a> 2485 private final <T> Class<? extends T> findImplClass(Class<T> c) {<a name="line.2485"></a> 2486 if (implClasses.isEmpty())<a name="line.2486"></a> 2487 return null;<a name="line.2487"></a> 2488 Class cc = c;<a name="line.2488"></a> 2489 while (cc != null) {<a name="line.2489"></a> 2490 Class implClass = implClasses.get(cc.getName());<a name="line.2490"></a> 2491 if (implClass != null)<a name="line.2491"></a> 2492 return implClass;<a name="line.2492"></a> 2493 for (Class ic : cc.getInterfaces()) {<a name="line.2493"></a> 2494 implClass = implClasses.get(ic.getName());<a name="line.2494"></a> 2495 if (implClass != null)<a name="line.2495"></a> 2496 return implClass;<a name="line.2496"></a> 2497 }<a name="line.2497"></a> 2498 cc = cc.getSuperclass();<a name="line.2498"></a> 2499 }<a name="line.2499"></a> 2500 return null;<a name="line.2500"></a> 2501 }<a name="line.2501"></a> 2502<a name="line.2502"></a> 2503 /**<a name="line.2503"></a> 2504 * Returns the {@link #BEAN_includeProperties} setting for the specified class.<a name="line.2504"></a> 2505 * <a name="line.2505"></a> 2506 * @param c The class.<a name="line.2506"></a> 2507 * @return The properties to include for the specified class, or <jk>null</jk> if it's not defined for the class.<a name="line.2507"></a> 2508 */<a name="line.2508"></a> 2509 public String[] getIncludeProperties(Class<?> c) {<a name="line.2509"></a> 2510 if (includeProperties.isEmpty())<a name="line.2510"></a> 2511 return null;<a name="line.2511"></a> 2512 String[] s = null;<a name="line.2512"></a> 2513 for (Iterator<Class<?>> i = ClassUtils.getParentClasses(c, false, true); i.hasNext();) {<a name="line.2513"></a> 2514 Class<?> c2 = i.next();<a name="line.2514"></a> 2515 s = includeProperties.get(c2.getName());<a name="line.2515"></a> 2516 if (s != null)<a name="line.2516"></a> 2517 return s;<a name="line.2517"></a> 2518 s = includeProperties.get(c2.getSimpleName());<a name="line.2518"></a> 2519 if (s != null)<a name="line.2519"></a> 2520 return s;<a name="line.2520"></a> 2521 }<a name="line.2521"></a> 2522 return includeProperties.get("*");<a name="line.2522"></a> 2523 }<a name="line.2523"></a> 2524<a name="line.2524"></a> 2525 /**<a name="line.2525"></a> 2526 * Returns the {@link #BEAN_excludeProperties} setting for the specified class.<a name="line.2526"></a> 2527 * <a name="line.2527"></a> 2528 * @param c The class.<a name="line.2528"></a> 2529 * @return The properties to exclude for the specified class, or <jk>null</jk> if it's not defined for the class.<a name="line.2529"></a> 2530 */<a name="line.2530"></a> 2531 public String[] getExcludeProperties(Class<?> c) {<a name="line.2531"></a> 2532 if (excludeProperties.isEmpty())<a name="line.2532"></a> 2533 return null;<a name="line.2533"></a> 2534 String[] s = null;<a name="line.2534"></a> 2535 for (Iterator<Class<?>> i = ClassUtils.getParentClasses(c, false, true); i.hasNext();) {<a name="line.2535"></a> 2536 Class<?> c2 = i.next();<a name="line.2536"></a> 2537 s = excludeProperties.get(c2.getName());<a name="line.2537"></a> 2538 if (s != null)<a name="line.2538"></a> 2539 return s;<a name="line.2539"></a> 2540 s = excludeProperties.get(c2.getSimpleName());<a name="line.2540"></a> 2541 if (s != null)<a name="line.2541"></a> 2542 return s;<a name="line.2542"></a> 2543 }<a name="line.2543"></a> 2544 return excludeProperties.get("*");<a name="line.2544"></a> 2545 }<a name="line.2545"></a> 2546<a name="line.2546"></a> 2547 /**<a name="line.2547"></a> 2548 * Creates an instance of the specified class.<a name="line.2548"></a> 2549 * <a name="line.2549"></a> 2550 * @param c <a name="line.2550"></a> 2551 * The class to cast to.<a name="line.2551"></a> 2552 * @param c2<a name="line.2552"></a> 2553 * The class to instantiate.<a name="line.2553"></a> 2554 * Can also be an instance of the class.<a name="line.2554"></a> 2555 * @return <a name="line.2555"></a> 2556 * The new class instance, or <jk>null</jk> if the class was <jk>null</jk> or is abstract or an interface.<a name="line.2556"></a> 2557 * @throws <a name="line.2557"></a> 2558 * RuntimeException if constructor could not be found or called.<a name="line.2558"></a> 2559 */<a name="line.2559"></a> 2560 public <T> T newInstance(Class<T> c, Object c2) {<a name="line.2560"></a> 2561 return ClassUtils.newInstance(c, c2);<a name="line.2561"></a> 2562 }<a name="line.2562"></a> 2563<a name="line.2563"></a> 2564 /**<a name="line.2564"></a> 2565 * Creates an instance of the specified class.<a name="line.2565"></a> 2566 * <a name="line.2566"></a> 2567 * @param c <a name="line.2567"></a> 2568 * The class to cast to.<a name="line.2568"></a> 2569 * @param c2<a name="line.2569"></a> 2570 * The class to instantiate.<a name="line.2570"></a> 2571 * Can also be an instance of the class.<a name="line.2571"></a> 2572 * @param fuzzyArgs <a name="line.2572"></a> 2573 * Use fuzzy constructor arg matching. <a name="line.2573"></a> 2574 * When <jk>true</jk>, constructor args can be in any order and extra args are ignored.<a name="line.2574"></a> 2575 * No-arg constructors are also used if no other constructors are found.<a name="line.2575"></a> 2576 * @param args <a name="line.2576"></a> 2577 * The arguments to pass to the constructor.<a name="line.2577"></a> 2578 * @return <a name="line.2578"></a> 2579 * The new class instance, or <jk>null</jk> if the class was <jk>null</jk> or is abstract or an interface.<a name="line.2579"></a> 2580 * @throws <a name="line.2580"></a> 2581 * RuntimeException if constructor could not be found or called.<a name="line.2581"></a> 2582 */<a name="line.2582"></a> 2583 public <T> T newInstance(Class<T> c, Object c2, boolean fuzzyArgs, Object...args) {<a name="line.2583"></a> 2584 return ClassUtils.newInstance(c, c2, fuzzyArgs, args);<a name="line.2584"></a> 2585 }<a name="line.2585"></a> 2586<a name="line.2586"></a> 2587 /**<a name="line.2587"></a> 2588 * Creates an instance of the specified class from within the context of another object.<a name="line.2588"></a> 2589 * <a name="line.2589"></a> 2590 * @param outer<a name="line.2590"></a> 2591 * The outer object.<a name="line.2591"></a> 2592 * Can be <jk>null</jk>.<a name="line.2592"></a> 2593 * @param c <a name="line.2593"></a> 2594 * The class to cast to.<a name="line.2594"></a> 2595 * @param c2<a name="line.2595"></a> 2596 * The class to instantiate.<a name="line.2596"></a> 2597 * Can also be an instance of the class.<a name="line.2597"></a> 2598 * @param fuzzyArgs <a name="line.2598"></a> 2599 * Use fuzzy constructor arg matching. <a name="line.2599"></a> 2600 * When <jk>true</jk>, constructor args can be in any order and extra args are ignored.<a name="line.2600"></a> 2601 * No-arg constructors are also used if no other constructors are found.<a name="line.2601"></a> 2602 * @param args <a name="line.2602"></a> 2603 * The arguments to pass to the constructor.<a name="line.2603"></a> 2604 * @return <a name="line.2604"></a> 2605 * The new class instance, or <jk>null</jk> if the class was <jk>null</jk> or is abstract or an interface.<a name="line.2605"></a> 2606 * @throws <a name="line.2606"></a> 2607 * RuntimeException if constructor could not be found or called.<a name="line.2607"></a> 2608 */<a name="line.2608"></a> 2609 public <T> T newInstanceFromOuter(Object outer, Class<T> c, Object c2, boolean fuzzyArgs, Object...args) {<a name="line.2609"></a> 2610 return ClassUtils.newInstanceFromOuter(outer, c, c2, fuzzyArgs, args);<a name="line.2610"></a> 2611 }<a name="line.2611"></a> 2612 <a name="line.2612"></a> 2613 /**<a name="line.2613"></a> 2614 * Returns a reusable {@link ClassMeta} representation for the class <code>Object</code>.<a name="line.2614"></a> 2615 * <a name="line.2615"></a> 2616 * <a name="line.2616"></a> 2617 * This <code>ClassMeta</code> is often used to represent "any object type" when an object type is not known.<a name="line.2617"></a> 2618 * <a name="line.2618"></a> 2619 * <a name="line.2619"></a> 2620 * This method is identical to calling <code>getClassMeta(Object.<jk>class</jk>)</code> but uses a cached copy to<a name="line.2620"></a> 2621 * avoid a hashmap lookup.<a name="line.2621"></a> 2622 * <a name="line.2622"></a> 2623 * @return The {@link ClassMeta} object associated with the <code>Object</code> class.<a name="line.2623"></a> 2624 */<a name="line.2624"></a> 2625 protected final ClassMeta<Object> object() {<a name="line.2625"></a> 2626 return cmObject;<a name="line.2626"></a> 2627 }<a name="line.2627"></a> 2628<a name="line.2628"></a> 2629 /**<a name="line.2629"></a> 2630 * Returns a reusable {@link ClassMeta} representation for the class <code>String</code>.<a name="line.2630"></a> 2631 * <a name="line.2631"></a> 2632 * <a name="line.2632"></a> 2633 * This <code>ClassMeta</code> is often used to represent key types in maps.<a name="line.2633"></a> 2634 * <a name="line.2634"></a> 2635 * <a name="line.2635"></a> 2636 * This method is identical to calling <code>getClassMeta(String.<jk>class</jk>)</code> but uses a cached copy to<a name="line.2636"></a> 2637 * avoid a hashmap lookup.<a name="line.2637"></a> 2638 * <a name="line.2638"></a> 2639 * @return The {@link ClassMeta} object associated with the <code>String</code> class.<a name="line.2639"></a> 2640 */<a name="line.2640"></a> 2641 protected final ClassMeta<String> string() {<a name="line.2641"></a> 2642 return cmString;<a name="line.2642"></a> 2643 }<a name="line.2643"></a> 2644<a name="line.2644"></a> 2645 /**<a name="line.2645"></a> 2646 * Returns a reusable {@link ClassMeta} representation for the class <code>Class</code>.<a name="line.2646"></a> 2647 * <a name="line.2647"></a> 2648 * <a name="line.2648"></a> 2649 * This <code>ClassMeta</code> is often used to represent key types in maps.<a name="line.2649"></a> 2650 * <a name="line.2650"></a> 2651 * <a name="line.2651"></a> 2652 * This method is identical to calling <code>getClassMeta(Class.<jk>class</jk>)</code> but uses a cached copy to<a name="line.2652"></a> 2653 * avoid a hashmap lookup.<a name="line.2653"></a> 2654 * <a name="line.2654"></a> 2655 * @return The {@link ClassMeta} object associated with the <code>String</code> class.<a name="line.2655"></a> 2656 */<a name="line.2656"></a> 2657 protected final ClassMeta<Class> _class() {<a name="line.2657"></a> 2658 return cmClass;<a name="line.2658"></a> 2659 }<a name="line.2659"></a> 2660<a name="line.2660"></a> 2661 @Override /* Context */<a name="line.2661"></a> 2662 public ObjectMap asMap() {<a name="line.2662"></a> 2663 return super.asMap()<a name="line.2663"></a> 2664 .append("BeanContext", new ObjectMap()<a name="line.2664"></a> 2665 .append("id", System.identityHashCode(this))<a name="line.2665"></a> 2666 .append("beanClassVisibility", beanClassVisibility)<a name="line.2666"></a> 2667 .append("beanConstructorVisibility", beanConstructorVisibility)<a name="line.2667"></a> 2668 .append("beanDictionaryClasses", beanDictionaryClasses)<a name="line.2668"></a> 2669 .append("beanFieldVisibility", beanFieldVisibility)<a name="line.2669"></a> 2670 .append("beanFilters", beanFilters)<a name="line.2670"></a> 2671 .append("beanMapPutReturnsOldValue", beanMapPutReturnsOldValue)<a name="line.2671"></a> 2672 .append("beanMethodVisibility", beanMethodVisibility)<a name="line.2672"></a> 2673 .append("beansRequireDefaultConstructor", beansRequireDefaultConstructor)<a name="line.2673"></a> 2674 .append("beansRequireSerializable", beansRequireSerializable)<a name="line.2674"></a> 2675 .append("beansRequireSettersForGetters", beansRequireSettersForGetters)<a name="line.2675"></a> 2676 .append("beansRequireSomeProperties", beansRequireSomeProperties)<a name="line.2676"></a> 2677 .append("excludeProperties", excludeProperties)<a name="line.2677"></a> 2678 .append("ignoreInvocationExceptionsOnGetters", ignoreInvocationExceptionsOnGetters)<a name="line.2678"></a> 2679 .append("ignoreInvocationExceptionsOnSetters", ignoreInvocationExceptionsOnSetters)<a name="line.2679"></a> 2680 .append("ignorePropertiesWithoutSetters", ignorePropertiesWithoutSetters)<a name="line.2680"></a> 2681 .append("ignoreUnknownBeanProperties", ignoreUnknownBeanProperties)<a name="line.2681"></a> 2682 .append("ignoreUnknownNullBeanProperties", ignoreUnknownNullBeanProperties)<a name="line.2682"></a> 2683 .append("implClasses", implClasses)<a name="line.2683"></a> 2684 .append("includeProperties", includeProperties)<a name="line.2684"></a> 2685 .append("locale", locale)<a name="line.2685"></a> 2686 .append("mediaType", mediaType)<a name="line.2686"></a> 2687 .append("notBeanClasses", notBeanClasses)<a name="line.2687"></a> 2688 .append("notBeanPackageNames", notBeanPackageNames)<a name="line.2688"></a> 2689 .append("notBeanPackagePrefixes", notBeanPackagePrefixes)<a name="line.2689"></a> 2690 .append("pojoSwaps", pojoSwaps)<a name="line.2690"></a> 2691 .append("sortProperties", sortProperties)<a name="line.2691"></a> 2692 .append("timeZone", timeZone)<a name="line.2692"></a> 2693 .append("useInterfaceProxies", useInterfaceProxies)<a name="line.2693"></a> 2694 .append("useJavaBeanIntrospector", useJavaBeanIntrospector)<a name="line.2694"></a> 2695 );<a name="line.2695"></a> 2696 }<a name="line.2696"></a> 2697}<a name="line.2697"></a> </pre> </div> </body> </html>

content/site/apidocs-7.1.0/src-html/org/apache/juneau/BeanContext.html (2,709 lines of code) (raw):