content/site/apidocs-7.1.0/src-html/org/apache/juneau/serializer/Serializer.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.serializer;<a name="line.13"></a> 014<a name="line.14"></a> 015import java.io.*;<a name="line.15"></a> 016<a name="line.16"></a> 017import org.apache.juneau.*;<a name="line.17"></a> 018import org.apache.juneau.annotation.*;<a name="line.18"></a> 019import org.apache.juneau.http.*;<a name="line.19"></a> 020import org.apache.juneau.parser.*;<a name="line.20"></a> 021<a name="line.21"></a> 022/**<a name="line.22"></a> 023 * Parent class for all Juneau serializers.<a name="line.23"></a> 024 * <a name="line.24"></a> 025 * <h5 class='topic'>Description</h5><a name="line.25"></a> 026 * <a name="line.26"></a> 027 * Base serializer class that serves as the parent class for all serializers.<a name="line.27"></a> 028 * <a name="line.28"></a> 029 * <a name="line.29"></a> 030 * The purpose of this class is:<a name="line.30"></a> 031 * <ul><a name="line.31"></a> 032 * <li>Maintain a read-only configuration state of a serializer.<a name="line.32"></a> 033 * <li>Create session objects used for serializing POJOs (i.e. {@link SerializerSession}).<a name="line.33"></a> 034 * <li>Provide convenience methods for serializing POJOs without having to construct session objects.<a name="line.34"></a> 035 * </ul><a name="line.35"></a> 036 * <a name="line.36"></a> 037 * <a name="line.37"></a> 038 * Subclasses should extend directly from {@link OutputStreamSerializer} or {@link WriterSerializer} depending on<a name="line.38"></a> 039 * whether it's a stream or character based serializer.<a name="line.39"></a> 040 */<a name="line.40"></a> 041public abstract class Serializer extends BeanContext {<a name="line.41"></a> 042<a name="line.42"></a> 043 //-------------------------------------------------------------------------------------------------------------------<a name="line.43"></a> 044 // Configurable properties<a name="line.44"></a> 045 //-------------------------------------------------------------------------------------------------------------------<a name="line.45"></a> 046<a name="line.46"></a> 047 private static final String PREFIX = "Serializer.";<a name="line.47"></a> 048<a name="line.48"></a> 049 /**<a name="line.49"></a> 050 * Configuration property: Abridged output.<a name="line.50"></a> 051 * <a name="line.51"></a> 052 * <h5 class='section'>Property:</h5><a name="line.52"></a> 053 * <ul><a name="line.53"></a> 054 * <li>Name: <js>"Serializer.abridged.b"</js><a name="line.54"></a> 055 * <li>Data type: <code>Boolean</code><a name="line.55"></a> 056 * <li>Default: <jk>false</jk><a name="line.56"></a> 057 * <li>Session-overridable: <jk>true</jk><a name="line.57"></a> 058 * <li>Methods: <a name="line.58"></a> 059 * <ul><a name="line.59"></a> 060 * <li class='jm'>{@link SerializerBuilder#abridged(boolean)}<a name="line.60"></a> 061 * <li class='jm'>{@link SerializerBuilder#abridged()}<a name="line.61"></a> 062 * </ul><a name="line.62"></a> 063 * </ul><a name="line.63"></a> 064 * <a name="line.64"></a> 065 * <h5 class='section'>Description:</h5><a name="line.65"></a> 066 * <a name="line.66"></a> 067 * When enabled, it is assumed that the parser knows the exact Java POJO type being parsed, and therefore top-level<a name="line.67"></a> 068 * type information that might normally be included to determine the data type will not be serialized.<a name="line.68"></a> 069 * <a name="line.69"></a> 070 * <a name="line.70"></a> 071 * For example, when serializing a top-level POJO with a {@link Bean#typeName() @Bean.typeName()} value, a <a name="line.71"></a> 072 * <js>'_type'</js> attribute will only be added when this setting is enabled.<a name="line.72"></a> 073 * <a name="line.73"></a> 074 * <a name="line.74"></a> 075 * Note the differences between the following settings:<a name="line.75"></a> 076 * <ul><a name="line.76"></a> 077 * <li class='jf'>{@link #SERIALIZER_abridged} - Affects whether <js>'_type'</js> is added to root node.<a name="line.77"></a> 078 * <li class='jf'>{@link #SERIALIZER_addBeanTypeProperties} - Affects whether <js>'_type'</js> is added to any nodes.<a name="line.78"></a> 079 * </ul><a name="line.79"></a> 080 * <a name="line.80"></a> 081 * <h5 class='section'>Example:</h5><a name="line.81"></a> 082 * <a name="line.82"></a> 083 * <jc>// Create a serializer that doesn't add _type to root node.</jc><a name="line.83"></a> 084 * WriterSerializer s = JsonSerializer<a name="line.84"></a> 085 * .<jsm>create</jsm>()<a name="line.85"></a> 086 * .abridged()<a name="line.86"></a> 087 * .build();<a name="line.87"></a> 088 * <a name="line.88"></a> 089 * <jc>// Same, but use property.</jc><a name="line.89"></a> 090 * WriterSerializer s = JsonSerializer<a name="line.90"></a> 091 * .<jsm>create</jsm>()<a name="line.91"></a> 092 * .set(<jsf>SERIALIZER_abridged</jsf>, <jk>true</jk>)<a name="line.92"></a> 093 * .build();<a name="line.93"></a> 094 * <a name="line.94"></a> 095 * <jc>// The bean we want to serialize.</jc><a name="line.95"></a> 096 * <ja>@Bean</ja>(typeName=<js>"mybean"</js>)<a name="line.96"></a> 097 * <jk>public class</jk> MyBean {...}<a name="line.97"></a> 098 * <a name="line.98"></a> 099 * <jc>// Will not contain '_type' attribute even though there's a type name on the bean.</jc><a name="line.99"></a> 100 * String json = s.serialize(<jk>new</jk> MyBean());<a name="line.100"></a> 101 * <a name="line.101"></a> 102 * <jc>// '_type' wasn't needed on the parse side because we know the type being parsed.</jc><a name="line.102"></a> 103 * MyBean myBean = JsonParser.<jsf>DEFAULT</jsf>.parse(json, MyBean.<jk>class</jk>);<a name="line.103"></a> 104 * <a name="line.104"></a> 105 */<a name="line.105"></a> 106 public static final String SERIALIZER_abridged = PREFIX + "abridged.b";<a name="line.106"></a> 107<a name="line.107"></a> 108 /**<a name="line.108"></a> 109 * Configuration property: Add <js>"_type"</js> properties when needed.<a name="line.109"></a> 110 * <a name="line.110"></a> 111 * <h5 class='section'>Property:</h5><a name="line.111"></a> 112 * <ul><a name="line.112"></a> 113 * <li>Name: <js>"Serializer.addBeanTypeProperties.b"</js><a name="line.113"></a> 114 * <li>Data type: <code>Boolean</code><a name="line.114"></a> 115 * <li>Default: <jk>true</jk><a name="line.115"></a> 116 * <li>Session-overridable: <jk>true</jk><a name="line.116"></a> 117 * <li>Methods: <a name="line.117"></a> 118 * <ul><a name="line.118"></a> 119 * <li class='jm'>{@link SerializerBuilder#addBeanTypeProperties(boolean)}<a name="line.119"></a> 120 * </ul><a name="line.120"></a> 121 * </ul><a name="line.121"></a> 122 * <a name="line.122"></a> 123 * <h5 class='section'>Description:</h5><a name="line.123"></a> 124 * <a name="line.124"></a> 125 * If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred<a name="line.125"></a> 126 * through reflection.<a name="line.126"></a> 127 * <a name="line.127"></a> 128 * <a name="line.128"></a> 129 * This is used to recreate the correct objects during parsing if the object types cannot be inferred.<a name="line.129"></a> 130 * For example, when serializing a <code>Map&lt;String,Object&gt;</code> field where the bean class cannot be determined from<a name="line.130"></a> 131 * the type of the values.<a name="line.131"></a> 132 * <a name="line.132"></a> 133 * <a name="line.133"></a> 134 * Note the differences between the following settings:<a name="line.134"></a> 135 * <ul><a name="line.135"></a> 136 * <li class='jf'>{@link #SERIALIZER_abridged} - Affects whether <js>'_type'</js> is added to root node.<a name="line.136"></a> 137 * <li class='jf'>{@link #SERIALIZER_addBeanTypeProperties} - Affects whether <js>'_type'</js> is added to any nodes.<a name="line.137"></a> 138 * </ul><a name="line.138"></a> 139 * <a name="line.139"></a> 140 * <h5 class='section'>Example:</h5><a name="line.140"></a> 141 * <a name="line.141"></a> 142 * <jc>// Create a serializer that never adds _type to nodes.</jc><a name="line.142"></a> 143 * WriterSerializer s = JsonSerializer<a name="line.143"></a> 144 * .<jsm>create</jsm>()<a name="line.144"></a> 145 * .addBeanTypeProperties(<jk>false</jk>)<a name="line.145"></a> 146 * .build();<a name="line.146"></a> 147 * <a name="line.147"></a> 148 * <jc>// Same, but use property.</jc><a name="line.148"></a> 149 * WriterSerializer s = JsonSerializer<a name="line.149"></a> 150 * .<jsm>create</jsm>()<a name="line.150"></a> 151 * .set(<jsf>SERIALIZER_addBeanTypeProperties</jsf>, <jk>false</jk>)<a name="line.151"></a> 152 * .build();<a name="line.152"></a> 153 * <a name="line.153"></a> 154 * <jc>// A map of objects we want to serialize.</jc><a name="line.154"></a> 155 * <ja>@Bean</ja>(typeName=<js>"mybean"</js>)<a name="line.155"></a> 156 * <jk>public class</jk> MyBean {...}<a name="line.156"></a> 157 * <a name="line.157"></a> 158 * Map&lt;String,Object&gt; m = new HashMap&lt;&gt;();<a name="line.158"></a> 159 * m.put(<js>"foo"</js>, <jk>new</jk> MyBean());<a name="line.159"></a> 160 * <a name="line.160"></a> 161 * <jc>// Will not contain '_type' attribute even though type name is on bean and we're serializing</jc><a name="line.161"></a> 162 * <jc>// a map of generic objects.</jc><a name="line.162"></a> 163 * String json = s.serialize(m);<a name="line.163"></a> 164 * <a name="line.164"></a> 165 */<a name="line.165"></a> 166 public static final String SERIALIZER_addBeanTypeProperties = PREFIX + "addBeanTypeProperties.b";<a name="line.166"></a> 167<a name="line.167"></a> 168 /**<a name="line.168"></a> 169 * Configuration property: Automatically detect POJO recursions.<a name="line.169"></a> 170 * <a name="line.170"></a> 171 * <h5 class='section'>Property:</h5><a name="line.171"></a> 172 * <ul><a name="line.172"></a> 173 * <li>Name: <js>"Serializer.detectRecursions.b"</js><a name="line.173"></a> 174 * <li>Data type: <code>Boolean</code><a name="line.174"></a> 175 * <li>Default: <jk>false</jk><a name="line.175"></a> 176 * <li>Session-overridable: <jk>true</jk><a name="line.176"></a> 177 * <li>Methods: <a name="line.177"></a> 178 * <ul><a name="line.178"></a> 179 * <li class='jm'>{@link SerializerBuilder#detectRecursions(boolean)}<a name="line.179"></a> 180 * <li class='jm'>{@link SerializerBuilder#detectRecursions()}<a name="line.180"></a> 181 * </ul><a name="line.181"></a> 182 * </ul><a name="line.182"></a> 183 * <a name="line.183"></a> 184 * <h5 class='section'>Description:</h5><a name="line.184"></a> 185 * <a name="line.185"></a> 186 * Specifies that recursions should be checked for during serialization.<a name="line.186"></a> 187 * <a name="line.187"></a> 188 * <a name="line.188"></a> 189 * Recursions can occur when serializing models that aren't true trees but rather contain loops.<a name="line.189"></a> 190 * In general, unchecked recursions cause stack-overflow-errors.<a name="line.190"></a> 191 * These show up as {@link ParseException ParseExceptions} with the message <js>"Depth too deep. Stack overflow occurred."</js>.<a name="line.191"></a> 192 * <a name="line.192"></a> 193 * <a name="line.193"></a> 194 * The behavior when recursions are detected depends on the value for {@link #SERIALIZER_ignoreRecursions}.<a name="line.194"></a> 195 * <a name="line.195"></a> 196 * <a name="line.196"></a> 197 * For example, if a model contains the links A-&gt;B-&gt;C-&gt;A, then the JSON generated will look like<a name="line.197"></a> 198 * the following when <jsf>SERIALIZER_ignoreRecursions</jsf> is <jk>true</jk>...<a name="line.198"></a> 199 * <a name="line.199"></a> 200 * <a name="line.200"></a> 201 * {A:{B:{C:<jk>null</jk>}}}<a name="line.201"></a> 202 * <a name="line.202"></a> 203 * <a name="line.203"></a> 204 * <h5 class='section'>Notes:</h5><a name="line.204"></a> 205 * <ul class='spaced-list'><a name="line.205"></a> 206 * <li><a name="line.206"></a> 207 * Checking for recursion can cause a small performance penalty.<a name="line.207"></a> 208 * </ul><a name="line.208"></a> 209 * <a name="line.209"></a> 210 * <h5 class='section'>Example:</h5><a name="line.210"></a> 211 * <a name="line.211"></a> 212 * <jc>// Create a serializer that never adds _type to nodes.</jc><a name="line.212"></a> 213 * WriterSerializer s = JsonSerializer<a name="line.213"></a> 214 * .<jsm>create</jsm>()<a name="line.214"></a> 215 * .detectRecursions()<a name="line.215"></a> 216 * .ignoreRecursions()<a name="line.216"></a> 217 * .build();<a name="line.217"></a> 218 * <a name="line.218"></a> 219 * <jc>// Same, but use property.</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 * .set(<jsf>SERIALIZER_detectRecursions</jsf>, <jk>true</jk>)<a name="line.222"></a> 223 * .set(<jsf>SERIALIZER_ignoreRecursions</jsf>, <jk>true</jk>)<a name="line.223"></a> 224 * .build();<a name="line.224"></a> 225 * <a name="line.225"></a> 226 * <jc>// Create a POJO model with a recursive loop.</jc><a name="line.226"></a> 227 * <jk>public class</jk> A {<a name="line.227"></a> 228 * <jk>public</jk> Object <jf>f</jf>;<a name="line.228"></a> 229 * }<a name="line.229"></a> 230 * A a = <jk>new</jk> A();<a name="line.230"></a> 231 * a.<jf>f</jf> = a;<a name="line.231"></a> 232 * <a name="line.232"></a> 233 * <jc>// Produces "{f:null}"</jc><a name="line.233"></a> 234 * String json = s.serialize(a);<a name="line.234"></a> 235 * <a name="line.235"></a> 236 */<a name="line.236"></a> 237 public static final String SERIALIZER_detectRecursions = PREFIX + "detectRecursions.b";<a name="line.237"></a> 238<a name="line.238"></a> 239 /**<a name="line.239"></a> 240 * Configuration property: Ignore recursion errors.<a name="line.240"></a> 241 * <a name="line.241"></a> 242 * <h5 class='section'>Property:</h5><a name="line.242"></a> 243 * <ul><a name="line.243"></a> 244 * <li>Name: <js>"Serializer.ignoreRecursions.b"</js><a name="line.244"></a> 245 * <li>Data type: <code>Boolean</code><a name="line.245"></a> 246 * <li>Default: <jk>false</jk><a name="line.246"></a> 247 * <li>Session-overridable: <jk>true</jk><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 SerializerBuilder#ignoreRecursions(boolean)}<a name="line.250"></a> 251 * <li class='jm'>{@link SerializerBuilder#ignoreRecursions()}<a name="line.251"></a> 252 * </ul><a name="line.252"></a> 253 * </ul><a name="line.253"></a> 254 * <a name="line.254"></a> 255 * <h5 class='section'>Description:</h5><a name="line.255"></a> 256 * <a name="line.256"></a> 257 * Used in conjunction with {@link #SERIALIZER_detectRecursions}.<a name="line.257"></a> 258 * Setting is ignored if <jsf>SERIALIZER_detectRecursions</jsf> is <jk>false</jk>.<a name="line.258"></a> 259 * <a name="line.259"></a> 260 * <a name="line.260"></a> 261 * If <jk>true</jk>, when we encounter the same object when serializing a tree, we set the value to <jk>null</jk>.<a name="line.261"></a> 262 * Otherwise, a {@link SerializeException} is thrown with the message <js>"Recursion occurred, stack=..."</js>.<a name="line.262"></a> 263 */<a name="line.263"></a> 264 public static final String SERIALIZER_ignoreRecursions = PREFIX + "ignoreRecursions.b";<a name="line.264"></a> 265<a name="line.265"></a> 266 /**<a name="line.266"></a> 267 * Configuration property: Initial depth.<a name="line.267"></a> 268 * <a name="line.268"></a> 269 * <h5 class='section'>Property:</h5><a name="line.269"></a> 270 * <ul><a name="line.270"></a> 271 * <li>Name: <js>"Serializer.initialDepth.i"</js><a name="line.271"></a> 272 * <li>Data type: <code>Integer</code><a name="line.272"></a> 273 * <li>Default: <code>0</code><a name="line.273"></a> 274 * <li>Session-overridable: <jk>true</jk><a name="line.274"></a> 275 * <li>Methods: <a name="line.275"></a> 276 * <ul><a name="line.276"></a> 277 * <li class='jm'>{@link SerializerBuilder#initialDepth(int)}<a name="line.277"></a> 278 * </ul><a name="line.278"></a> 279 * </ul><a name="line.279"></a> 280 * <a name="line.280"></a> 281 * <h5 class='section'>Description:</h5><a name="line.281"></a> 282 * <a name="line.282"></a> 283 * The initial indentation level at the root.<a name="line.283"></a> 284 * Useful when constructing document fragments that need to be indented at a certain level.<a name="line.284"></a> 285 * <a name="line.285"></a> 286 * <h5 class='section'>Example:</h5><a name="line.286"></a> 287 * <a name="line.287"></a> 288 * <jc>// Create a serializer with whitespace enabled and an initial depth of 2.</jc><a name="line.288"></a> 289 * WriterSerializer s = JsonSerializer<a name="line.289"></a> 290 * .<jsm>create</jsm>()<a name="line.290"></a> 291 * .ws()<a name="line.291"></a> 292 * .initialDepth(2)<a name="line.292"></a> 293 * .build();<a name="line.293"></a> 294 * <a name="line.294"></a> 295 * <jc>// Same, but use property.</jc><a name="line.295"></a> 296 * WriterSerializer s = JsonSerializer<a name="line.296"></a> 297 * .<jsm>create</jsm>()<a name="line.297"></a> 298 * .set(<jsf>SERIALIZER_useWhitespace</jsf>, <jk>true</jk>)<a name="line.298"></a> 299 * .set(<jsf>SERIALIZER_initialDepth</jsf>, 2)<a name="line.299"></a> 300 * .build();<a name="line.300"></a> 301 * <a name="line.301"></a> 302 * <jc>// Produces "\t\t{\n\t\t\t'foo':'bar'\n\t\t}\n"</jc><a name="line.302"></a> 303 * String json = s.serialize(<jk>new</jk> MyBean());<a name="line.303"></a> 304 * <a name="line.304"></a> 305 */<a name="line.305"></a> 306 public static final String SERIALIZER_initialDepth = PREFIX + "initialDepth.i";<a name="line.306"></a> 307<a name="line.307"></a> 308 /**<a name="line.308"></a> 309 * Configuration property: Serializer listener.<a name="line.309"></a> 310 * <a name="line.310"></a> 311 * <h5 class='section'>Property:</h5><a name="line.311"></a> 312 * <ul><a name="line.312"></a> 313 * <li>Name: <js>"Serializer.listener.c"</js><a name="line.313"></a> 314 * <li>Data type: <code>Class&lt;? extends SerializerListener&gt;</code><a name="line.314"></a> 315 * <li>Default: <jk>null</jk><a name="line.315"></a> 316 * <li>Session-overridable: <jk>true</jk><a name="line.316"></a> 317 * <li>Methods: <a name="line.317"></a> 318 * <ul><a name="line.318"></a> 319 * <li class='jm'>{@link SerializerBuilder#listener(Class)}<a name="line.319"></a> 320 * </ul><a name="line.320"></a> 321 * </ul><a name="line.321"></a> 322 * <a name="line.322"></a> 323 * <h5 class='section'>Description:</h5><a name="line.323"></a> 324 * <a name="line.324"></a> 325 * Class used to listen for errors and warnings that occur during serialization.<a name="line.325"></a> 326 * <a name="line.326"></a> 327 * <h5 class='section'>Example:</h5><a name="line.327"></a> 328 * <a name="line.328"></a> 329 * <jc>// Define our serializer listener.</jc><a name="line.329"></a> 330 * <jc>// Simply captures all errors.</jc><a name="line.330"></a> 331 * <jk>public class</jk> MySerializerListener <jk>extends</jk> SerializerListener {<a name="line.331"></a> 332 * <a name="line.332"></a> 333 * <jc>// A simple property to store our events.</jc><a name="line.333"></a> 334 * <jk>public</jk> List&lt;String&gt; <jf>events</jf> = <jk>new</jk> LinkedList&lt;&gt;();<a name="line.334"></a> 335 * <a name="line.335"></a> 336 * <ja>@Override</ja> <a name="line.336"></a> 337 * <jk>public</jk> &lt;T&gt; <jk>void</jk> onError(SerializerSession session, Throwable t, String msg) {<a name="line.337"></a> 338 * <jf>events</jf>.add(session.getLastLocation() + <js>","</js> + msg + <js>","</js> + t);<a name="line.338"></a> 339 * }<a name="line.339"></a> 340 * }<a name="line.340"></a> 341 * <a name="line.341"></a> 342 * <jc>// Create a serializer using our listener.</jc><a name="line.342"></a> 343 * WriterSerializer s = JsonSerializer.<a name="line.343"></a> 344 * .<jsm>create</jsm>()<a name="line.344"></a> 345 * .listener(MySerializerListener.<jk>class</jk>)<a name="line.345"></a> 346 * .build();<a name="line.346"></a> 347 * <a name="line.347"></a> 348 * <jc>// Same, but use property.</jc><a name="line.348"></a> 349 * WriterSerializer s = JsonSerializer.<a name="line.349"></a> 350 * .<jsm>create</jsm>()<a name="line.350"></a> 351 * .set(<jsf>SERIALIZER_listener</jsf>, MySerializerListener.<jk>class</jk>)<a name="line.351"></a> 352 * .build();<a name="line.352"></a> 353 * <a name="line.353"></a> 354 * <jc>// Create a session object.</jc><a name="line.354"></a> 355 * <jc>// Needed because listeners are created per-session.</jc><a name="line.355"></a> 356 * <jk>try</jk> (WriterSerializerSession ss = s.createSession()) {<a name="line.356"></a> 357 * <a name="line.357"></a> 358 * <jc>// Serialize a bean.</jc><a name="line.358"></a> 359 * String json = ss.serialize(<jk>new</jk> MyBean());<a name="line.359"></a> 360 * <a name="line.360"></a> 361 * <jc>// Get the listener.</jc><a name="line.361"></a> 362 * MySerializerListener l = ss.getListener(MySerializerListener.<jk>class</jk>);<a name="line.362"></a> 363 * <a name="line.363"></a> 364 * <jc>// Dump the results to the console.</jc><a name="line.364"></a> 365 * JsonSerializer.<jsf>DEFAULT_LAX</jsf>.println(l.<jf>events</jf>);<a name="line.365"></a> 366 * }<a name="line.366"></a> 367 * <a name="line.367"></a> 368 */<a name="line.368"></a> 369 public static final String SERIALIZER_listener = PREFIX + "listener.c";<a name="line.369"></a> 370<a name="line.370"></a> 371 /**<a name="line.371"></a> 372 * Configuration property: Max serialization depth.<a name="line.372"></a> 373 * <a name="line.373"></a> 374 * <h5 class='section'>Property:</h5><a name="line.374"></a> 375 * <ul><a name="line.375"></a> 376 * <li>Name: <js>"Serializer.maxDepth.i"</js><a name="line.376"></a> 377 * <li>Data type: <code>Integer</code><a name="line.377"></a> 378 * <li>Default: <code>100</code><a name="line.378"></a> 379 * <li>Session-overridable: <jk>true</jk><a name="line.379"></a> 380 * <li>Methods: <a name="line.380"></a> 381 * <ul><a name="line.381"></a> 382 * <li class='jm'>{@link SerializerBuilder#maxDepth(int)}<a name="line.382"></a> 383 * </ul><a name="line.383"></a> 384 * </ul><a name="line.384"></a> 385 * <a name="line.385"></a> 386 * <h5 class='section'>Description:</h5><a name="line.386"></a> 387 * <a name="line.387"></a> 388 * Abort serialization if specified depth is reached in the POJO tree.<a name="line.388"></a> 389 * If this depth is exceeded, an exception is thrown.<a name="line.389"></a> 390 * <a name="line.390"></a> 391 * <h5 class='section'>Example:</h5><a name="line.391"></a> 392 * <a name="line.392"></a> 393 * <jc>// Create a serializer that throws an exception if the depth is greater than 20.</jc><a name="line.393"></a> 394 * WriterSerializer s = JsonSerializer<a name="line.394"></a> 395 * .<jsm>create</jsm>()<a name="line.395"></a> 396 * .maxDepth(20)<a name="line.396"></a> 397 * .build();<a name="line.397"></a> 398 * <a name="line.398"></a> 399 * <jc>// Same, but use property.</jc><a name="line.399"></a> 400 * WriterSerializer s = JsonSerializer<a name="line.400"></a> 401 * .<jsm>create</jsm>()<a name="line.401"></a> 402 * .set(<jsf>SERIALIZER_maxDepth</jsf>, 20)<a name="line.402"></a> 403 * .build();<a name="line.403"></a> 404 * <a name="line.404"></a> 405 */<a name="line.405"></a> 406 public static final String SERIALIZER_maxDepth = PREFIX + "maxDepth.i";<a name="line.406"></a> 407<a name="line.407"></a> 408 /**<a name="line.408"></a> 409 * Configuration property: Maximum indentation.<a name="line.409"></a> 410 * <a name="line.410"></a> 411 * <h5 class='section'>Property:</h5><a name="line.411"></a> 412 * <ul><a name="line.412"></a> 413 * <li>Name: <js>"Serializer.maxIndent.i"</js><a name="line.413"></a> 414 * <li>Data type: <code>Integer</code><a name="line.414"></a> 415 * <li>Default: <code>100</code><a name="line.415"></a> 416 * <li>Session-overridable: <jk>true</jk><a name="line.416"></a> 417 * <li>Methods: <a name="line.417"></a> 418 * <ul><a name="line.418"></a> 419 * <li class='jm'>{@link SerializerBuilder#maxIndent(int)}<a name="line.419"></a> 420 * </ul><a name="line.420"></a> 421 * </ul><a name="line.421"></a> 422 * <a name="line.422"></a> 423 * <h5 class='section'>Description:</h5><a name="line.423"></a> 424 * <a name="line.424"></a> 425 * Specifies the maximum indentation level in the serialized document.<a name="line.425"></a> 426 * <a name="line.426"></a> 427 * <a name="line.427"></a> 428 * This setting does not apply to the MessagePack or RDF serializers.<a name="line.428"></a> 429 * <a name="line.429"></a> 430 * <h5 class='section'>Example:</h5><a name="line.430"></a> 431 * <a name="line.431"></a> 432 * <jc>// Create a serializer that indents a maximum of 20 tabs.</jc><a name="line.432"></a> 433 * WriterSerializer s = JsonSerializer<a name="line.433"></a> 434 * .<jsm>create</jsm>()<a name="line.434"></a> 435 * .maxIndent(20)<a name="line.435"></a> 436 * .build();<a name="line.436"></a> 437 * <a name="line.437"></a> 438 * <jc>// Same, but use property.</jc><a name="line.438"></a> 439 * WriterSerializer s = JsonSerializer<a name="line.439"></a> 440 * .<jsm>create</jsm>()<a name="line.440"></a> 441 * .set(<jsf>SERIALIZER_maxIndent</jsf>, 20)<a name="line.441"></a> 442 * .build();<a name="line.442"></a> 443 * <a name="line.443"></a> 444 */<a name="line.444"></a> 445 public static final String SERIALIZER_maxIndent = PREFIX + "maxIndent.i";<a name="line.445"></a> 446<a name="line.446"></a> 447 /**<a name="line.447"></a> 448 * Configuration property: Quote character.<a name="line.448"></a> 449 * <a name="line.449"></a> 450 * <h5 class='section'>Property:</h5><a name="line.450"></a> 451 * <ul><a name="line.451"></a> 452 * <li>Name: <js>"Serializer.quoteChar.s"</js><a name="line.452"></a> 453 * <li>Data type: <code>String</code><a name="line.453"></a> 454 * <li>Default: <js>"\""</js><a name="line.454"></a> 455 * <li>Session-overridable: <jk>true</jk><a name="line.455"></a> 456 * <li>Methods: <a name="line.456"></a> 457 * <ul><a name="line.457"></a> 458 * <li class='jm'>{@link SerializerBuilder#quoteChar(char)}<a name="line.458"></a> 459 * <li class='jm'>{@link SerializerBuilder#sq()}<a name="line.459"></a> 460 * </ul><a name="line.460"></a> 461 * </ul><a name="line.461"></a> 462 * <a name="line.462"></a> 463 * <h5 class='section'>Description:</h5><a name="line.463"></a> 464 * <a name="line.464"></a> 465 * This is the character used for quoting attributes and values.<a name="line.465"></a> 466 * <a name="line.466"></a> 467 * <a name="line.467"></a> 468 * This setting does not apply to the MessagePack or RDF serializers.<a name="line.468"></a> 469 * <a name="line.469"></a> 470 * <h5 class='section'>Example:</h5><a name="line.470"></a> 471 * <a name="line.471"></a> 472 * <jc>// Create a serializer that uses single quotes.</jc><a name="line.472"></a> 473 * WriterSerializer s = JsonSerializer<a name="line.473"></a> 474 * .<jsm>create</jsm>()<a name="line.474"></a> 475 * .sq()<a name="line.475"></a> 476 * .build();<a name="line.476"></a> 477 * <a name="line.477"></a> 478 * <jc>// Same, but use property.</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 * .set(<jsf>SERIALIZER_quoteChar</jsf>, <js>'\''</js>)<a name="line.481"></a> 482 * .build();<a name="line.482"></a> 483 * <a name="line.483"></a> 484 */<a name="line.484"></a> 485 public static final String SERIALIZER_quoteChar = PREFIX + "quoteChar.s";<a name="line.485"></a> 486<a name="line.486"></a> 487 /**<a name="line.487"></a> 488 * Configuration property: Sort arrays and collections alphabetically.<a name="line.488"></a> 489 * <a name="line.489"></a> 490 * <h5 class='section'>Property:</h5><a name="line.490"></a> 491 * <ul><a name="line.491"></a> 492 * <li>Name: <js>"Serializer.sortCollections.b"</js><a name="line.492"></a> 493 * <li>Data type: <code>Boolean</code><a name="line.493"></a> 494 * <li>Default: <jk>false</jk><a name="line.494"></a> 495 * <li>Session-overridable: <jk>true</jk><a name="line.495"></a> 496 * <li>Methods: <a name="line.496"></a> 497 * <ul><a name="line.497"></a> 498 * <li class='jm'>{@link SerializerBuilder#sortCollections(boolean)}<a name="line.498"></a> 499 * <li class='jm'>{@link SerializerBuilder#sortCollections()}<a name="line.499"></a> 500 * </ul><a name="line.500"></a> 501 * </ul><a name="line.501"></a> 502 * <a name="line.502"></a> 503 * <h5 class='section'>Description:</h5><a name="line.503"></a> 504 * <a name="line.504"></a> 505 * <a name="line.505"></a> 506 * Copies and sorts the contents of arrays and collections before serializing them.<a name="line.506"></a> 507 * <a name="line.507"></a> 508 * <a name="line.508"></a> 509 * Note that this introduces a performance penalty.<a name="line.509"></a> 510 * <a name="line.510"></a> 511 * <h5 class='section'>Example:</h5><a name="line.511"></a> 512 * <a name="line.512"></a> 513 * <jc>// Create a serializer that sorts arrays and collections before serialization.</jc><a name="line.513"></a> 514 * WriterSerializer s = JsonSerializer<a name="line.514"></a> 515 * .<jsm>create</jsm>()<a name="line.515"></a> 516 * .sortCollections()<a name="line.516"></a> 517 * .build();<a name="line.517"></a> 518 * <a name="line.518"></a> 519 * <jc>// Same, but use property.</jc><a name="line.519"></a> 520 * WriterSerializer s = JsonSerializer<a name="line.520"></a> 521 * .<jsm>create</jsm>()<a name="line.521"></a> 522 * .set(<jsf>SERIALIZER_sortCollections</jsf>, <jk>true</jk>)<a name="line.522"></a> 523 * .build();<a name="line.523"></a> 524 * <a name="line.524"></a> 525 */<a name="line.525"></a> 526 public static final String SERIALIZER_sortCollections = PREFIX + "sortCollections.b";<a name="line.526"></a> 527<a name="line.527"></a> 528 /**<a name="line.528"></a> 529 * Configuration property: Sort maps alphabetically.<a name="line.529"></a> 530 * <a name="line.530"></a> 531 * <h5 class='section'>Property:</h5><a name="line.531"></a> 532 * <ul><a name="line.532"></a> 533 * <li>Name: <js>"Serializer.sortMaps.b"</js><a name="line.533"></a> 534 * <li>Data type: <code>Boolean</code><a name="line.534"></a> 535 * <li>Default: <jk>false</jk><a name="line.535"></a> 536 * <li>Session-overridable: <jk>true</jk><a name="line.536"></a> 537 * <li>Methods: <a name="line.537"></a> 538 * <ul><a name="line.538"></a> 539 * <li class='jm'>{@link SerializerBuilder#sortMaps(boolean)}<a name="line.539"></a> 540 * <li class='jm'>{@link SerializerBuilder#sortMaps()}<a name="line.540"></a> 541 * </ul><a name="line.541"></a> 542 * </ul><a name="line.542"></a> 543 * <a name="line.543"></a> 544 * <h5 class='section'>Description:</h5><a name="line.544"></a> 545 * <a name="line.545"></a> 546 * <a name="line.546"></a> 547 * Copies and sorts the contents of maps by their keys before serializing them.<a name="line.547"></a> 548 * <a name="line.548"></a> 549 * <a name="line.549"></a> 550 * Note that this introduces a performance penalty.<a name="line.550"></a> 551 * <a name="line.551"></a> 552 * <h5 class='section'>Example:</h5><a name="line.552"></a> 553 * <a name="line.553"></a> 554 * <jc>// Create a serializer that sorts maps before serialization.</jc><a name="line.554"></a> 555 * WriterSerializer s = JsonSerializer<a name="line.555"></a> 556 * .<jsm>create</jsm>()<a name="line.556"></a> 557 * .sortMaps()<a name="line.557"></a> 558 * .build();<a name="line.558"></a> 559 * <a name="line.559"></a> 560 * <jc>// Same, but use property.</jc><a name="line.560"></a> 561 * WriterSerializer s = JsonSerializer<a name="line.561"></a> 562 * .<jsm>create</jsm>()<a name="line.562"></a> 563 * .set(<jsf>SERIALIZER_sortMaps</jsf>, <jk>true</jk>)<a name="line.563"></a> 564 * .build();<a name="line.564"></a> 565 * <a name="line.565"></a> 566 */<a name="line.566"></a> 567 public static final String SERIALIZER_sortMaps = PREFIX + "sortMaps.b";<a name="line.567"></a> 568<a name="line.568"></a> 569 /**<a name="line.569"></a> 570 * Configuration property: Trim empty lists and arrays.<a name="line.570"></a> 571 * <a name="line.571"></a> 572 * <h5 class='section'>Property:</h5><a name="line.572"></a> 573 * <ul><a name="line.573"></a> 574 * <li>Name: <js>"Serializer.trimEmptyCollections.b"</js><a name="line.574"></a> 575 * <li>Data type: <code>Boolean</code><a name="line.575"></a> 576 * <li>Default: <jk>false</jk><a name="line.576"></a> 577 * <li>Session-overridable: <jk>true</jk><a name="line.577"></a> 578 * <li>Methods: <a name="line.578"></a> 579 * <ul><a name="line.579"></a> 580 * <li class='jm'>{@link SerializerBuilder#trimEmptyCollections(boolean)}<a name="line.580"></a> 581 * <li class='jm'>{@link SerializerBuilder#trimEmptyCollections()}<a name="line.581"></a> 582 * </ul><a name="line.582"></a> 583 * </ul><a name="line.583"></a> 584 * <a name="line.584"></a> 585 * <h5 class='section'>Description:</h5><a name="line.585"></a> 586 * <a name="line.586"></a> 587 * <a name="line.587"></a> 588 * If <jk>true</jk>, empty lists and arrays will not be serialized.<a name="line.588"></a> 589 * <a name="line.589"></a> 590 * <a name="line.590"></a> 591 * Note that enabling this setting has the following effects on parsing:<a name="line.591"></a> 592 * <ul class='spaced-list'><a name="line.592"></a> 593 * <li><a name="line.593"></a> 594 * Map entries with empty list values will be lost.<a name="line.594"></a> 595 * <li><a name="line.595"></a> 596 * Bean properties with empty list values will not be set.<a name="line.596"></a> 597 * </ul><a name="line.597"></a> 598 * <a name="line.598"></a> 599 * <h5 class='section'>Example:</h5><a name="line.599"></a> 600 * <a name="line.600"></a> 601 * <jc>// Create a serializer that skips empty arrays and collections.</jc><a name="line.601"></a> 602 * WriterSerializer s = JsonSerializer<a name="line.602"></a> 603 * .<jsm>create</jsm>()<a name="line.603"></a> 604 * .trimEmptyCollections()<a name="line.604"></a> 605 * .build();<a name="line.605"></a> 606 * <a name="line.606"></a> 607 * <jc>// Same, but use property.</jc><a name="line.607"></a> 608 * WriterSerializer s = JsonSerializer<a name="line.608"></a> 609 * .<jsm>create</jsm>()<a name="line.609"></a> 610 * .set(<jsf>SERIALIZER_trimEmptyCollections</jsf>, <jk>true</jk>)<a name="line.610"></a> 611 * .build();<a name="line.611"></a> 612 * <a name="line.612"></a> 613 */<a name="line.613"></a> 614 public static final String SERIALIZER_trimEmptyCollections = PREFIX + "trimEmptyCollections.b";<a name="line.614"></a> 615<a name="line.615"></a> 616 /**<a name="line.616"></a> 617 * Configuration property: Trim empty maps.<a name="line.617"></a> 618 * <a name="line.618"></a> 619 * <h5 class='section'>Property:</h5><a name="line.619"></a> 620 * <ul><a name="line.620"></a> 621 * <li>Name: <js>"Serializer.trimEmptyMaps.b"</js><a name="line.621"></a> 622 * <li>Data type: <code>Boolean</code><a name="line.622"></a> 623 * <li>Default: <jk>false</jk><a name="line.623"></a> 624 * <li>Session-overridable: <jk>true</jk><a name="line.624"></a> 625 * <li>Methods: <a name="line.625"></a> 626 * <ul><a name="line.626"></a> 627 * <li class='jm'>{@link SerializerBuilder#trimEmptyMaps(boolean)}<a name="line.627"></a> 628 * <li class='jm'>{@link SerializerBuilder#trimEmptyMaps()}<a name="line.628"></a> 629 * </ul><a name="line.629"></a> 630 * </ul><a name="line.630"></a> 631 * <a name="line.631"></a> 632 * <h5 class='section'>Description:</h5><a name="line.632"></a> 633 * <a name="line.633"></a> 634 * If <jk>true</jk>, empty map values will not be serialized to the output.<a name="line.634"></a> 635 * <a name="line.635"></a> 636 * <a name="line.636"></a> 637 * Note that enabling this setting has the following effects on parsing:<a name="line.637"></a> 638 * <ul class='spaced-list'><a name="line.638"></a> 639 * <li><a name="line.639"></a> 640 * Bean properties with empty map values will not be set.<a name="line.640"></a> 641 * </ul><a name="line.641"></a> 642 * <a name="line.642"></a> 643 * <h5 class='section'>Example:</h5><a name="line.643"></a> 644 * <a name="line.644"></a> 645 * <jc>// Create a serializer that skips empty maps.</jc><a name="line.645"></a> 646 * WriterSerializer s = JsonSerializer<a name="line.646"></a> 647 * .<jsm>create</jsm>()<a name="line.647"></a> 648 * .trimEmptyMaps()<a name="line.648"></a> 649 * .build();<a name="line.649"></a> 650 * <a name="line.650"></a> 651 * <jc>// Same, but use property.</jc><a name="line.651"></a> 652 * WriterSerializer s = JsonSerializer<a name="line.652"></a> 653 * .<jsm>create</jsm>()<a name="line.653"></a> 654 * .set(<jsf>SERIALIZER_trimEmptyMaps</jsf>, <jk>true</jk>)<a name="line.654"></a> 655 * .build();<a name="line.655"></a> 656 * <a name="line.656"></a> 657 */<a name="line.657"></a> 658 public static final String SERIALIZER_trimEmptyMaps = PREFIX + "trimEmptyMaps.b";<a name="line.658"></a> 659<a name="line.659"></a> 660 /**<a name="line.660"></a> 661 * Configuration property: Trim null bean property values.<a name="line.661"></a> 662 * <a name="line.662"></a> 663 * <h5 class='section'>Property:</h5><a name="line.663"></a> 664 * <ul><a name="line.664"></a> 665 * <li>Name: <js>"Serializer.trimNullProperties.b"</js><a name="line.665"></a> 666 * <li>Data type: <code>Boolean</code><a name="line.666"></a> 667 * <li>Default: <jk>true</jk><a name="line.667"></a> 668 * <li>Session-overridable: <jk>true</jk><a name="line.668"></a> 669 * <li>Methods: <a name="line.669"></a> 670 * <ul><a name="line.670"></a> 671 * <li class='jm'>{@link SerializerBuilder#trimNullProperties(boolean)}<a name="line.671"></a> 672 * </ul><a name="line.672"></a> 673 * </ul><a name="line.673"></a> 674 * <a name="line.674"></a> 675 * <h5 class='section'>Description:</h5><a name="line.675"></a> 676 * <a name="line.676"></a> 677 * If <jk>true</jk>, null bean values will not be serialized to the output.<a name="line.677"></a> 678 * <a name="line.678"></a> 679 * <a name="line.679"></a> 680 * Note that enabling this setting has the following effects on parsing:<a name="line.680"></a> 681 * <ul class='spaced-list'><a name="line.681"></a> 682 * <li><a name="line.682"></a> 683 * Map entries with <jk>null</jk> values will be lost.<a name="line.683"></a> 684 * </ul><a name="line.684"></a> 685 * <a name="line.685"></a> 686 * <h5 class='section'>Example:</h5><a name="line.686"></a> 687 * <a name="line.687"></a> 688 * <jc>// Create a serializer that serializes null properties.</jc><a name="line.688"></a> 689 * WriterSerializer s = JsonSerializer<a name="line.689"></a> 690 * .<jsm>create</jsm>()<a name="line.690"></a> 691 * .trimNullProperties(<jk>false</jk>)<a name="line.691"></a> 692 * .build();<a name="line.692"></a> 693 * <a name="line.693"></a> 694 * <jc>// Same, but use property.</jc><a name="line.694"></a> 695 * WriterSerializer s = JsonSerializer<a name="line.695"></a> 696 * .<jsm>create</jsm>()<a name="line.696"></a> 697 * .set(<jsf>SERIALIZER_trimNullProperties</jsf>, <jk>false</jk>)<a name="line.697"></a> 698 * .build();<a name="line.698"></a> 699 * <a name="line.699"></a> 700 */<a name="line.700"></a> 701 public static final String SERIALIZER_trimNullProperties = PREFIX + "trimNullProperties.b";<a name="line.701"></a> 702<a name="line.702"></a> 703 /**<a name="line.703"></a> 704 * Configuration property: Trim strings.<a name="line.704"></a> 705 * <a name="line.705"></a> 706 * <h5 class='section'>Property:</h5><a name="line.706"></a> 707 * <ul><a name="line.707"></a> 708 * <li>Name: <js>"Serializer.trimStrings.b"</js><a name="line.708"></a> 709 * <li>Data type: <code>Boolean</code><a name="line.709"></a> 710 * <li>Default: <jk>false</jk><a name="line.710"></a> 711 * <li>Session-overridable: <jk>true</jk><a name="line.711"></a> 712 * <li>Methods: <a name="line.712"></a> 713 * <ul><a name="line.713"></a> 714 * <li class='jm'>{@link SerializerBuilder#trimStrings(boolean)}<a name="line.714"></a> 715 * <li class='jm'>{@link SerializerBuilder#trimStrings()}<a name="line.715"></a> 716 * </ul><a name="line.716"></a> 717 * </ul><a name="line.717"></a> 718 * <a name="line.718"></a> 719 * <h5 class='section'>Description:</h5><a name="line.719"></a> 720 * <a name="line.720"></a> 721 * If <jk>true</jk>, string values will be trimmed of whitespace using {@link String#trim()} before being serialized.<a name="line.721"></a> 722 * <a name="line.722"></a> 723 * <h5 class='section'>Example:</h5><a name="line.723"></a> 724 * <a name="line.724"></a> 725 * <jc>// Create a serializer that trims strings before serialization.</jc><a name="line.725"></a> 726 * WriterSerializer s = JsonSerializer<a name="line.726"></a> 727 * .<jsm>create</jsm>()<a name="line.727"></a> 728 * .trimStrings()<a name="line.728"></a> 729 * .build();<a name="line.729"></a> 730 * <a name="line.730"></a> 731 * <jc>// Same, but use property.</jc><a name="line.731"></a> 732 * WriterSerializer s = JsonSerializer<a name="line.732"></a> 733 * .<jsm>create</jsm>()<a name="line.733"></a> 734 * .set(<jsf>SERIALIZER_trimStrings</jsf>, <jk>true</jk>)<a name="line.734"></a> 735 * .build();<a name="line.735"></a> 736 * <a name="line.736"></a> 737 * Map&lt;String,String&gt; m = <jk>new</jk> HashMap&lt;&gt;();<a name="line.737"></a> 738 * m.put(<js>" foo "</js>, <js>" bar "</js>);<a name="line.738"></a> 739 * <a name="line.739"></a> 740 * <jc>// Produces "{foo:'bar'}"</jc><a name="line.740"></a> 741 * String json = JsonSerializer.<jsf>DEFAULT_LAX</jsf>.toString(m);<a name="line.741"></a> 742 * <a name="line.742"></a> 743 */<a name="line.743"></a> 744 public static final String SERIALIZER_trimStrings = PREFIX + "trimStrings.b";<a name="line.744"></a> 745<a name="line.745"></a> 746 /**<a name="line.746"></a> 747 * Configuration property: URI context bean.<a name="line.747"></a> 748 * <a name="line.748"></a> 749 * <h5 class='section'>Property:</h5><a name="line.749"></a> 750 * <ul><a name="line.750"></a> 751 * <li>Name: <js>"Serializer.uriContext.s"</js><a name="line.751"></a> 752 * <li>Data type: <code>String</code> (JSON object representing a {@link UriContext})<a name="line.752"></a> 753 * <li>Default: <js>"{}"</js><a name="line.753"></a> 754 * <li>Session-overridable: <jk>true</jk><a name="line.754"></a> 755 * <li>Methods: <a name="line.755"></a> 756 * <ul><a name="line.756"></a> 757 * <li class='jm'>{@link SerializerBuilder#uriContext(UriContext)}<a name="line.757"></a> 758 * <li class='jm'>{@link SerializerBuilder#uriContext(String)}<a name="line.758"></a> 759 * </ul><a name="line.759"></a> 760 * </ul><a name="line.760"></a> 761 * <a name="line.761"></a> 762 * <h5 class='section'>Description:</h5><a name="line.762"></a> 763 * <a name="line.763"></a> 764 * Bean used for resolution of URIs to absolute or root-relative form.<a name="line.764"></a> 765 * <a name="line.765"></a> 766 * <h5 class='section'>Example:</h5><a name="line.766"></a> 767 * <a name="line.767"></a> 768 * <jc>// Our URI contextual information.</jc><a name="line.768"></a> 769 * String authority = <js>"http://localhost:10000"</js>;<a name="line.769"></a> 770 * String contextRoot = <js>"/myContext"</js>;<a name="line.770"></a> 771 * String servletPath = <js>"/myServlet"</js>;<a name="line.771"></a> 772 * String pathInfo = <js>"/foo"</js>;<a name="line.772"></a> 773 * <a name="line.773"></a> 774 * <jc>// Create a UriContext object.</jc><a name="line.774"></a> 775 * UriContext uriContext = <jk>new</jk> UriContext(authority, contextRoot, servletPath, pathInfo);<a name="line.775"></a> 776 * <a name="line.776"></a> 777 * <jc>// Associate it with our serializer.</jc><a name="line.777"></a> 778 * WriterSerializer s = JsonSerializer<a name="line.778"></a> 779 * .<jsm>create</jsm>()<a name="line.779"></a> 780 * .uriContext(uriContext)<a name="line.780"></a> 781 * .build();<a name="line.781"></a> 782 * <a name="line.782"></a> 783 * <jc>// Same, but specify as a JSON string.</jc><a name="line.783"></a> 784 * WriterSerializer s = JsonSerializer<a name="line.784"></a> 785 * .<jsm>create</jsm>()<a name="line.785"></a> 786 * .uriContext(<js>"{authority:'http://localhost:10000',contextRoot:'/myContext',servletPath:'/myServlet',pathInfo:'/foo'}"</js>)<a name="line.786"></a> 787 * .build();<a name="line.787"></a> 788 * <a name="line.788"></a> 789 * <jc>// Same, but use property.</jc><a name="line.789"></a> 790 * WriterSerializer s = JsonSerializer<a name="line.790"></a> 791 * .<jsm>create</jsm>()<a name="line.791"></a> 792 * .set(<jsf>SERIALIZER_uriContext</jsf>, uriContext)<a name="line.792"></a> 793 * .build();<a name="line.793"></a> 794 * <a name="line.794"></a> 795 * <jc>// Same, but define it on the session args instead.</jc><a name="line.795"></a> 796 * SerializerSessionArgs sessionArgs = <jk>new</jk> SerializerSessionArgs().uriContext(uriContext);<a name="line.796"></a> 797 * <jk>try</jk> (WriterSerializerSession session = s.createSession(sessionArgs)) {<a name="line.797"></a> 798 * ...<a name="line.798"></a> 799 * }<a name="line.799"></a> 800 * <a name="line.800"></a> 801 * <a name="line.801"></a> 802 * <h5 class='section'>See Also:</h5><a name="line.802"></a> 803 * <ul><a name="line.803"></a> 804 * <li class='link'><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.URIs">Overview &gt; juneau-marshall &gt; URIs</a><a name="line.804"></a> 805 * </ul><a name="line.805"></a> 806 */<a name="line.806"></a> 807 public static final String SERIALIZER_uriContext = PREFIX + "uriContext.s";<a name="line.807"></a> 808<a name="line.808"></a> 809 /**<a name="line.809"></a> 810 * Configuration property: URI relativity.<a name="line.810"></a> 811 * <a name="line.811"></a> 812 * <h5 class='section'>Property:</h5><a name="line.812"></a> 813 * <ul><a name="line.813"></a> 814 * <li>Name: <js>"Serializer.uriRelativity.s"</js><a name="line.814"></a> 815 * <li>Data type: <code>String</code> ({@link UriRelativity})<a name="line.815"></a> 816 * <li>Default: <js>"RESOURCE"</js><a name="line.816"></a> 817 * <li>Session-overridable: <jk>true</jk><a name="line.817"></a> 818 * <li>Methods: <a name="line.818"></a> 819 * <ul><a name="line.819"></a> 820 * <li class='jm'>{@link SerializerBuilder#uriRelativity(UriRelativity)}<a name="line.820"></a> 821 * <li class='jm'>{@link SerializerBuilder#uriRelativity(String)}<a name="line.821"></a> 822 * </ul><a name="line.822"></a> 823 * </ul><a name="line.823"></a> 824 * <a name="line.824"></a> 825 * <h5 class='section'>Description:</h5><a name="line.825"></a> 826 * <a name="line.826"></a> 827 * Defines what relative URIs are relative to when serializing any of the following:<a name="line.827"></a> 828 * <ul><a name="line.828"></a> 829 * <li>{@link java.net.URI}<a name="line.829"></a> 830 * <li>{@link java.net.URL}<a name="line.830"></a> 831 * <li>Properties and classes annotated with {@link org.apache.juneau.annotation.URI @URI}<a name="line.831"></a> 832 * </ul><a name="line.832"></a> 833 * <a name="line.833"></a> 834 * <a name="line.834"></a> 835 * Possible values are:<a name="line.835"></a> 836 * <ul><a name="line.836"></a> 837 * <li class='jf'>{@link UriRelativity#RESOURCE}<a name="line.837"></a> 838 * - Relative URIs should be considered relative to the servlet URI.<a name="line.838"></a> 839 * <li class='jf'>{@link UriRelativity#PATH_INFO}<a name="line.839"></a> 840 * - Relative URIs should be considered relative to the request URI.<a name="line.840"></a> 841 * </ul><a name="line.841"></a> 842 * <a name="line.842"></a> 843 * <h5 class='figure'>Example:</h5><a name="line.843"></a> 844 * <a name="line.844"></a> 845 * <jc>// Define a serializer that converts resource-relative URIs to absolute form.</jc><a name="line.845"></a> 846 * WriterSerializer s = JsonSerializer<a name="line.846"></a> 847 * .<jsm>create</jsm>()<a name="line.847"></a> 848 * .uriContext(<js>"{authority:'http://localhost:10000',contextRoot:'/myContext',servletPath:'/myServlet',pathInfo:'/foo'}"</js>)<a name="line.848"></a> 849 * .uriResolution(<jsf>ABSOLUTE</jsf>)<a name="line.849"></a> 850 * .uriRelativity(<jsf>RESOURCE</jsf>)<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 * <h5 class='section'>See Also:</h5><a name="line.854"></a> 855 * <ul><a name="line.855"></a> 856 * <li class='link'><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.URIs">Overview &gt; juneau-marshall &gt; URIs</a><a name="line.856"></a> 857 * </ul><a name="line.857"></a> 858 */<a name="line.858"></a> 859 public static final String SERIALIZER_uriRelativity = PREFIX + "uriRelativity.s";<a name="line.859"></a> 860<a name="line.860"></a> 861 /**<a name="line.861"></a> 862 * Configuration property: URI resolution.<a name="line.862"></a> 863 * <a name="line.863"></a> 864 * <h5 class='section'>Property:</h5><a name="line.864"></a> 865 * <ul><a name="line.865"></a> 866 * <li>Name: <js>"Serializer.uriResolution.s"</js><a name="line.866"></a> 867 * <li>Data type: <code>String</code> ({@link UriResolution})<a name="line.867"></a> 868 * <li>Default: <js>"NONE"</js><a name="line.868"></a> 869 * <li>Session-overridable: <jk>true</jk><a name="line.869"></a> 870 * <li>Methods: <a name="line.870"></a> 871 * <ul><a name="line.871"></a> 872 * <li class='jm'>{@link SerializerBuilder#uriResolution(UriResolution)}<a name="line.872"></a> 873 * <li class='jm'>{@link SerializerBuilder#uriResolution(String)}<a name="line.873"></a> 874 * </ul><a name="line.874"></a> 875 * </ul><a name="line.875"></a> 876 * <a name="line.876"></a> 877 * <h5 class='section'>Description:</h5><a name="line.877"></a> 878 * <a name="line.878"></a> 879 * Defines the resolution level for URIs when serializing any of the following:<a name="line.879"></a> 880 * <ul><a name="line.880"></a> 881 * <li>{@link java.net.URI}<a name="line.881"></a> 882 * <li>{@link java.net.URL}<a name="line.882"></a> 883 * <li>Properties and classes annotated with {@link org.apache.juneau.annotation.URI @URI}<a name="line.883"></a> 884 * </ul><a name="line.884"></a> 885 * <a name="line.885"></a> 886 * <a name="line.886"></a> 887 * Possible values are:<a name="line.887"></a> 888 * <ul><a name="line.888"></a> 889 * <li class='jf'>{@link UriResolution#ABSOLUTE}<a name="line.889"></a> 890 * - Resolve to an absolute URL (e.g. <js>"http://host:port/context-root/servlet-path/path-info"</js>).<a name="line.890"></a> 891 * <li class='jf'>{@link UriResolution#ROOT_RELATIVE}<a name="line.891"></a> 892 * - Resolve to a root-relative URL (e.g. <js>"/context-root/servlet-path/path-info"</js>).<a name="line.892"></a> 893 * <li class='jf'>{@link UriResolution#NONE}<a name="line.893"></a> 894 * - Don't do any URL resolution.<a name="line.894"></a> 895 * </ul><a name="line.895"></a> 896 * <a name="line.896"></a> 897 * <h5 class='figure'>Example:</h5><a name="line.897"></a> 898 * <a name="line.898"></a> 899 * <jc>// Define a serializer that converts resource-relative URIs to absolute form.</jc><a name="line.899"></a> 900 * WriterSerializer s = JsonSerializer<a name="line.900"></a> 901 * .<jsm>create</jsm>()<a name="line.901"></a> 902 * .uriContext(<js>"{authority:'http://localhost:10000',contextRoot:'/myContext',servletPath:'/myServlet',pathInfo:'/foo'}"</js>)<a name="line.902"></a> 903 * .uriResolution(<jsf>ABSOLUTE</jsf>)<a name="line.903"></a> 904 * .uriRelativity(<jsf>RESOURCE</jsf>)<a name="line.904"></a> 905 * .build();<a name="line.905"></a> 906 * <a name="line.906"></a> 907 * <a name="line.907"></a> 908 * <h5 class='section'>See Also:</h5><a name="line.908"></a> 909 * <ul><a name="line.909"></a> 910 * <li class='link'><a class="doclink" href="../../../../overview-summary.html#juneau-marshall.URIs">Overview &gt; juneau-marshall &gt; URIs</a><a name="line.910"></a> 911 * </ul><a name="line.911"></a> 912 */<a name="line.912"></a> 913 public static final String SERIALIZER_uriResolution = PREFIX + "uriResolution.s";<a name="line.913"></a> 914<a name="line.914"></a> 915 /**<a name="line.915"></a> 916 * Configuration property: Use whitespace.<a name="line.916"></a> 917 * <a name="line.917"></a> 918 * <h5 class='section'>Property:</h5><a name="line.918"></a> 919 * <ul><a name="line.919"></a> 920 * <li>Name: <js>"Serializer.useWhitespace.b"</js><a name="line.920"></a> 921 * <li>Data type: <code>Boolean</code><a name="line.921"></a> 922 * <li>Default: <jk>false</jk><a name="line.922"></a> 923 * <li>Session-overridable: <jk>true</jk><a name="line.923"></a> 924 * <li>Methods: <a name="line.924"></a> 925 * <ul><a name="line.925"></a> 926 * <li class='jm'>{@link SerializerBuilder#useWhitespace(boolean)}<a name="line.926"></a> 927 * <li class='jm'>{@link SerializerBuilder#useWhitespace()}<a name="line.927"></a> 928 * <li class='jm'>{@link SerializerBuilder#ws()}<a name="line.928"></a> 929 * </ul><a name="line.929"></a> 930 * </ul><a name="line.930"></a> 931 * <a name="line.931"></a> 932 * <h5 class='section'>Description:</h5><a name="line.932"></a> 933 * <a name="line.933"></a> 934 * If <jk>true</jk>, whitespace is added to the output to improve readability.<a name="line.934"></a> 935 * <a name="line.935"></a> 936 * <a name="line.936"></a> 937 * This setting does not apply to the MessagePack serializer.<a name="line.937"></a> 938 * <a name="line.938"></a> 939 * <h5 class='section'>Example:</h5><a name="line.939"></a> 940 * <a name="line.940"></a> 941 * <jc>// Create a serializer with whitespace enabled.</jc><a name="line.941"></a> 942 * WriterSerializer s = JsonSerializer<a name="line.942"></a> 943 * .<jsm>create</jsm>()<a name="line.943"></a> 944 * .ws()<a name="line.944"></a> 945 * .build();<a name="line.945"></a> 946 * <a name="line.946"></a> 947 * <jc>// Same, but use property.</jc><a name="line.947"></a> 948 * WriterSerializer s = JsonSerializer<a name="line.948"></a> 949 * .<jsm>create</jsm>()<a name="line.949"></a> 950 * .set(<jsf>SERIALIZER_useWhitespace</jsf>, <jk>true</jk>)<a name="line.950"></a> 951 * .build();<a name="line.951"></a> 952 * <a name="line.952"></a> 953 * <jc>// Produces "\{\n\t'foo': 'bar'\n\}\n"</jc><a name="line.953"></a> 954 * String json = s.serialize(<jk>new</jk> MyBean());<a name="line.954"></a> 955 * <a name="line.955"></a> 956 */<a name="line.956"></a> 957 public static final String SERIALIZER_useWhitespace = PREFIX + "useWhitespace.b";<a name="line.957"></a> 958<a name="line.958"></a> 959 <a name="line.959"></a> 960 static final Serializer DEFAULT = new Serializer(PropertyStore.create().build(), "") {<a name="line.960"></a> 961 @Override<a name="line.961"></a> 962 public SerializerSession createSession(SerializerSessionArgs args) {<a name="line.962"></a> 963 throw new NoSuchMethodError();<a name="line.963"></a> 964 }<a name="line.964"></a> 965 };<a name="line.965"></a> 966 <a name="line.966"></a> 967 //-------------------------------------------------------------------------------------------------------------------<a name="line.967"></a> 968 // Instance<a name="line.968"></a> 969 //-------------------------------------------------------------------------------------------------------------------<a name="line.969"></a> 970<a name="line.970"></a> 971 final int maxDepth, initialDepth, maxIndent;<a name="line.971"></a> 972 final boolean<a name="line.972"></a> 973 detectRecursions,<a name="line.973"></a> 974 ignoreRecursions,<a name="line.974"></a> 975 useWhitespace,<a name="line.975"></a> 976 addBeanTypeProperties,<a name="line.976"></a> 977 trimNulls,<a name="line.977"></a> 978 trimEmptyCollections,<a name="line.978"></a> 979 trimEmptyMaps,<a name="line.979"></a> 980 trimStrings,<a name="line.980"></a> 981 sortCollections,<a name="line.981"></a> 982 sortMaps,<a name="line.982"></a> 983 abridged;<a name="line.983"></a> 984 final char quoteChar;<a name="line.984"></a> 985 final UriContext uriContext;<a name="line.985"></a> 986 final UriResolution uriResolution;<a name="line.986"></a> 987 final UriRelativity uriRelativity;<a name="line.987"></a> 988 final Class<? extends SerializerListener> listener;<a name="line.988"></a> 989<a name="line.989"></a> 990 private final MediaType[] accept;<a name="line.990"></a> 991 private final MediaType produces;<a name="line.991"></a> 992<a name="line.992"></a> 993 // Hidden constructors to force subclass from OuputStreamSerializer or WriterSerializer.<a name="line.993"></a> 994 Serializer(PropertyStore ps, String produces, String...accept) {<a name="line.994"></a> 995 super(ps);<a name="line.995"></a> 996 <a name="line.996"></a> 997 maxDepth = getIntegerProperty(SERIALIZER_maxDepth, 100);<a name="line.997"></a> 998 initialDepth = getIntegerProperty(SERIALIZER_initialDepth, 0);<a name="line.998"></a> 999 detectRecursions = getBooleanProperty(SERIALIZER_detectRecursions, false);<a name="line.999"></a> 1000 ignoreRecursions = getBooleanProperty(SERIALIZER_ignoreRecursions, false);<a name="line.1000"></a> 1001 useWhitespace = getBooleanProperty(SERIALIZER_useWhitespace, false);<a name="line.1001"></a> 1002 maxIndent = getIntegerProperty(SERIALIZER_maxIndent, 100);<a name="line.1002"></a> 1003 addBeanTypeProperties = getBooleanProperty(SERIALIZER_addBeanTypeProperties, true);<a name="line.1003"></a> 1004 trimNulls = getBooleanProperty(SERIALIZER_trimNullProperties, true);<a name="line.1004"></a> 1005 trimEmptyCollections = getBooleanProperty(SERIALIZER_trimEmptyCollections, false);<a name="line.1005"></a> 1006 trimEmptyMaps = getBooleanProperty(SERIALIZER_trimEmptyMaps, false);<a name="line.1006"></a> 1007 trimStrings = getBooleanProperty(SERIALIZER_trimStrings, false);<a name="line.1007"></a> 1008 sortCollections = getBooleanProperty(SERIALIZER_sortCollections, false);<a name="line.1008"></a> 1009 sortMaps = getBooleanProperty(SERIALIZER_sortMaps, false);<a name="line.1009"></a> 1010 abridged = getBooleanProperty(SERIALIZER_abridged, false);<a name="line.1010"></a> 1011 quoteChar = getStringProperty(SERIALIZER_quoteChar, "\"").charAt(0);<a name="line.1011"></a> 1012 uriContext = getProperty(SERIALIZER_uriContext, UriContext.class, UriContext.DEFAULT);<a name="line.1012"></a> 1013 uriResolution = getProperty(SERIALIZER_uriResolution, UriResolution.class, UriResolution.NONE);<a name="line.1013"></a> 1014 uriRelativity = getProperty(SERIALIZER_uriRelativity, UriRelativity.class, UriRelativity.RESOURCE);<a name="line.1014"></a> 1015 listener = getClassProperty(SERIALIZER_listener, SerializerListener.class, null);<a name="line.1015"></a> 1016<a name="line.1016"></a> 1017 this.produces = MediaType.forString(produces);<a name="line.1017"></a> 1018 if (accept.length == 0) {<a name="line.1018"></a> 1019 this.accept = new MediaType[]{this.produces};<a name="line.1019"></a> 1020 } else {<a name="line.1020"></a> 1021 this.accept = new MediaType[accept.length];<a name="line.1021"></a> 1022 for (int i = 0; i < accept.length; i++) {<a name="line.1022"></a> 1023 this.accept[i] = MediaType.forString(accept[i]);<a name="line.1023"></a> 1024 }<a name="line.1024"></a> 1025 }<a name="line.1025"></a> 1026 }<a name="line.1026"></a> 1027<a name="line.1027"></a> 1028 @Override /* Context */<a name="line.1028"></a> 1029 public SerializerBuilder builder() {<a name="line.1029"></a> 1030 return null;<a name="line.1030"></a> 1031 }<a name="line.1031"></a> 1032<a name="line.1032"></a> 1033 //--------------------------------------------------------------------------------<a name="line.1033"></a> 1034 // Abstract methods<a name="line.1034"></a> 1035 //--------------------------------------------------------------------------------<a name="line.1035"></a> 1036<a name="line.1036"></a> 1037 /**<a name="line.1037"></a> 1038 * Returns <jk>true</jk> if this serializer subclasses from {@link WriterSerializer}.<a name="line.1038"></a> 1039 * <a name="line.1039"></a> 1040 * @return <jk>true</jk> if this serializer subclasses from {@link WriterSerializer}.<a name="line.1040"></a> 1041 */<a name="line.1041"></a> 1042 public boolean isWriterSerializer() {<a name="line.1042"></a> 1043 return true;<a name="line.1043"></a> 1044 }<a name="line.1044"></a> 1045<a name="line.1045"></a> 1046 /**<a name="line.1046"></a> 1047 * Create the session object used for actual serialization of objects.<a name="line.1047"></a> 1048 * <a name="line.1048"></a> 1049 * @param args<a name="line.1049"></a> 1050 * Runtime arguments.<a name="line.1050"></a> 1051 * These specify session-level information such as locale and URI context.<a name="line.1051"></a> 1052 * It also include session-level properties that override the properties defined on the bean and serializer<a name="line.1052"></a> 1053 * contexts.<a name="line.1053"></a> 1054 * @return<a name="line.1054"></a> 1055 * The new session object.<a name="line.1055"></a> 1056 */<a name="line.1056"></a> 1057 public abstract SerializerSession createSession(SerializerSessionArgs args);<a name="line.1057"></a> 1058<a name="line.1058"></a> 1059<a name="line.1059"></a> 1060 //--------------------------------------------------------------------------------<a name="line.1060"></a> 1061 // Convenience methods<a name="line.1061"></a> 1062 //--------------------------------------------------------------------------------<a name="line.1062"></a> 1063<a name="line.1063"></a> 1064 @Override /* Context */<a name="line.1064"></a> 1065 public final SerializerSession createSession() {<a name="line.1065"></a> 1066 return createSession(createDefaultSessionArgs());<a name="line.1066"></a> 1067 }<a name="line.1067"></a> 1068<a name="line.1068"></a> 1069 @Override /* Context */<a name="line.1069"></a> 1070 public final SerializerSessionArgs createDefaultSessionArgs() {<a name="line.1070"></a> 1071 return new SerializerSessionArgs(ObjectMap.EMPTY_MAP, null, null, null, getResponseContentType(), null);<a name="line.1071"></a> 1072 }<a name="line.1072"></a> 1073<a name="line.1073"></a> 1074 /**<a name="line.1074"></a> 1075 * Serializes a POJO to the specified output stream or writer.<a name="line.1075"></a> 1076 * <a name="line.1076"></a> 1077 * <a name="line.1077"></a> 1078 * Equivalent to calling <code>serializer.createSession().serialize(o, output);</code><a name="line.1078"></a> 1079 * <a name="line.1079"></a> 1080 * @param o The object to serialize.<a name="line.1080"></a> 1081 * @param output<a name="line.1081"></a> 1082 * The output object.<a name="line.1082"></a> 1083 * Character-based serializers can handle the following output class types:<a name="line.1083"></a> 1084 * <ul><a name="line.1084"></a> 1085 * <li>{@link Writer}<a name="line.1085"></a> 1086 * <li>{@link OutputStream} - Output will be written as UTF-8 encoded stream.<a name="line.1086"></a> 1087 * <li>{@link File} - Output will be written as system-default encoded stream.<a name="line.1087"></a> 1088 * <li>{@link StringBuilder} - Output will be written to the specified string builder.<a name="line.1088"></a> 1089 * </ul><a name="line.1089"></a> 1090 * Stream-based serializers can handle the following output class types:<a name="line.1090"></a> 1091 * <ul><a name="line.1091"></a> 1092 * <li>{@link OutputStream}<a name="line.1092"></a> 1093 * <li>{@link File}<a name="line.1093"></a> 1094 * </ul><a name="line.1094"></a> 1095 * @throws SerializeException If a problem occurred trying to convert the output.<a name="line.1095"></a> 1096 */<a name="line.1096"></a> 1097 public final void serialize(Object o, Object output) throws SerializeException {<a name="line.1097"></a> 1098 createSession().serialize(o, output);<a name="line.1098"></a> 1099 }<a name="line.1099"></a> 1100<a name="line.1100"></a> 1101 /**<a name="line.1101"></a> 1102 * Shortcut method for serializing objects directly to either a <code>String</code> or <code><jk>byte</jk>[]</code><a name="line.1102"></a> 1103 * depending on the serializer type.<a name="line.1103"></a> 1104 * <a name="line.1104"></a> 1105 * @param o The object to serialize.<a name="line.1105"></a> 1106 * @return<a name="line.1106"></a> 1107 * The serialized object.<a name="line.1107"></a> 1108 * Character-based serializers will return a <code>String</code><a name="line.1108"></a> 1109 * Stream-based serializers will return a <code><jk>byte</jk>[]</code><a name="line.1109"></a> 1110 * @throws SerializeException If a problem occurred trying to convert the output.<a name="line.1110"></a> 1111 */<a name="line.1111"></a> 1112 public Object serialize(Object o) throws SerializeException {<a name="line.1112"></a> 1113 return createSession().serialize(o);<a name="line.1113"></a> 1114 }<a name="line.1114"></a> 1115<a name="line.1115"></a> 1116 //--------------------------------------------------------------------------------<a name="line.1116"></a> 1117 // Other methods<a name="line.1117"></a> 1118 //--------------------------------------------------------------------------------<a name="line.1118"></a> 1119<a name="line.1119"></a> 1120 /**<a name="line.1120"></a> 1121 * Returns the media types handled based on the value of the <code>accept</code> parameter passed into the constructor.<a name="line.1121"></a> 1122 * <a name="line.1122"></a> 1123 * @return The list of media types. Never <jk>null</jk>.<a name="line.1123"></a> 1124 */<a name="line.1124"></a> 1125 public final MediaType[] getMediaTypes() {<a name="line.1125"></a> 1126 return accept;<a name="line.1126"></a> 1127 }<a name="line.1127"></a> 1128<a name="line.1128"></a> 1129 /**<a name="line.1129"></a> 1130 * Optional method that returns the response <code>Content-Type</code> for this serializer if it is different from<a name="line.1130"></a> 1131 * the matched media type.<a name="line.1131"></a> 1132 * <a name="line.1132"></a> 1133 * <a name="line.1133"></a> 1134 * This method is specified to override the content type for this serializer.<a name="line.1134"></a> 1135 * For example, the {@link org.apache.juneau.json.JsonSerializer.Simple} class returns that it handles media type<a name="line.1135"></a> 1136 * <js>"text/json+simple"</js>, but returns <js>"text/json"</js> as the actual content type.<a name="line.1136"></a> 1137 * This allows clients to request specific 'flavors' of content using specialized <code>Accept</code> header values.<a name="line.1137"></a> 1138 * <a name="line.1138"></a> 1139 * <a name="line.1139"></a> 1140 * This method is typically meaningless if the serializer is being used stand-alone (i.e. outside of a REST server<a name="line.1140"></a> 1141 * or client).<a name="line.1141"></a> 1142 * <a name="line.1142"></a> 1143 * @return The response content type. If <jk>null</jk>, then the matched media type is used.<a name="line.1143"></a> 1144 */<a name="line.1144"></a> 1145 public final MediaType getResponseContentType() {<a name="line.1145"></a> 1146 return produces;<a name="line.1146"></a> 1147 }<a name="line.1147"></a> 1148 <a name="line.1148"></a> 1149 @Override /* Context */<a name="line.1149"></a> 1150 public ObjectMap asMap() {<a name="line.1150"></a> 1151 return super.asMap()<a name="line.1151"></a> 1152 .append("Serializer", new ObjectMap()<a name="line.1152"></a> 1153 .append("maxDepth", maxDepth)<a name="line.1153"></a> 1154 .append("initialDepth", initialDepth)<a name="line.1154"></a> 1155 .append("detectRecursions", detectRecursions)<a name="line.1155"></a> 1156 .append("ignoreRecursions", ignoreRecursions)<a name="line.1156"></a> 1157 .append("useWhitespace", useWhitespace)<a name="line.1157"></a> 1158 .append("maxIndent", maxIndent)<a name="line.1158"></a> 1159 .append("addBeanTypeProperties", addBeanTypeProperties)<a name="line.1159"></a> 1160 .append("trimNulls", trimNulls)<a name="line.1160"></a> 1161 .append("trimEmptyCollections", trimEmptyCollections)<a name="line.1161"></a> 1162 .append("trimEmptyMaps", trimEmptyMaps)<a name="line.1162"></a> 1163 .append("trimStrings", trimStrings)<a name="line.1163"></a> 1164 .append("sortCollections", sortCollections)<a name="line.1164"></a> 1165 .append("sortMaps", sortMaps)<a name="line.1165"></a> 1166 .append("parserKnowsRootTypes", abridged)<a name="line.1166"></a> 1167 .append("quoteChar", quoteChar)<a name="line.1167"></a> 1168 .append("uriContext", uriContext)<a name="line.1168"></a> 1169 .append("uriResolution", uriResolution)<a name="line.1169"></a> 1170 .append("uriRelativity", uriRelativity)<a name="line.1170"></a> 1171 .append("listener", listener)<a name="line.1171"></a> 1172 );<a name="line.1172"></a> 1173 }<a name="line.1173"></a> 1174}<a name="line.1174"></a> </pre> </div> </body> </html>

content/site/apidocs-7.1.0/src-html/org/apache/juneau/serializer/Serializer.html (1,186 lines of code) (raw):