You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2018/01/14 23:06:48 UTC
[05/51] [partial] juneau-website git commit: Update javadocs.
http://git-wip-us.apache.org/repos/asf/juneau-website/blob/c319662c/content/site/apidocs/org/apache/juneau/json/JsonSchemaSerializerSession.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/json/JsonSchemaSerializerSession.html b/content/site/apidocs/org/apache/juneau/json/JsonSchemaSerializerSession.html
index e781db4..98b39cc 100644
--- a/content/site/apidocs/org/apache/juneau/json/JsonSchemaSerializerSession.html
+++ b/content/site/apidocs/org/apache/juneau/json/JsonSchemaSerializerSession.html
@@ -136,7 +136,7 @@ var activeTableTab = "activeTableTab";
<pre>public class <a href="../../../../src-html/org/apache/juneau/json/JsonSchemaSerializerSession.html#line.30">JsonSchemaSerializerSession</a>
extends <a href="../../../../org/apache/juneau/json/JsonSerializerSession.html" title="class in org.apache.juneau.json">JsonSerializerSession</a></pre>
<div class="block">Session object that lives for the duration of a single use of <a href="../../../../org/apache/juneau/json/JsonSchemaSerializer.html" title="class in org.apache.juneau.json"><code>JsonSchemaSerializer</code></a>.
-
+
<p>
This class is NOT thread safe.
It is typically discarded after one-time use although it can be reused within the same thread.</div>
@@ -222,7 +222,7 @@ extends <a href="../../../../org/apache/juneau/json/JsonSerializerSession.html"
<!-- -->
</a>
<h3>Methods inherited from class org.apache.juneau.serializer.<a href="../../../../org/apache/juneau/serializer/SerializerSession.html" title="class in org.apache.juneau.serializer">SerializerSession</a></h3>
-<code><a href="../../../../org/apache/juneau/serializer/SerializerSession.html#canIgnoreValue-org.apache.juneau.ClassMeta-java.lang.String-java.lang.Object-">canIgnoreValue</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#createBeanTypeNameProperty-org.apache.juneau.BeanMap-java.lang.String-">createBeanTypeNameProperty</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#createPipe-java.lang.Object-">createPipe</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#generalize-java.lang.Object-org.apache.juneau.ClassMeta-">generalize</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getBeanTypeName-org.apache.juneau.ClassMeta-org.apache.juneau.ClassMeta-org.apache.juneau.BeanPropertyMeta-">getBeanTypeName</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getExpectedRootType-java.lang.Object-">getExpectedRootType</a>, <a href="../../../../org/apache/june
au/serializer/SerializerSession.html#getInitialDepth--">getInitialDepth</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getJavaMethod--">getJavaMethod</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getLastLocation--">getLastLocation</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getMaxDepth--">getMaxDepth</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getMaxIndent--">getMaxIndent</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getQuoteChar--">getQuoteChar</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getResponseHeaders--">getResponseHeaders</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getUriResolver--">getUriResolver</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#isDetectRecursions--">isDetectRecursions</a>, <a href="../../../../org/apach
e/juneau/serializer/SerializerSession.html#isIgnoreRecursions--">isIgnoreRecursions</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#isSortCollections--">isSortCollections</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#isSortMaps--">isSortMaps</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#isTrimEmptyCollections--">isTrimEmptyCollections</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#isTrimEmptyMaps--">isTrimEmptyMaps</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#isTrimNulls--">isTrimNulls</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#isTrimStrings--">isTrimStrings</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#isUseWhitespace--">isUseWhitespace</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#onBeanGetterException-org.apache.juneau.BeanProp
ertyMeta-java.lang.Throwable-">onBeanGetterException</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#onError-java.lang.Throwable-java.lang.String-java.lang.Object...-">onError</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#pop--">pop</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#push-java.lang.String-java.lang.Object-org.apache.juneau.ClassMeta-">push</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#relativizeUri-java.lang.Object-java.lang.Object-">relativizeUri</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#resolveUri-java.lang.Object-">resolveUri</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#serialize-java.lang.Object-java.lang.Object-">serialize</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#setCurrentClass-org.apache.juneau.ClassMeta-">setCurrentClass</a>, <a href=".
./../../../org/apache/juneau/serializer/SerializerSession.html#setCurrentProperty-org.apache.juneau.BeanPropertyMeta-">setCurrentProperty</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#sort-java.util.Collection-">sort</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#sort-java.util.Map-">sort</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#toList-java.lang.Class-java.lang.Object-">toList</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#toString-java.lang.Object-">toString</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#trim-java.lang.Object-">trim</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#willRecurse-java.lang.String-java.lang.Object-org.apache.juneau.ClassMeta-">willRecurse</a></code></li>
+<code><a href="../../../../org/apache/juneau/serializer/SerializerSession.html#canIgnoreValue-org.apache.juneau.ClassMeta-java.lang.String-java.lang.Object-">canIgnoreValue</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#createBeanTypeNameProperty-org.apache.juneau.BeanMap-java.lang.String-">createBeanTypeNameProperty</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#createPipe-java.lang.Object-">createPipe</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#generalize-java.lang.Object-org.apache.juneau.ClassMeta-">generalize</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getBeanTypeName-org.apache.juneau.ClassMeta-org.apache.juneau.ClassMeta-org.apache.juneau.BeanPropertyMeta-">getBeanTypeName</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getExpectedRootType-java.lang.Object-">getExpectedRootType</a>, <a href="../../../../org/apache/june
au/serializer/SerializerSession.html#getInitialDepth--">getInitialDepth</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getJavaMethod--">getJavaMethod</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getLastLocation--">getLastLocation</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getListener--">getListener</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getListener-java.lang.Class-">getListener</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getMaxDepth--">getMaxDepth</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getMaxIndent--">getMaxIndent</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getQuoteChar--">getQuoteChar</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getResponseHeaders--">getResponseHeaders</a>, <a href="../../../../org/apache/jun
eau/serializer/SerializerSession.html#getUriResolver--">getUriResolver</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#isDetectRecursions--">isDetectRecursions</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#isIgnoreRecursions--">isIgnoreRecursions</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#isSortCollections--">isSortCollections</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#isSortMaps--">isSortMaps</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#isTrimEmptyCollections--">isTrimEmptyCollections</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#isTrimEmptyMaps--">isTrimEmptyMaps</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#isTrimNulls--">isTrimNulls</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#isTrimStrings--">isTrimStrings</a>, <a href="
../../../../org/apache/juneau/serializer/SerializerSession.html#isUseWhitespace--">isUseWhitespace</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#onBeanGetterException-org.apache.juneau.BeanPropertyMeta-java.lang.Throwable-">onBeanGetterException</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#onError-java.lang.Throwable-java.lang.String-java.lang.Object...-">onError</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#pop--">pop</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#push-java.lang.String-java.lang.Object-org.apache.juneau.ClassMeta-">push</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#relativizeUri-java.lang.Object-java.lang.Object-">relativizeUri</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#resolveUri-java.lang.Object-">resolveUri</a>, <a href="../../../../org/apache/juneau/serializer/Serialize
rSession.html#serialize-java.lang.Object-java.lang.Object-">serialize</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#setCurrentClass-org.apache.juneau.ClassMeta-">setCurrentClass</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#setCurrentProperty-org.apache.juneau.BeanPropertyMeta-">setCurrentProperty</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#sort-java.util.Collection-">sort</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#sort-java.util.Map-">sort</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#toList-java.lang.Class-java.lang.Object-">toList</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#toString-java.lang.Object-">toString</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#trim-java.lang.Object-">trim</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSessi
on.html#willRecurse-java.lang.String-java.lang.Object-org.apache.juneau.ClassMeta-">willRecurse</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.BeanSession">
@@ -298,7 +298,7 @@ extends <a href="../../../../org/apache/juneau/json/JsonSerializerSession.html"
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerSession.html#doSerialize-org.apache.juneau.serializer.SerializerPipe-java.lang.Object-">SerializerSession</a></code></span></div>
<div class="block">Serializes a POJO to the specified output stream or writer.
-
+
<p>
This method should NOT close the context object.</div>
<dl>
http://git-wip-us.apache.org/repos/asf/juneau-website/blob/c319662c/content/site/apidocs/org/apache/juneau/json/JsonSerializer.Readable.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/json/JsonSerializer.Readable.html b/content/site/apidocs/org/apache/juneau/json/JsonSerializer.Readable.html
index 0279beb..78aeaa0 100644
--- a/content/site/apidocs/org/apache/juneau/json/JsonSerializer.Readable.html
+++ b/content/site/apidocs/org/apache/juneau/json/JsonSerializer.Readable.html
@@ -131,7 +131,7 @@
</dl>
<hr>
<br>
-<pre>public static class <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.203">JsonSerializer.Readable</a>
+<pre>public static class <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.282">JsonSerializer.Readable</a>
extends <a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json">JsonSerializer</a></pre>
<div class="block">Default serializer, with whitespace.</div>
</li>
@@ -271,7 +271,7 @@ extends <a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="
<ul class="blockListLast">
<li class="blockList">
<h4>Readable</h4>
-<pre>public <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.Readable.html#line.210">Readable</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> ps)</pre>
+<pre>public <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.Readable.html#line.289">Readable</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> ps)</pre>
<div class="block">Constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
http://git-wip-us.apache.org/repos/asf/juneau-website/blob/c319662c/content/site/apidocs/org/apache/juneau/json/JsonSerializer.Simple.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/json/JsonSerializer.Simple.html b/content/site/apidocs/org/apache/juneau/json/JsonSerializer.Simple.html
index 77cd9dc..55a312f 100644
--- a/content/site/apidocs/org/apache/juneau/json/JsonSerializer.Simple.html
+++ b/content/site/apidocs/org/apache/juneau/json/JsonSerializer.Simple.html
@@ -131,7 +131,7 @@
</dl>
<hr>
<br>
-<pre>public static class <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.218">JsonSerializer.Simple</a>
+<pre>public static class <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.297">JsonSerializer.Simple</a>
extends <a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json">JsonSerializer</a></pre>
<div class="block">Default serializer, single quotes, simple mode.</div>
</li>
@@ -271,7 +271,7 @@ extends <a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="
<ul class="blockListLast">
<li class="blockList">
<h4>Simple</h4>
-<pre>public <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.Simple.html#line.225">Simple</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> ps)</pre>
+<pre>public <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.Simple.html#line.304">Simple</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> ps)</pre>
<div class="block">Constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
http://git-wip-us.apache.org/repos/asf/juneau-website/blob/c319662c/content/site/apidocs/org/apache/juneau/json/JsonSerializer.SimpleReadable.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/json/JsonSerializer.SimpleReadable.html b/content/site/apidocs/org/apache/juneau/json/JsonSerializer.SimpleReadable.html
index a1901a1..bfcaa1f 100644
--- a/content/site/apidocs/org/apache/juneau/json/JsonSerializer.SimpleReadable.html
+++ b/content/site/apidocs/org/apache/juneau/json/JsonSerializer.SimpleReadable.html
@@ -131,7 +131,7 @@
</dl>
<hr>
<br>
-<pre>public static class <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.238">JsonSerializer.SimpleReadable</a>
+<pre>public static class <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.317">JsonSerializer.SimpleReadable</a>
extends <a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json">JsonSerializer</a></pre>
<div class="block">Default serializer, single quotes, simple mode, with whitespace.</div>
</li>
@@ -271,7 +271,7 @@ extends <a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="
<ul class="blockListLast">
<li class="blockList">
<h4>SimpleReadable</h4>
-<pre>public <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.SimpleReadable.html#line.245">SimpleReadable</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> ps)</pre>
+<pre>public <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.SimpleReadable.html#line.324">SimpleReadable</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> ps)</pre>
<div class="block">Constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
http://git-wip-us.apache.org/repos/asf/juneau-website/blob/c319662c/content/site/apidocs/org/apache/juneau/json/JsonSerializer.SimpleReadableSafe.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/json/JsonSerializer.SimpleReadableSafe.html b/content/site/apidocs/org/apache/juneau/json/JsonSerializer.SimpleReadableSafe.html
index 4043f87..019fdf1 100644
--- a/content/site/apidocs/org/apache/juneau/json/JsonSerializer.SimpleReadableSafe.html
+++ b/content/site/apidocs/org/apache/juneau/json/JsonSerializer.SimpleReadableSafe.html
@@ -131,7 +131,7 @@
</dl>
<hr>
<br>
-<pre>public static class <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.260">JsonSerializer.SimpleReadableSafe</a>
+<pre>public static class <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.339">JsonSerializer.SimpleReadableSafe</a>
extends <a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json">JsonSerializer</a></pre>
<div class="block">Default serializer, single quotes, simple mode, with whitespace and recursion detection.
Note that recursion detection introduces a small performance penalty.</div>
@@ -272,7 +272,7 @@ extends <a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="
<ul class="blockListLast">
<li class="blockList">
<h4>SimpleReadableSafe</h4>
-<pre>public <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.SimpleReadableSafe.html#line.267">SimpleReadableSafe</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> ps)</pre>
+<pre>public <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.SimpleReadableSafe.html#line.346">SimpleReadableSafe</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> ps)</pre>
<div class="block">Constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
http://git-wip-us.apache.org/repos/asf/juneau-website/blob/c319662c/content/site/apidocs/org/apache/juneau/json/JsonSerializer.html
----------------------------------------------------------------------
diff --git a/content/site/apidocs/org/apache/juneau/json/JsonSerializer.html b/content/site/apidocs/org/apache/juneau/json/JsonSerializer.html
index ce8204f..01bdef1 100644
--- a/content/site/apidocs/org/apache/juneau/json/JsonSerializer.html
+++ b/content/site/apidocs/org/apache/juneau/json/JsonSerializer.html
@@ -132,18 +132,20 @@ var activeTableTab = "activeTableTab";
</dl>
<hr>
<br>
-<pre>public class <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.89">JsonSerializer</a>
+<pre>public class <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.91">JsonSerializer</a>
extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html" title="class in org.apache.juneau.serializer">WriterSerializer</a></pre>
<div class="block">Serializes POJO models to JSON.
-
- <h5 class='section'>Media types:</h5>
-
- Handles <code>Accept</code> types: <code>application/json, text/json</code>
+
+
+ <h5 class='topic'>Media types</h5>
+
+ Handles <code>Accept</code> types: <code><b>application/json, text/json</b></code>
<p>
- Produces <code>Content-Type</code> types: <code>application/json</code>
-
- <h5 class='section'>Description:</h5>
-
+ Produces <code>Content-Type</code> types: <code><b>application/json</b></code>
+
+
+ <h5 class='topic'>Description</h5>
+
The conversion is as follows...
<ul class='spaced-list'>
<li>
@@ -164,21 +166,21 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html"
<li>
<code>beans</code> are converted to JSON objects.
</ul>
-
+
<p>
The types above are considered "JSON-primitive" object types.
Any non-JSON-primitive object types are transformed into JSON-primitive object types through
<a href="../../../../org/apache/juneau/transform/PojoSwap.html" title="class in org.apache.juneau.transform"><code>PojoSwaps</code></a> associated through the
<a href="../../../../org/apache/juneau/BeanContextBuilder.html#pojoSwaps-java.lang.Class...-"><code>BeanContextBuilder.pojoSwaps(Class...)</code></a> method.
Several default transforms are provided for transforming Dates, Enums, Iterators, etc...
-
+
<p>
This serializer provides several serialization options.
Typically, one of the predefined DEFAULT serializers will be sufficient.
However, custom serializers can be constructed to fine-tune behavior.
-
+
<h6 class='topic'>Behavior-specific subclasses</h6>
-
+
The following direct subclasses are provided for convenience:
<ul class='spaced-list'>
<li>
@@ -186,18 +188,18 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html"
<li>
<a href="../../../../org/apache/juneau/json/JsonSerializer.SimpleReadable.html" title="class in org.apache.juneau.json"><code>JsonSerializer.SimpleReadable</code></a> - Default serializer, single quotes, simple mode, with whitespace.
</ul>
-
+
<h5 class='section'>Example:</h5>
<p class='bcode'>
<jc>// Use one of the default serializers to serialize a POJO</jc>
String json = JsonSerializer.<jsf>DEFAULT</jsf>.serialize(someObject);
-
+
<jc>// Create a custom serializer for lax syntax using single quote characters</jc>
- JsonSerializer serializer = <jk>new</jk> JsonSerializerBuilder().simple().sq().build();
-
+ JsonSerializer serializer = JsonSerializer.<jsm>create</jsm>().simple().sq().build();
+
<jc>// Clone an existing serializer and modify it to use single-quotes</jc>
JsonSerializer serializer = JsonSerializer.<jsf>DEFAULT</jsf>.builder().sq().build();
-
+
<jc>// Serialize a POJO to JSON</jc>
String json = serializer.serialize(someObject);
</p></div>
@@ -447,10 +449,10 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html"
<ul class="blockList">
<li class="blockList">
<h4>JSON_addBeanTypeProperties</h4>
-<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.124">JSON_addBeanTypeProperties</a></pre>
+<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.123">JSON_addBeanTypeProperties</a></pre>
<div class="block">Configuration property: Add <js>"_type"</js> properties when needed.
-
- <h5 class='section'>Property:</h5>
+
+ <h5 class='section'>Property:</h5>
<ul>
<li><b>Name:</b> <js>"JsonSerializer.addBeanTypeProperties.b"</js>
<li><b>Data type:</b> <code>Boolean</code>
@@ -461,15 +463,12 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html"
<li class='jm'><a href="../../../../org/apache/juneau/json/JsonSerializerBuilder.html#addBeanTypeProperties-boolean-"><code>JsonSerializerBuilder.addBeanTypeProperties(boolean)</code></a>
</ul>
</ul>
-
- <h5 class='section'>Description:</h5>
+
+ <h5 class='section'>Description:</h5>
<p>
If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred
through reflection.
- This is used to recreate the correct objects during parsing if the object types cannot be inferred.
- For example, when serializing a <code>Map<String,Object></code> field, where the bean class cannot be determined from
- the value type.
-
+
<p>
When present, this value overrides the <a href="../../../../org/apache/juneau/serializer/Serializer.html#SERIALIZER_addBeanTypeProperties"><code>Serializer.SERIALIZER_addBeanTypeProperties</code></a> setting and is
provided to customize the behavior of specific serializers in a <a href="../../../../org/apache/juneau/serializer/SerializerGroup.html" title="class in org.apache.juneau.serializer"><code>SerializerGroup</code></a>.</div>
@@ -485,10 +484,10 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html"
<ul class="blockList">
<li class="blockList">
<h4>JSON_escapeSolidus</h4>
-<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.149">JSON_escapeSolidus</a></pre>
+<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.168">JSON_escapeSolidus</a></pre>
<div class="block">Configuration property: Prefix solidus <js>'/'</js> characters with escapes.
-
- <h5 class='section'>Property:</h5>
+
+ <h5 class='section'>Property:</h5>
<ul>
<li><b>Name:</b> <js>"JsonSerializer.escapeSolidus.b"</js>
<li><b>Data type:</b> <code>Boolean</code>
@@ -500,13 +499,33 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html"
<li class='jm'><a href="../../../../org/apache/juneau/json/JsonSerializerBuilder.html#escapeSolidus--"><code>JsonSerializerBuilder.escapeSolidus()</code></a>
</ul>
</ul>
-
- <h5 class='section'>Description:</h5>
+
+ <h5 class='section'>Description:</h5>
<p>
If <jk>true</jk>, solidus (e.g. slash) characters should be escaped.
The JSON specification allows for either format.
- However, if you're embedding JSON in an HTML script tag, this setting prevents confusion when trying to serialize
- <xt><\/script></xt>.</div>
+ <br>However, if you're embedding JSON in an HTML script tag, this setting prevents confusion when trying to serialize
+ <xt><\/script></xt>.
+
+ <h5 class='section'>Example:</h5>
+ <p class='bcode'>
+ <jc>// Create a JSON serializer that escapes solidus characters.</jc>
+ WriterSerializer s = JsonSerializer
+ .<jsm>create</jsm>()
+ .simple()
+ .escapeSolidus()
+ .build();
+
+ <jc>// Same, but use property.</jc>
+ WriterSerializer s = JsonSerializer
+ .<jsm>create</jsm>()
+ .simple()
+ .set(<jsf>JSON_escapeSolidus</jsf>, <jk>true</jk>)
+ .build();
+
+ <jc>// Produces: "{foo:'<\/bar>'"</jc>
+ String json = s.serialize(<jk>new</jk> ObjectMap().append(<js>"foo"</js>, <js>"</bar>"</js>);
+ </p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.juneau.json.JsonSerializer.JSON_escapeSolidus">Constant Field Values</a></dd>
@@ -519,10 +538,10 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html"
<ul class="blockList">
<li class="blockList">
<h4>JSON_simpleMode</h4>
-<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.172">JSON_simpleMode</a></pre>
+<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.251">JSON_simpleMode</a></pre>
<div class="block">Configuration property: Simple JSON mode.
-
- <h5 class='section'>Property:</h5>
+
+ <h5 class='section'>Property:</h5>
<ul>
<li><b>Name:</b> <js>"JsonSerializer.simpleMode.b"</js>
<li><b>Data type:</b> <code>Boolean</code>
@@ -532,13 +551,73 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html"
<ul>
<li class='jm'><a href="../../../../org/apache/juneau/json/JsonSerializerBuilder.html#simple-boolean-"><code>JsonSerializerBuilder.simple(boolean)</code></a>
<li class='jm'><a href="../../../../org/apache/juneau/json/JsonSerializerBuilder.html#simple--"><code>JsonSerializerBuilder.simple()</code></a>
+ <li class='jm'><a href="../../../../org/apache/juneau/json/JsonSerializerBuilder.html#ssq--"><code>JsonSerializerBuilder.ssq()</code></a>
</ul>
</ul>
-
- <h5 class='section'>Description:</h5>
+
+ <h5 class='section'>Description:</h5>
<p>
If <jk>true</jk>, JSON attribute names will only be quoted when necessary.
- Otherwise, they are always quoted.</div>
+ <br>Otherwise, they are always quoted.
+
+ <p>
+ Attributes do not need to be quoted when they conform to the following:
+ <ol class='spaced-list'>
+ <li>They start with an ASCII character or <js>'_'</js>.
+ <li>They contain only ASCII characters or numbers or <js>'_'</js>.
+ <li>They are not one of the following reserved words:
+ <p class='bcode'>
+ arguments, break, case, catch, class, const, continue, debugger, default,
+ delete, do, else, enum, eval, export, extends, false, finally, for, function,
+ if, implements, import, in, instanceof, interface, let, new, null, package,
+ private, protected, public, return, static, super, switch, this, throw,
+ true, try, typeof, var, void, while, with, undefined, yield
+ </p>
+ </ol>
+
+ <h5 class='section'>Example:</h5>
+ <p class='bcode'>
+ <jc>// Create a JSON serializer in normal mode.</jc>
+ WriterSerializer s1 = JsonSerializer
+ .<jsm>create</jsm>()
+ .build();
+
+ <jc>// Create a JSON serializer in simple mode.</jc>
+ WriterSerializer s2 = JsonSerializer
+ .<jsm>create</jsm>()
+ .simple()
+ .build();
+
+ ObjectMap m = <jk>new</jk> ObjectMap()
+ .append(<js>"foo"</js>, <js>"x1"</js>)
+ .append(<js>"_bar"</js>, <js>"x2"</js>)
+ .append(<js>" baz "</js>, <js>"x3"</js>)
+ .append(<js>"123"</js>, <js>"x4"</js>)
+ .append(<js>"return"</js>, <js>"x5"</js>);
+ .append(<js>""</js>, <js>"x6"</js>);
+
+ <jc>// Produces:</jc>
+ <jc>// {</jc>
+ <jc>// "foo": "x1"</jc>
+ <jc>// "_bar": "x2"</jc>
+ <jc>// " baz ": "x3"</jc>
+ <jc>// "123": "x4"</jc>
+ <jc>// "return": "x5"</jc>
+ <jc>// "": "x6"</jc>
+ <jc>// }</jc>
+ String json1 = s1.serialize(m);
+
+ <jc>// Produces:</jc>
+ <jc>// {</jc>
+ <jc>// foo: "x1"</jc>
+ <jc>// _bar: "x2"</jc>
+ <jc>// " baz ": "x3"</jc>
+ <jc>// "123": "x4"</jc>
+ <jc>// "return": "x5"</jc>
+ <jc>// "": "x6"</jc>
+ <jc>// }</jc>
+ String json2 = s2.serialize(m);
+ </p></div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.apache.juneau.json.JsonSerializer.JSON_simpleMode">Constant Field Values</a></dd>
@@ -551,7 +630,7 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html"
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT</h4>
-<pre>public static final <a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json">JsonSerializer</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.180">DEFAULT</a></pre>
+<pre>public static final <a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json">JsonSerializer</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.259">DEFAULT</a></pre>
<div class="block">Default serializer, all default settings.</div>
</li>
</ul>
@@ -561,7 +640,7 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html"
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_READABLE</h4>
-<pre>public static final <a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json">JsonSerializer</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.183">DEFAULT_READABLE</a></pre>
+<pre>public static final <a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json">JsonSerializer</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.262">DEFAULT_READABLE</a></pre>
<div class="block">Default serializer, all default settings.</div>
</li>
</ul>
@@ -571,7 +650,7 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html"
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_LAX</h4>
-<pre>public static final <a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json">JsonSerializer</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.186">DEFAULT_LAX</a></pre>
+<pre>public static final <a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json">JsonSerializer</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.265">DEFAULT_LAX</a></pre>
<div class="block">Default serializer, single quotes, simple mode.</div>
</li>
</ul>
@@ -581,7 +660,7 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html"
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_LAX_READABLE</h4>
-<pre>public static final <a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json">JsonSerializer</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.189">DEFAULT_LAX_READABLE</a></pre>
+<pre>public static final <a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json">JsonSerializer</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.268">DEFAULT_LAX_READABLE</a></pre>
<div class="block">Default serializer, single quotes, simple mode, with whitespace.</div>
</li>
</ul>
@@ -591,7 +670,7 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html"
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_LAX_READABLE_SAFE</h4>
-<pre>public static final <a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json">JsonSerializer</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.195">DEFAULT_LAX_READABLE_SAFE</a></pre>
+<pre>public static final <a href="../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json">JsonSerializer</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.274">DEFAULT_LAX_READABLE_SAFE</a></pre>
<div class="block">Default serializer, single quotes, simple mode, with whitespace and recursion detection.
Note that recursion detection introduces a small performance penalty.</div>
</li>
@@ -610,7 +689,7 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html"
<ul class="blockList">
<li class="blockList">
<h4>JsonSerializer</h4>
-<pre>public <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.297">JsonSerializer</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> ps)</pre>
+<pre>public <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.376">JsonSerializer</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> ps)</pre>
<div class="block">Constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
@@ -624,7 +703,7 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html"
<ul class="blockListLast">
<li class="blockList">
<h4>JsonSerializer</h4>
-<pre>public <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.322">JsonSerializer</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> ps,
+<pre>public <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.405">JsonSerializer</a>(<a href="../../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> ps,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> produces,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... accept)</pre>
<div class="block">Constructor.</div>
@@ -641,9 +720,13 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html"
<p>
For example, if this serializer produces <js>"application/json"</js> but should handle media types of
<js>"application/json"</js> and <js>"text/json"</js>, then the arguments should be:
- <br><code><jk>super</jk>(propertyStore, <js>"application/json"</js>, <js>"application/json"</js>, <js>"text/json"</js>);</code>
+ <p class='bcode'>
+ <jk>super</jk>(ps, <js>"application/json"</js>, <js>"application/json"</js>, <js>"text/json"</js>);
+ </p>
<br>...or...
- <br><code><jk>super</jk>(propertyStore, <js>"application/json"</js>, <js>"*​/json"</js>);</code></dd>
+ <p class='bcode'>
+ <jk>super</jk>(ps, <js>"application/json"</js>, <js>"*​/json"</js>);
+ </p></dd>
</dl>
</li>
</ul>
@@ -661,7 +744,7 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html"
<ul class="blockList">
<li class="blockList">
<h4>builder</h4>
-<pre>public <a href="../../../../org/apache/juneau/json/JsonSerializerBuilder.html" title="class in org.apache.juneau.json">JsonSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.331">builder</a>()</pre>
+<pre>public <a href="../../../../org/apache/juneau/json/JsonSerializerBuilder.html" title="class in org.apache.juneau.json">JsonSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.414">builder</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/Context.html#builder--">Context</a></code></span></div>
<div class="block">Creates a builder from this context object.
@@ -681,7 +764,7 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html"
<ul class="blockList">
<li class="blockList">
<h4>create</h4>
-<pre>public static <a href="../../../../org/apache/juneau/json/JsonSerializerBuilder.html" title="class in org.apache.juneau.json">JsonSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.343">create</a>()</pre>
+<pre>public static <a href="../../../../org/apache/juneau/json/JsonSerializerBuilder.html" title="class in org.apache.juneau.json">JsonSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.426">create</a>()</pre>
<div class="block">Instantiates a new clean-slate <a href="../../../../org/apache/juneau/json/JsonSerializerBuilder.html" title="class in org.apache.juneau.json"><code>JsonSerializerBuilder</code></a> object.
<p>
@@ -698,7 +781,7 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html"
<ul class="blockList">
<li class="blockList">
<h4>getSchemaSerializer</h4>
-<pre>public <a href="../../../../org/apache/juneau/json/JsonSchemaSerializer.html" title="class in org.apache.juneau.json">JsonSchemaSerializer</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.356">getSchemaSerializer</a>()</pre>
+<pre>public <a href="../../../../org/apache/juneau/json/JsonSchemaSerializer.html" title="class in org.apache.juneau.json">JsonSchemaSerializer</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.439">getSchemaSerializer</a>()</pre>
<div class="block">Returns the schema serializer based on the settings of this serializer.
<p>
@@ -716,7 +799,7 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html"
<ul class="blockList">
<li class="blockList">
<h4>createSession</h4>
-<pre>public <a href="../../../../org/apache/juneau/serializer/WriterSerializerSession.html" title="class in org.apache.juneau.serializer">WriterSerializerSession</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.367">createSession</a>(<a href="../../../../org/apache/juneau/serializer/SerializerSessionArgs.html" title="class in org.apache.juneau.serializer">SerializerSessionArgs</a> args)</pre>
+<pre>public <a href="../../../../org/apache/juneau/serializer/WriterSerializerSession.html" title="class in org.apache.juneau.serializer">WriterSerializerSession</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.450">createSession</a>(<a href="../../../../org/apache/juneau/serializer/SerializerSessionArgs.html" title="class in org.apache.juneau.serializer">SerializerSessionArgs</a> args)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/Serializer.html#createSession-org.apache.juneau.serializer.SerializerSessionArgs-">Serializer</a></code></span></div>
<div class="block">Create the session object used for actual serialization of objects.</div>
<dl>
@@ -738,7 +821,7 @@ extends <a href="../../../../org/apache/juneau/serializer/WriterSerializer.html"
<ul class="blockListLast">
<li class="blockList">
<h4>asMap</h4>
-<pre>public <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.372">asMap</a>()</pre>
+<pre>public <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> <a href="../../../../src-html/org/apache/juneau/json/JsonSerializer.html#line.455">asMap</a>()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/Context.html#asMap--">Context</a></code></span></div>
<div class="block">Returns the properties defined on this bean context as a simple map for debugging purposes.</div>
<dl>