juneau-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jamesbog...@apache.org
Subject [26/51] [partial] incubator-juneau-website git commit: Update javadocs.
Date Sun, 27 Aug 2017 22:19:59 GMT
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2ead32d5/content/site/apidocs/src-html/org/apache/juneau/json/JsonSerializer.SimpleReadable.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/src-html/org/apache/juneau/json/JsonSerializer.SimpleReadable.html b/content/site/apidocs/src-html/org/apache/juneau/json/JsonSerializer.SimpleReadable.html
index 4484c96..3a31851 100644
--- a/content/site/apidocs/src-html/org/apache/juneau/json/JsonSerializer.SimpleReadable.html
+++ b/content/site/apidocs/src-html/org/apache/juneau/json/JsonSerializer.SimpleReadable.html
@@ -25,222 +25,247 @@
 <span class="sourceLineNo">017</span>import java.util.*;<a name="line.17"></a>
 <span class="sourceLineNo">018</span><a name="line.18"></a>
 <span class="sourceLineNo">019</span>import org.apache.juneau.*;<a name="line.19"></a>
-<span class="sourceLineNo">020</span>import org.apache.juneau.annotation.*;<a name="line.20"></a>
-<span class="sourceLineNo">021</span>import org.apache.juneau.serializer.*;<a name="line.21"></a>
-<span class="sourceLineNo">022</span><a name="line.22"></a>
-<span class="sourceLineNo">023</span>/**<a name="line.23"></a>
-<span class="sourceLineNo">024</span> * Serializes POJO models to JSON.<a name="line.24"></a>
-<span class="sourceLineNo">025</span> *<a name="line.25"></a>
-<span class="sourceLineNo">026</span> * &lt;h5 class='section'&gt;Media types:&lt;/h5&gt;<a name="line.26"></a>
-<span class="sourceLineNo">027</span> *<a name="line.27"></a>
-<span class="sourceLineNo">028</span> * Handles &lt;code&gt;Accept&lt;/code&gt; types: &lt;code&gt;application/json, text/json&lt;/code&gt;<a name="line.28"></a>
-<span class="sourceLineNo">029</span> * &lt;p&gt;<a name="line.29"></a>
-<span class="sourceLineNo">030</span> * Produces &lt;code&gt;Content-Type&lt;/code&gt; types: &lt;code&gt;application/json&lt;/code&gt;<a name="line.30"></a>
-<span class="sourceLineNo">031</span> *<a name="line.31"></a>
-<span class="sourceLineNo">032</span> * &lt;h5 class='section'&gt;Description:&lt;/h5&gt;<a name="line.32"></a>
-<span class="sourceLineNo">033</span> *<a name="line.33"></a>
-<span class="sourceLineNo">034</span> * The conversion is as follows...<a name="line.34"></a>
-<span class="sourceLineNo">035</span> * &lt;ul class='spaced-list'&gt;<a name="line.35"></a>
-<span class="sourceLineNo">036</span> *    &lt;li&gt;<a name="line.36"></a>
-<span class="sourceLineNo">037</span> *       Maps (e.g. {@link HashMap HashMaps}, {@link TreeMap TreeMaps}) are converted to JSON objects.<a name="line.37"></a>
-<span class="sourceLineNo">038</span> *    &lt;li&gt;<a name="line.38"></a>
-<span class="sourceLineNo">039</span> *       Collections (e.g. {@link HashSet HashSets}, {@link LinkedList LinkedLists}) and Java arrays are converted to<a name="line.39"></a>
-<span class="sourceLineNo">040</span> *       JSON arrays.<a name="line.40"></a>
-<span class="sourceLineNo">041</span> *    &lt;li&gt;<a name="line.41"></a>
-<span class="sourceLineNo">042</span> *       {@link String Strings} are converted to JSON strings.<a name="line.42"></a>
-<span class="sourceLineNo">043</span> *    &lt;li&gt;<a name="line.43"></a>
-<span class="sourceLineNo">044</span> *       {@link Number Numbers} (e.g. {@link Integer}, {@link Long}, {@link Double}) are converted to JSON numbers.<a name="line.44"></a>
-<span class="sourceLineNo">045</span> *    &lt;li&gt;<a name="line.45"></a>
-<span class="sourceLineNo">046</span> *       {@link Boolean Booleans} are converted to JSON booleans.<a name="line.46"></a>
-<span class="sourceLineNo">047</span> *    &lt;li&gt;<a name="line.47"></a>
-<span class="sourceLineNo">048</span> *       {@code nulls} are converted to JSON nulls.<a name="line.48"></a>
-<span class="sourceLineNo">049</span> *    &lt;li&gt;<a name="line.49"></a>
-<span class="sourceLineNo">050</span> *       {@code arrays} are converted to JSON arrays.<a name="line.50"></a>
-<span class="sourceLineNo">051</span> *    &lt;li&gt;<a name="line.51"></a>
-<span class="sourceLineNo">052</span> *       {@code beans} are converted to JSON objects.<a name="line.52"></a>
-<span class="sourceLineNo">053</span> * &lt;/ul&gt;<a name="line.53"></a>
-<span class="sourceLineNo">054</span> *<a name="line.54"></a>
-<span class="sourceLineNo">055</span> * &lt;p&gt;<a name="line.55"></a>
-<span class="sourceLineNo">056</span> * The types above are considered "JSON-primitive" object types.<a name="line.56"></a>
-<span class="sourceLineNo">057</span> * Any non-JSON-primitive object types are transformed into JSON-primitive object types through<a name="line.57"></a>
-<span class="sourceLineNo">058</span> * {@link org.apache.juneau.transform.PojoSwap PojoSwaps} associated through the<a name="line.58"></a>
-<span class="sourceLineNo">059</span> * {@link CoreObjectBuilder#pojoSwaps(Class...)} method.<a name="line.59"></a>
-<span class="sourceLineNo">060</span> * Several default transforms are provided for transforming Dates, Enums, Iterators, etc...<a name="line.60"></a>
-<span class="sourceLineNo">061</span> *<a name="line.61"></a>
-<span class="sourceLineNo">062</span> * &lt;p&gt;<a name="line.62"></a>
-<span class="sourceLineNo">063</span> * This serializer provides several serialization options.<a name="line.63"></a>
-<span class="sourceLineNo">064</span> * Typically, one of the predefined DEFAULT serializers will be sufficient.<a name="line.64"></a>
-<span class="sourceLineNo">065</span> * However, custom serializers can be constructed to fine-tune behavior.<a name="line.65"></a>
-<span class="sourceLineNo">066</span> *<a name="line.66"></a>
-<span class="sourceLineNo">067</span> * &lt;h5 class='section'&gt;Configurable properties:&lt;/h5&gt;<a name="line.67"></a>
-<span class="sourceLineNo">068</span> *<a name="line.68"></a>
-<span class="sourceLineNo">069</span> * This class has the following properties associated with it:<a name="line.69"></a>
-<span class="sourceLineNo">070</span> * &lt;ul&gt;<a name="line.70"></a>
-<span class="sourceLineNo">071</span> *    &lt;li&gt;{@link JsonSerializerContext}<a name="line.71"></a>
-<span class="sourceLineNo">072</span> *    &lt;li&gt;{@link SerializerContext}<a name="line.72"></a>
-<span class="sourceLineNo">073</span> *    &lt;li&gt;{@link BeanContext}<a name="line.73"></a>
-<span class="sourceLineNo">074</span> * &lt;/ul&gt;<a name="line.74"></a>
-<span class="sourceLineNo">075</span> *<a name="line.75"></a>
-<span class="sourceLineNo">076</span> * &lt;h6 class='topic'&gt;Behavior-specific subclasses&lt;/h6&gt;<a name="line.76"></a>
-<span class="sourceLineNo">077</span> *<a name="line.77"></a>
-<span class="sourceLineNo">078</span> * The following direct subclasses are provided for convenience:<a name="line.78"></a>
-<span class="sourceLineNo">079</span> * &lt;ul class='spaced-list'&gt;<a name="line.79"></a>
-<span class="sourceLineNo">080</span> *    &lt;li&gt;<a name="line.80"></a>
-<span class="sourceLineNo">081</span> *       {@link Simple} - Default serializer, single quotes, simple mode.<a name="line.81"></a>
-<span class="sourceLineNo">082</span> *    &lt;li&gt;<a name="line.82"></a>
-<span class="sourceLineNo">083</span> *       {@link SimpleReadable} - Default serializer, single quotes, simple mode, with whitespace.<a name="line.83"></a>
-<span class="sourceLineNo">084</span> * &lt;/ul&gt;<a name="line.84"></a>
-<span class="sourceLineNo">085</span> *<a name="line.85"></a>
-<span class="sourceLineNo">086</span> * &lt;h5 class='section'&gt;Example:&lt;/h5&gt;<a name="line.86"></a>
-<span class="sourceLineNo">087</span> * &lt;p class='bcode'&gt;<a name="line.87"></a>
-<span class="sourceLineNo">088</span> *    &lt;jc&gt;// Use one of the default serializers to serialize a POJO&lt;/jc&gt;<a name="line.88"></a>
-<span class="sourceLineNo">089</span> *    String json = JsonSerializer.&lt;jsf&gt;DEFAULT&lt;/jsf&gt;.serialize(someObject);<a name="line.89"></a>
-<span class="sourceLineNo">090</span> *<a name="line.90"></a>
-<span class="sourceLineNo">091</span> *    &lt;jc&gt;// Create a custom serializer for lax syntax using single quote characters&lt;/jc&gt;<a name="line.91"></a>
-<span class="sourceLineNo">092</span> *    JsonSerializer serializer = &lt;jk&gt;new&lt;/jk&gt; JsonSerializerBuilder().simple().sq().build();<a name="line.92"></a>
-<span class="sourceLineNo">093</span> *<a name="line.93"></a>
-<span class="sourceLineNo">094</span> *    &lt;jc&gt;// Clone an existing serializer and modify it to use single-quotes&lt;/jc&gt;<a name="line.94"></a>
-<span class="sourceLineNo">095</span> *    JsonSerializer serializer = JsonSerializer.&lt;jsf&gt;DEFAULT&lt;/jsf&gt;.builder().sq().build();<a name="line.95"></a>
-<span class="sourceLineNo">096</span> *<a name="line.96"></a>
-<span class="sourceLineNo">097</span> *    &lt;jc&gt;// Serialize a POJO to JSON&lt;/jc&gt;<a name="line.97"></a>
-<span class="sourceLineNo">098</span> *    String json = serializer.serialize(someObject);<a name="line.98"></a>
-<span class="sourceLineNo">099</span> * &lt;/p&gt;<a name="line.99"></a>
-<span class="sourceLineNo">100</span> */<a name="line.100"></a>
-<span class="sourceLineNo">101</span>@Produces("application/json,text/json")<a name="line.101"></a>
-<span class="sourceLineNo">102</span>public class JsonSerializer extends WriterSerializer {<a name="line.102"></a>
-<span class="sourceLineNo">103</span><a name="line.103"></a>
-<span class="sourceLineNo">104</span>   /** Default serializer, all default settings.*/<a name="line.104"></a>
-<span class="sourceLineNo">105</span>   public static final JsonSerializer DEFAULT = new JsonSerializer(PropertyStore.create());<a name="line.105"></a>
-<span class="sourceLineNo">106</span><a name="line.106"></a>
-<span class="sourceLineNo">107</span>   /** Default serializer, all default settings.*/<a name="line.107"></a>
-<span class="sourceLineNo">108</span>   public static final JsonSerializer DEFAULT_READABLE = new Readable(PropertyStore.create());<a name="line.108"></a>
-<span class="sourceLineNo">109</span><a name="line.109"></a>
-<span class="sourceLineNo">110</span>   /** Default serializer, single quotes, simple mode. */<a name="line.110"></a>
-<span class="sourceLineNo">111</span>   public static final JsonSerializer DEFAULT_LAX = new Simple(PropertyStore.create());<a name="line.111"></a>
-<span class="sourceLineNo">112</span><a name="line.112"></a>
-<span class="sourceLineNo">113</span>   /** Default serializer, single quotes, simple mode, with whitespace. */<a name="line.113"></a>
-<span class="sourceLineNo">114</span>   public static final JsonSerializer DEFAULT_LAX_READABLE = new SimpleReadable(PropertyStore.create());<a name="line.114"></a>
-<span class="sourceLineNo">115</span><a name="line.115"></a>
-<span class="sourceLineNo">116</span>   /**<a name="line.116"></a>
-<span class="sourceLineNo">117</span>    * Default serializer, single quotes, simple mode, with whitespace and recursion detection.<a name="line.117"></a>
-<span class="sourceLineNo">118</span>    * Note that recursion detection introduces a small performance penalty.<a name="line.118"></a>
-<span class="sourceLineNo">119</span>    */<a name="line.119"></a>
-<span class="sourceLineNo">120</span>   public static final JsonSerializer DEFAULT_LAX_READABLE_SAFE = new SimpleReadableSafe(PropertyStore.create());<a name="line.120"></a>
-<span class="sourceLineNo">121</span><a name="line.121"></a>
-<span class="sourceLineNo">122</span><a name="line.122"></a>
-<span class="sourceLineNo">123</span>   /** Default serializer, with whitespace. */<a name="line.123"></a>
-<span class="sourceLineNo">124</span>   public static class Readable extends JsonSerializer {<a name="line.124"></a>
-<span class="sourceLineNo">125</span><a name="line.125"></a>
-<span class="sourceLineNo">126</span>      /**<a name="line.126"></a>
-<span class="sourceLineNo">127</span>       * Constructor.<a name="line.127"></a>
-<span class="sourceLineNo">128</span>       *<a name="line.128"></a>
-<span class="sourceLineNo">129</span>       * @param propertyStore The property store containing all the settings for this object.<a name="line.129"></a>
-<span class="sourceLineNo">130</span>       */<a name="line.130"></a>
-<span class="sourceLineNo">131</span>      public Readable(PropertyStore propertyStore) {<a name="line.131"></a>
-<span class="sourceLineNo">132</span>         super(<a name="line.132"></a>
-<span class="sourceLineNo">133</span>            propertyStore.copy()<a name="line.133"></a>
-<span class="sourceLineNo">134</span>            .append(SERIALIZER_useWhitespace, true)<a name="line.134"></a>
-<span class="sourceLineNo">135</span>         );<a name="line.135"></a>
-<span class="sourceLineNo">136</span>      }<a name="line.136"></a>
-<span class="sourceLineNo">137</span>   }<a name="line.137"></a>
-<span class="sourceLineNo">138</span><a name="line.138"></a>
-<span class="sourceLineNo">139</span>   /** Default serializer, single quotes, simple mode. */<a name="line.139"></a>
-<span class="sourceLineNo">140</span>   @Produces(value="application/json+simple,text/json+simple",contentType="application/json")<a name="line.140"></a>
-<span class="sourceLineNo">141</span>   public static class Simple extends JsonSerializer {<a name="line.141"></a>
-<span class="sourceLineNo">142</span><a name="line.142"></a>
-<span class="sourceLineNo">143</span>      /**<a name="line.143"></a>
-<span class="sourceLineNo">144</span>       * Constructor.<a name="line.144"></a>
-<span class="sourceLineNo">145</span>       *<a name="line.145"></a>
-<span class="sourceLineNo">146</span>       * @param propertyStore The property store containing all the settings for this object.<a name="line.146"></a>
-<span class="sourceLineNo">147</span>       */<a name="line.147"></a>
-<span class="sourceLineNo">148</span>      public Simple(PropertyStore propertyStore) {<a name="line.148"></a>
-<span class="sourceLineNo">149</span>         super(<a name="line.149"></a>
-<span class="sourceLineNo">150</span>            propertyStore.copy()<a name="line.150"></a>
-<span class="sourceLineNo">151</span>            .append(JSON_simpleMode, true)<a name="line.151"></a>
-<span class="sourceLineNo">152</span>            .append(SERIALIZER_quoteChar, '\'')<a name="line.152"></a>
-<span class="sourceLineNo">153</span>         );<a name="line.153"></a>
-<span class="sourceLineNo">154</span>      }<a name="line.154"></a>
-<span class="sourceLineNo">155</span>   }<a name="line.155"></a>
-<span class="sourceLineNo">156</span><a name="line.156"></a>
-<span class="sourceLineNo">157</span>   /** Default serializer, single quotes, simple mode, with whitespace. */<a name="line.157"></a>
-<span class="sourceLineNo">158</span>   public static class SimpleReadable extends JsonSerializer {<a name="line.158"></a>
-<span class="sourceLineNo">159</span><a name="line.159"></a>
-<span class="sourceLineNo">160</span>      /**<a name="line.160"></a>
-<span class="sourceLineNo">161</span>       * Constructor.<a name="line.161"></a>
-<span class="sourceLineNo">162</span>       *<a name="line.162"></a>
-<span class="sourceLineNo">163</span>       * @param propertyStore The property store containing all the settings for this object.<a name="line.163"></a>
-<span class="sourceLineNo">164</span>       */<a name="line.164"></a>
-<span class="sourceLineNo">165</span>      public SimpleReadable(PropertyStore propertyStore) {<a name="line.165"></a>
-<span class="sourceLineNo">166</span>         super(<a name="line.166"></a>
-<span class="sourceLineNo">167</span>            propertyStore.copy()<a name="line.167"></a>
-<span class="sourceLineNo">168</span>            .append(JSON_simpleMode, true)<a name="line.168"></a>
-<span class="sourceLineNo">169</span>            .append(SERIALIZER_quoteChar, '\'')<a name="line.169"></a>
-<span class="sourceLineNo">170</span>            .append(SERIALIZER_useWhitespace, true)<a name="line.170"></a>
-<span class="sourceLineNo">171</span>         );<a name="line.171"></a>
-<span class="sourceLineNo">172</span>      }<a name="line.172"></a>
-<span class="sourceLineNo">173</span>   }<a name="line.173"></a>
-<span class="sourceLineNo">174</span><a name="line.174"></a>
-<span class="sourceLineNo">175</span>   /**<a name="line.175"></a>
-<span class="sourceLineNo">176</span>    * Default serializer, single quotes, simple mode, with whitespace and recursion detection.<a name="line.176"></a>
-<span class="sourceLineNo">177</span>    * Note that recursion detection introduces a small performance penalty.<a name="line.177"></a>
-<span class="sourceLineNo">178</span>    */<a name="line.178"></a>
-<span class="sourceLineNo">179</span>   public static class SimpleReadableSafe extends JsonSerializer {<a name="line.179"></a>
-<span class="sourceLineNo">180</span><a name="line.180"></a>
-<span class="sourceLineNo">181</span>      /**<a name="line.181"></a>
-<span class="sourceLineNo">182</span>       * Constructor.<a name="line.182"></a>
-<span class="sourceLineNo">183</span>       *<a name="line.183"></a>
-<span class="sourceLineNo">184</span>       * @param propertyStore The property store containing all the settings for this object.<a name="line.184"></a>
-<span class="sourceLineNo">185</span>       */<a name="line.185"></a>
-<span class="sourceLineNo">186</span>      public SimpleReadableSafe(PropertyStore propertyStore) {<a name="line.186"></a>
-<span class="sourceLineNo">187</span>         super(<a name="line.187"></a>
-<span class="sourceLineNo">188</span>            propertyStore.copy()<a name="line.188"></a>
-<span class="sourceLineNo">189</span>            .append(JSON_simpleMode, true)<a name="line.189"></a>
-<span class="sourceLineNo">190</span>            .append(SERIALIZER_quoteChar, '\'')<a name="line.190"></a>
-<span class="sourceLineNo">191</span>            .append(SERIALIZER_useWhitespace, true)<a name="line.191"></a>
-<span class="sourceLineNo">192</span>            .append(SERIALIZER_detectRecursions, true)<a name="line.192"></a>
-<span class="sourceLineNo">193</span>         );<a name="line.193"></a>
-<span class="sourceLineNo">194</span>      }<a name="line.194"></a>
-<span class="sourceLineNo">195</span>   }<a name="line.195"></a>
+<span class="sourceLineNo">020</span>import org.apache.juneau.serializer.*;<a name="line.20"></a>
+<span class="sourceLineNo">021</span><a name="line.21"></a>
+<span class="sourceLineNo">022</span>/**<a name="line.22"></a>
+<span class="sourceLineNo">023</span> * Serializes POJO models to JSON.<a name="line.23"></a>
+<span class="sourceLineNo">024</span> *<a name="line.24"></a>
+<span class="sourceLineNo">025</span> * &lt;h5 class='section'&gt;Media types:&lt;/h5&gt;<a name="line.25"></a>
+<span class="sourceLineNo">026</span> *<a name="line.26"></a>
+<span class="sourceLineNo">027</span> * Handles &lt;code&gt;Accept&lt;/code&gt; types: &lt;code&gt;application/json, text/json&lt;/code&gt;<a name="line.27"></a>
+<span class="sourceLineNo">028</span> * &lt;p&gt;<a name="line.28"></a>
+<span class="sourceLineNo">029</span> * Produces &lt;code&gt;Content-Type&lt;/code&gt; types: &lt;code&gt;application/json&lt;/code&gt;<a name="line.29"></a>
+<span class="sourceLineNo">030</span> *<a name="line.30"></a>
+<span class="sourceLineNo">031</span> * &lt;h5 class='section'&gt;Description:&lt;/h5&gt;<a name="line.31"></a>
+<span class="sourceLineNo">032</span> *<a name="line.32"></a>
+<span class="sourceLineNo">033</span> * The conversion is as follows...<a name="line.33"></a>
+<span class="sourceLineNo">034</span> * &lt;ul class='spaced-list'&gt;<a name="line.34"></a>
+<span class="sourceLineNo">035</span> *    &lt;li&gt;<a name="line.35"></a>
+<span class="sourceLineNo">036</span> *       Maps (e.g. {@link HashMap HashMaps}, {@link TreeMap TreeMaps}) are converted to JSON objects.<a name="line.36"></a>
+<span class="sourceLineNo">037</span> *    &lt;li&gt;<a name="line.37"></a>
+<span class="sourceLineNo">038</span> *       Collections (e.g. {@link HashSet HashSets}, {@link LinkedList LinkedLists}) and Java arrays are converted to<a name="line.38"></a>
+<span class="sourceLineNo">039</span> *       JSON arrays.<a name="line.39"></a>
+<span class="sourceLineNo">040</span> *    &lt;li&gt;<a name="line.40"></a>
+<span class="sourceLineNo">041</span> *       {@link String Strings} are converted to JSON strings.<a name="line.41"></a>
+<span class="sourceLineNo">042</span> *    &lt;li&gt;<a name="line.42"></a>
+<span class="sourceLineNo">043</span> *       {@link Number Numbers} (e.g. {@link Integer}, {@link Long}, {@link Double}) are converted to JSON numbers.<a name="line.43"></a>
+<span class="sourceLineNo">044</span> *    &lt;li&gt;<a name="line.44"></a>
+<span class="sourceLineNo">045</span> *       {@link Boolean Booleans} are converted to JSON booleans.<a name="line.45"></a>
+<span class="sourceLineNo">046</span> *    &lt;li&gt;<a name="line.46"></a>
+<span class="sourceLineNo">047</span> *       {@code nulls} are converted to JSON nulls.<a name="line.47"></a>
+<span class="sourceLineNo">048</span> *    &lt;li&gt;<a name="line.48"></a>
+<span class="sourceLineNo">049</span> *       {@code arrays} are converted to JSON arrays.<a name="line.49"></a>
+<span class="sourceLineNo">050</span> *    &lt;li&gt;<a name="line.50"></a>
+<span class="sourceLineNo">051</span> *       {@code beans} are converted to JSON objects.<a name="line.51"></a>
+<span class="sourceLineNo">052</span> * &lt;/ul&gt;<a name="line.52"></a>
+<span class="sourceLineNo">053</span> *<a name="line.53"></a>
+<span class="sourceLineNo">054</span> * &lt;p&gt;<a name="line.54"></a>
+<span class="sourceLineNo">055</span> * The types above are considered "JSON-primitive" object types.<a name="line.55"></a>
+<span class="sourceLineNo">056</span> * Any non-JSON-primitive object types are transformed into JSON-primitive object types through<a name="line.56"></a>
+<span class="sourceLineNo">057</span> * {@link org.apache.juneau.transform.PojoSwap PojoSwaps} associated through the<a name="line.57"></a>
+<span class="sourceLineNo">058</span> * {@link CoreObjectBuilder#pojoSwaps(Class...)} method.<a name="line.58"></a>
+<span class="sourceLineNo">059</span> * Several default transforms are provided for transforming Dates, Enums, Iterators, etc...<a name="line.59"></a>
+<span class="sourceLineNo">060</span> *<a name="line.60"></a>
+<span class="sourceLineNo">061</span> * &lt;p&gt;<a name="line.61"></a>
+<span class="sourceLineNo">062</span> * This serializer provides several serialization options.<a name="line.62"></a>
+<span class="sourceLineNo">063</span> * Typically, one of the predefined DEFAULT serializers will be sufficient.<a name="line.63"></a>
+<span class="sourceLineNo">064</span> * However, custom serializers can be constructed to fine-tune behavior.<a name="line.64"></a>
+<span class="sourceLineNo">065</span> *<a name="line.65"></a>
+<span class="sourceLineNo">066</span> * &lt;h5 class='section'&gt;Configurable properties:&lt;/h5&gt;<a name="line.66"></a>
+<span class="sourceLineNo">067</span> *<a name="line.67"></a>
+<span class="sourceLineNo">068</span> * This class has the following properties associated with it:<a name="line.68"></a>
+<span class="sourceLineNo">069</span> * &lt;ul&gt;<a name="line.69"></a>
+<span class="sourceLineNo">070</span> *    &lt;li&gt;{@link JsonSerializerContext}<a name="line.70"></a>
+<span class="sourceLineNo">071</span> *    &lt;li&gt;{@link SerializerContext}<a name="line.71"></a>
+<span class="sourceLineNo">072</span> *    &lt;li&gt;{@link BeanContext}<a name="line.72"></a>
+<span class="sourceLineNo">073</span> * &lt;/ul&gt;<a name="line.73"></a>
+<span class="sourceLineNo">074</span> *<a name="line.74"></a>
+<span class="sourceLineNo">075</span> * &lt;h6 class='topic'&gt;Behavior-specific subclasses&lt;/h6&gt;<a name="line.75"></a>
+<span class="sourceLineNo">076</span> *<a name="line.76"></a>
+<span class="sourceLineNo">077</span> * The following direct subclasses are provided for convenience:<a name="line.77"></a>
+<span class="sourceLineNo">078</span> * &lt;ul class='spaced-list'&gt;<a name="line.78"></a>
+<span class="sourceLineNo">079</span> *    &lt;li&gt;<a name="line.79"></a>
+<span class="sourceLineNo">080</span> *       {@link Simple} - Default serializer, single quotes, simple mode.<a name="line.80"></a>
+<span class="sourceLineNo">081</span> *    &lt;li&gt;<a name="line.81"></a>
+<span class="sourceLineNo">082</span> *       {@link SimpleReadable} - Default serializer, single quotes, simple mode, with whitespace.<a name="line.82"></a>
+<span class="sourceLineNo">083</span> * &lt;/ul&gt;<a name="line.83"></a>
+<span class="sourceLineNo">084</span> *<a name="line.84"></a>
+<span class="sourceLineNo">085</span> * &lt;h5 class='section'&gt;Example:&lt;/h5&gt;<a name="line.85"></a>
+<span class="sourceLineNo">086</span> * &lt;p class='bcode'&gt;<a name="line.86"></a>
+<span class="sourceLineNo">087</span> *    &lt;jc&gt;// Use one of the default serializers to serialize a POJO&lt;/jc&gt;<a name="line.87"></a>
+<span class="sourceLineNo">088</span> *    String json = JsonSerializer.&lt;jsf&gt;DEFAULT&lt;/jsf&gt;.serialize(someObject);<a name="line.88"></a>
+<span class="sourceLineNo">089</span> *<a name="line.89"></a>
+<span class="sourceLineNo">090</span> *    &lt;jc&gt;// Create a custom serializer for lax syntax using single quote characters&lt;/jc&gt;<a name="line.90"></a>
+<span class="sourceLineNo">091</span> *    JsonSerializer serializer = &lt;jk&gt;new&lt;/jk&gt; JsonSerializerBuilder().simple().sq().build();<a name="line.91"></a>
+<span class="sourceLineNo">092</span> *<a name="line.92"></a>
+<span class="sourceLineNo">093</span> *    &lt;jc&gt;// Clone an existing serializer and modify it to use single-quotes&lt;/jc&gt;<a name="line.93"></a>
+<span class="sourceLineNo">094</span> *    JsonSerializer serializer = JsonSerializer.&lt;jsf&gt;DEFAULT&lt;/jsf&gt;.builder().sq().build();<a name="line.94"></a>
+<span class="sourceLineNo">095</span> *<a name="line.95"></a>
+<span class="sourceLineNo">096</span> *    &lt;jc&gt;// Serialize a POJO to JSON&lt;/jc&gt;<a name="line.96"></a>
+<span class="sourceLineNo">097</span> *    String json = serializer.serialize(someObject);<a name="line.97"></a>
+<span class="sourceLineNo">098</span> * &lt;/p&gt;<a name="line.98"></a>
+<span class="sourceLineNo">099</span> */<a name="line.99"></a>
+<span class="sourceLineNo">100</span>public class JsonSerializer extends WriterSerializer {<a name="line.100"></a>
+<span class="sourceLineNo">101</span><a name="line.101"></a>
+<span class="sourceLineNo">102</span>   /** Default serializer, all default settings.*/<a name="line.102"></a>
+<span class="sourceLineNo">103</span>   public static final JsonSerializer DEFAULT = new JsonSerializer(PropertyStore.create());<a name="line.103"></a>
+<span class="sourceLineNo">104</span><a name="line.104"></a>
+<span class="sourceLineNo">105</span>   /** Default serializer, all default settings.*/<a name="line.105"></a>
+<span class="sourceLineNo">106</span>   public static final JsonSerializer DEFAULT_READABLE = new Readable(PropertyStore.create());<a name="line.106"></a>
+<span class="sourceLineNo">107</span><a name="line.107"></a>
+<span class="sourceLineNo">108</span>   /** Default serializer, single quotes, simple mode. */<a name="line.108"></a>
+<span class="sourceLineNo">109</span>   public static final JsonSerializer DEFAULT_LAX = new Simple(PropertyStore.create());<a name="line.109"></a>
+<span class="sourceLineNo">110</span><a name="line.110"></a>
+<span class="sourceLineNo">111</span>   /** Default serializer, single quotes, simple mode, with whitespace. */<a name="line.111"></a>
+<span class="sourceLineNo">112</span>   public static final JsonSerializer DEFAULT_LAX_READABLE = new SimpleReadable(PropertyStore.create());<a name="line.112"></a>
+<span class="sourceLineNo">113</span><a name="line.113"></a>
+<span class="sourceLineNo">114</span>   /**<a name="line.114"></a>
+<span class="sourceLineNo">115</span>    * Default serializer, single quotes, simple mode, with whitespace and recursion detection.<a name="line.115"></a>
+<span class="sourceLineNo">116</span>    * Note that recursion detection introduces a small performance penalty.<a name="line.116"></a>
+<span class="sourceLineNo">117</span>    */<a name="line.117"></a>
+<span class="sourceLineNo">118</span>   public static final JsonSerializer DEFAULT_LAX_READABLE_SAFE = new SimpleReadableSafe(PropertyStore.create());<a name="line.118"></a>
+<span class="sourceLineNo">119</span><a name="line.119"></a>
+<span class="sourceLineNo">120</span><a name="line.120"></a>
+<span class="sourceLineNo">121</span>   /** Default serializer, with whitespace. */<a name="line.121"></a>
+<span class="sourceLineNo">122</span>   public static class Readable extends JsonSerializer {<a name="line.122"></a>
+<span class="sourceLineNo">123</span><a name="line.123"></a>
+<span class="sourceLineNo">124</span>      /**<a name="line.124"></a>
+<span class="sourceLineNo">125</span>       * Constructor.<a name="line.125"></a>
+<span class="sourceLineNo">126</span>       *<a name="line.126"></a>
+<span class="sourceLineNo">127</span>       * @param propertyStore The property store containing all the settings for this object.<a name="line.127"></a>
+<span class="sourceLineNo">128</span>       */<a name="line.128"></a>
+<span class="sourceLineNo">129</span>      public Readable(PropertyStore propertyStore) {<a name="line.129"></a>
+<span class="sourceLineNo">130</span>         super(<a name="line.130"></a>
+<span class="sourceLineNo">131</span>            propertyStore.copy()<a name="line.131"></a>
+<span class="sourceLineNo">132</span>            .append(SERIALIZER_useWhitespace, true)<a name="line.132"></a>
+<span class="sourceLineNo">133</span>         );<a name="line.133"></a>
+<span class="sourceLineNo">134</span>      }<a name="line.134"></a>
+<span class="sourceLineNo">135</span>   }<a name="line.135"></a>
+<span class="sourceLineNo">136</span><a name="line.136"></a>
+<span class="sourceLineNo">137</span>   /** Default serializer, single quotes, simple mode. */<a name="line.137"></a>
+<span class="sourceLineNo">138</span>   public static class Simple extends JsonSerializer {<a name="line.138"></a>
+<span class="sourceLineNo">139</span><a name="line.139"></a>
+<span class="sourceLineNo">140</span>      /**<a name="line.140"></a>
+<span class="sourceLineNo">141</span>       * Constructor.<a name="line.141"></a>
+<span class="sourceLineNo">142</span>       *<a name="line.142"></a>
+<span class="sourceLineNo">143</span>       * @param propertyStore The property store containing all the settings for this object.<a name="line.143"></a>
+<span class="sourceLineNo">144</span>       */<a name="line.144"></a>
+<span class="sourceLineNo">145</span>      public Simple(PropertyStore propertyStore) {<a name="line.145"></a>
+<span class="sourceLineNo">146</span>         super(<a name="line.146"></a>
+<span class="sourceLineNo">147</span>            propertyStore.copy()<a name="line.147"></a>
+<span class="sourceLineNo">148</span>               .append(JSON_simpleMode, true)<a name="line.148"></a>
+<span class="sourceLineNo">149</span>               .append(SERIALIZER_quoteChar, '\''),<a name="line.149"></a>
+<span class="sourceLineNo">150</span>            "application/json",<a name="line.150"></a>
+<span class="sourceLineNo">151</span>            "application/json+simple", "text/json+simple"<a name="line.151"></a>
+<span class="sourceLineNo">152</span>         );<a name="line.152"></a>
+<span class="sourceLineNo">153</span>      }<a name="line.153"></a>
+<span class="sourceLineNo">154</span>   }<a name="line.154"></a>
+<span class="sourceLineNo">155</span><a name="line.155"></a>
+<span class="sourceLineNo">156</span>   /** Default serializer, single quotes, simple mode, with whitespace. */<a name="line.156"></a>
+<span class="sourceLineNo">157</span>   public static class SimpleReadable extends JsonSerializer {<a name="line.157"></a>
+<span class="sourceLineNo">158</span><a name="line.158"></a>
+<span class="sourceLineNo">159</span>      /**<a name="line.159"></a>
+<span class="sourceLineNo">160</span>       * Constructor.<a name="line.160"></a>
+<span class="sourceLineNo">161</span>       *<a name="line.161"></a>
+<span class="sourceLineNo">162</span>       * @param propertyStore The property store containing all the settings for this object.<a name="line.162"></a>
+<span class="sourceLineNo">163</span>       */<a name="line.163"></a>
+<span class="sourceLineNo">164</span>      public SimpleReadable(PropertyStore propertyStore) {<a name="line.164"></a>
+<span class="sourceLineNo">165</span>         super(<a name="line.165"></a>
+<span class="sourceLineNo">166</span>            propertyStore.copy()<a name="line.166"></a>
+<span class="sourceLineNo">167</span>            .append(JSON_simpleMode, true)<a name="line.167"></a>
+<span class="sourceLineNo">168</span>            .append(SERIALIZER_quoteChar, '\'')<a name="line.168"></a>
+<span class="sourceLineNo">169</span>            .append(SERIALIZER_useWhitespace, true)<a name="line.169"></a>
+<span class="sourceLineNo">170</span>         );<a name="line.170"></a>
+<span class="sourceLineNo">171</span>      }<a name="line.171"></a>
+<span class="sourceLineNo">172</span>   }<a name="line.172"></a>
+<span class="sourceLineNo">173</span><a name="line.173"></a>
+<span class="sourceLineNo">174</span>   /**<a name="line.174"></a>
+<span class="sourceLineNo">175</span>    * Default serializer, single quotes, simple mode, with whitespace and recursion detection.<a name="line.175"></a>
+<span class="sourceLineNo">176</span>    * Note that recursion detection introduces a small performance penalty.<a name="line.176"></a>
+<span class="sourceLineNo">177</span>    */<a name="line.177"></a>
+<span class="sourceLineNo">178</span>   public static class SimpleReadableSafe extends JsonSerializer {<a name="line.178"></a>
+<span class="sourceLineNo">179</span><a name="line.179"></a>
+<span class="sourceLineNo">180</span>      /**<a name="line.180"></a>
+<span class="sourceLineNo">181</span>       * Constructor.<a name="line.181"></a>
+<span class="sourceLineNo">182</span>       *<a name="line.182"></a>
+<span class="sourceLineNo">183</span>       * @param propertyStore The property store containing all the settings for this object.<a name="line.183"></a>
+<span class="sourceLineNo">184</span>       */<a name="line.184"></a>
+<span class="sourceLineNo">185</span>      public SimpleReadableSafe(PropertyStore propertyStore) {<a name="line.185"></a>
+<span class="sourceLineNo">186</span>         super(<a name="line.186"></a>
+<span class="sourceLineNo">187</span>            propertyStore.copy()<a name="line.187"></a>
+<span class="sourceLineNo">188</span>            .append(JSON_simpleMode, true)<a name="line.188"></a>
+<span class="sourceLineNo">189</span>            .append(SERIALIZER_quoteChar, '\'')<a name="line.189"></a>
+<span class="sourceLineNo">190</span>            .append(SERIALIZER_useWhitespace, true)<a name="line.190"></a>
+<span class="sourceLineNo">191</span>            .append(SERIALIZER_detectRecursions, true)<a name="line.191"></a>
+<span class="sourceLineNo">192</span>         );<a name="line.192"></a>
+<span class="sourceLineNo">193</span>      }<a name="line.193"></a>
+<span class="sourceLineNo">194</span>   }<a name="line.194"></a>
+<span class="sourceLineNo">195</span><a name="line.195"></a>
 <span class="sourceLineNo">196</span><a name="line.196"></a>
-<span class="sourceLineNo">197</span><a name="line.197"></a>
-<span class="sourceLineNo">198</span>   final JsonSerializerContext ctx;<a name="line.198"></a>
-<span class="sourceLineNo">199</span>   private volatile JsonSchemaSerializer schemaSerializer;<a name="line.199"></a>
-<span class="sourceLineNo">200</span><a name="line.200"></a>
-<span class="sourceLineNo">201</span>   /**<a name="line.201"></a>
-<span class="sourceLineNo">202</span>    * Constructor.<a name="line.202"></a>
-<span class="sourceLineNo">203</span>    *<a name="line.203"></a>
-<span class="sourceLineNo">204</span>    * @param propertyStore The property store containing all the settings for this object.<a name="line.204"></a>
+<span class="sourceLineNo">197</span>   final JsonSerializerContext ctx;<a name="line.197"></a>
+<span class="sourceLineNo">198</span>   private volatile JsonSchemaSerializer schemaSerializer;<a name="line.198"></a>
+<span class="sourceLineNo">199</span><a name="line.199"></a>
+<span class="sourceLineNo">200</span>   /**<a name="line.200"></a>
+<span class="sourceLineNo">201</span>    * Constructor.<a name="line.201"></a>
+<span class="sourceLineNo">202</span>    *<a name="line.202"></a>
+<span class="sourceLineNo">203</span>    * @param propertyStore<a name="line.203"></a>
+<span class="sourceLineNo">204</span>    *    The property store containing all the settings for this object.<a name="line.204"></a>
 <span class="sourceLineNo">205</span>    */<a name="line.205"></a>
 <span class="sourceLineNo">206</span>   public JsonSerializer(PropertyStore propertyStore) {<a name="line.206"></a>
-<span class="sourceLineNo">207</span>      super(propertyStore);<a name="line.207"></a>
-<span class="sourceLineNo">208</span>      this.ctx = createContext(JsonSerializerContext.class);<a name="line.208"></a>
-<span class="sourceLineNo">209</span>   }<a name="line.209"></a>
-<span class="sourceLineNo">210</span><a name="line.210"></a>
-<span class="sourceLineNo">211</span>   @Override /* CoreObject */<a name="line.211"></a>
-<span class="sourceLineNo">212</span>   public JsonSerializerBuilder builder() {<a name="line.212"></a>
-<span class="sourceLineNo">213</span>      return new JsonSerializerBuilder(propertyStore);<a name="line.213"></a>
-<span class="sourceLineNo">214</span>   }<a name="line.214"></a>
-<span class="sourceLineNo">215</span><a name="line.215"></a>
-<span class="sourceLineNo">216</span>   /**<a name="line.216"></a>
-<span class="sourceLineNo">217</span>    * Returns the schema serializer based on the settings of this serializer.<a name="line.217"></a>
-<span class="sourceLineNo">218</span>    *<a name="line.218"></a>
-<span class="sourceLineNo">219</span>    * @return The schema serializer.<a name="line.219"></a>
-<span class="sourceLineNo">220</span>    */<a name="line.220"></a>
-<span class="sourceLineNo">221</span>   public JsonSchemaSerializer getSchemaSerializer() {<a name="line.221"></a>
-<span class="sourceLineNo">222</span>      if (schemaSerializer == null)<a name="line.222"></a>
-<span class="sourceLineNo">223</span>         schemaSerializer = new JsonSchemaSerializer(propertyStore);<a name="line.223"></a>
-<span class="sourceLineNo">224</span>      return schemaSerializer;<a name="line.224"></a>
-<span class="sourceLineNo">225</span>   }<a name="line.225"></a>
-<span class="sourceLineNo">226</span><a name="line.226"></a>
-<span class="sourceLineNo">227</span>   //--------------------------------------------------------------------------------<a name="line.227"></a>
-<span class="sourceLineNo">228</span>   // Entry point methods<a name="line.228"></a>
-<span class="sourceLineNo">229</span>   //--------------------------------------------------------------------------------<a name="line.229"></a>
-<span class="sourceLineNo">230</span><a name="line.230"></a>
-<span class="sourceLineNo">231</span>   @Override /* Serializer */<a name="line.231"></a>
-<span class="sourceLineNo">232</span>   public WriterSerializerSession createSession(SerializerSessionArgs args) {<a name="line.232"></a>
-<span class="sourceLineNo">233</span>      return new JsonSerializerSession(ctx, args);<a name="line.233"></a>
+<span class="sourceLineNo">207</span>      this(propertyStore, "application/json", "application/json", "text/json");<a name="line.207"></a>
+<span class="sourceLineNo">208</span>   }<a name="line.208"></a>
+<span class="sourceLineNo">209</span><a name="line.209"></a>
+<span class="sourceLineNo">210</span>   /**<a name="line.210"></a>
+<span class="sourceLineNo">211</span>    * Constructor.<a name="line.211"></a>
+<span class="sourceLineNo">212</span>    *<a name="line.212"></a>
+<span class="sourceLineNo">213</span>    * @param propertyStore<a name="line.213"></a>
+<span class="sourceLineNo">214</span>    *    The property store containing all the settings for this object.<a name="line.214"></a>
+<span class="sourceLineNo">215</span>    * @param produces<a name="line.215"></a>
+<span class="sourceLineNo">216</span>    *    The media type that this serializer produces.<a name="line.216"></a>
+<span class="sourceLineNo">217</span>    * @param accept<a name="line.217"></a>
+<span class="sourceLineNo">218</span>    *    The accept media types that the serializer can handle.<a name="line.218"></a>
+<span class="sourceLineNo">219</span>    *    &lt;p&gt;<a name="line.219"></a>
+<span class="sourceLineNo">220</span>    *    Can contain meta-characters per the &lt;code&gt;media-type&lt;/code&gt; specification of<a name="line.220"></a>
+<span class="sourceLineNo">221</span>    *    &lt;a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1"&gt;RFC2616/14.1&lt;/a&gt;<a name="line.221"></a>
+<span class="sourceLineNo">222</span>    *    &lt;p&gt;<a name="line.222"></a>
+<span class="sourceLineNo">223</span>    *    If empty, then assumes the only media type supported is &lt;code&gt;produces&lt;/code&gt;.<a name="line.223"></a>
+<span class="sourceLineNo">224</span>    *    &lt;p&gt;<a name="line.224"></a>
+<span class="sourceLineNo">225</span>    *    For example, if this serializer produces &lt;js&gt;"application/json"&lt;/js&gt; but should handle media types of<a name="line.225"></a>
+<span class="sourceLineNo">226</span>    *    &lt;js&gt;"application/json"&lt;/js&gt; and &lt;js&gt;"text/json"&lt;/js&gt;, then the arguments should be:<a name="line.226"></a>
+<span class="sourceLineNo">227</span>    *    &lt;br&gt;&lt;code&gt;&lt;jk&gt;super&lt;/jk&gt;(propertyStore, &lt;js&gt;"application/json"&lt;/js&gt;, &lt;js&gt;"application/json"&lt;/js&gt;, &lt;js&gt;"text/json"&lt;/js&gt;);&lt;/code&gt;<a name="line.227"></a>
+<span class="sourceLineNo">228</span>    *    &lt;br&gt;...or...<a name="line.228"></a>
+<span class="sourceLineNo">229</span>    *    &lt;br&gt;&lt;code&gt;&lt;jk&gt;super&lt;/jk&gt;(propertyStore, &lt;js&gt;"application/json"&lt;/js&gt;, &lt;js&gt;"*&amp;#8203;/json"&lt;/js&gt;);&lt;/code&gt;<a name="line.229"></a>
+<span class="sourceLineNo">230</span>    */<a name="line.230"></a>
+<span class="sourceLineNo">231</span>   public JsonSerializer(PropertyStore propertyStore, String produces, String...accept) {<a name="line.231"></a>
+<span class="sourceLineNo">232</span>      super(propertyStore, produces, accept);<a name="line.232"></a>
+<span class="sourceLineNo">233</span>      this.ctx = createContext(JsonSerializerContext.class);<a name="line.233"></a>
 <span class="sourceLineNo">234</span>   }<a name="line.234"></a>
-<span class="sourceLineNo">235</span>}<a name="line.235"></a>
+<span class="sourceLineNo">235</span><a name="line.235"></a>
+<span class="sourceLineNo">236</span>   @Override /* CoreObject */<a name="line.236"></a>
+<span class="sourceLineNo">237</span>   public JsonSerializerBuilder builder() {<a name="line.237"></a>
+<span class="sourceLineNo">238</span>      return new JsonSerializerBuilder(propertyStore);<a name="line.238"></a>
+<span class="sourceLineNo">239</span>   }<a name="line.239"></a>
+<span class="sourceLineNo">240</span><a name="line.240"></a>
+<span class="sourceLineNo">241</span>   /**<a name="line.241"></a>
+<span class="sourceLineNo">242</span>    * Returns the schema serializer based on the settings of this serializer.<a name="line.242"></a>
+<span class="sourceLineNo">243</span>    *<a name="line.243"></a>
+<span class="sourceLineNo">244</span>    * @return The schema serializer.<a name="line.244"></a>
+<span class="sourceLineNo">245</span>    */<a name="line.245"></a>
+<span class="sourceLineNo">246</span>   public JsonSchemaSerializer getSchemaSerializer() {<a name="line.246"></a>
+<span class="sourceLineNo">247</span>      if (schemaSerializer == null)<a name="line.247"></a>
+<span class="sourceLineNo">248</span>         schemaSerializer = new JsonSchemaSerializer(propertyStore);<a name="line.248"></a>
+<span class="sourceLineNo">249</span>      return schemaSerializer;<a name="line.249"></a>
+<span class="sourceLineNo">250</span>   }<a name="line.250"></a>
+<span class="sourceLineNo">251</span><a name="line.251"></a>
+<span class="sourceLineNo">252</span>   //--------------------------------------------------------------------------------<a name="line.252"></a>
+<span class="sourceLineNo">253</span>   // Entry point methods<a name="line.253"></a>
+<span class="sourceLineNo">254</span>   //--------------------------------------------------------------------------------<a name="line.254"></a>
+<span class="sourceLineNo">255</span><a name="line.255"></a>
+<span class="sourceLineNo">256</span>   @Override /* Serializer */<a name="line.256"></a>
+<span class="sourceLineNo">257</span>   public WriterSerializerSession createSession(SerializerSessionArgs args) {<a name="line.257"></a>
+<span class="sourceLineNo">258</span>      return new JsonSerializerSession(ctx, args);<a name="line.258"></a>
+<span class="sourceLineNo">259</span>   }<a name="line.259"></a>
+<span class="sourceLineNo">260</span>}<a name="line.260"></a>
 
 
 



Mime
View raw message