Google Git
Sign in
apache / juneau-website / 5a0996fc57378085a5ec5610f9cdd5869ea182cb / . / content / site / apidocs-9.0.B1 / org / apache / juneau / BeanFilter.Builder.html
blob: ff3531ec262fa973110a744ca4debb5b1c7995ac [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BeanFilter.Builder (Apache Juneau 9.0-B1)</title>
<link rel="stylesheet" type="text/css" href="../../../javadoc.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BeanFilter.Builder (Apache Juneau 9.0-B1)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/apache/juneau/BeanFilter.html" title="class in org.apache.juneau"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/apache/juneau/BeanMap.html" title="class in org.apache.juneau"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/juneau/BeanFilter.Builder.html" target="_top">Frames</a></li>
<li><a href="BeanFilter.Builder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.juneau</div>
<h2 title="Class BeanFilter.Builder" class="title">Class BeanFilter.Builder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.juneau.BeanFilter.Builder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../org/apache/juneau/BeanFilter.html" title="class in org.apache.juneau">BeanFilter</a></dd>
</dl>
<hr>
<br>
<pre>public static class <a href="../../../src-html/org/apache/juneau/BeanFilter.html#line.65">BeanFilter.Builder</a>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Builder class.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanFilter.Builder.html#Builder-java.lang.Class-">Builder</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;beanClass)</code>
<div class="block">Constructor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanFilter.Builder.html#applyAnnotations-java.util.List-">applyAnnotations</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation">Bean</a>&gt;&nbsp;annotations)</code>
<div class="block">Applies the information in the specified list of <a href="../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotations to this filter.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/juneau/BeanFilter.html" title="class in org.apache.juneau">BeanFilter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanFilter.Builder.html#build--">build</a></span>()</code>
<div class="block">Creates a <a href="../../../org/apache/juneau/BeanFilter.html" title="class in org.apache.juneau"><code>BeanFilter</code></a> with settings in this builder class.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanFilter.Builder.html#dictionary-java.lang.Class...-">dictionary</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;values)</code>
<div class="block">Bean dictionary.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanFilter.Builder.html#example-java.lang.String-">example</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Example.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanFilter.Builder.html#excludeProperties-java.lang.String...-">excludeProperties</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;value)</code>
<div class="block">Bean property excludes.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanFilter.Builder.html#findFluentSetters--">findFluentSetters</a></span>()</code>
<div class="block">Find fluent setters.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanFilter.Builder.html#implClass-java.lang.Class-">implClass</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;value)</code>
<div class="block">Bean implementation class.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanFilter.Builder.html#interceptor-java.lang.Class-">interceptor</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;value)</code>
<div class="block">Bean interceptor.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanFilter.Builder.html#interfaceClass-java.lang.Class-">interfaceClass</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;value)</code>
<div class="block">Bean interface class.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanFilter.Builder.html#properties-java.lang.String...-">properties</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;value)</code>
<div class="block">Bean property includes.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanFilter.Builder.html#propertyNamer-java.lang.Class-">propertyNamer</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../org/apache/juneau/PropertyNamer.html" title="interface in org.apache.juneau">PropertyNamer</a>&gt;&nbsp;value)</code>
<div class="block">Bean property namer</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanFilter.Builder.html#readOnlyProperties-java.lang.String...-">readOnlyProperties</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;value)</code>
<div class="block">Read-only bean properties.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanFilter.Builder.html#sortProperties--">sortProperties</a></span>()</code>
<div class="block">Sort bean properties.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanFilter.Builder.html#sortProperties-boolean-">sortProperties</a></span>(boolean&nbsp;value)</code>
<div class="block">Sort bean properties.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanFilter.Builder.html#stopClass-java.lang.Class-">stopClass</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;value)</code>
<div class="block">Bean stop class.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanFilter.Builder.html#typeName-java.lang.String-">typeName</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</code>
<div class="block">Bean dictionary type name.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/BeanFilter.Builder.html#writeOnlyProperties-java.lang.String...-">writeOnlyProperties</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;value)</code>
<div class="block">Write-only bean properties.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Builder-java.lang.Class-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Builder</h4>
<pre>protected&nbsp;<a href="../../../src-html/org/apache/juneau/BeanFilter.Builder.html#line.86">Builder</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;beanClass)</pre>
<div class="block">Constructor.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>beanClass</code> - The bean class that this filter applies to.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="applyAnnotations-java.util.List-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>applyAnnotations</h4>
<pre>public&nbsp;<a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a>&nbsp;<a href="../../../src-html/org/apache/juneau/BeanFilter.Builder.html#line.96">applyAnnotations</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation">Bean</a>&gt;&nbsp;annotations)</pre>
<div class="block">Applies the information in the specified list of <a href="../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotations to this filter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>annotations</code> - The annotations to apply.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="typeName-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>typeName</h4>
<pre>public&nbsp;<a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a>&nbsp;<a href="../../../src-html/org/apache/juneau/BeanFilter.Builder.html#line.149">typeName</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block">Bean dictionary type name.
<p>
Specifies the dictionary type name for this bean.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Define our filter.</jc>
<jk>public class</jk> MyFilter <jk>extends</jk> Builder&lt;MyBean&gt; {
<jk>public</jk> MyFilter() {
typeName(<js>"mybean"</js>);
}
}
<jc>// Register it with a serializer or parser.</jc>
WriterSerializer <jv>serializer<jv> = JsonSerializer
.<jsm>create</jsm>()
.beanFilters(MyFilter.<jk>class</jk>)
.build();
<jc>// Produces: "{_type:'mybean', ...}"</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../org/apache/juneau/annotation/Bean.html#typeName--"><code>Bean.typeName()</code></a>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="implClass-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>implClass</h4>
<pre>public&nbsp;<a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a>&nbsp;<a href="../../../src-html/org/apache/juneau/BeanFilter.Builder.html#line.160">implClass</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;value)</pre>
<div class="block">Bean implementation class.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="interfaceClass-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interfaceClass</h4>
<pre>public&nbsp;<a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a>&nbsp;<a href="../../../src-html/org/apache/juneau/BeanFilter.Builder.html#line.215">interfaceClass</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;value)</pre>
<div class="block">Bean interface class.
Identifies a class to be used as the interface class for this and all subclasses.
<p>
When specified, only the list of properties defined on the interface class will be used during serialization.
<br>Additional properties on subclasses will be ignored.
<p class='bjava'>
<jc>// Parent class</jc>
<jk>public abstract class</jk> A {
<jk>public</jk> String <jf>f0</jf> = <js>"f0"</js>;
}
<jc>// Sub class</jc>
<jk>public class</jk> A1 <jk>extends</jk> A {
<jk>public</jk> String <jf>f1</jf> = <js>"f1"</js>;
}
<jc>// Define our filter.</jc>
<jk>public class</jk> AFilter <jk>extends</jk> Builder&lt;A&gt; {
<jk>public</jk> AFilter() {
interfaceClass(A.<jk>class</jk>);
}
}
<jc>// Register it with a serializer.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanFilters(AFilter.<jk>class</jk>)
.build();
<jc>// Use it.</jc>
A1 <jv>a1</jv> = <jk>new</jk> A1();
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jv>a1</jv>);
<jsm>assertEquals</jsm>(<js>"{f0:'f0'}"</js>, <jv>json</jv>); <jc>// Note f1 is not serialized</jc>
</p>
<p>
Note that this filter can be used on the parent class so that it filters to all child classes, or can be set
individually on the child classes.
<ul class='seealso'>
<li class='ja'><a href="../../../org/apache/juneau/annotation/Bean.html#interfaceClass--"><code>Bean.interfaceClass()</code></a>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="stopClass-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stopClass</h4>
<pre>public&nbsp;<a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a>&nbsp;<a href="../../../src-html/org/apache/juneau/BeanFilter.Builder.html#line.272">stopClass</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;value)</pre>
<div class="block">Bean stop class.
<p>
Identifies a stop class for this class and all subclasses.
<p>
Identical in purpose to the stop class specified by <a href="https://docs.oracle.com/javase/8/docs/api/java/beans/Introspector.html?is-external=true#getBeanInfo-java.lang.Class-java.lang.Class-" title="class or interface in java.beans"><code>Introspector.getBeanInfo(Class, Class)</code></a>.
<br>Any properties in the stop class or in its base classes will be ignored during analysis.
<p>
For example, in the following class hierarchy, instances of <c>C3</c> will include property <c>p3</c>,
but not <c>p1</c> or <c>p2</c>.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jk>public class</jk> C1 {
<jk>public int</jk> getP1();
}
<jk>public class</jk> C2 <jk>extends</jk> C1 {
<jk>public int</jk> getP2();
}
<jk>public class</jk> C3 <jk>extends</jk> C2 {
<jk>public int</jk> getP3();
}
<jc>// Define our filter.</jc>
<jk>public class</jk> C3Filter <jk>extends</jk> Builder&lt;C3&gt; {
<jk>public</jk> C3Filter() {
stopClass(C2.<jk>class</jk>);
}
}
<jc>// Register it with a serializer.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanFilters(C3Filter.<jk>class</jk>)
.build();
<jc>// Serializes property 'p3', but NOT 'p1' or 'p2'.</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> C3());
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../org/apache/juneau/annotation/Bean.html#stopClass--"><code>Bean.stopClass()</code></a>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="sortProperties-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sortProperties</h4>
<pre>public&nbsp;<a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a>&nbsp;<a href="../../../src-html/org/apache/juneau/BeanFilter.Builder.html#line.313">sortProperties</a>(boolean&nbsp;value)</pre>
<div class="block">Sort bean properties.
<p>
When <jk>true</jk>, all bean properties will be serialized and access in alphabetical order.
<br>Otherwise, the natural order of the bean properties is used which is dependent on the JVM vendor.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Define our filter.</jc>
<jk>public class</jk> MyFilter <jk>extends</jk> Builder&lt;MyBean&gt; {
<jk>public</jk> MyFilter() {
sortProperties();
}
}
<jc>// Register it with a serializer.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanFilters(MyFilter.<jk>class</jk>)
.build();
<jc>// Properties will be sorted alphabetically.</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../org/apache/juneau/annotation/Bean.html#sort--"><code>Bean.sort()</code></a>
<li class='jf'><a href="../../../org/apache/juneau/BeanContext.Builder.html#sortProperties--"><code>BeanContext.Builder.sortProperties()</code></a>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this property.
<br>The default is <jk>false</jk>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="sortProperties--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sortProperties</h4>
<pre>public&nbsp;<a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a>&nbsp;<a href="../../../src-html/org/apache/juneau/BeanFilter.Builder.html#line.331">sortProperties</a>()</pre>
<div class="block">Sort bean properties.
<p>
Shortcut for calling <code>sortProperties(<jk>true</jk>)</code>.
<ul class='seealso'>
<li class='ja'><a href="../../../org/apache/juneau/annotation/Bean.html#sort--"><code>Bean.sort()</code></a>
<li class='jf'><a href="../../../org/apache/juneau/BeanContext.Builder.html#sortProperties--"><code>BeanContext.Builder.sortProperties()</code></a>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="findFluentSetters--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findFluentSetters</h4>
<pre>public&nbsp;<a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a>&nbsp;<a href="../../../src-html/org/apache/juneau/BeanFilter.Builder.html#line.368">findFluentSetters</a>()</pre>
<div class="block">Find fluent setters.
<p>
When enabled, fluent setters are detected on beans.
<p>
Fluent setters must have the following attributes:
<ul>
<li>Public.
<li>Not static.
<li>Take in one parameter.
<li>Return the bean itself.
</ul>
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Define our filter.</jc>
<jk>public class</jk> MyFilter <jk>extends</jk> Builder&lt;MyBean&gt; {
<jk>public</jk> MyFilter() {
findFluentSetters();
}
}
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../org/apache/juneau/annotation/Bean.html#findFluentSetters--"><code>Bean.findFluentSetters()</code></a>
<li class='jm'><a href="../../../org/apache/juneau/BeanContext.Builder.html#findFluentSetters--"><code>BeanContext.Builder.findFluentSetters()</code></a>
</ul></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="propertyNamer-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>propertyNamer</h4>
<pre>public&nbsp;<a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a>&nbsp;<a href="../../../src-html/org/apache/juneau/BeanFilter.Builder.html#line.411">propertyNamer</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../org/apache/juneau/PropertyNamer.html" title="interface in org.apache.juneau">PropertyNamer</a>&gt;&nbsp;value)</pre>
<div class="block">Bean property namer
<p>
The class to use for calculating bean property names.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Define our filter.</jc>
<jk>public class</jk> MyFilter <jk>extends</jk> Builder&lt;MyBean&gt; {
<jk>public</jk> MyFilter() {
<jc>// Use Dashed-Lower-Case property names.</jc>
<jc>// (e.g. "foo-bar-url" instead of "fooBarURL")</jc>
propertyNamer(PropertyNamerDLC.<jk>class</jk>);
}
}
<jc>// Register it with a serializer or parser.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanFilters(MyFilter.<jk>class</jk>)
.build();
<jc>// Properties names will be Dashed-Lower-Case.</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../org/apache/juneau/annotation/Bean.html#propertyNamer--"><code>Bean.propertyNamer()</code></a>
<li class='jm'><a href="../../../org/apache/juneau/BeanContext.Builder.html#propertyNamer-java.lang.Class-"><code>BeanContext.Builder.propertyNamer(Class)</code></a>
<li class='jc'><a href="../../../org/apache/juneau/PropertyNamer.html" title="interface in org.apache.juneau"><code>PropertyNamer</code></a>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default is <a href="../../../org/apache/juneau/BasicPropertyNamer.html" title="class in org.apache.juneau"><code>BasicPropertyNamer</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="properties-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>properties</h4>
<pre>public&nbsp;<a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a>&nbsp;<a href="../../../src-html/org/apache/juneau/BeanFilter.Builder.html#line.453">properties</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;value)</pre>
<div class="block">Bean property includes.
<p>
Specifies the set and order of names of properties associated with the bean class.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Define our filter.</jc>
<jk>public class</jk> MyFilter <jk>extends</jk> Builder&lt;MyBean&gt; {
<jk>public</jk> MyFilter() {
properties(<js>"foo,bar,baz"</js>);
}
}
<jc>// Register it with a serializer.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanFilters(MyFilter.<jk>class</jk>)
.build();
<jc>// Only serializes the properties 'foo', 'bar', and 'baz'.</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../org/apache/juneau/annotation/Bean.html#properties--"><code>Bean.properties()</code></a>
<li class='jm'><a href="../../../org/apache/juneau/BeanContext.Builder.html#beanProperties-java.lang.Class-java.lang.String-"><code>BeanContext.Builder.beanProperties(Class, String)</code></a>
<li class='jm'><a href="../../../org/apache/juneau/BeanContext.Builder.html#beanProperties-java.lang.String-java.lang.String-"><code>BeanContext.Builder.beanProperties(String, String)</code></a>
<li class='jm'><a href="../../../org/apache/juneau/BeanContext.Builder.html#beanProperties-java.util.Map-"><code>BeanContext.Builder.beanProperties(Map)</code></a>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>Values can contain comma-delimited list of property names.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="excludeProperties-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>excludeProperties</h4>
<pre>public&nbsp;<a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a>&nbsp;<a href="../../../src-html/org/apache/juneau/BeanFilter.Builder.html#line.497">excludeProperties</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;value)</pre>
<div class="block">Bean property excludes.
<p>
Specifies properties to exclude from the bean class.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Define our filter.</jc>
<jk>public class</jk> MyFilter <jk>extends</jk> Builder&lt;MyBean&gt; {
<jk>public</jk> MyFilter() {
excludeProperties(<js>"foo,bar"</js>);
}
}
<jc>// Register it with a serializer.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanFilters(MyFilter.<jk>class</jk>)
.build();
<jc>// Serializes all properties except for 'foo' and 'bar'.</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../org/apache/juneau/annotation/Bean.html#excludeProperties--"><code>Bean.excludeProperties()</code></a>
<li class='jm'><a href="../../../org/apache/juneau/BeanContext.Builder.html#beanPropertiesExcludes-java.lang.Class-java.lang.String-"><code>BeanContext.Builder.beanPropertiesExcludes(Class, String)</code></a>
<li class='jm'><a href="../../../org/apache/juneau/BeanContext.Builder.html#beanPropertiesExcludes-java.lang.String-java.lang.String-"><code>BeanContext.Builder.beanPropertiesExcludes(String, String)</code></a>
<li class='jm'><a href="../../../org/apache/juneau/BeanContext.Builder.html#beanPropertiesExcludes-java.util.Map-"><code>BeanContext.Builder.beanPropertiesExcludes(Map)</code></a>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>Values can contain comma-delimited list of property names.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="readOnlyProperties-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readOnlyProperties</h4>
<pre>public&nbsp;<a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a>&nbsp;<a href="../../../src-html/org/apache/juneau/BeanFilter.Builder.html#line.543">readOnlyProperties</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;value)</pre>
<div class="block">Read-only bean properties.
<p>
Specifies one or more properties on a bean that are read-only despite having valid getters.
Serializers will serialize such properties as usual, but parsers will silently ignore them.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Define our filter.</jc>
<jk>public class</jk> MyFilter <jk>extends</jk> Builder&lt;MyBean&gt; {
<jk>public</jk> MyFilter() {
readOnlyProperties(<js>"foo,bar"</js>);
}
}
<jc>// Register it with a parser.</jc>
ReaderParser <jv>parser</jv> = JsonParser
.<jsm>create</jsm>()
.beanFilters(MyFilter.<jk>class</jk>)
.build();
<jc>// Parsers all properties except for 'foo' and 'bar'.</jc>
MyBean <jv>bean</jv> = <jv>parser</jv>.parse(<js>"..."</js>, MyBean.<jk>class</jk>);
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../org/apache/juneau/annotation/Bean.html#readOnlyProperties--"><code>Bean.readOnlyProperties()</code></a>
<li class='ja'><a href="../../../org/apache/juneau/annotation/Beanp.html#ro--"><code>Beanp.ro()</code></a>
<li class='jm'><a href="../../../org/apache/juneau/BeanContext.Builder.html#beanPropertiesReadOnly-java.lang.Class-java.lang.String-"><code>BeanContext.Builder.beanPropertiesReadOnly(Class, String)</code></a>
<li class='jm'><a href="../../../org/apache/juneau/BeanContext.Builder.html#beanPropertiesReadOnly-java.lang.String-java.lang.String-"><code>BeanContext.Builder.beanPropertiesReadOnly(String, String)</code></a>
<li class='jm'><a href="../../../org/apache/juneau/BeanContext.Builder.html#beanPropertiesReadOnly-java.util.Map-"><code>BeanContext.Builder.beanPropertiesReadOnly(Map)</code></a>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>Values can contain comma-delimited list of property names.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="writeOnlyProperties-java.lang.String...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeOnlyProperties</h4>
<pre>public&nbsp;<a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a>&nbsp;<a href="../../../src-html/org/apache/juneau/BeanFilter.Builder.html#line.589">writeOnlyProperties</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>...&nbsp;value)</pre>
<div class="block">Write-only bean properties.
<p>
Specifies one or more properties on a bean that are write-only despite having valid setters.
Parsers will parse such properties as usual, but serializers will silently ignore them.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Define our filter.</jc>
<jk>public class</jk> MyFilter <jk>extends</jk> Builder&lt;MyBean&gt; {
<jk>public</jk> MyFilter() {
writeOnlyProperties(<js>"foo,bar"</js>);
}
}
<jc>// Register it with a serializer.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanFilters(MyFilter.<jk>class</jk>)
.build();
<jc>// Serializes all properties except for 'foo' and 'bar'.</jc>
String <jv>json</jv> = <jv>serializer</jv>.serialize(<jk>new</jk> MyBean());
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../org/apache/juneau/annotation/Bean.html#writeOnlyProperties--"><code>Bean.writeOnlyProperties()</code></a>
<li class='ja'><a href="../../../org/apache/juneau/annotation/Beanp.html#wo--"><code>Beanp.wo()</code></a>
<li class='jm'><a href="../../../org/apache/juneau/BeanContext.Builder.html#beanPropertiesWriteOnly-java.lang.Class-java.lang.String-"><code>BeanContext.Builder.beanPropertiesWriteOnly(Class, String)</code></a>
<li class='jm'><a href="../../../org/apache/juneau/BeanContext.Builder.html#beanPropertiesWriteOnly-java.lang.String-java.lang.String-"><code>BeanContext.Builder.beanPropertiesWriteOnly(String, String)</code></a>
<li class='jm'><a href="../../../org/apache/juneau/BeanContext.Builder.html#beanPropertiesWriteOnly-java.util.Map-"><code>BeanContext.Builder.beanPropertiesWriteOnly(Map)</code></a>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>Values can contain comma-delimited list of property names.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="dictionary-java.lang.Class...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dictionary</h4>
<pre>public&nbsp;<a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a>&nbsp;<a href="../../../src-html/org/apache/juneau/BeanFilter.Builder.html#line.631">dictionary</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;...&nbsp;values)</pre>
<div class="block">Bean dictionary.
<p>
Adds to the list of classes that make up the bean dictionary for this bean.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Define our filter.</jc>
<jk>public class</jk> MyFilter <jk>extends</jk> Builder&lt;MyBean&gt; {
<jk>public</jk> MyFilter() {
<jc>// Our bean contains generic collections of Foo and Bar objects.</jc>
beanDictionary(Foo.<jk>class</jk>, Bar.<jk>class</jk>);
}
}
<jc>// Register it with a parser.</jc>
ReaderParser <jv>parser</jv> = JsonParser
.<jsm>create</jsm>()
.beanFilters(MyFilter.<jk>class</jk>)
.build();
<jc>// Instantiate our bean.</jc>
MyBean <jv>bean</jv> = <jv>parser</jv>.parse(<jv>json</jv>);
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../org/apache/juneau/annotation/Bean.html#dictionary--"><code>Bean.dictionary()</code></a>
<li class='jm'><a href="../../../org/apache/juneau/BeanContext.Builder.html#beanDictionary-java.lang.Class...-"><code>BeanContext.Builder.beanDictionary(Class...)</code></a>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>values</code> - The values to add to this property.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="example-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>example</h4>
<pre>public&nbsp;<a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a>&nbsp;<a href="../../../src-html/org/apache/juneau/BeanFilter.Builder.html#line.646">example</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;value)</pre>
<div class="block">Example.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this property.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="interceptor-java.lang.Class-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>interceptor</h4>
<pre>public&nbsp;<a href="../../../org/apache/juneau/BeanFilter.Builder.html" title="class in org.apache.juneau">BeanFilter.Builder</a>&nbsp;<a href="../../../src-html/org/apache/juneau/BeanFilter.Builder.html#line.684">interceptor</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;&nbsp;value)</pre>
<div class="block">Bean interceptor.
<p>
The interceptor to use for intercepting and altering getter and setter calls.
<h5 class='section'>Example:</h5>
<p class='bjava'>
<jc>// Define our filter.</jc>
<jk>public class</jk> MyFilter <jk>extends</jk> Builder&lt;MyBean&gt; {
<jk>public</jk> MyFilter() {
<jc>// Our bean contains generic collections of Foo and Bar objects.</jc>
interceptor(AddressInterceptor.<jk>class</jk>);
}
}
<jc>// Register it with a serializer or parser.</jc>
WriterSerializer <jv>serializer</jv> = JsonSerializer
.<jsm>create</jsm>()
.beanFilters(MyFilter.<jk>class</jk>)
.build();
</p>
<ul class='seealso'>
<li class='ja'><a href="../../../org/apache/juneau/annotation/Bean.html#interceptor--"><code>Bean.interceptor()</code></a>
<li class='jc'><a href="../../../org/apache/juneau/swap/BeanInterceptor.html" title="class in org.apache.juneau.swap"><code>BeanInterceptor</code></a>
</ul></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - The new value for this setting.
<br>The default value is <a href="../../../org/apache/juneau/swap/BeanInterceptor.html" title="class in org.apache.juneau.swap"><code>BeanInterceptor</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>This object.</dd>
</dl>
</li>
</ul>
<a name="build--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre>public&nbsp;<a href="../../../org/apache/juneau/BeanFilter.html" title="class in org.apache.juneau">BeanFilter</a>&nbsp;<a href="../../../src-html/org/apache/juneau/BeanFilter.Builder.html#line.694">build</a>()</pre>
<div class="block">Creates a <a href="../../../org/apache/juneau/BeanFilter.html" title="class in org.apache.juneau"><code>BeanFilter</code></a> with settings in this builder class.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A new <a href="../../../org/apache/juneau/BeanFilter.html" title="class in org.apache.juneau"><code>BeanFilter</code></a> instance.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/apache/juneau/BeanFilter.html" title="class in org.apache.juneau"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../org/apache/juneau/BeanMap.html" title="class in org.apache.juneau"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/apache/juneau/BeanFilter.Builder.html" target="_top">Frames</a></li>
<li><a href="BeanFilter.Builder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2016&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>