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_25) on Wed Nov 13 20:23:18 PST 2013 --> 6<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> 7<title>JsonAutoDetect (Jackson-annotations 2.3.0 API)</title> 8<meta name="date" content="2013-11-13"> 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.3.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://download.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://download.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://download.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://download.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://download.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://download.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://download.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. 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 Pseudo-value <code>NONE</code> means that all auto-detection is disabled 99 for the <b>specific</b> class that annotation is applied to (including 100 its super-types, but only when resolving that class). 101 Pseudo-value <code>ALWAYS</code> means that auto-detection is enabled 102 for all method types for the class in similar way. 103<p> 104 The default value is <code>ALWAYS</code>: that is, by default, auto-detection 105 is enabled for all classes unless instructed otherwise. 106<p> 107 Starting with version 1.5, it is also possible to use more fine-grained 108 definitions, to basically define minimum visibility level needed. Defaults 109 are different for different types (getters need to be public; setters can 110 have any access modifier, for example).</div> 111</li> 112</ul> 113</div> 114<div class="summary"> 115<ul class="blockList"> 116<li class="blockList"> 117<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 118<ul class="blockList"> 119<li class="blockList"><a name="annotation_type_optional_element_summary"> 120<!-- --> 121</a> 122<h3>Optional Element Summary</h3> 123<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> 124<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> 125<tr> 126<th class="colFirst" scope="col">Modifier and Type</th> 127<th class="colLast" scope="col">Optional Element and Description</th> 128</tr> 129<tr class="altColor"> 130<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> 131<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html#creatorVisibility()">creatorVisibility</a></strong></code> 132<div class="block">Minimum visibility required for auto-detecting Creator methods, 133 except for no-argument constructors (which are always detected 134 no matter what).</div> 135</td> 136</tr> 137<tr class="rowColor"> 138<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> 139<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html#fieldVisibility()">fieldVisibility</a></strong></code> 140<div class="block">Minimum visibility required for auto-detecting member fields.</div> 141</td> 142</tr> 143<tr class="altColor"> 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><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html#getterVisibility()">getterVisibility</a></strong></code> 146<div class="block">Minimum visibility required for auto-detecting regular getter methods.</div> 147</td> 148</tr> 149<tr class="rowColor"> 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><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html#isGetterVisibility()">isGetterVisibility</a></strong></code> 152<div class="block">Minimum visibility required for auto-detecting is-getter methods.</div> 153</td> 154</tr> 155<tr class="altColor"> 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><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html#setterVisibility()">setterVisibility</a></strong></code> 158<div class="block">Minimum visibility required for auto-detecting setter methods.</div> 159</td> 160</tr> 161</table> 162</li> 163</ul> 164</li> 165</ul> 166</div> 167<div class="details"> 168<ul class="blockList"> 169<li class="blockList"> 170<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 171<ul class="blockList"> 172<li class="blockList"><a name="annotation_type_element_detail"> 173<!-- --> 174</a> 175<h3>Element Detail</h3> 176<a name="getterVisibility()"> 177<!-- --> 178</a> 179<ul class="blockList"> 180<li class="blockList"> 181<h4>getterVisibility</h4> 182<pre>public abstract <a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</a> getterVisibility</pre> 183<div class="block">Minimum visibility required for auto-detecting regular getter methods.</div> 184<dl> 185<dt>Default:</dt> 186<dd>com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.DEFAULT</dd> 187</dl> 188</li> 189</ul> 190<a name="isGetterVisibility()"> 191<!-- --> 192</a> 193<ul class="blockList"> 194<li class="blockList"> 195<h4>isGetterVisibility</h4> 196<pre>public abstract <a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</a> isGetterVisibility</pre> 197<div class="block">Minimum visibility required for auto-detecting is-getter methods.</div> 198<dl> 199<dt>Default:</dt> 200<dd>com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.DEFAULT</dd> 201</dl> 202</li> 203</ul> 204<a name="setterVisibility()"> 205<!-- --> 206</a> 207<ul class="blockList"> 208<li class="blockList"> 209<h4>setterVisibility</h4> 210<pre>public abstract <a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</a> setterVisibility</pre> 211<div class="block">Minimum visibility required for auto-detecting setter methods.</div> 212<dl> 213<dt>Default:</dt> 214<dd>com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.DEFAULT</dd> 215</dl> 216</li> 217</ul> 218<a name="creatorVisibility()"> 219<!-- --> 220</a> 221<ul class="blockList"> 222<li class="blockList"> 223<h4>creatorVisibility</h4> 224<pre>public abstract <a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</a> creatorVisibility</pre> 225<div class="block">Minimum visibility required for auto-detecting Creator methods, 226 except for no-argument constructors (which are always detected 227 no matter what).</div> 228<dl> 229<dt>Default:</dt> 230<dd>com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.DEFAULT</dd> 231</dl> 232</li> 233</ul> 234<a name="fieldVisibility()"> 235<!-- --> 236</a> 237<ul class="blockListLast"> 238<li class="blockList"> 239<h4>fieldVisibility</h4> 240<pre>public abstract <a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</a> fieldVisibility</pre> 241<div class="block">Minimum visibility required for auto-detecting member fields.</div> 242<dl> 243<dt>Default:</dt> 244<dd>com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.DEFAULT</dd> 245</dl> 246</li> 247</ul> 248</li> 249</ul> 250</li> 251</ul> 252</div> 253</div> 254<!-- ========= END OF CLASS DATA ========= --> 255<!-- ======= START OF BOTTOM NAVBAR ====== --> 256<div class="bottomNav"><a name="navbar_bottom"> 257<!-- --> 258</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 259<!-- --> 260</a> 261<ul class="navList" title="Navigation"> 262<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 263<li class="navBarCell1Rev">Class</li> 264<li><a href="class-use/JsonAutoDetect.html">Use</a></li> 265<li><a href="package-tree.html">Tree</a></li> 266<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 267<li><a href="../../../../index-all.html">Index</a></li> 268<li><a href="../../../../help-doc.html">Help</a></li> 269</ul> 270</div> 271<div class="subNav"> 272<ul class="navList"> 273<li><a href="../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 274<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> 275</ul> 276<ul class="navList"> 277<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonAutoDetect.html" target="_top">Frames</a></li> 278<li><a href="JsonAutoDetect.html" target="_top">No Frames</a></li> 279</ul> 280<ul class="navList" id="allclasses_navbar_bottom"> 281<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 282</ul> 283<div> 284<script type="text/javascript"><!-- 285 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 286 if(window==top) { 287 allClassesLink.style.display = "block"; 288 } 289 else { 290 allClassesLink.style.display = "none"; 291 } 292 //--> 293</script> 294</div> 295<div> 296<ul class="subNavList"> 297<li>Summary: </li> 298<li>Required | </li> 299<li><a href="#annotation_type_optional_element_summary">Optional</a></li> 300</ul> 301<ul class="subNavList"> 302<li>Detail: </li> 303<li><a href="#annotation_type_element_detail">Element</a></li> 304</ul> 305</div> 306<a name="skip-navbar_bottom"> 307<!-- --> 308</a></div> 309<!-- ======== END OF BOTTOM NAVBAR ======= --> 310<p class="legalCopy"><small>Copyright © 2012-2013 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved.</small></p> 311</body> 312</html> 313