http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1b5bde65/content/site/apidocs/org/apache/juneau/csv/CsvSerializerBuilder.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/csv/CsvSerializerBuilder.html b/content/site/apidocs/org/apache/juneau/csv/CsvSerializerBuilder.html index 122b273..e71ca54 100644 --- a/content/site/apidocs/org/apache/juneau/csv/CsvSerializerBuilder.html +++ b/content/site/apidocs/org/apache/juneau/csv/CsvSerializerBuilder.html @@ -824,18 +824,19 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.53">maxDepth</a>(int value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html#maxDepth-int-">SerializerBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Max serialization depth. - <p> + <ul> <li><b>Name:</b> <js>"Serializer.maxDepth"</js> <li><b>Data type:</b> <code>Integer</code> <li><b>Default:</b> <code>100</code> <li><b>Session-overridable:</b> <jk>true</jk> </ul> + <p> Abort serialization if specified depth is reached in the POJO tree. If this depth is exceeded, an exception is thrown. This prevents stack overflows from occurring when trying to serialize models with recursive references. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_maxDepth</jsf>, value)</code>. @@ -861,17 +862,18 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.59">initialDepth</a>(int value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html#initialDepth-int-">SerializerBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Initial depth. - <p> + <ul> <li><b>Name:</b> <js>"Serializer.initialDepth"</js> <li><b>Data type:</b> <code>Integer</code> <li><b>Default:</b> <code>0</code> <li><b>Session-overridable:</b> <jk>true</jk> </ul> + <p> The initial indentation level at the root. Useful when constructing document fragments that need to be indented at a certain level. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_initialDepth</jsf>, value)</code>. @@ -897,25 +899,29 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.65">detectRecursions</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html#detectRecursions-boolean-">SerializerBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Automatically detect POJO recursions. - <p> + <ul> <li><b>Name:</b> <js>"Serializer.detectRecursions"</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> Specifies that recursions should be checked for during serialization. + <p> Recursions can occur when serializing models that aren't true trees, but rather contain loops. + <p> The behavior when recursions are detected depends on the value for <a href="../../../../org/apache/juneau/serializer/SerializerContext.html#SERIALIZER_ignoreRecursions"><code>SerializerContext.SERIALIZER_ignoreRecursions</code></a>. + <p> For example, if a model contains the links A->B->C->A, then the JSON generated will look like the following when <jsf>SERIALIZER_ignoreRecursions</jsf> is <jk>true</jk>... <code>{A:{B:{C:null}}}</code> - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_detectRecursions</jsf>, value)</code>. @@ -942,21 +948,22 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.71">ignoreRecursions</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html#ignoreRecursions-boolean-">SerializerBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Ignore recursion errors. - <p> + <ul> <li><b>Name:</b> <js>"Serializer.ignoreRecursions"</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> Used in conjunction with <a href="../../../../org/apache/juneau/serializer/SerializerContext.html#SERIALIZER_detectRecursions"><code>SerializerContext.SERIALIZER_detectRecursions</code></a>. Setting is ignored if <jsf>SERIALIZER_detectRecursions</jsf> is <jk>false</jk>. + <p> - If <jk>true</jk>, when we encounter the same object when serializing a tree, - we set the value to <jk>null</jk>. + If <jk>true</jk>, when we encounter the same object when serializing a tree, we set the value to <jk>null</jk>. Otherwise, an exception is thrown. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_ignoreRecursions</jsf>, value)</code>. @@ -983,16 +990,17 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.77">useWhitespace</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html#useWhitespace-boolean-">SerializerBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Use whitespace. - <p> + <ul> <li><b>Name:</b> <js>"Serializer.useWhitepace"</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>, newlines and indentation and spaces are added to the output to improve readability. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_useWhitespace</jsf>, value)</code>. @@ -1035,16 +1043,17 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.89">maxIndent</a>(int value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html#maxIndent-int-">SerializerBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Maximum indentation. - <p> + <ul> <li><b>Name:</b> <js>"Serializer.maxIndent"</js> <li><b>Data type:</b> <code>Integer</code> <li><b>Default:</b> <code>100</code> <li><b>Session-overridable:</b> <jk>true</jk> </ul> + <p> Specifies the maximum indentation level in the serialized document. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_maxIndent</jsf>, value)</code>. @@ -1070,20 +1079,21 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.95">addBeanTypeProperties</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html#addBeanTypeProperties-boolean-">SerializerBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Add <js>"_type"</js> properties when needed. - <p> + <ul> <li><b>Name:</b> <js>"Serializer.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> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_addBeanTypeProperties</jsf>, value)</code>. @@ -1110,16 +1120,17 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.101">quoteChar</a>(char value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html#quoteChar-char-">SerializerBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Quote character. - <p> + <ul> <li><b>Name:</b> <js>"Serializer.quoteChar"</js> <li><b>Data type:</b> <code>Character</code> <li><b>Default:</b> <js>'"'</js> <li><b>Session-overridable:</b> <jk>true</jk> </ul> + <p> This is the character used for quoting attributes and values. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_quoteChar</jsf>, value)</code>. @@ -1162,16 +1173,17 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.113">trimNullProperties</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html#trimNullProperties-boolean-">SerializerBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Trim null bean property values. - <p> + <ul> <li><b>Name:</b> <js>"Serializer.trimNullProperties"</js> <li><b>Data type:</b> <code>Boolean</code> <li><b>Default:</b> <jk>true</jk> <li><b>Session-overridable:</b> <jk>true</jk> </ul> + <p> If <jk>true</jk>, null bean values will not be serialized to the output. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_trimNullProperties</jsf>, value)</code>. @@ -1201,16 +1213,17 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.119">trimEmptyCollections</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html#trimEmptyCollections-boolean-">SerializerBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Trim empty lists and arrays. - <p> + <ul> <li><b>Name:</b> <js>"Serializer.trimEmptyLists"</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>, empty list values will not be serialized to the output. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_trimEmptyCollections</jsf>, value)</code>. @@ -1241,16 +1254,17 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.125">trimEmptyMaps</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html#trimEmptyMaps-boolean-">SerializerBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Trim empty maps. - <p> + <ul> <li><b>Name:</b> <js>"Serializer.trimEmptyMaps"</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>, empty map values will not be serialized to the output. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_trimEmptyMaps</jsf>, value)</code>. @@ -1280,16 +1294,17 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.131">trimStrings</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html#trimStrings-boolean-">SerializerBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Trim strings. - <p> + <ul> <li><b>Name:</b> <js>"Serializer.trimStrings"</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>, string values will be trimmed of whitespace using <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true#trim--"; title="class or interface in java.lang"><code>String.trim()</code></a> before being serialized. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_trimStrings</jsf>, value)</code>. @@ -1315,21 +1330,22 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.137">uriContext</a>(<a href="../../../../org/apache/juneau/UriContext.html" title="class in org.apache.juneau">UriContext</a> value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html#uriContext-org.apache.juneau.UriContext-">SerializerBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> URI context bean. - <p> + <ul> <li><b>Name:</b> <js>"Serializer.uriContext"</js> <li><b>Data type:</b> <a href="../../../../org/apache/juneau/UriContext.html" title="class in org.apache.juneau"><code>UriContext</code></a> <li><b>Default:</b> <a href="../../../../org/apache/juneau/UriContext.html#DEFAULT"><code>UriContext.DEFAULT</code></a> <li><b>Session-overridable:</b> <jk>true</jk> </ul> + <p> Bean used for resolution of URIs to absolute or root-relative form. - <p> + <h6 class='figure'>Example:</h6> <p class='bcode'> <js>"{authority:'http://localhost:10000',contextRoot:'/myContext',servletPath:'/myServlet',pathInfo:'/foo'}"</js> </p> - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_uriContext</jsf>, value)</code>. @@ -1355,13 +1371,14 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.143">uriResolution</a>(<a href="../../../../org/apache/juneau/UriResolution.html" title="enum in org.apache.juneau">UriResolution</a> value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html#uriResolution-org.apache.juneau.UriResolution-">SerializerBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> URI resolution. - <p> + <ul> <li><b>Name:</b> <js>"Serializer.uriResolution"</js> <li><b>Data type:</b> <a href="../../../../org/apache/juneau/UriResolution.html" title="enum in org.apache.juneau"><code>UriResolution</code></a> <li><b>Default:</b> <a href="../../../../org/apache/juneau/UriResolution.html#ROOT_RELATIVE"><code>UriResolution.ROOT_RELATIVE</code></a> <li><b>Session-overridable:</b> <jk>true</jk> </ul> + <p> Defines the resolution level for URIs when serializing any of the following: <ul> @@ -1369,6 +1386,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <li><a href="http://docs.oracle.com/javase/7/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net"><code>URL</code></a> <li>Properties annotated with <a href="../../../../org/apache/juneau/annotation/URI.html" title="annotation in org.apache.juneau.annotation"><code>@URI</code></a> </ul> + <p> Possible values are: <ul> @@ -1379,7 +1397,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <li><a href="../../../../org/apache/juneau/UriResolution.html#NONE"><code>UriResolution.NONE</code></a> - Don't do any URL resolution. </ul> - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_uriResolution</jsf>, value)</code>. @@ -1405,13 +1423,14 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.149">uriRelativity</a>(<a href="../../../../org/apache/juneau/UriRelativity.html" title="enum in org.apache.juneau">UriRelativity</a> value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html#uriRelativity-org.apache.juneau.UriRelativity-">SerializerBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> URI relativity. - <p> + <ul> <li><b>Name:</b> <js>"Serializer.uriRelativity"</js> <li><b>Data type:</b> <a href="../../../../org/apache/juneau/UriRelativity.html" title="enum in org.apache.juneau"><code>UriRelativity</code></a> <li><b>Default:</b> <a href="../../../../org/apache/juneau/UriRelativity.html#RESOURCE"><code>UriRelativity.RESOURCE</code></a> <li><b>Session-overridable:</b> <jk>true</jk> </ul> + <p> Defines what relative URIs are relative to when serializing any of the following: <ul> @@ -1419,6 +1438,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <li><a href="http://docs.oracle.com/javase/7/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net"><code>URL</code></a> <li>Properties annotated with <a href="../../../../org/apache/juneau/annotation/URI.html" title="annotation in org.apache.juneau.annotation"><code>@URI</code></a> </ul> + <p> Possible values are: <ul> @@ -1427,7 +1447,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <li><a href="../../../../org/apache/juneau/UriRelativity.html#PATH_INFO"><code>UriRelativity.PATH_INFO</code></a> - Relative URIs should be considered relative to the request URI. </ul> - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_uriRelativity</jsf>, value)</code>. @@ -1453,14 +1473,14 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.155">sortCollections</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html#sortCollections-boolean-">SerializerBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Sort arrays and collections alphabetically. - <p> + <ul> <li><b>Name:</b> <js>"Serializer.sortCollections"</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> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_sortCollections</jsf>, value)</code>. @@ -1487,13 +1507,14 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.161">sortMaps</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html#sortMaps-boolean-">SerializerBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Sort maps alphabetically. - <p> + <ul> <li><b>Name:</b> <js>"Serializer.sortMaps"</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> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>SERIALIZER_sortMaps</jsf>, value)</code>. @@ -1520,20 +1541,21 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.167">abridged</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html#abridged-boolean-">SerializerBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Abridged output. - <p> + <ul> <li><b>Name:</b> <js>"Serializer.parserKnowsRootTypes"</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> - When enabled, it is assumed that the parser knows the exact Java POJO type being parsed, - and therefore top-level type information that might normally be included to determine - the data type will not be serialized. + When enabled, it is assumed that the parser knows the exact Java POJO type being parsed, and therefore top-level + type information that might normally be included to determine the data type will not be serialized. + <p> - For example, when serializing a POJO with a <a href="../../../../org/apache/juneau/annotation/Bean.html#typeName--"><code>Bean.typeName()</code></a> value, a <js>"_type"</js> - will be added when this setting is disabled, but not added when it is enabled.</div> + For example, when serializing a POJO with a <a href="../../../../org/apache/juneau/annotation/Bean.html#typeName--"><code>Bean.typeName()</code></a> value, a <js>"_type"</js> will be added when + this setting is disabled, but not added when it is enabled.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html#abridged-boolean-">abridged</a></code> in class <code><a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html" title="class in org.apache.juneau.serializer">SerializerBuilder</a></code></dd> @@ -1555,13 +1577,14 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.173">listener</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../org/apache/juneau/serializer/SerializerListener.html" title="class in org.apache.juneau.serializer">SerializerListener</a>> value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html#listener-java.lang.Class-">SerializerBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Serializer listener. - <p> + <ul> <li><b>Name:</b> <js>"Serializer.listener"</js> <li><b>Data type:</b> <code>Class<? extends SerializerListener></code> <li><b>Default:</b> <jk>null</jk> <li><b>Session-overridable:</b> <jk>true</jk> </ul> + <p> Class used to listen for errors and warnings that occur during serialization.</div> <dl> @@ -1585,19 +1608,21 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.179">beansRequireDefaultConstructor</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#beansRequireDefaultConstructor-boolean-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Beans require no-arg constructors. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.beansRequireDefaultConstructor"</js> <li><b>Data type:</b> <code>Boolean</code> <li><b>Default:</b> <jk>false</jk> <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> If <jk>true</jk>, a Java class must implement a default no-arg constructor to be considered a bean. Otherwise, the bean will be serialized as a string using the <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang"><code>Object.toString()</code></a> method. + <p> The <a href="../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotation can be used on a class to override this setting when <jk>true</jk>. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>BEAN_beansRequireDefaultConstructor</jsf>, value)</code>. @@ -1623,19 +1648,21 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.185">beansRequireSerializable</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#beansRequireSerializable-boolean-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Beans require <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io"><code>Serializable</code></a> interface. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.beansRequireSerializable"</js> <li><b>Data type:</b> <code>Boolean</code> <li><b>Default:</b> <jk>false</jk> <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> If <jk>true</jk>, a Java class must implement the <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io"><code>Serializable</code></a> interface to be considered a bean. Otherwise, the bean will be serialized as a string using the <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang"><code>Object.toString()</code></a> method. + <p> The <a href="../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotation can be used on a class to override this setting when <jk>true</jk>. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>BEAN_beansRequireSerializable</jsf>, value)</code>. @@ -1661,17 +1688,18 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.191">beansRequireSettersForGetters</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#beansRequireSettersForGetters-boolean-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Beans require setters for getters. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.beansRequireSettersForGetters"</js> <li><b>Data type:</b> <code>Boolean</code> <li><b>Default:</b> <jk>false</jk> <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> If <jk>true</jk>, only getters that have equivalent setters will be considered as properties on a bean. Otherwise, they will be ignored. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>BEAN_beansRequireSettersForGetters</jsf>, value)</code>. @@ -1697,19 +1725,21 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.197">beansRequireSomeProperties</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#beansRequireSomeProperties-boolean-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Beans require at least one property. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.beansRequireSomeProperties"</js> <li><b>Data type:</b> <code>Boolean</code> <li><b>Default:</b> <jk>true</jk> <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> If <jk>true</jk>, then a Java class must contain at least 1 property to be considered a bean. Otherwise, the bean will be serialized as a string using the <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang"><code>Object.toString()</code></a> method. + <p> The <a href="../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotation can be used on a class to override this setting when <jk>true</jk>. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>BEAN_beansRequireSomeProperties</jsf>, value)</code>. @@ -1736,20 +1766,22 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#beanMapPutReturnsOldValue-boolean-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> <a href="../../../../org/apache/juneau/BeanMap.html#put-java.lang.String-java.lang.Object-"><code>BeanMap.put()</code></a> method will return old property value. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.beanMapPutReturnsOldValue"</js> <li><b>Data type:</b> <code>Boolean</code> <li><b>Default:</b> <jk>false</jk> <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> If <jk>true</jk>, then the <a href="../../../../org/apache/juneau/BeanMap.html#put-java.lang.String-java.lang.Object-"><code>BeanMap.put()</code></a> method will return old property values. Otherwise, it returns <jk>null</jk>. + <p> Disabled by default because it introduces a slight performance penalty. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>BEAN_beanMapPutReturnsOldValue</jsf>, value)</code>. @@ -1775,18 +1807,19 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.209">beanConstructorVisibility</a>(<a href="../../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a> value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#beanConstructorVisibility-org.apache.juneau.Visibility-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Look for bean constructors with the specified minimum visibility. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.beanConstructorVisibility"</js> <li><b>Data type:</b> <a href="../../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau"><code>Visibility</code></a> <li><b>Default:</b> <a href="../../../../org/apache/juneau/Visibility.html#PUBLIC"><code>Visibility.PUBLIC</code></a> <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> Constructors not meeting this minimum visibility will be ignored. - For example, if the visibility is <code>PUBLIC</code> and the constructor is <jk>protected</jk>, then - the constructor will be ignored. - <p> + For example, if the visibility is <code>PUBLIC</code> and the constructor is <jk>protected</jk>, then the + constructor will be ignored. + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>BEAN_beanConstructorVisibility</jsf>, value)</code>. @@ -1812,18 +1845,19 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.215">beanClassVisibility</a>(<a href="../../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a> value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#beanClassVisibility-org.apache.juneau.Visibility-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Look for bean classes with the specified minimum visibility. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.beanClassVisibility"</js> <li><b>Data type:</b> <a href="../../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau"><code>Visibility</code></a> <li><b>Default:</b> <a href="../../../../org/apache/juneau/Visibility.html#PUBLIC"><code>Visibility.PUBLIC</code></a> <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> Classes are not considered beans unless they meet the minimum visibility requirements. - For example, if the visibility is <code>PUBLIC</code> and the bean class is <jk>protected</jk>, then - the class will not be interpreted as a bean class. - <p> + For example, if the visibility is <code>PUBLIC</code> and the bean class is <jk>protected</jk>, then the class + will not be interpreted as a bean class. + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>BEAN_beanClassVisibility</jsf>, value)</code>. @@ -1849,18 +1883,19 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.221">beanFieldVisibility</a>(<a href="../../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a> value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#beanFieldVisibility-org.apache.juneau.Visibility-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Look for bean fields with the specified minimum visibility. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.beanFieldVisibility"</js> <li><b>Data type:</b> <a href="../../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau"><code>Visibility</code></a> <li><b>Default:</b> <a href="../../../../org/apache/juneau/Visibility.html#PUBLIC"><code>Visibility.PUBLIC</code></a> <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> Fields are not considered bean properties unless they meet the minimum visibility requirements. - For example, if the visibility is <code>PUBLIC</code> and the bean field is <jk>protected</jk>, then - the field will not be interpreted as a bean property. - <p> + For example, if the visibility is <code>PUBLIC</code> and the bean field is <jk>protected</jk>, then the field + will not be interpreted as a bean property. + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>BEAN_beanFieldVisibility</jsf>, value)</code>. @@ -1887,18 +1922,19 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.227">methodVisibility</a>(<a href="../../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau">Visibility</a> value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#methodVisibility-org.apache.juneau.Visibility-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Look for bean methods with the specified minimum visibility. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.methodVisibility"</js> <li><b>Data type:</b> <a href="../../../../org/apache/juneau/Visibility.html" title="enum in org.apache.juneau"><code>Visibility</code></a> <li><b>Default:</b> <a href="../../../../org/apache/juneau/Visibility.html#PUBLIC"><code>Visibility.PUBLIC</code></a> <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> Methods are not considered bean getters/setters unless they meet the minimum visibility requirements. - For example, if the visibility is <code>PUBLIC</code> and the bean method is <jk>protected</jk>, then - the method will not be interpreted as a bean getter or setter. - <p> + For example, if the visibility is <code>PUBLIC</code> and the bean method is <jk>protected</jk>, then the method + will not be interpreted as a bean getter or setter. + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>BEAN_methodVisibility</jsf>, value)</code>. @@ -1925,17 +1961,18 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.233">useJavaBeanIntrospector</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#useJavaBeanIntrospector-boolean-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Use Java <a href="http://docs.oracle.com/javase/7/docs/api/java/beans/Introspector.html?is-external=true"; title="class or interface in java.beans"><code>Introspector</code></a> for determining bean properties. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.useJavaBeanIntrospector"</js> <li><b>Data type:</b> <code>Boolean</code> <li><b>Default:</b> <jk>false</jk> <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> Using the built-in Java bean introspector will not pick up fields or non-standard getters/setters. - <p> - <h5 class='section'>Notes:</h5> + + <h5 class 'section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>BEAN_useJavaBeanIntrospector</jsf>, value)</code>. <li>Most <a href="../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotations will be ignored if you enable this setting. @@ -1961,17 +1998,18 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.239">useInterfaceProxies</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#useInterfaceProxies-boolean-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Use interface proxies. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.useInterfaceProxies"</js> <li><b>Data type:</b> <code>Boolean</code> <li><b>Default:</b> <jk>true</jk> <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> If <jk>true</jk>, then interfaces will be instantiated as proxy classes through the use of an <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/InvocationHandler.html?is-external=true"; title="class or interface in java.lang.reflect"><code>InvocationHandler</code></a> if there is no other way of instantiating them. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>BEAN_useInterfaceProxies</jsf>, value)</code>. @@ -1997,17 +2035,18 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.245">ignoreUnknownBeanProperties</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#ignoreUnknownBeanProperties-boolean-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Ignore unknown properties. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.ignoreUnknownBeanProperties"</js> <li><b>Data type:</b> <code>Boolean</code> <li><b>Default:</b> <jk>false</jk> <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> If <jk>true</jk>, trying to set a value on a non-existent bean property will silently be ignored. Otherwise, a <code>BeanRuntimeException</code> is thrown. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>BEAN_ignoreUnknownBeanProperties</jsf>, value)</code>. @@ -2033,17 +2072,18 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.251">ignoreUnknownNullBeanProperties</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#ignoreUnknownNullBeanProperties-boolean-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Ignore unknown properties with null values. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.ignoreUnknownNullBeanProperties"</js> <li><b>Data type:</b> <code>Boolean</code> <li><b>Default:</b> <jk>true</jk> <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> If <jk>true</jk>, trying to set a <jk>null</jk> value on a non-existent bean property will silently be ignored. Otherwise, a <code>BeanRuntimeException</code> is thrown. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>BEAN_ignoreUnknownNullBeanProperties</jsf>, value)</code>. @@ -2069,17 +2109,18 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.257">ignorePropertiesWithoutSetters</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#ignorePropertiesWithoutSetters-boolean-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Ignore properties without setters. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.ignorePropertiesWithoutSetters"</js> <li><b>Data type:</b> <code>Boolean</code> <li><b>Default:</b> <jk>true</jk> <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> If <jk>true</jk>, trying to set a value on a bean property without a setter will silently be ignored. Otherwise, a <code>BeanRuntimeException</code> is thrown. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>BEAN_ignorePropertiesWithoutSetters</jsf>, value)</code>. @@ -2105,17 +2146,18 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.263">ignoreInvocationExceptionsOnGetters</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#ignoreInvocationExceptionsOnGetters-boolean-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Ignore invocation errors on getters. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.ignoreInvocationExceptionsOnGetters"</js> <li><b>Data type:</b> <code>Boolean</code> <li><b>Default:</b> <jk>false</jk> <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> If <jk>true</jk>, errors thrown when calling bean getter methods will silently be ignored. Otherwise, a <code>BeanRuntimeException</code> is thrown. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>BEAN_ignoreInvocationExceptionsOnGetters</jsf>, value)</code>. @@ -2141,17 +2183,18 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.269">ignoreInvocationExceptionsOnSetters</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#ignoreInvocationExceptionsOnSetters-boolean-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Ignore invocation errors on setters. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.ignoreInvocationExceptionsOnSetters"</js> <li><b>Data type:</b> <code>Boolean</code> <li><b>Default:</b> <jk>false</jk> <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> If <jk>true</jk>, errors thrown when calling bean setter methods will silently be ignored. Otherwise, a <code>BeanRuntimeException</code> is thrown. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>BEAN_ignoreInvocationExceptionsOnSetters</jsf>, value)</code>. @@ -2177,24 +2220,26 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.275">sortProperties</a>(boolean value)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#sortProperties-boolean-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Sort bean properties in alphabetical order. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.sortProperties"</js> <li><b>Data type:</b> <code>Boolean</code> <li><b>Default:</b> <jk>false</jk> <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> When <jk>true</jk>, all bean properties will be serialized and access in alphabetical order. - Otherwise, the natural order of the bean properties is used which is dependent on the - JVM vendor. + Otherwise, the natural order of the bean properties is used which is dependent on the JVM vendor. On IBM JVMs, the bean properties are ordered based on their ordering in the Java file. - On Oracle JVMs, the bean properties are not ordered (which follows the offical JVM specs). - <p> + On Oracle JVMs, the bean properties are not ordered (which follows the official JVM specs). + <h5 class='section'>Notes:</h5> <ul> - <li>This is equivalent to calling <code>property(<jsf>BEAN_sortProperties</jsf>, value)</code>. - <li>This property is disabled by default so that IBM JVM users don't have to use <a href="../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotations + <li> + This is equivalent to calling <code>property(<jsf>BEAN_sortProperties</jsf>, value)</code>. + <li> + This property is disabled by default so that IBM JVM users don't have to use <a href="../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotations to force bean properties to be in a particular order and can just alter the order of the fields/methods in the Java file. </ul></div> @@ -2219,7 +2264,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.281">notBeanPackages</a>(<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>... values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#notBeanPackages-java.lang.String...-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Add to packages whose classes should not be considered beans. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>addToProperty(<jsf>BEAN_notBeanPackages</jsf>, values)</code> @@ -2246,6 +2291,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.287">notBeanPackages</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<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>> values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#notBeanPackages-java.util.Collection-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Add to packages whose classes should not be considered beans. + <p> Same as <a href="../../../../org/apache/juneau/CoreObjectBuilder.html#notBeanPackages-java.lang.String...-"><code>CoreObjectBuilder.notBeanPackages(String...)</code></a> but using a <code>Collection</code>.</div> <dl> @@ -2269,7 +2315,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.293">setNotBeanPackages</a>(<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>... values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#setNotBeanPackages-java.lang.String...-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Packages whose classes should not be considered beans. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.notBeanPackages.set"</js> <li><b>Data type:</b> <code>Set<String></code> @@ -2286,13 +2332,16 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html </ul> <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> When specified, the current list of ignore packages are appended to. + <p> Any classes within these packages will be serialized to strings using <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang"><code>Object.toString()</code></a>. + <p> Note that you can specify prefix patterns to include all subpackages. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>BEAN_notBeanPackages</jsf>, values)</code>. @@ -2318,7 +2367,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.299">setNotBeanPackages</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<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>> values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#setNotBeanPackages-java.util.Collection-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Packages whose classes should not be considered beans. - <p> + Same as <a href="../../../../org/apache/juneau/CoreObjectBuilder.html#setNotBeanPackages-java.lang.String...-"><code>CoreObjectBuilder.setNotBeanPackages(String...)</code></a> but using a <code>Collection</code>.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> @@ -2341,7 +2390,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.305">removeNotBeanPackages</a>(<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>... values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#removeNotBeanPackages-java.lang.String...-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Remove from packages whose classes should not be considered beans. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>removeFromProperty(<jsf>BEAN_notBeanPackages</jsf>, values)</code> @@ -2369,6 +2418,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.311">removeNotBeanPackages</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<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>> values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#removeNotBeanPackages-java.util.Collection-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Remove from packages whose classes should not be considered beans. + <p> Same as <a href="../../../../org/apache/juneau/CoreObjectBuilder.html#removeNotBeanPackages-java.lang.String...-"><code>CoreObjectBuilder.removeNotBeanPackages(String...)</code></a> but using a <code>Collection</code>.</div> <dl> @@ -2393,7 +2443,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.317">notBeanClasses</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>... values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#notBeanClasses-java.lang.Class...-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Add to classes that should not be considered beans. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>addToProperty(<jsf>BEAN_notBeanClasses</jsf>, values)</code> @@ -2421,6 +2471,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.323">notBeanClasses</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>> values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#notBeanClasses-java.util.Collection-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Add to classes that should not be considered beans. + <p> Same as <a href="../../../../org/apache/juneau/CoreObjectBuilder.html#notBeanClasses-java.lang.Class...-"><code>CoreObjectBuilder.notBeanClasses(Class...)</code></a> but using a <code>Collection</code>.</div> <dl> @@ -2445,17 +2496,18 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.329">setNotBeanClasses</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>... values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#setNotBeanClasses-java.lang.Class...-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Classes to be excluded from consideration as being beans. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.notBeanClasses.set"</js> <li><b>Data type:</b> <code>Set<Class></code> <li><b>Default:</b> empty set <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> - Not-bean classes are typically converted to <code>Strings</code> during serialization even if they - appear to be bean-like. - <p> + Not-bean classes are typically converted to <code>Strings</code> during serialization even if they appear to be + bean-like. + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>BEAN_notBeanClasses</jsf>, values)</code>. @@ -2481,6 +2533,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.335">setNotBeanClasses</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>> values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#setNotBeanClasses-java.util.Collection-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Classes to be excluded from consideration as being beans. + <p> Same as <a href="../../../../org/apache/juneau/CoreObjectBuilder.html#setNotBeanClasses-java.lang.Class...-"><code>CoreObjectBuilder.setNotBeanClasses(Class...)</code></a> but using a <code>Collection</code>.</div> <dl> @@ -2504,7 +2557,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.341">removeNotBeanClasses</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>... values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#removeNotBeanClasses-java.lang.Class...-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Remove from classes that should not be considered beans. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>removeFromProperty(<jsf>BEAN_notBeanClasses</jsf>, values)</code> @@ -2532,6 +2585,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.347">removeNotBeanClasses</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>> values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#removeNotBeanClasses-java.util.Collection-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Remove from classes that should not be considered beans. + <p> Same as <a href="../../../../org/apache/juneau/CoreObjectBuilder.html#removeNotBeanClasses-java.lang.Class...-"><code>CoreObjectBuilder.removeNotBeanClasses(Class...)</code></a> but using a <code>Collection</code>.</div> <dl> @@ -2556,7 +2610,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.353">beanFilters</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>... values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#beanFilters-java.lang.Class...-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Add to bean filters. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>addToProperty(<jsf>BEAN_beanFilters</jsf>, values)</code> @@ -2584,6 +2638,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.359">beanFilters</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>> values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#beanFilters-java.util.Collection-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Add to bean filters. + <p> Same as <a href="../../../../org/apache/juneau/CoreObjectBuilder.html#beanFilters-java.lang.Class...-"><code>CoreObjectBuilder.beanFilters(Class...)</code></a> but using a <code>Collection</code>.</div> <dl> @@ -2608,28 +2663,32 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.365">setBeanFilters</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>... values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#setBeanFilters-java.lang.Class...-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Bean filters to apply to beans. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.beanFilters.list"</js> <li><b>Data type:</b> <code>List<Class></code> <li><b>Default:</b> empty list <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> This is a programmatic equivalent to the <a href="../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotation. - It's useful when you want to use the Bean annotation functionality, but you don't have the ability - to alter the bean classes. + It's useful when you want to use the Bean annotation functionality, but you don't have the ability to alter the + bean classes. + <p> There are two category of classes that can be passed in through this method: <ul class='spaced-list'> - <li>Subclasses of <a href="../../../../org/apache/juneau/transform/BeanFilterBuilder.html" title="class in org.apache.juneau.transform"><code>BeanFilterBuilder</code></a>. + <li> + Subclasses of <a href="../../../../org/apache/juneau/transform/BeanFilterBuilder.html" title="class in org.apache.juneau.transform"><code>BeanFilterBuilder</code></a>. These must have a public no-arg constructor. - <li>Bean interface classes. + <li> + Bean interface classes. A shortcut for defining a <a href="../../../../org/apache/juneau/transform/InterfaceBeanFilterBuilder.html" title="class in org.apache.juneau.transform"><code>InterfaceBeanFilterBuilder</code></a>. Any subclasses of an interface class will only have properties defined on the interface. All other bean properties will be ignored. </ul> - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>BEAN_beanFilters</jsf>, values)</code>. @@ -2655,6 +2714,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.371">setBeanFilters</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>> values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#setBeanFilters-java.util.Collection-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Bean filters to apply to beans. + <p> Same as <a href="../../../../org/apache/juneau/CoreObjectBuilder.html#setBeanFilters-java.lang.Class...-"><code>CoreObjectBuilder.setBeanFilters(Class...)</code></a> but using a <code>Collection</code>.</div> <dl> @@ -2678,7 +2738,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.377">removeBeanFilters</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>... values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#removeBeanFilters-java.lang.Class...-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Remove from bean filters. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>removeFromProperty(<jsf>BEAN_beanFilters</jsf>, values)</code> @@ -2706,6 +2766,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.383">removeBeanFilters</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>> values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#removeBeanFilters-java.util.Collection-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Remove from bean filters. + <p> Same as <a href="../../../../org/apache/juneau/CoreObjectBuilder.html#removeBeanFilters-java.lang.Class...-"><code>CoreObjectBuilder.removeBeanFilters(Class...)</code></a> but using a <code>Collection</code>.</div> <dl> @@ -2730,7 +2791,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.389">pojoSwaps</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>... values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#pojoSwaps-java.lang.Class...-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Add to POJO swaps. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>addToProperty(<jsf>BEAN_pojoSwaps</jsf>, values)</code> @@ -2758,6 +2819,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.395">pojoSwaps</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>> values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#pojoSwaps-java.util.Collection-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Add to POJO swaps. + <p> Same as <a href="../../../../org/apache/juneau/CoreObjectBuilder.html#pojoSwaps-java.lang.Class...-"><code>CoreObjectBuilder.pojoSwaps(Class...)</code></a> but using a <code>Collection</code>.</div> <dl> @@ -2782,20 +2844,21 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.401">setPojoSwaps</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>... values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#setPojoSwaps-java.lang.Class...-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> POJO swaps to apply to Java objects. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.pojoSwaps.list"</js> <li><b>Data type:</b> <code>List<Class></code> <li><b>Default:</b> empty list <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> There are two category of classes that can be passed in through this method: <ul> <li>Subclasses of <a href="../../../../org/apache/juneau/transform/PojoSwap.html" title="class in org.apache.juneau.transform"><code>PojoSwap</code></a>. <li>Surrogate classes. A shortcut for defining a <a href="../../../../org/apache/juneau/transform/SurrogateSwap.html" title="class in org.apache.juneau.transform"><code>SurrogateSwap</code></a>. </ul> - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>BEAN_pojoSwaps</jsf>, values)</code>. @@ -2821,6 +2884,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.407">setPojoSwaps</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>> values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#setPojoSwaps-java.util.Collection-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> POJO swaps to apply to Java objects. + <p> Same as <a href="../../../../org/apache/juneau/CoreObjectBuilder.html#setPojoSwaps-java.lang.Class...-"><code>CoreObjectBuilder.setPojoSwaps(Class...)</code></a> but using a <code>Collection</code>.</div> <dl> @@ -2844,7 +2908,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.413">removePojoSwaps</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>... values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#removePojoSwaps-java.lang.Class...-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Remove from POJO swaps. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>removeFromProperty(<jsf>BEAN_pojoSwaps</jsf>, values)</code> @@ -2872,6 +2936,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.419">removePojoSwaps</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>> values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#removePojoSwaps-java.util.Collection-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Remove from POJO swaps. + <p> Same as <a href="../../../../org/apache/juneau/CoreObjectBuilder.html#removePojoSwaps-java.lang.Class...-"><code>CoreObjectBuilder.removePojoSwaps(Class...)</code></a> but using a <code>Collection</code>.</div> <dl> @@ -2896,18 +2961,19 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.425">implClasses</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>> values)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#implClasses-java.util.Map-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Implementation classes for interfaces and abstract classes. - <p> + <ul> <li><b>Name:</b> <js>"BeanContext.implClasses.map"</js> <li><b>Data type:</b> <code>Map<Class,Class></code> <li><b>Default:</b> empty map <li><b>Session-overridable:</b> <jk>false</jk> </ul> + <p> - For interfaces and abstract classes this method can be used to specify an implementation - class for the interface/abstract class so that instances of the implementation - class are used when instantiated (e.g. during a parse). - <p> + For interfaces and abstract classes this method can be used to specify an implementation class for the + interface/abstract class so that instances of the implementation class are used when instantiated (e.g. during a + parse). + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>property(<jsf>BEAN_implClasses</jsf>, values)</code>. @@ -2934,7 +3000,7 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends T> implClass)</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObjectBuilder.html#implClass-java.lang.Class-java.lang.Class-">CoreObjectBuilder</a></code></span></div> <div class="block"><b>Configuration property:</b> Implementation classes for interfaces and abstract classes. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>putToProperty(<jsf>BEAN_implClasses</jsf>, interfaceClass, implClass)</code> @@ -2965,23 +3031,26 @@ extends <a href="../../../../org/apache/juneau/serializer/SerializerBuilder.html <pre>public <a href="../../../../org/apache/juneau/csv/CsvSerializerBuilder.html" title="class in org.apache.juneau.csv">CsvSerializerBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvSerializerBuilder.html#line.437">includeProperties</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</a><<
<TRUNCATED>
