• 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 Sat Apr 25 16:37:30 PDT 2020 -->
6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<title>JsonAutoDetect (Jackson-annotations 2.11.0 API)</title>
8<meta name="date" content="2020-04-25">
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="JsonAutoDetect (Jackson-annotations 2.11.0 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="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li>
36<li class="navBarCell1Rev">Class</li>
37<li><a href="class-use/JsonAutoDetect.html">Use</a></li>
38<li><a href="package-tree.html">Tree</a></li>
39<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
40<li><a href="../../../../index-all.html">Index</a></li>
41<li><a href="../../../../help-doc.html">Help</a></li>
42</ul>
43</div>
44<div class="subNav">
45<ul class="navList">
46<li><a href="../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
47<li><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Value.html" title="class in com.fasterxml.jackson.annotation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
48</ul>
49<ul class="navList">
50<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonAutoDetect.html" target="_top">Frames</a></li>
51<li><a href="JsonAutoDetect.html" target="_top">No&nbsp;Frames</a></li>
52</ul>
53<ul class="navList" id="allclasses_navbar_top">
54<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
55</ul>
56<div>
57<script type="text/javascript"><!--
58  allClassesLink = document.getElementById("allclasses_navbar_top");
59  if(window==top) {
60    allClassesLink.style.display = "block";
61  }
62  else {
63    allClassesLink.style.display = "none";
64  }
65  //-->
66</script>
67</div>
68<div>
69<ul class="subNavList">
70<li>Summary:&nbsp;</li>
71<li>Field&nbsp;|&nbsp;</li>
72<li>Required&nbsp;|&nbsp;</li>
73<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
74</ul>
75<ul class="subNavList">
76<li>Detail:&nbsp;</li>
77<li>Field&nbsp;|&nbsp;</li>
78<li><a href="#annotation.type.element.detail">Element</a></li>
79</ul>
80</div>
81<a name="skip.navbar.top">
82<!--   -->
83</a></div>
84<!-- ========= END OF TOP NAVBAR ========= -->
85<!-- ======== START OF CLASS DATA ======== -->
86<div class="header">
87<div class="subTitle">com.fasterxml.jackson.annotation</div>
88<h2 title="Annotation Type JsonAutoDetect" class="title">Annotation Type JsonAutoDetect</h2>
89</div>
90<div class="contentContainer">
91<div class="description">
92<ul class="blockList">
93<li class="blockList">
94<hr>
95<br>
96<pre><a href="https://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>={<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#ANNOTATION_TYPE" title="class or interface in java.lang.annotation">ANNOTATION_TYPE</a>,<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>})
97 <a href="https://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true#value--" title="class or interface in java.lang.annotation">value</a>=<a href="https://docs.oracle.com/javase/6/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
98public @interface <span class="memberNameLabel">JsonAutoDetect</span></pre>
99<div class="block">Class annotation that can be used to define which kinds of Methods
100 are to be detected by auto-detection, and with what minimum access level.
101 Auto-detection means using name conventions
102 and/or signature templates to find methods to use for data binding.
103 For example, so-called "getters" can be auto-detected by looking for
104 public member methods that return a value, do not take argument,
105 and have prefix "get" in their name.
106<p>
107 Default setting for all accessors is <a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html#DEFAULT"><code>JsonAutoDetect.Visibility.DEFAULT</code></a>, which
108 in turn means that the global defaults are used. Defaults
109 are different for different accessor types (getters need to be public;
110 setters can have any access modifier, for example).
111 If you assign different <a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation"><code>JsonAutoDetect.Visibility</code></a> type then it will override
112 global defaults: for example, to require that all setters must be public,
113 you would use:
114<pre>
115   &#64;JsonAutoDetect(setterVisibility=Visibility.PUBLIC_ONLY)
116</pre></div>
117</li>
118</ul>
119</div>
120<div class="summary">
121<ul class="blockList">
122<li class="blockList">
123<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
124<ul class="blockList">
125<li class="blockList"><a name="annotation.type.optional.element.summary">
126<!--   -->
127</a>
128<h3>Optional Element Summary</h3>
129<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
130<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
131<tr>
132<th class="colFirst" scope="col">Modifier and Type</th>
133<th class="colLast" scope="col">Optional Element and Description</th>
134</tr>
135<tr class="altColor">
136<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</a></code></td>
137<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html#creatorVisibility--">creatorVisibility</a></span></code>
138<div class="block">Minimum visibility required for auto-detecting Creator methods,
139 except for no-argument constructors (which are always detected
140 no matter what).</div>
141</td>
142</tr>
143<tr class="rowColor">
144<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</a></code></td>
145<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html#fieldVisibility--">fieldVisibility</a></span></code>
146<div class="block">Minimum visibility required for auto-detecting member fields.</div>
147</td>
148</tr>
149<tr class="altColor">
150<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</a></code></td>
151<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html#getterVisibility--">getterVisibility</a></span></code>
152<div class="block">Minimum visibility required for auto-detecting regular getter methods.</div>
153</td>
154</tr>
155<tr class="rowColor">
156<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</a></code></td>
157<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html#isGetterVisibility--">isGetterVisibility</a></span></code>
158<div class="block">Minimum visibility required for auto-detecting is-getter methods.</div>
159</td>
160</tr>
161<tr class="altColor">
162<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</a></code></td>
163<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html#setterVisibility--">setterVisibility</a></span></code>
164<div class="block">Minimum visibility required for auto-detecting setter methods.</div>
165</td>
166</tr>
167</table>
168</li>
169</ul>
170</li>
171</ul>
172</div>
173<div class="details">
174<ul class="blockList">
175<li class="blockList">
176<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
177<ul class="blockList">
178<li class="blockList"><a name="annotation.type.element.detail">
179<!--   -->
180</a>
181<h3>Element Detail</h3>
182<a name="getterVisibility--">
183<!--   -->
184</a>
185<ul class="blockList">
186<li class="blockList">
187<h4>getterVisibility</h4>
188<pre>public abstract&nbsp;<a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</a>&nbsp;getterVisibility</pre>
189<div class="block">Minimum visibility required for auto-detecting regular getter methods.</div>
190<dl>
191<dt>Default:</dt>
192<dd>com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.DEFAULT</dd>
193</dl>
194</li>
195</ul>
196</li>
197</ul>
198<ul class="blockList">
199<li class="blockList"><a name="isGetterVisibility--">
200<!--   -->
201</a>
202<ul class="blockList">
203<li class="blockList">
204<h4>isGetterVisibility</h4>
205<pre>public abstract&nbsp;<a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</a>&nbsp;isGetterVisibility</pre>
206<div class="block">Minimum visibility required for auto-detecting is-getter methods.</div>
207<dl>
208<dt>Default:</dt>
209<dd>com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.DEFAULT</dd>
210</dl>
211</li>
212</ul>
213</li>
214</ul>
215<ul class="blockList">
216<li class="blockList"><a name="setterVisibility--">
217<!--   -->
218</a>
219<ul class="blockList">
220<li class="blockList">
221<h4>setterVisibility</h4>
222<pre>public abstract&nbsp;<a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</a>&nbsp;setterVisibility</pre>
223<div class="block">Minimum visibility required for auto-detecting setter methods.</div>
224<dl>
225<dt>Default:</dt>
226<dd>com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.DEFAULT</dd>
227</dl>
228</li>
229</ul>
230</li>
231</ul>
232<ul class="blockList">
233<li class="blockList"><a name="creatorVisibility--">
234<!--   -->
235</a>
236<ul class="blockList">
237<li class="blockList">
238<h4>creatorVisibility</h4>
239<pre>public abstract&nbsp;<a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</a>&nbsp;creatorVisibility</pre>
240<div class="block">Minimum visibility required for auto-detecting Creator methods,
241 except for no-argument constructors (which are always detected
242 no matter what).</div>
243<dl>
244<dt>Default:</dt>
245<dd>com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.DEFAULT</dd>
246</dl>
247</li>
248</ul>
249</li>
250</ul>
251<ul class="blockList">
252<li class="blockList"><a name="fieldVisibility--">
253<!--   -->
254</a>
255<ul class="blockListLast">
256<li class="blockList">
257<h4>fieldVisibility</h4>
258<pre>public abstract&nbsp;<a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</a>&nbsp;fieldVisibility</pre>
259<div class="block">Minimum visibility required for auto-detecting member fields.</div>
260<dl>
261<dt>Default:</dt>
262<dd>com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.DEFAULT</dd>
263</dl>
264</li>
265</ul>
266</li>
267</ul>
268</li>
269</ul>
270</div>
271</div>
272<!-- ========= END OF CLASS DATA ========= -->
273<!-- ======= START OF BOTTOM NAVBAR ====== -->
274<div class="bottomNav"><a name="navbar.bottom">
275<!--   -->
276</a>
277<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
278<a name="navbar.bottom.firstrow">
279<!--   -->
280</a>
281<ul class="navList" title="Navigation">
282<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li>
283<li class="navBarCell1Rev">Class</li>
284<li><a href="class-use/JsonAutoDetect.html">Use</a></li>
285<li><a href="package-tree.html">Tree</a></li>
286<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
287<li><a href="../../../../index-all.html">Index</a></li>
288<li><a href="../../../../help-doc.html">Help</a></li>
289</ul>
290</div>
291<div class="subNav">
292<ul class="navList">
293<li><a href="../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
294<li><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Value.html" title="class in com.fasterxml.jackson.annotation"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
295</ul>
296<ul class="navList">
297<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonAutoDetect.html" target="_top">Frames</a></li>
298<li><a href="JsonAutoDetect.html" target="_top">No&nbsp;Frames</a></li>
299</ul>
300<ul class="navList" id="allclasses_navbar_bottom">
301<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
302</ul>
303<div>
304<script type="text/javascript"><!--
305  allClassesLink = document.getElementById("allclasses_navbar_bottom");
306  if(window==top) {
307    allClassesLink.style.display = "block";
308  }
309  else {
310    allClassesLink.style.display = "none";
311  }
312  //-->
313</script>
314</div>
315<div>
316<ul class="subNavList">
317<li>Summary:&nbsp;</li>
318<li>Field&nbsp;|&nbsp;</li>
319<li>Required&nbsp;|&nbsp;</li>
320<li><a href="#annotation.type.optional.element.summary">Optional</a></li>
321</ul>
322<ul class="subNavList">
323<li>Detail:&nbsp;</li>
324<li>Field&nbsp;|&nbsp;</li>
325<li><a href="#annotation.type.element.detail">Element</a></li>
326</ul>
327</div>
328<a name="skip.navbar.bottom">
329<!--   -->
330</a></div>
331<!-- ======== END OF BOTTOM NAVBAR ======= -->
332<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
333</body>
334</html>
335