• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!-- NewPage -->
3<html lang="en">
4<head>
5<!-- Generated by javadoc (1.8.0_162) on Tue Mar 24 11:44:43 PDT 2020 -->
6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<title>Uses of Class com.fasterxml.jackson.databind.ser.FilterProvider (jackson-databind 2.11.0.rc1 API)</title>
8<meta name="date" content="2020-03-24">
9<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
10<script type="text/javascript" src="../../../../../../script.js"></script>
11</head>
12<body>
13<script type="text/javascript"><!--
14    try {
15        if (location.href.indexOf('is-external=true') == -1) {
16            parent.document.title="Uses of Class com.fasterxml.jackson.databind.ser.FilterProvider (jackson-databind 2.11.0.rc1 API)";
17        }
18    }
19    catch(err) {
20    }
21//-->
22</script>
23<noscript>
24<div>JavaScript is disabled on your browser.</div>
25</noscript>
26<!-- ========= START OF TOP NAVBAR ======= -->
27<div class="topNav"><a name="navbar.top">
28<!--   -->
29</a>
30<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
31<a name="navbar.top.firstrow">
32<!--   -->
33</a>
34<ul class="navList" title="Navigation">
35<li><a href="../../../../../../overview-summary.html">Overview</a></li>
36<li><a href="../package-summary.html">Package</a></li>
37<li><a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser">Class</a></li>
38<li class="navBarCell1Rev">Use</li>
39<li><a href="../package-tree.html">Tree</a></li>
40<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
41<li><a href="../../../../../../index-all.html">Index</a></li>
42<li><a href="../../../../../../help-doc.html">Help</a></li>
43</ul>
44</div>
45<div class="subNav">
46<ul class="navList">
47<li>Prev</li>
48<li>Next</li>
49</ul>
50<ul class="navList">
51<li><a href="../../../../../../index.html?com/fasterxml/jackson/databind/ser/class-use/FilterProvider.html" target="_top">Frames</a></li>
52<li><a href="FilterProvider.html" target="_top">No&nbsp;Frames</a></li>
53</ul>
54<ul class="navList" id="allclasses_navbar_top">
55<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
56</ul>
57<div>
58<script type="text/javascript"><!--
59  allClassesLink = document.getElementById("allclasses_navbar_top");
60  if(window==top) {
61    allClassesLink.style.display = "block";
62  }
63  else {
64    allClassesLink.style.display = "none";
65  }
66  //-->
67</script>
68</div>
69<a name="skip.navbar.top">
70<!--   -->
71</a></div>
72<!-- ========= END OF TOP NAVBAR ========= -->
73<div class="header">
74<h2 title="Uses of Class com.fasterxml.jackson.databind.ser.FilterProvider" class="title">Uses of Class<br>com.fasterxml.jackson.databind.ser.FilterProvider</h2>
75</div>
76<div class="classUseContainer">
77<ul class="blockList">
78<li class="blockList">
79<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
80<caption><span>Packages that use <a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser">FilterProvider</a></span><span class="tabEnd">&nbsp;</span></caption>
81<tr>
82<th class="colFirst" scope="col">Package</th>
83<th class="colLast" scope="col">Description</th>
84</tr>
85<tbody>
86<tr class="altColor">
87<td class="colFirst"><a href="#com.fasterxml.jackson.databind">com.fasterxml.jackson.databind</a></td>
88<td class="colLast">
89<div class="block">Basic data binding (mapping) functionality that
90allows for reading JSON content into Java Objects (POJOs)
91and JSON Trees (<a href="../../../../../../com/fasterxml/jackson/databind/JsonNode.html" title="class in com.fasterxml.jackson.databind"><code>JsonNode</code></a>), as well as
92writing Java Objects and trees as JSON.</div>
93</td>
94</tr>
95<tr class="rowColor">
96<td class="colFirst"><a href="#com.fasterxml.jackson.databind.cfg">com.fasterxml.jackson.databind.cfg</a></td>
97<td class="colLast">
98<div class="block">Package that contains most of configuration-related classes;
99exception being couple of most-commonly used configuration
100things (like Feature enumerations) that are at the
101main level (<code>com.fasterxml.jackson.databind</code>).</div>
102</td>
103</tr>
104<tr class="altColor">
105<td class="colFirst"><a href="#com.fasterxml.jackson.databind.ser.impl">com.fasterxml.jackson.databind.ser.impl</a></td>
106<td class="colLast">
107<div class="block">Contains implementation classes of serialization part of
108 data binding.</div>
109</td>
110</tr>
111</tbody>
112</table>
113</li>
114<li class="blockList">
115<ul class="blockList">
116<li class="blockList"><a name="com.fasterxml.jackson.databind">
117<!--   -->
118</a>
119<h3>Uses of <a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser">FilterProvider</a> in <a href="../../../../../../com/fasterxml/jackson/databind/package-summary.html">com.fasterxml.jackson.databind</a></h3>
120<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing fields, and an explanation">
121<caption><span>Fields in <a href="../../../../../../com/fasterxml/jackson/databind/package-summary.html">com.fasterxml.jackson.databind</a> declared as <a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser">FilterProvider</a></span><span class="tabEnd">&nbsp;</span></caption>
122<tr>
123<th class="colFirst" scope="col">Modifier and Type</th>
124<th class="colLast" scope="col">Field and Description</th>
125</tr>
126<tbody>
127<tr class="altColor">
128<td class="colFirst"><code>protected <a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser">FilterProvider</a></code></td>
129<td class="colLast"><span class="typeNameLabel">SerializationConfig.</span><code><span class="memberNameLink"><a href="../../../../../../com/fasterxml/jackson/databind/SerializationConfig.html#Z:Z_filterProvider">_filterProvider</a></span></code>
130<div class="block">Object used for resolving filter ids to filter instances.</div>
131</td>
132</tr>
133</tbody>
134</table>
135<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
136<caption><span>Methods in <a href="../../../../../../com/fasterxml/jackson/databind/package-summary.html">com.fasterxml.jackson.databind</a> that return <a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser">FilterProvider</a></span><span class="tabEnd">&nbsp;</span></caption>
137<tr>
138<th class="colFirst" scope="col">Modifier and Type</th>
139<th class="colLast" scope="col">Method and Description</th>
140</tr>
141<tbody>
142<tr class="altColor">
143<td class="colFirst"><code><a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser">FilterProvider</a></code></td>
144<td class="colLast"><span class="typeNameLabel">SerializationConfig.</span><code><span class="memberNameLink"><a href="../../../../../../com/fasterxml/jackson/databind/SerializationConfig.html#getFilterProvider--">getFilterProvider</a></span>()</code>
145<div class="block">Method for getting provider used for locating filters given
146 id (which is usually provided with filter annotations).</div>
147</td>
148</tr>
149<tr class="rowColor">
150<td class="colFirst"><code><a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser">FilterProvider</a></code></td>
151<td class="colLast"><span class="typeNameLabel">SerializerProvider.</span><code><span class="memberNameLink"><a href="../../../../../../com/fasterxml/jackson/databind/SerializerProvider.html#getFilterProvider--">getFilterProvider</a></span>()</code>
152<div class="block">Convenience method for accessing provider to find serialization filters used,
153 equivalent to calling:</div>
154</td>
155</tr>
156</tbody>
157</table>
158<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
159<caption><span>Methods in <a href="../../../../../../com/fasterxml/jackson/databind/package-summary.html">com.fasterxml.jackson.databind</a> with parameters of type <a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser">FilterProvider</a></span><span class="tabEnd">&nbsp;</span></caption>
160<tr>
161<th class="colFirst" scope="col">Modifier and Type</th>
162<th class="colLast" scope="col">Method and Description</th>
163</tr>
164<tbody>
165<tr class="altColor">
166<td class="colFirst"><code><a href="../../../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind">ObjectMapper</a></code></td>
167<td class="colLast"><span class="typeNameLabel">ObjectMapper.</span><code><span class="memberNameLink"><a href="../../../../../../com/fasterxml/jackson/databind/ObjectMapper.html#setFilterProvider-com.fasterxml.jackson.databind.ser.FilterProvider-">setFilterProvider</a></span>(<a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser">FilterProvider</a>&nbsp;filterProvider)</code>
168<div class="block">Method for configuring this mapper to use specified <a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser"><code>FilterProvider</code></a> for
169 mapping Filter Ids to actual filter instances.</div>
170</td>
171</tr>
172<tr class="rowColor">
173<td class="colFirst"><code>void</code></td>
174<td class="colLast"><span class="typeNameLabel">ObjectMapper.</span><code><span class="memberNameLink"><a href="../../../../../../com/fasterxml/jackson/databind/ObjectMapper.html#setFilters-com.fasterxml.jackson.databind.ser.FilterProvider-">setFilters</a></span>(<a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser">FilterProvider</a>&nbsp;filterProvider)</code>
175<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
176<div class="block"><span class="deprecationComment">Since 2.6, use <a href="../../../../../../com/fasterxml/jackson/databind/ObjectMapper.html#setFilterProvider-com.fasterxml.jackson.databind.ser.FilterProvider-"><code>ObjectMapper.setFilterProvider(com.fasterxml.jackson.databind.ser.FilterProvider)</code></a> instead (allows chaining)</span></div>
177</div>
178</td>
179</tr>
180<tr class="altColor">
181<td class="colFirst"><code><a href="../../../../../../com/fasterxml/jackson/databind/ObjectWriter.html" title="class in com.fasterxml.jackson.databind">ObjectWriter</a></code></td>
182<td class="colLast"><span class="typeNameLabel">ObjectWriter.</span><code><span class="memberNameLink"><a href="../../../../../../com/fasterxml/jackson/databind/ObjectWriter.html#with-com.fasterxml.jackson.databind.ser.FilterProvider-">with</a></span>(<a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser">FilterProvider</a>&nbsp;filterProvider)</code>
183<div class="block">Method that will construct a new instance that uses specified
184 provider for resolving filter instances by id.</div>
185</td>
186</tr>
187<tr class="rowColor">
188<td class="colFirst"><code><a href="../../../../../../com/fasterxml/jackson/databind/SerializationConfig.html" title="class in com.fasterxml.jackson.databind">SerializationConfig</a></code></td>
189<td class="colLast"><span class="typeNameLabel">SerializationConfig.</span><code><span class="memberNameLink"><a href="../../../../../../com/fasterxml/jackson/databind/SerializationConfig.html#withFilters-com.fasterxml.jackson.databind.ser.FilterProvider-">withFilters</a></span>(<a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser">FilterProvider</a>&nbsp;filterProvider)</code>&nbsp;</td>
190</tr>
191<tr class="altColor">
192<td class="colFirst"><code><a href="../../../../../../com/fasterxml/jackson/databind/ObjectWriter.html" title="class in com.fasterxml.jackson.databind">ObjectWriter</a></code></td>
193<td class="colLast"><span class="typeNameLabel">ObjectMapper.</span><code><span class="memberNameLink"><a href="../../../../../../com/fasterxml/jackson/databind/ObjectMapper.html#writer-com.fasterxml.jackson.databind.ser.FilterProvider-">writer</a></span>(<a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser">FilterProvider</a>&nbsp;filterProvider)</code>
194<div class="block">Factory method for constructing <a href="../../../../../../com/fasterxml/jackson/databind/ObjectWriter.html" title="class in com.fasterxml.jackson.databind"><code>ObjectWriter</code></a> that will
195 serialize objects using specified filter provider.</div>
196</td>
197</tr>
198</tbody>
199</table>
200</li>
201<li class="blockList"><a name="com.fasterxml.jackson.databind.cfg">
202<!--   -->
203</a>
204<h3>Uses of <a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser">FilterProvider</a> in <a href="../../../../../../com/fasterxml/jackson/databind/cfg/package-summary.html">com.fasterxml.jackson.databind.cfg</a></h3>
205<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation">
206<caption><span>Methods in <a href="../../../../../../com/fasterxml/jackson/databind/cfg/package-summary.html">com.fasterxml.jackson.databind.cfg</a> with parameters of type <a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser">FilterProvider</a></span><span class="tabEnd">&nbsp;</span></caption>
207<tr>
208<th class="colFirst" scope="col">Modifier and Type</th>
209<th class="colLast" scope="col">Method and Description</th>
210</tr>
211<tbody>
212<tr class="altColor">
213<td class="colFirst"><code><a href="../../../../../../com/fasterxml/jackson/databind/cfg/MapperBuilder.html" title="type parameter in MapperBuilder">B</a></code></td>
214<td class="colLast"><span class="typeNameLabel">MapperBuilder.</span><code><span class="memberNameLink"><a href="../../../../../../com/fasterxml/jackson/databind/cfg/MapperBuilder.html#filterProvider-com.fasterxml.jackson.databind.ser.FilterProvider-">filterProvider</a></span>(<a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser">FilterProvider</a>&nbsp;prov)</code>
215<div class="block">Method for configuring this mapper to use specified <a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser"><code>FilterProvider</code></a> for
216 mapping Filter Ids to actual filter instances.</div>
217</td>
218</tr>
219</tbody>
220</table>
221</li>
222<li class="blockList"><a name="com.fasterxml.jackson.databind.ser.impl">
223<!--   -->
224</a>
225<h3>Uses of <a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser">FilterProvider</a> in <a href="../../../../../../com/fasterxml/jackson/databind/ser/impl/package-summary.html">com.fasterxml.jackson.databind.ser.impl</a></h3>
226<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation">
227<caption><span>Subclasses of <a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser">FilterProvider</a> in <a href="../../../../../../com/fasterxml/jackson/databind/ser/impl/package-summary.html">com.fasterxml.jackson.databind.ser.impl</a></span><span class="tabEnd">&nbsp;</span></caption>
228<tr>
229<th class="colFirst" scope="col">Modifier and Type</th>
230<th class="colLast" scope="col">Class and Description</th>
231</tr>
232<tbody>
233<tr class="altColor">
234<td class="colFirst"><code>class&nbsp;</code></td>
235<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../com/fasterxml/jackson/databind/ser/impl/SimpleFilterProvider.html" title="class in com.fasterxml.jackson.databind.ser.impl">SimpleFilterProvider</a></span></code>
236<div class="block">Simple <a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser"><code>FilterProvider</code></a> implementation that just stores
237 direct id-to-filter mapping.</div>
238</td>
239</tr>
240</tbody>
241</table>
242</li>
243</ul>
244</li>
245</ul>
246</div>
247<!-- ======= START OF BOTTOM NAVBAR ====== -->
248<div class="bottomNav"><a name="navbar.bottom">
249<!--   -->
250</a>
251<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
252<a name="navbar.bottom.firstrow">
253<!--   -->
254</a>
255<ul class="navList" title="Navigation">
256<li><a href="../../../../../../overview-summary.html">Overview</a></li>
257<li><a href="../package-summary.html">Package</a></li>
258<li><a href="../../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser">Class</a></li>
259<li class="navBarCell1Rev">Use</li>
260<li><a href="../package-tree.html">Tree</a></li>
261<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
262<li><a href="../../../../../../index-all.html">Index</a></li>
263<li><a href="../../../../../../help-doc.html">Help</a></li>
264</ul>
265</div>
266<div class="subNav">
267<ul class="navList">
268<li>Prev</li>
269<li>Next</li>
270</ul>
271<ul class="navList">
272<li><a href="../../../../../../index.html?com/fasterxml/jackson/databind/ser/class-use/FilterProvider.html" target="_top">Frames</a></li>
273<li><a href="FilterProvider.html" target="_top">No&nbsp;Frames</a></li>
274</ul>
275<ul class="navList" id="allclasses_navbar_bottom">
276<li><a href="../../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
277</ul>
278<div>
279<script type="text/javascript"><!--
280  allClassesLink = document.getElementById("allclasses_navbar_bottom");
281  if(window==top) {
282    allClassesLink.style.display = "block";
283  }
284  else {
285    allClassesLink.style.display = "none";
286  }
287  //-->
288</script>
289</div>
290<a name="skip.navbar.bottom">
291<!--   -->
292</a></div>
293<!-- ======== END OF BOTTOM NAVBAR ======= -->
294<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
295</body>
296</html>
297