http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/org/apache/juneau/serializer/SerializerSession.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/serializer/SerializerSession.html b/content/site/apidocs/org/apache/juneau/serializer/SerializerSession.html index 3df4a76..767ac29 100644 --- a/content/site/apidocs/org/apache/juneau/serializer/SerializerSession.html +++ b/content/site/apidocs/org/apache/juneau/serializer/SerializerSession.html @@ -721,7 +721,7 @@ extends <a href="../../../../org/apache/juneau/BeanSession.html" title="class in <ul class="blockList"> <li class="blockList"> <h4>isAddBeanTypeProperties</h4> -<pre>public final boolean <a href="../../../../src-html/org/apache/juneau/serializer/SerializerSession.html#line.288">isAddBeanTypeProperties</a>()</pre> +<pre>public boolean <a href="../../../../src-html/org/apache/juneau/serializer/SerializerSession.html#line.288">isAddBeanTypeProperties</a>()</pre> <div class="block">Returns the <a href="../../../../org/apache/juneau/serializer/SerializerContext.html#SERIALIZER_addBeanTypeProperties"><code>SerializerContext.SERIALIZER_addBeanTypeProperties</code></a> setting value for this session.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/org/apache/juneau/urlencoding/UonSerializerContext.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/urlencoding/UonSerializerContext.html b/content/site/apidocs/org/apache/juneau/urlencoding/UonSerializerContext.html index 75e2b9d..9f14863 100644 --- a/content/site/apidocs/org/apache/juneau/urlencoding/UonSerializerContext.html +++ b/content/site/apidocs/org/apache/juneau/urlencoding/UonSerializerContext.html @@ -163,6 +163,12 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerContext.html </tr> <tr class="altColor"> <td class="colFirst"><code>static <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></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/urlencoding/UonSerializerContext.html#UON_addBeanTypeProperties">UON_addBeanTypeProperties</a></span></code> +<div class="block"><b>Configuration property:</b> Add <js>"_type"</js> properties when needed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <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></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/urlencoding/UonSerializerContext.html#UON_encodeChars">UON_encodeChars</a></span></code> <div class="block"><b>Configuration property:</b> Encode non-valid URI characters.</div> </td> @@ -260,7 +266,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerContext.html <a name="UON_encodeChars"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>UON_encodeChars</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/urlencoding/UonSerializerContext.html#line.52">UON_encodeChars</a></pre> @@ -284,6 +290,34 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerContext.html </dl> </li> </ul> +<a name="UON_addBeanTypeProperties"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UON_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/urlencoding/UonSerializerContext.html#line.71">UON_addBeanTypeProperties</a></pre> +<div class="block"><b>Configuration property:</b> Add <js>"_type"</js> properties when needed. + <p> + <ul> + <li><b>Name:</b> <js>"UonSerializer.addBeanTypeProperties"</js> + <li><b>Data type:</b> <code>Boolean</code> + <li><b>Default:</b> <jk>false</jk> + <li><b>Session-overridable:</b> <jk>true</jk> + </ul> + <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/SerializerContext.html#SERIALIZER_addBeanTypeProperties"><code>SerializerContext.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> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.juneau.urlencoding.UonSerializerContext.UON_addBeanTypeProperties">Constant Field Values</a></dd> +</dl> +</li> +</ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> @@ -298,7 +332,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerContext.html <ul class="blockListLast"> <li class="blockList"> <h4>UonSerializerContext</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/urlencoding/UonSerializerContext.html#line.65">UonSerializerContext</a>(<a href="../../../../org/apache/juneau/ContextFactory.html" title="class in org.apache.juneau">ContextFactory</a> cf)</pre> +<pre>public <a href="../../../../src-html/org/apache/juneau/urlencoding/UonSerializerContext.html#line.85">UonSerializerContext</a>(<a href="../../../../org/apache/juneau/ContextFactory.html" title="class in org.apache.juneau">ContextFactory</a> cf)</pre> <div class="block">Constructor. <p> Typically only called from <a href="../../../../org/apache/juneau/ContextFactory.html#getContext-java.lang.Class-"><code>ContextFactory.getContext(Class)</code></a>.</div> @@ -322,7 +356,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerContext.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/urlencoding/UonSerializerContext.html#line.71">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/urlencoding/UonSerializerContext.html#line.92">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> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/org/apache/juneau/urlencoding/UonSerializerSession.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/urlencoding/UonSerializerSession.html b/content/site/apidocs/org/apache/juneau/urlencoding/UonSerializerSession.html index ec1cad0..f44f860 100644 --- a/content/site/apidocs/org/apache/juneau/urlencoding/UonSerializerSession.html +++ b/content/site/apidocs/org/apache/juneau/urlencoding/UonSerializerSession.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10}; +var methods = {"i0":10,"i1":10,"i2":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -127,7 +127,7 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public class <a href="../../../../src-html/org/apache/juneau/urlencoding/UonSerializerSession.html#line.29">UonSerializerSession</a> +<pre>public class <a href="../../../../src-html/org/apache/juneau/urlencoding/UonSerializerSession.html#line.30">UonSerializerSession</a> extends <a href="../../../../org/apache/juneau/serializer/SerializerSession.html" title="class in org.apache.juneau.serializer">SerializerSession</a></pre> <div class="block">Session object that lives for the duration of a single use of <a href="../../../../org/apache/juneau/urlencoding/UonSerializer.html" title="class in org.apache.juneau.urlencoding"><code>UonSerializer</code></a>. <p> @@ -200,6 +200,12 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerSession.html </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/urlencoding/UonSerializerSession.html#isAddBeanTypeProperties--">isAddBeanTypeProperties</a></span>()</code> +<div class="block">Returns the <a href="../../../../org/apache/juneau/urlencoding/UonSerializerContext.html#UON_addBeanTypeProperties"><code>UonSerializerContext.UON_addBeanTypeProperties</code></a> setting value for this session.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/urlencoding/UonSerializerSession.html#isEncodeChars--">isEncodeChars</a></span>()</code> <div class="block">Returns the <a href="../../../../org/apache/juneau/urlencoding/UonSerializerContext.html#UON_encodeChars"><code>UonSerializerContext.UON_encodeChars</code></a> setting value for this session.</div> </td> @@ -210,7 +216,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerSession.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#addBeanGetterWarning-org.apache.juneau.BeanPropertyMeta-java.lang.Throwable-">addBeanGetterWarning</a>, <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#close--">close</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#generalize-java.lang.Object-org.apache.juneau.ClassMeta-">generalize</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getAbsolutePathUriBase--">getAbsolutePathUriBase</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getBeanTypeName-org.apach e.juneau.ClassMeta-org.apache.juneau.ClassMeta-org.apache.juneau.BeanPropertyMeta-">getBeanTypeName</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getIndent--">getIndent</a>, <a href="../../../../org/apache/juneau/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#getOutput--">getOutput</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getOutputStream--">getOutputStream</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getQuoteChar--">getQuoteChar</a>, <a href="../../../../org/apach e/juneau/serializer/SerializerSession.html#getRelativeUriBase--">getRelativeUriBase</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#isAddBeanTypeProperties--">isAddBeanTypeProperties</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#isTrimNu lls--">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#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#resolveUri-java.lang.String-">resolveUri</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#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#addBeanGetterWarning-org.apache.juneau.BeanPropertyMeta-java.lang.Throwable-">addBeanGetterWarning</a>, <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#close--">close</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#generalize-java.lang.Object-org.apache.juneau.ClassMeta-">generalize</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getAbsolutePathUriBase--">getAbsolutePathUriBase</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getBeanTypeName-org.apach e.juneau.ClassMeta-org.apache.juneau.ClassMeta-org.apache.juneau.BeanPropertyMeta-">getBeanTypeName</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getIndent--">getIndent</a>, <a href="../../../../org/apache/juneau/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#getOutput--">getOutput</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getOutputStream--">getOutputStream</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getQuoteChar--">getQuoteChar</a>, <a href="../../../../org/apach e/juneau/serializer/SerializerSession.html#getRelativeUriBase--">getRelativeUriBase</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#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#resolveUri-java.lang.String-">resolveUri</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#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> </ul> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.BeanSession"> @@ -253,7 +259,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerSession.html <ul class="blockListLast"> <li class="blockList"> <h4>UonSerializerSession</h4> -<pre>protected <a href="../../../../src-html/org/apache/juneau/urlencoding/UonSerializerSession.html#line.48">UonSerializerSession</a>(<a href="../../../../org/apache/juneau/urlencoding/UonSerializerContext.html" title="class in org.apache.juneau.urlencoding">UonSerializerContext</a> ctx, +<pre>protected <a href="../../../../src-html/org/apache/juneau/urlencoding/UonSerializerSession.html#line.51">UonSerializerSession</a>(<a href="../../../../org/apache/juneau/urlencoding/UonSerializerContext.html" title="class in org.apache.juneau.urlencoding">UonSerializerContext</a> ctx, <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> op, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> output, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> javaMethod, @@ -285,13 +291,43 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerSession.html <!-- --> </a> <h3>Method Detail</h3> -<a name="getWriter--"> +<a name="isEncodeChars--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> +<h4>isEncodeChars</h4> +<pre>public final boolean <a href="../../../../src-html/org/apache/juneau/urlencoding/UonSerializerSession.html#line.67">isEncodeChars</a>()</pre> +<div class="block">Returns the <a href="../../../../org/apache/juneau/urlencoding/UonSerializerContext.html#UON_encodeChars"><code>UonSerializerContext.UON_encodeChars</code></a> setting value for this session.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The <a href="../../../../org/apache/juneau/urlencoding/UonSerializerContext.html#UON_encodeChars"><code>UonSerializerContext.UON_encodeChars</code></a> setting value for this session.</dd> +</dl> +</li> +</ul> +<a name="isAddBeanTypeProperties--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAddBeanTypeProperties</h4> +<pre>public final boolean <a href="../../../../src-html/org/apache/juneau/urlencoding/UonSerializerSession.html#line.77">isAddBeanTypeProperties</a>()</pre> +<div class="block">Returns the <a href="../../../../org/apache/juneau/urlencoding/UonSerializerContext.html#UON_addBeanTypeProperties"><code>UonSerializerContext.UON_addBeanTypeProperties</code></a> setting value for this session.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/serializer/SerializerSession.html#isAddBeanTypeProperties--">isAddBeanTypeProperties</a></code> in class <code><a href="../../../../org/apache/juneau/serializer/SerializerSession.html" title="class in org.apache.juneau.serializer">SerializerSession</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The <a href="../../../../org/apache/juneau/urlencoding/UonSerializerContext.html#UON_addBeanTypeProperties"><code>UonSerializerContext.UON_addBeanTypeProperties</code></a> setting value for this session.</dd> +</dl> +</li> +</ul> +<a name="getWriter--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> <h4>getWriter</h4> -<pre>public final <a href="../../../../org/apache/juneau/urlencoding/UonWriter.html" title="class in org.apache.juneau.urlencoding">UonWriter</a> <a href="../../../../src-html/org/apache/juneau/urlencoding/UonSerializerSession.html#line.58">getWriter</a>() +<pre>public final <a href="../../../../org/apache/juneau/urlencoding/UonWriter.html" title="class in org.apache.juneau.urlencoding">UonWriter</a> <a href="../../../../src-html/org/apache/juneau/urlencoding/UonSerializerSession.html#line.82">getWriter</a>() 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#getWriter--">SerializerSession</a></code></span></div> <div class="block">Wraps the specified output object inside a writer. @@ -313,20 +349,6 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerSession.html </dl> </li> </ul> -<a name="isEncodeChars--"> -<!-- --> -</a> -<ul class="blockListLast"> -<li class="blockList"> -<h4>isEncodeChars</h4> -<pre>public final boolean <a href="../../../../src-html/org/apache/juneau/urlencoding/UonSerializerSession.html#line.70">isEncodeChars</a>()</pre> -<div class="block">Returns the <a href="../../../../org/apache/juneau/urlencoding/UonSerializerContext.html#UON_encodeChars"><code>UonSerializerContext.UON_encodeChars</code></a> setting value for this session.</div> -<dl> -<dt><span class="returnLabel">Returns:</span></dt> -<dd>The <a href="../../../../org/apache/juneau/urlencoding/UonSerializerContext.html#UON_encodeChars"><code>UonSerializerContext.UON_encodeChars</code></a> setting value for this session.</dd> -</dl> -</li> -</ul> </li> </ul> </li> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/org/apache/juneau/urlencoding/UrlEncodingSerializerContext.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/urlencoding/UrlEncodingSerializerContext.html b/content/site/apidocs/org/apache/juneau/urlencoding/UrlEncodingSerializerContext.html index 2a875d5..9675dee 100644 --- a/content/site/apidocs/org/apache/juneau/urlencoding/UrlEncodingSerializerContext.html +++ b/content/site/apidocs/org/apache/juneau/urlencoding/UrlEncodingSerializerContext.html @@ -166,7 +166,7 @@ extends <a href="../../../../org/apache/juneau/urlencoding/UonSerializerContext. <!-- --> </a> <h3>Fields inherited from class org.apache.juneau.urlencoding.<a href="../../../../org/apache/juneau/urlencoding/UonSerializerContext.html" title="class in org.apache.juneau.urlencoding">UonSerializerContext</a></h3> -<code><a href="../../../../org/apache/juneau/urlencoding/UonSerializerContext.html#UON_encodeChars">UON_encodeChars</a></code></li> +<code><a href="../../../../org/apache/juneau/urlencoding/UonSerializerContext.html#UON_addBeanTypeProperties">UON_addBeanTypeProperties</a>, <a href="../../../../org/apache/juneau/urlencoding/UonSerializerContext.html#UON_encodeChars">UON_encodeChars</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="fields.inherited.from.class.org.apache.juneau.serializer.SerializerContext"> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/org/apache/juneau/urlencoding/UrlEncodingSerializerSession.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/urlencoding/UrlEncodingSerializerSession.html b/content/site/apidocs/org/apache/juneau/urlencoding/UrlEncodingSerializerSession.html index 0e81d3a..5a5cd9a 100644 --- a/content/site/apidocs/org/apache/juneau/urlencoding/UrlEncodingSerializerSession.html +++ b/content/site/apidocs/org/apache/juneau/urlencoding/UrlEncodingSerializerSession.html @@ -209,14 +209,14 @@ extends <a href="../../../../org/apache/juneau/urlencoding/UonSerializerSession. <!-- --> </a> <h3>Methods inherited from class org.apache.juneau.urlencoding.<a href="../../../../org/apache/juneau/urlencoding/UonSerializerSession.html" title="class in org.apache.juneau.urlencoding">UonSerializerSession</a></h3> -<code><a href="../../../../org/apache/juneau/urlencoding/UonSerializerSession.html#getWriter--">getWriter</a>, <a href="../../../../org/apache/juneau/urlencoding/UonSerializerSession.html#isEncodeChars--">isEncodeChars</a></code></li> +<code><a href="../../../../org/apache/juneau/urlencoding/UonSerializerSession.html#getWriter--">getWriter</a>, <a href="../../../../org/apache/juneau/urlencoding/UonSerializerSession.html#isAddBeanTypeProperties--">isAddBeanTypeProperties</a>, <a href="../../../../org/apache/juneau/urlencoding/UonSerializerSession.html#isEncodeChars--">isEncodeChars</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.serializer.SerializerSession"> <!-- --> </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#addBeanGetterWarning-org.apache.juneau.BeanPropertyMeta-java.lang.Throwable-">addBeanGetterWarning</a>, <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#close--">close</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#generalize-java.lang.Object-org.apache.juneau.ClassMeta-">generalize</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getAbsolutePathUriBase--">getAbsolutePathUriBase</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getBeanTypeName-org.apach e.juneau.ClassMeta-org.apache.juneau.ClassMeta-org.apache.juneau.BeanPropertyMeta-">getBeanTypeName</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getIndent--">getIndent</a>, <a href="../../../../org/apache/juneau/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#getOutput--">getOutput</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getOutputStream--">getOutputStream</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getQuoteChar--">getQuoteChar</a>, <a href="../../../../org/apach e/juneau/serializer/SerializerSession.html#getRelativeUriBase--">getRelativeUriBase</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#isAddBeanTypeProperties--">isAddBeanTypeProperties</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#isTrimNu lls--">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#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#resolveUri-java.lang.String-">resolveUri</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#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#addBeanGetterWarning-org.apache.juneau.BeanPropertyMeta-java.lang.Throwable-">addBeanGetterWarning</a>, <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#close--">close</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#generalize-java.lang.Object-org.apache.juneau.ClassMeta-">generalize</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getAbsolutePathUriBase--">getAbsolutePathUriBase</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getBeanTypeName-org.apach e.juneau.ClassMeta-org.apache.juneau.ClassMeta-org.apache.juneau.BeanPropertyMeta-">getBeanTypeName</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getIndent--">getIndent</a>, <a href="../../../../org/apache/juneau/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#getOutput--">getOutput</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getOutputStream--">getOutputStream</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getQuoteChar--">getQuoteChar</a>, <a href="../../../../org/apach e/juneau/serializer/SerializerSession.html#getRelativeUriBase--">getRelativeUriBase</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#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#resolveUri-java.lang.String-">resolveUri</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#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> </ul> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.BeanSession"> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/org/apache/juneau/urlencoding/doc-files/rfc_uon.txt ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/urlencoding/doc-files/rfc_uon.txt b/content/site/apidocs/org/apache/juneau/urlencoding/doc-files/rfc_uon.txt index a78153f..7880064 100644 --- a/content/site/apidocs/org/apache/juneau/urlencoding/doc-files/rfc_uon.txt +++ b/content/site/apidocs/org/apache/juneau/urlencoding/doc-files/rfc_uon.txt @@ -81,12 +81,12 @@ Abstract Using the syntax defined in this document, the equivalent UON notation would be as follows: - x=(id=1,name=John+Smith,uri=http://sample/ + x=(id=1,name='John+Smith',uri=http://sample/ addressBook/person/1,addressBookUri=http://sample/ - addressBook,birthDate=1946-08-12T00:00:00Z,otherIds=%00, + addressBook,birthDate=1946-08-12T00:00:00Z,otherIds=null, addresses=@((uri=http://sample/addressBook/ address/1,personUri=http://sample/addressBook/ - person/1,id=1,street=100+Main+Street,city= + person/1,id=1,street='100+Main+Street',city= Anywhereville,state=NY,zip=12345,isCurrent=true))) 1. Language constraints @@ -167,7 +167,13 @@ Abstract a1=123&a2=1.23e1 -2.5. Strings +2.5. Null values + + Nulls are represented by the keyword 'null': + + a1=null + +2.6. Strings Strings are encapsulated in single quote (') characters. @@ -209,13 +215,7 @@ Abstract a1='foo~'bar~~baz' -2.7. Null values - - Nulls are represented by the keyword 'null': - - a1=null - -2.8. Top-level attribute names +2.7. Top-level attribute names Top-level attribute names (e.g. "a1" in "&a1=foobar") are treated as strings but for one exception. The '=' character must be @@ -231,7 +231,7 @@ Abstract Note that the '=' character is encoded in the attribute name, but it is not necessary to have it encoded in the attribute value. -2.9. URL-encoded characters +2.8. URL-encoded characters UON notation allows for any character, even UON grammar characters, to be URL-encoded. @@ -239,7 +239,7 @@ Abstract The following query strings are fully equivalent in structure: a1=(b1='x1',b2='x2') - %61%31=%24%6F%28%62%31%3D%78%31%2C%62%32%3D%78%32%29 + %61%31=%79%6f%75%20%61%72%65%20%61%20%6e%65%72%64%21 3. BNF @@ -251,7 +251,7 @@ Abstract value = (var | string | null) string = ("'" litchar* "'") | litchar* - null = "%00" + null = "null" var = ovar | avar | nvar | boolean | number ovar = "(" [pairs] ")" http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/org/apache/juneau/xml/XmlSerializerContext.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/xml/XmlSerializerContext.html b/content/site/apidocs/org/apache/juneau/xml/XmlSerializerContext.html index ab1966e..7c5f9d0 100644 --- a/content/site/apidocs/org/apache/juneau/xml/XmlSerializerContext.html +++ b/content/site/apidocs/org/apache/juneau/xml/XmlSerializerContext.html @@ -163,35 +163,41 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerContext.html </tr> <tr class="altColor"> <td class="colFirst"><code>static <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></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_addBeanTypeProperties">XML_addBeanTypeProperties</a></span></code> +<div class="block"><b>Configuration property:</b> Add <js>"_type"</js> properties when needed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <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></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_addNamespaceUrisToRoot">XML_addNamespaceUrisToRoot</a></span></code> <div class="block"><b>Configuration property:</b> Add namespace URLs to the root element.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static <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></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_autoDetectNamespaces">XML_autoDetectNamespaces</a></span></code> <div class="block"><b>Configuration property:</b> Auto-detect namespace usage.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static <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></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_defaultNamespace">XML_defaultNamespace</a></span></code> <div class="block"><b>Configuration property:</b> Default namespace.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static <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></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_enableNamespaces">XML_enableNamespaces</a></span></code> <div class="block"><b>Configuration property:</b> Enable support for XML namespaces.</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><code>static <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></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_namespaces">XML_namespaces</a></span></code> <div class="block"><b>Configuration property:</b> Default namespaces.</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><code>static <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></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_xsNamespace">XML_xsNamespace</a></span></code> <div class="block"><b>Configuration property:</b> XMLSchema namespace.</div> @@ -426,7 +432,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerContext.html <a name="XML_namespaces"> <!-- --> </a> -<ul class="blockListLast"> +<ul class="blockList"> <li class="blockList"> <h4>XML_namespaces</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/xml/XmlSerializerContext.html#line.139">XML_namespaces</a></pre> @@ -446,6 +452,34 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerContext.html </dl> </li> </ul> +<a name="XML_addBeanTypeProperties"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>XML_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/xml/XmlSerializerContext.html#line.158">XML_addBeanTypeProperties</a></pre> +<div class="block"><b>Configuration property:</b> Add <js>"_type"</js> properties when needed. + <p> + <ul> + <li><b>Name:</b> <js>"XmlSerializer.addBeanTypeProperties"</js> + <li><b>Data type:</b> <code>Boolean</code> + <li><b>Default:</b> <jk>false</jk> + <li><b>Session-overridable:</b> <jk>true</jk> + </ul> + <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/SerializerContext.html#SERIALIZER_addBeanTypeProperties"><code>SerializerContext.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> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.juneau.xml.XmlSerializerContext.XML_addBeanTypeProperties">Constant Field Values</a></dd> +</dl> +</li> +</ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> @@ -460,7 +494,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerContext.html <ul class="blockListLast"> <li class="blockList"> <h4>XmlSerializerContext</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerContext.html#line.161">XmlSerializerContext</a>(<a href="../../../../org/apache/juneau/ContextFactory.html" title="class in org.apache.juneau">ContextFactory</a> cf)</pre> +<pre>public <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerContext.html#line.181">XmlSerializerContext</a>(<a href="../../../../org/apache/juneau/ContextFactory.html" title="class in org.apache.juneau">ContextFactory</a> cf)</pre> <div class="block">Constructor. <p> Typically only called from <a href="../../../../org/apache/juneau/ContextFactory.html#getContext-java.lang.Class-"><code>ContextFactory.getContext(Class)</code></a>.</div> @@ -484,7 +518,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerContext.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/xml/XmlSerializerContext.html#line.172">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/xml/XmlSerializerContext.html#line.193">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> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/org/apache/juneau/xml/XmlSerializerSession.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/xml/XmlSerializerSession.html b/content/site/apidocs/org/apache/juneau/xml/XmlSerializerSession.html index 17df001..c0d5f12 100644 --- a/content/site/apidocs/org/apache/juneau/xml/XmlSerializerSession.html +++ b/content/site/apidocs/org/apache/juneau/xml/XmlSerializerSession.html @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -127,7 +127,7 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public class <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerSession.html#line.32">XmlSerializerSession</a> +<pre>public class <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerSession.html#line.33">XmlSerializerSession</a> extends <a href="../../../../org/apache/juneau/serializer/SerializerSession.html" title="class in org.apache.juneau.serializer">SerializerSession</a></pre> <div class="block">Session object that lives for the duration of a single use of <a href="../../../../org/apache/juneau/xml/XmlSerializer.html" title="class in org.apache.juneau.xml"><code>XmlSerializer</code></a>. <p> @@ -222,17 +222,23 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerSession.html </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/xml/XmlSerializerSession.html#isAddBeanTypeProperties--">isAddBeanTypeProperties</a></span>()</code> +<div class="block">Returns the <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_addBeanTypeProperties"><code>XmlSerializerContext.XML_addBeanTypeProperties</code></a> setting value for this session.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/xml/XmlSerializerSession.html#isAddNamespaceUrlsToRoot--">isAddNamespaceUrlsToRoot</a></span>()</code> <div class="block">Returns the <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_addNamespaceUrisToRoot"><code>XmlSerializerContext.XML_addNamespaceUrisToRoot</code></a> setting value in this context.</div> </td> </tr> -<tr id="i6" class="altColor"> +<tr id="i7" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/xml/XmlSerializerSession.html#isAutoDetectNamespaces--">isAutoDetectNamespaces</a></span>()</code> <div class="block">Returns the <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_autoDetectNamespaces"><code>XmlSerializerContext.XML_autoDetectNamespaces</code></a> setting value in this context.</div> </td> </tr> -<tr id="i7" class="rowColor"> +<tr id="i8" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/xml/XmlSerializerSession.html#isEnableNamespaces--">isEnableNamespaces</a></span>()</code> <div class="block">Returns the <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_enableNamespaces"><code>XmlSerializerContext.XML_enableNamespaces</code></a> setting value in this context.</div> @@ -244,7 +250,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerSession.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#addBeanGetterWarning-org.apache.juneau.BeanPropertyMeta-java.lang.Throwable-">addBeanGetterWarning</a>, <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#close--">close</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#generalize-java.lang.Object-org.apache.juneau.ClassMeta-">generalize</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getAbsolutePathUriBase--">getAbsolutePathUriBase</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getBeanTypeName-org.apach e.juneau.ClassMeta-org.apache.juneau.ClassMeta-org.apache.juneau.BeanPropertyMeta-">getBeanTypeName</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getIndent--">getIndent</a>, <a href="../../../../org/apache/juneau/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#getOutput--">getOutput</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getOutputStream--">getOutputStream</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getQuoteChar--">getQuoteChar</a>, <a href="../../../../org/apach e/juneau/serializer/SerializerSession.html#getRelativeUriBase--">getRelativeUriBase</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#isAddBeanTypeProperties--">isAddBeanTypeProperties</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#isTrimNu lls--">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#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#resolveUri-java.lang.String-">resolveUri</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#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#addBeanGetterWarning-org.apache.juneau.BeanPropertyMeta-java.lang.Throwable-">addBeanGetterWarning</a>, <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#close--">close</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#generalize-java.lang.Object-org.apache.juneau.ClassMeta-">generalize</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getAbsolutePathUriBase--">getAbsolutePathUriBase</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getBeanTypeName-org.apach e.juneau.ClassMeta-org.apache.juneau.ClassMeta-org.apache.juneau.BeanPropertyMeta-">getBeanTypeName</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getIndent--">getIndent</a>, <a href="../../../../org/apache/juneau/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#getOutput--">getOutput</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getOutputStream--">getOutputStream</a>, <a href="../../../../org/apache/juneau/serializer/SerializerSession.html#getQuoteChar--">getQuoteChar</a>, <a href="../../../../org/apach e/juneau/serializer/SerializerSession.html#getRelativeUriBase--">getRelativeUriBase</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#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#resolveUri-java.lang.String-">resolveUri</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#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> </ul> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.BeanSession"> @@ -287,7 +293,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerSession.html <ul class="blockListLast"> <li class="blockList"> <h4>XmlSerializerSession</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerSession.html#line.61">XmlSerializerSession</a>(<a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html" title="class in org.apache.juneau.xml">XmlSerializerContext</a> ctx, +<pre>public <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerSession.html#line.63">XmlSerializerSession</a>(<a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html" title="class in org.apache.juneau.xml">XmlSerializerContext</a> ctx, <a href="../../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> op, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> output, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> javaMethod, @@ -325,7 +331,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerSession.html <ul class="blockList"> <li class="blockList"> <h4>addNamespace</h4> -<pre>public void <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerSession.html#line.100">addNamespace</a>(<a href="../../../../org/apache/juneau/xml/Namespace.html" title="class in org.apache.juneau.xml">Namespace</a> ns)</pre> +<pre>public void <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerSession.html#line.104">addNamespace</a>(<a href="../../../../org/apache/juneau/xml/Namespace.html" title="class in org.apache.juneau.xml">Namespace</a> ns)</pre> <div class="block">Add a namespace to this session.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -339,7 +345,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerSession.html <ul class="blockList"> <li class="blockList"> <h4>getNamespaces</h4> -<pre>public <a href="../../../../org/apache/juneau/xml/Namespace.html" title="class in org.apache.juneau.xml">Namespace</a>[] <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerSession.html#line.119">getNamespaces</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/xml/Namespace.html" title="class in org.apache.juneau.xml">Namespace</a>[] <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerSession.html#line.123">getNamespaces</a>()</pre> <div class="block">Returns the list of namespaces being used in the current XML serialization.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -353,7 +359,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerSession.html <ul class="blockList"> <li class="blockList"> <h4>isAutoDetectNamespaces</h4> -<pre>public final boolean <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerSession.html#line.128">isAutoDetectNamespaces</a>()</pre> +<pre>public final boolean <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerSession.html#line.132">isAutoDetectNamespaces</a>()</pre> <div class="block">Returns the <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_autoDetectNamespaces"><code>XmlSerializerContext.XML_autoDetectNamespaces</code></a> setting value in this context.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -367,7 +373,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerSession.html <ul class="blockList"> <li class="blockList"> <h4>isEnableNamespaces</h4> -<pre>public final boolean <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerSession.html#line.137">isEnableNamespaces</a>()</pre> +<pre>public final boolean <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerSession.html#line.141">isEnableNamespaces</a>()</pre> <div class="block">Returns the <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_enableNamespaces"><code>XmlSerializerContext.XML_enableNamespaces</code></a> setting value in this context.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -381,7 +387,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerSession.html <ul class="blockList"> <li class="blockList"> <h4>isAddNamespaceUrlsToRoot</h4> -<pre>public final boolean <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerSession.html#line.146">isAddNamespaceUrlsToRoot</a>()</pre> +<pre>public final boolean <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerSession.html#line.150">isAddNamespaceUrlsToRoot</a>()</pre> <div class="block">Returns the <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_addNamespaceUrisToRoot"><code>XmlSerializerContext.XML_addNamespaceUrisToRoot</code></a> setting value in this context.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -389,13 +395,29 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerSession.html </dl> </li> </ul> +<a name="isAddBeanTypeProperties--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAddBeanTypeProperties</h4> +<pre>public boolean <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerSession.html#line.160">isAddBeanTypeProperties</a>()</pre> +<div class="block">Returns the <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_addBeanTypeProperties"><code>XmlSerializerContext.XML_addBeanTypeProperties</code></a> setting value for this session.</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code><a href="../../../../org/apache/juneau/serializer/SerializerSession.html#isAddBeanTypeProperties--">isAddBeanTypeProperties</a></code> in class <code><a href="../../../../org/apache/juneau/serializer/SerializerSession.html" title="class in org.apache.juneau.serializer">SerializerSession</a></code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_addBeanTypeProperties"><code>XmlSerializerContext.XML_addBeanTypeProperties</code></a> setting value for this session.</dd> +</dl> +</li> +</ul> <a name="getDefaultNamespace--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getDefaultNamespace</h4> -<pre>public final <a href="../../../../org/apache/juneau/xml/Namespace.html" title="class in org.apache.juneau.xml">Namespace</a> <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerSession.html#line.155">getDefaultNamespace</a>()</pre> +<pre>public final <a href="../../../../org/apache/juneau/xml/Namespace.html" title="class in org.apache.juneau.xml">Namespace</a> <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerSession.html#line.169">getDefaultNamespace</a>()</pre> <div class="block">Returns the <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_defaultNamespace"><code>XmlSerializerContext.XML_defaultNamespace</code></a> setting value in this context.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -409,7 +431,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerSession.html <ul class="blockList"> <li class="blockList"> <h4>getXsNamespace</h4> -<pre>public final <a href="../../../../org/apache/juneau/xml/Namespace.html" title="class in org.apache.juneau.xml">Namespace</a> <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerSession.html#line.164">getXsNamespace</a>()</pre> +<pre>public final <a href="../../../../org/apache/juneau/xml/Namespace.html" title="class in org.apache.juneau.xml">Namespace</a> <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerSession.html#line.178">getXsNamespace</a>()</pre> <div class="block">Returns the <a href="../../../../org/apache/juneau/xml/XmlSerializerContext.html#XML_xsNamespace"><code>XmlSerializerContext.XML_xsNamespace</code></a> setting value in this context.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -423,7 +445,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerSession.html <ul class="blockListLast"> <li class="blockList"> <h4>getWriter</h4> -<pre>public <a href="../../../../org/apache/juneau/xml/XmlWriter.html" title="class in org.apache.juneau.xml">XmlWriter</a> <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerSession.html#line.169">getWriter</a>() +<pre>public <a href="../../../../org/apache/juneau/xml/XmlWriter.html" title="class in org.apache.juneau.xml">XmlWriter</a> <a href="../../../../src-html/org/apache/juneau/xml/XmlSerializerSession.html#line.183">getWriter</a>() 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#getWriter--">SerializerSession</a></code></span></div> <div class="block">Wraps the specified output object inside a writer. http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/4903c5d1/content/site/apidocs/overview-summary.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/overview-summary.html b/content/site/apidocs/overview-summary.html index f1bcc01..0a08e95 100644 --- a/content/site/apidocs/overview-summary.html +++ b/content/site/apidocs/overview-summary.html @@ -2099,7 +2099,136 @@ <a id="DTOs.Swagger"></a> <h3 class='topic' onclick='toggle(this)'>3.3 - Swagger</h3> <div class='topic'> - TODO + <p> + The Juneau Swagger DTOs are simply beans with fluent-style setters that allow you to quickly construct Swagger + documents as Java objects. These object can then be serialized to JSON using one of the existing JSON serializers, + or to other languages such as XML or HTML using the other serializers. + </p> + <p> + The <a href="org/apache/juneau/dto/swagger/SwaggerBuilder.html" title="class in org.apache.juneau.dto.swagger"><code>SwaggerBuilder</code></a> class is a utility class with predefined static methods + that allow you to easily construct DTO instances in a minimal amount of code. + </p> + <p> + The following is an example Swagger document from the <a href="http://petstore.swagger.io/";>Swagger website</a>. + </p> + <p class='bcode'> + { + <jf>"swagger"</jf>: <js>"2.0"</js>, + <jf>"info"</jf>: { + <jf>"title"</jf>: <js>"Swagger Petstore"</js>, + <jf>"description"</jf>: <js>"This is a sample server Petstore server."</js>, + <jf>"version"</jf>: <js>"1.0.0"</js>, + <jf>"termsOfService"</jf>: <js>"http://swagger.io/terms/";</js>, + <jf>"contact"</jf>: { + <jf>"email"</jf>: <js>"[email protected]"</js> + }, + <jf>"license"</jf>: { + <jf>"name"</jf>: <js>"Apache 2.0"</js>, + <jf>"url"</jf>: <js>"http://www.apache.org/licenses/LICENSE-2.0.html";</js> + } + }, + <jf>"host"</jf>: <js>"petstore.swagger.io"</js>, + <jf>"basePath"</jf>: <js>"/v2"</js>, + <jf>"tags"</jf>: [ + { + <jf>"name"</jf>: <js>"pet"</js>, + <jf>"description"</jf>: <js>"Everything about your Pets"</js>, + <jf>"externalDocs"</jf>: { + <jf>"description"</jf>: <js>"Find out more"</js>, + <jf>"url"</jf>: <js>"http://swagger.io";</js> + } + } + ], + <jf>"schemes"</jf>: [ + <js>"http"</js> + ], + <jf>"paths"</jf>: { + <jf>"/pet"</jf>: { + <jf>"post"</jf>: { + <jf>"tags"</jf>: [ + <js>"pet"</js> + ], + <jf>"summary"</jf>: <js>"Add a new pet to the store"</js>, + <jf>"description"</jf>: <js>""</js>, + <jf>"operationId"</jf>: <js>"addPet"</js>, + <jf>"consumes"</jf>: [ + <js>"application/json"</js>, + <js>"text/xml"</js> + ], + <jf>"produces"</jf>: [ + <js>"application/json"</js>, + <js>"text/xml"</js> + ], + <jf>"parameters"</jf>: [ + { + <jf>"in"</jf>: <js>"body"</js>, + <jf>"name"</jf>: <js>"body"</js>, + <jf>"description"</jf>: <js>"Pet object that needs to be added to the store"</js>, + <jf>"required"</jf>: <jk>true</jk> + } + ], + <jf>"responses"</jf>: { + <jf>"405"</jf>: { + <jf>"description"</jf>: <js>"Invalid input"</js> + } + } + } + } + }, + } + </p> + <p> + This document can be generated by the following Java code: + </p> + <p class='bcode'> + <jk>static import</jk> org.apache.juneau.dto.swagger.SwaggerBuilder.*; + + Swagger swagger = <jsm>swagger</jsm>() + .swagger(<js>"2.0"</js>) + .info( + <jsm>info</jsm>(<js>"Swagger Petstore"</js>, <js>"1.0.0"</js>) + .description(<js>"This is a sample server Petstore server."</js>) + .termsOfService(<js>"http://swagger.io/terms/";</js>) + .contact( + <jsm>contact</jsm>().email(<js>"[email protected]"</js>) + ) + .license( + <jsm>license</jsm>(<js>"Apache 2.0"</js>).url(<js>"http://www.apache.org/licenses/LICENSE-2.0.html";</js>) + ) + ) + .host(<js>"petstore.swagger.io"</js>) + .basePath(<js>"/v2"</js>) + .tags( + <jsm>tag</jsm>(<js>"pet"</js>).description(<js>"Everything about your Pets"</js>) + .externalDocs( + <jsm>externalDocumentation</jsm>(<js>"http://swagger.io";</js>, <js>"http://swagger.io";</js>) + ) + ) + .schemes(<js>"http"</js>) + .path(<js>"/pet"</js>, <js>"post"</js>, + <jsm>operation</jsm>() + .tags(<js>"pet"</js>) + .summary(<js>"Add a new pet to the store"</js>) + .description(<js>""</js>) + .operationId(<js>"addPet"</js>) + .consumes(MediaType.<jsf>JSON</jsf>, MediaType.<jsf>XML</jsf>) + .produces(MediaType.<jsf>JSON</jsf>, MediaType.<jsf>XML</jsf>) + .parameters( + <jsm>parameterInfo</jsm>(<js>"body"</js>, <js>"body"</js>) + .description(<js>"Pet object that needs to be added to the store"</js>) + .required(<jk>true</jk>) + ) + .response(405, <jsm>responseInfo</jsm>(<js>"Invalid input"</js>)) + ); + + String swaggerJson = JsonSerializer.<jsf>DEFAULT_READABLE</jsf>.serialize(swagger); + </p> + <p> + Swagger docs can be parsed back into Swagger beans using the following code: + </p> + <p class='bcode'> + Swagger swagger = JsonParser.<jsf>DEFAULT</jsf>.parse(swaggerJson, Swagger.<jk>class</jk>); + </p> </div> <!-- ======================================================================================================== --> @@ -5719,6 +5848,7 @@ <h5 class='toc'>What's new in each release</h5> <ul class='toc'> + <li><p><a class='doclink' href='#6.1.1'>6.1.1 (TBD)</a></p> <li><p><a class='doclink' href='#6.1.0'>6.1.0 (TBD)</a></p> <li><p><a class='doclink' href='#6.0.1'>6.0.1 (Jan 3, 2017)</a></p> <li><p><a class='doclink' href='#6.0.0'>6.0.0 (Oct 3, 2016)</a></p> @@ -5786,6 +5916,31 @@ <!-- ======================================================================================================== --> + <a id="6.1.1"></a> + <h3 class='topic' onclick='toggle(this)'>6.1.1 (TBD)</h3> + <div class='topic'> + <p> + Juneau 6.1.1 is ... + </p> + + <h6 class='topic'>org.apache.juneau</h6> + <ul class='spaced-list'> + <li>New <code>addBeanTypeProperties</code> setting added to serializers to override the + <a href="org/apache/juneau/serializer/SerializerContext.html#SERIALIZER_addBeanTypeProperties"><code>SerializerContext.SERIALIZER_addBeanTypeProperties</code></a> setting + for individual serializers in a serializer group: + <ul> + <li><a href="org/apache/juneau/html/HtmlSerializerContext.html#HTML_addBeanTypeProperties"><code>HtmlSerializerContext.HTML_addBeanTypeProperties</code></a> + <li><a href="org/apache/juneau/json/JsonSerializerContext.html#JSON_addBeanTypeProperties"><code>JsonSerializerContext.JSON_addBeanTypeProperties</code></a> + <li><a href="org/apache/juneau/msgpack/MsgPackSerializerContext.html#MSGPACK_addBeanTypeProperties"><code>MsgPackSerializerContext.MSGPACK_addBeanTypeProperties</code></a> + <li><a href="org/apache/juneau/urlencoding/UonSerializerContext.html#UON_addBeanTypeProperties"><code>UonSerializerContext.UON_addBeanTypeProperties</code></a> + <li><a href="org/apache/juneau/xml/XmlSerializerContext.html#XML_addBeanTypeProperties"><code>XmlSerializerContext.XML_addBeanTypeProperties</code></a> + <li><a href="org/apache/juneau/jena/RdfSerializerContext.html#RDF_addBeanTypeProperties"><code>RdfSerializerContext.RDF_addBeanTypeProperties</code></a> + </ul> + </ul> + </div> + + + <!-- ======================================================================================================== --> <a id="6.1.0"></a> <h3 class='topic' onclick='toggle(this)'>6.1.0 (TBD)</h3> <div class='topic'>
