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