1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_35) on Fri Oct 05 20:53:29 PDT 2012 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8JsonAutoDetect (Jackson-annotations 2.1.0 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2012-10-05"> 12 13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> 14 15<SCRIPT type="text/javascript"> 16function windowTitle() 17{ 18 if (location.href.indexOf('is-external=true') == -1) { 19 parent.document.title="JsonAutoDetect (Jackson-annotations 2.1.0 API)"; 20 } 21} 22</SCRIPT> 23<NOSCRIPT> 24</NOSCRIPT> 25 26</HEAD> 27 28<BODY BGCOLOR="white" onload="windowTitle();"> 29<HR> 30 31 32<!-- ========= START OF TOP NAVBAR ======= --> 33<A NAME="navbar_top"><!-- --></A> 34<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 36<TR> 37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 38<A NAME="navbar_top_firstrow"><!-- --></A> 39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 40 <TR ALIGN="center" VALIGN="top"> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonAutoDetect.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 48 </TR> 49</TABLE> 50</TD> 51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><script type="text/javascript"><!-- 52google_ad_client = "pub-1467773697956887"; 53/* Jackson-ad-small */ 54google_ad_slot = "6699487946"; 55google_ad_width = 234; 56google_ad_height = 60; 57//--> 58</script> 59<script type="text/javascript" 60src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> 61</script> 62</TD> 63</TR> 64 65<TR> 66<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 67 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 68 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 69<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 70 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonAutoDetect.html" target="_top"><B>FRAMES</B></A> 71 <A HREF="JsonAutoDetect.html" target="_top"><B>NO FRAMES</B></A> 72 <SCRIPT type="text/javascript"> 73 <!-- 74 if(window==top) { 75 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 76 } 77 //--> 78</SCRIPT> 79<NOSCRIPT> 80 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 81</NOSCRIPT> 82 83 84</FONT></TD> 85</TR> 86<TR> 87<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 88 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 89<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 90DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 91</TR> 92</TABLE> 93<A NAME="skip-navbar_top"></A> 94<!-- ========= END OF TOP NAVBAR ========= --> 95 96<HR> 97<!-- ======== START OF CLASS DATA ======== --> 98<H2> 99<FONT SIZE="-1"> 100com.fasterxml.jackson.annotation</FONT> 101<BR> 102Annotation Type JsonAutoDetect</H2> 103<HR> 104<DL> 105<DT><PRE><FONT SIZE="-1"><A HREF="http://download.oracle.com/javase/1.5.0/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/1.5.0/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/1.5.0/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/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</A>}) 106<A HREF="http://download.oracle.com/javase/1.5.0/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/1.5.0/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/1.5.0/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</A>) 107</FONT>public @interface <B>JsonAutoDetect</B></DL> 108</PRE> 109 110<P> 111Class annotation that can be used to define which kinds of Methods 112 are to be detected by auto-detection. 113 Auto-detection means using name conventions 114 and/or signature templates to find methods to use for data binding. 115 For example, so-called "getters" can be auto-detected by looking for 116 public member methods that return a value, do not take argument, 117 and have prefix "get" in their name. 118<p> 119 Pseudo-value <code>NONE</code> means that all auto-detection is disabled 120 for the <b>specific</b> class that annotation is applied to (including 121 its super-types, but only when resolving that class). 122 Pseudo-value <code>ALWAYS</code> means that auto-detection is enabled 123 for all method types for the class in similar way. 124<p> 125 The default value is <code>ALWAYS</code>: that is, by default, auto-detection 126 is enabled for all classes unless instructed otherwise. 127<p> 128 Starting with version 1.5, it is also possible to use more fine-grained 129 definitions, to basically define minimum visibility level needed. Defaults 130 are different for different types (getters need to be public; setters can 131 have any access modifier, for example). 132<P> 133 134<P> 135<HR> 136 137<P> 138<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 139 140<A NAME="annotation_type_optional_element_summary"><!-- --></A> 141<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 142<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 143<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 144<B>Optional Element Summary</B></FONT></TH> 145</TR> 146<TR BGCOLOR="white" CLASS="TableRowColor"> 147<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 148<CODE> <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</A></CODE></FONT></TD> 149<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html#creatorVisibility()">creatorVisibility</A></B></CODE> 150 151<BR> 152 Minimum visibility required for auto-detecting Creator methods, 153 except for no-argument constructors (which are always detected 154 no matter what).</TD> 155</TR> 156<TR BGCOLOR="white" CLASS="TableRowColor"> 157<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 158<CODE> <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</A></CODE></FONT></TD> 159<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html#fieldVisibility()">fieldVisibility</A></B></CODE> 160 161<BR> 162 Minimum visibility required for auto-detecting member fields.</TD> 163</TR> 164<TR BGCOLOR="white" CLASS="TableRowColor"> 165<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 166<CODE> <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</A></CODE></FONT></TD> 167<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html#getterVisibility()">getterVisibility</A></B></CODE> 168 169<BR> 170 Minimum visibility required for auto-detecting regular getter methods.</TD> 171</TR> 172<TR BGCOLOR="white" CLASS="TableRowColor"> 173<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 174<CODE> <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</A></CODE></FONT></TD> 175<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html#isGetterVisibility()">isGetterVisibility</A></B></CODE> 176 177<BR> 178 Minimum visibility required for auto-detecting is-getter methods.</TD> 179</TR> 180<TR BGCOLOR="white" CLASS="TableRowColor"> 181<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 182<CODE> <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</A></CODE></FONT></TD> 183<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html#setterVisibility()">setterVisibility</A></B></CODE> 184 185<BR> 186 Minimum visibility required for auto-detecting setter methods.</TD> 187</TR> 188</TABLE> 189 190<P> 191<A NAME="getterVisibility()"><!-- --></A><H3> 192getterVisibility</H3> 193<PRE> 194public abstract <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</A> <B>getterVisibility</B></PRE> 195<DL> 196<DD>Minimum visibility required for auto-detecting regular getter methods. 197<P> 198<DD><DL> 199</DL> 200</DD> 201<DD><DL> 202</DL> 203<DL> 204<DT><B>Default:</B><DD>com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.DEFAULT</DD> 205</DL> 206</DL> 207<HR> 208 209<A NAME="isGetterVisibility()"><!-- --></A><H3> 210isGetterVisibility</H3> 211<PRE> 212public abstract <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</A> <B>isGetterVisibility</B></PRE> 213<DL> 214<DD>Minimum visibility required for auto-detecting is-getter methods. 215<P> 216<DD><DL> 217</DL> 218</DD> 219<DD><DL> 220</DL> 221<DL> 222<DT><B>Default:</B><DD>com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.DEFAULT</DD> 223</DL> 224</DL> 225<HR> 226 227<A NAME="setterVisibility()"><!-- --></A><H3> 228setterVisibility</H3> 229<PRE> 230public abstract <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</A> <B>setterVisibility</B></PRE> 231<DL> 232<DD>Minimum visibility required for auto-detecting setter methods. 233<P> 234<DD><DL> 235</DL> 236</DD> 237<DD><DL> 238</DL> 239<DL> 240<DT><B>Default:</B><DD>com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.DEFAULT</DD> 241</DL> 242</DL> 243<HR> 244 245<A NAME="creatorVisibility()"><!-- --></A><H3> 246creatorVisibility</H3> 247<PRE> 248public abstract <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</A> <B>creatorVisibility</B></PRE> 249<DL> 250<DD>Minimum visibility required for auto-detecting Creator methods, 251 except for no-argument constructors (which are always detected 252 no matter what). 253<P> 254<DD><DL> 255</DL> 256</DD> 257<DD><DL> 258</DL> 259<DL> 260<DT><B>Default:</B><DD>com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.DEFAULT</DD> 261</DL> 262</DL> 263<HR> 264 265<A NAME="fieldVisibility()"><!-- --></A><H3> 266fieldVisibility</H3> 267<PRE> 268public abstract <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</A> <B>fieldVisibility</B></PRE> 269<DL> 270<DD>Minimum visibility required for auto-detecting member fields. 271<P> 272<DD><DL> 273</DL> 274</DD> 275<DD><DL> 276</DL> 277<DL> 278<DT><B>Default:</B><DD>com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.DEFAULT</DD> 279</DL> 280</DL> 281<!-- ========= END OF CLASS DATA ========= --> 282<HR> 283 284 285<!-- ======= START OF BOTTOM NAVBAR ====== --> 286<A NAME="navbar_bottom"><!-- --></A> 287<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 288<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 289<TR><td rowspan='3'><script type="text/javascript"><!-- 290google_ad_client = "pub-1467773697956887"; 291/* Jackson-ad-small */ 292google_ad_slot = "6699487946"; 293google_ad_width = 234; 294google_ad_height = 60; 295//--> 296</script> 297<script type="text/javascript" 298src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> 299</script> 300<!-- GA --> 301<script type="text/javascript"> 302var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); 303document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); 304</script> 305<script type="text/javascript"> 306try { 307var pageTracker = _gat._getTracker("UA-140287-6"); 308pageTracker._trackPageview(); 309} catch(err) {} 310</script> 311</td> 312<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 313<A NAME="navbar_bottom_firstrow"><!-- --></A> 314<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 315 <TR ALIGN="center" VALIGN="top"> 316 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 317 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 318 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonAutoDetect.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 319 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 320 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 321 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 322 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 323 </TR> 324</TABLE> 325</TD> 326<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 327</EM> 328</TD> 329</TR> 330 331<TR> 332<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 333 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 334 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 335<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 336 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonAutoDetect.html" target="_top"><B>FRAMES</B></A> 337 <A HREF="JsonAutoDetect.html" target="_top"><B>NO FRAMES</B></A> 338 <SCRIPT type="text/javascript"> 339 <!-- 340 if(window==top) { 341 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 342 } 343 //--> 344</SCRIPT> 345<NOSCRIPT> 346 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 347</NOSCRIPT> 348 349 350</FONT></TD> 351</TR> 352<TR> 353<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 354 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 355<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 356DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 357</TR> 358</TABLE> 359<A NAME="skip-navbar_bottom"></A> 360<!-- ======== END OF BOTTOM NAVBAR ======= --> 361 362<HR> 363Copyright © 2012 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved. 364</BODY> 365</HTML> 366