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_29) on Mon Mar 26 18:49:10 PDT 2012 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8JsonAutoDetect (Jackson-annotations 2.0.0 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2012-03-26"> 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.0.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><EM> 52</EM> 53</TD> 54</TR> 55 56<TR> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 59 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 61 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonAutoDetect.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="JsonAutoDetect.html" target="_top"><B>NO FRAMES</B></A> 63 <SCRIPT type="text/javascript"> 64 <!-- 65 if(window==top) { 66 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 67 } 68 //--> 69</SCRIPT> 70<NOSCRIPT> 71 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 72</NOSCRIPT> 73 74 75</FONT></TD> 76</TR> 77<TR> 78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 79 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 82</TR> 83</TABLE> 84<A NAME="skip-navbar_top"></A> 85<!-- ========= END OF TOP NAVBAR ========= --> 86 87<HR> 88<!-- ======== START OF CLASS DATA ======== --> 89<H2> 90<FONT SIZE="-1"> 91com.fasterxml.jackson.annotation</FONT> 92<BR> 93Annotation Type JsonAutoDetect</H2> 94<HR> 95<DL> 96<DT><PRE><FONT SIZE="-1"><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>}) 97<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>) 98</FONT>public @interface <B>JsonAutoDetect</B></DL> 99</PRE> 100 101<P> 102Class annotation that can be used to define which kinds of Methods 103 are to be detected by auto-detection. 104 Auto-detection means using name conventions 105 and/or signature templates to find methods to use for data binding. 106 For example, so-called "getters" can be auto-detected by looking for 107 public member methods that return a value, do not take argument, 108 and have prefix "get" in their name. 109<p> 110 Pseudo-value <code>NONE</code> means that all auto-detection is disabled 111 for the <b>specific</b> class that annotation is applied to (including 112 its super-types, but only when resolving that class). 113 Pseudo-value <code>ALWAYS</code> means that auto-detection is enabled 114 for all method types for the class in similar way. 115<p> 116 The default value is <code>ALWAYS</code>: that is, by default, auto-detection 117 is enabled for all classes unless instructed otherwise. 118<p> 119 Starting with version 1.5, it is also possible to use more fine-grained 120 definitions, to basically define minimum visibility level needed. Defaults 121 are different for different types (getters need to be public; setters can 122 have any access modifier, for example). 123<P> 124 125<P> 126<HR> 127 128<P> 129<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 130 131<A NAME="annotation_type_optional_element_summary"><!-- --></A> 132<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 133<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 134<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 135<B>Optional Element Summary</B></FONT></TH> 136</TR> 137<TR BGCOLOR="white" CLASS="TableRowColor"> 138<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 139<CODE> <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</A></CODE></FONT></TD> 140<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html#creatorVisibility()">creatorVisibility</A></B></CODE> 141 142<BR> 143 Minimum visibility required for auto-detecting Creator methods, 144 except for no-argument constructors (which are always detected 145 no matter what).</TD> 146</TR> 147<TR BGCOLOR="white" CLASS="TableRowColor"> 148<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 149<CODE> <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</A></CODE></FONT></TD> 150<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html#fieldVisibility()">fieldVisibility</A></B></CODE> 151 152<BR> 153 Minimum visibility required for auto-detecting member fields.</TD> 154</TR> 155<TR BGCOLOR="white" CLASS="TableRowColor"> 156<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 157<CODE> <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</A></CODE></FONT></TD> 158<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html#getterVisibility()">getterVisibility</A></B></CODE> 159 160<BR> 161 Minimum visibility required for auto-detecting regular getter methods.</TD> 162</TR> 163<TR BGCOLOR="white" CLASS="TableRowColor"> 164<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 165<CODE> <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</A></CODE></FONT></TD> 166<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html#isGetterVisibility()">isGetterVisibility</A></B></CODE> 167 168<BR> 169 Minimum visibility required for auto-detecting is-getter methods.</TD> 170</TR> 171<TR BGCOLOR="white" CLASS="TableRowColor"> 172<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 173<CODE> <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</A></CODE></FONT></TD> 174<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html#setterVisibility()">setterVisibility</A></B></CODE> 175 176<BR> 177 Minimum visibility required for auto-detecting setter methods.</TD> 178</TR> 179</TABLE> 180 181<P> 182<A NAME="getterVisibility()"><!-- --></A><H3> 183getterVisibility</H3> 184<PRE> 185public abstract <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</A> <B>getterVisibility</B></PRE> 186<DL> 187<DD>Minimum visibility required for auto-detecting regular getter methods. 188<P> 189<DD><DL> 190</DL> 191</DD> 192<DD><DL> 193</DL> 194<DL> 195<DT><B>Default:</B><DD>com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.DEFAULT</DD> 196</DL> 197</DL> 198<HR> 199 200<A NAME="isGetterVisibility()"><!-- --></A><H3> 201isGetterVisibility</H3> 202<PRE> 203public abstract <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</A> <B>isGetterVisibility</B></PRE> 204<DL> 205<DD>Minimum visibility required for auto-detecting is-getter methods. 206<P> 207<DD><DL> 208</DL> 209</DD> 210<DD><DL> 211</DL> 212<DL> 213<DT><B>Default:</B><DD>com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.DEFAULT</DD> 214</DL> 215</DL> 216<HR> 217 218<A NAME="setterVisibility()"><!-- --></A><H3> 219setterVisibility</H3> 220<PRE> 221public abstract <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</A> <B>setterVisibility</B></PRE> 222<DL> 223<DD>Minimum visibility required for auto-detecting setter methods. 224<P> 225<DD><DL> 226</DL> 227</DD> 228<DD><DL> 229</DL> 230<DL> 231<DT><B>Default:</B><DD>com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.DEFAULT</DD> 232</DL> 233</DL> 234<HR> 235 236<A NAME="creatorVisibility()"><!-- --></A><H3> 237creatorVisibility</H3> 238<PRE> 239public abstract <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</A> <B>creatorVisibility</B></PRE> 240<DL> 241<DD>Minimum visibility required for auto-detecting Creator methods, 242 except for no-argument constructors (which are always detected 243 no matter what). 244<P> 245<DD><DL> 246</DL> 247</DD> 248<DD><DL> 249</DL> 250<DL> 251<DT><B>Default:</B><DD>com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.DEFAULT</DD> 252</DL> 253</DL> 254<HR> 255 256<A NAME="fieldVisibility()"><!-- --></A><H3> 257fieldVisibility</H3> 258<PRE> 259public abstract <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</A> <B>fieldVisibility</B></PRE> 260<DL> 261<DD>Minimum visibility required for auto-detecting member fields. 262<P> 263<DD><DL> 264</DL> 265</DD> 266<DD><DL> 267</DL> 268<DL> 269<DT><B>Default:</B><DD>com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.DEFAULT</DD> 270</DL> 271</DL> 272<!-- ========= END OF CLASS DATA ========= --> 273<HR> 274 275 276<!-- ======= START OF BOTTOM NAVBAR ====== --> 277<A NAME="navbar_bottom"><!-- --></A> 278<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 279<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 280<TR> 281<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 282<A NAME="navbar_bottom_firstrow"><!-- --></A> 283<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 284 <TR ALIGN="center" VALIGN="top"> 285 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 286 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 287 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonAutoDetect.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 288 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 289 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 290 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 291 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 292 </TR> 293</TABLE> 294</TD> 295<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 296</EM> 297</TD> 298</TR> 299 300<TR> 301<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 302 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 303 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 304<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 305 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonAutoDetect.html" target="_top"><B>FRAMES</B></A> 306 <A HREF="JsonAutoDetect.html" target="_top"><B>NO FRAMES</B></A> 307 <SCRIPT type="text/javascript"> 308 <!-- 309 if(window==top) { 310 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 311 } 312 //--> 313</SCRIPT> 314<NOSCRIPT> 315 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 316</NOSCRIPT> 317 318 319</FONT></TD> 320</TR> 321<TR> 322<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 323 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 324<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 325DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 326</TR> 327</TABLE> 328<A NAME="skip-navbar_bottom"></A> 329<!-- ======== END OF BOTTOM NAVBAR ======= --> 330 331<HR> 332Copyright © 2012 <a href="http://fasterxml.com">fasterxml.com</a>. All Rights Reserved. 333</BODY> 334</HTML> 335