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 Tue Oct 09 17:08:07 PDT 2012 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8MapperFeature (jackson-databind 2.1.0 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2012-10-09"> 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="MapperFeature (jackson-databind 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="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 43 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MapperFeature.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 49 </TR> 50</TABLE> 51</TD> 52<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 53</EM> 54</TD> 55</TR> 56 57<TR> 58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 59 <A HREF="../../../../com/fasterxml/jackson/databind/KeyDeserializer.None.html" title="class in com.fasterxml.jackson.databind"><B>PREV CLASS</B></A> 60 <A HREF="../../../../com/fasterxml/jackson/databind/MappingIterator.html" title="class in com.fasterxml.jackson.databind"><B>NEXT CLASS</B></A></FONT></TD> 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 62 <A HREF="../../../../index.html?com/fasterxml/jackson/databind/MapperFeature.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="MapperFeature.html" target="_top"><B>NO FRAMES</B></A> 64 <SCRIPT type="text/javascript"> 65 <!-- 66 if(window==top) { 67 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 68 } 69 //--> 70</SCRIPT> 71<NOSCRIPT> 72 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 73</NOSCRIPT> 74 75 76</FONT></TD> 77</TR> 78<TR> 79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 80 SUMMARY: NESTED | <A HREF="#enum_constant_summary">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_summary">METHOD</A></FONT></TD> 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 82DETAIL: <A HREF="#enum_constant_detail">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_detail">METHOD</A></FONT></TD> 83</TR> 84</TABLE> 85<A NAME="skip-navbar_top"></A> 86<!-- ========= END OF TOP NAVBAR ========= --> 87 88<HR> 89<!-- ======== START OF CLASS DATA ======== --> 90<H2> 91<FONT SIZE="-1"> 92com.fasterxml.jackson.databind</FONT> 93<BR> 94Enum MapperFeature</H2> 95<PRE> 96<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> 97 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</A><<A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</A>> 98 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.fasterxml.jackson.databind.MapperFeature</B> 99</PRE> 100<DL> 101<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../com/fasterxml/jackson/databind/cfg/ConfigFeature.html" title="interface in com.fasterxml.jackson.databind.cfg">ConfigFeature</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</A><<A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</A>></DD> 102</DL> 103<HR> 104<DL> 105<DT><PRE>public enum <B>MapperFeature</B><DT>extends <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</A><<A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</A>><DT>implements <A HREF="../../../../com/fasterxml/jackson/databind/cfg/ConfigFeature.html" title="interface in com.fasterxml.jackson.databind.cfg">ConfigFeature</A></DL> 106</PRE> 107 108<P> 109Enumeration that defines simple on/off features to set 110 for <A HREF="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><CODE>ObjectMapper</CODE></A>, and accessible (but not changeable) 111 via <A HREF="../../../../com/fasterxml/jackson/databind/ObjectReader.html" title="class in com.fasterxml.jackson.databind"><CODE>ObjectReader</CODE></A> and <A HREF="../../../../com/fasterxml/jackson/databind/ObjectWriter.html" title="class in com.fasterxml.jackson.databind"><CODE>ObjectWriter</CODE></A> (as well as 112 through various convenience methods through context objects). 113<p> 114 Note that in addition to being only mutable via <A HREF="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><CODE>ObjectMapper</CODE></A>, 115 changes only take effect when done <b>before any serialization or 116 deserialization</b> calls -- that is, caller must follow 117 "configure-then-use" pattern. 118<P> 119 120<P> 121<HR> 122 123<P> 124<!-- =========== ENUM CONSTANT SUMMARY =========== --> 125 126<A NAME="enum_constant_summary"><!-- --></A> 127<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 128<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 129<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 130<B>Enum Constant Summary</B></FONT></TH> 131</TR> 132<TR BGCOLOR="white" CLASS="TableRowColor"> 133<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html#AUTO_DETECT_CREATORS">AUTO_DETECT_CREATORS</A></B></CODE> 134 135<BR> 136 Feature that determines whether "creator" methods are 137 automatically detected by consider public constructors, 138 and static single argument methods with name "valueOf".</TD> 139</TR> 140<TR BGCOLOR="white" CLASS="TableRowColor"> 141<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html#AUTO_DETECT_FIELDS">AUTO_DETECT_FIELDS</A></B></CODE> 142 143<BR> 144 Feature that determines whether non-static fields are recognized as 145 properties.</TD> 146</TR> 147<TR BGCOLOR="white" CLASS="TableRowColor"> 148<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html#AUTO_DETECT_GETTERS">AUTO_DETECT_GETTERS</A></B></CODE> 149 150<BR> 151 Feature that determines whether regualr "getter" methods are 152 automatically detected based on standard Bean naming convention 153 or not.</TD> 154</TR> 155<TR BGCOLOR="white" CLASS="TableRowColor"> 156<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html#AUTO_DETECT_IS_GETTERS">AUTO_DETECT_IS_GETTERS</A></B></CODE> 157 158<BR> 159 Feature that determines whether "is getter" methods are 160 automatically detected based on standard Bean naming convention 161 or not.</TD> 162</TR> 163<TR BGCOLOR="white" CLASS="TableRowColor"> 164<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html#AUTO_DETECT_SETTERS">AUTO_DETECT_SETTERS</A></B></CODE> 165 166<BR> 167 Feature that determines whether "setter" methods are 168 automatically detected based on standard Bean naming convention 169 or not.</TD> 170</TR> 171<TR BGCOLOR="white" CLASS="TableRowColor"> 172<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html#CAN_OVERRIDE_ACCESS_MODIFIERS">CAN_OVERRIDE_ACCESS_MODIFIERS</A></B></CODE> 173 174<BR> 175 Feature that determines whether method and field access 176 modifier settings can be overridden when accessing 177 properties.</TD> 178</TR> 179<TR BGCOLOR="white" CLASS="TableRowColor"> 180<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html#DEFAULT_VIEW_INCLUSION">DEFAULT_VIEW_INCLUSION</A></B></CODE> 181 182<BR> 183 Feature that determines whether properties that have no view 184 annotations are included in JSON serialization views (see 185 <A HREF="http://fasterxml.github.com/jackson-annotations/javadoc/2.1.0/com/fasterxml/jackson/annotation/JsonView.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation"><CODE>JsonView</CODE></A> for more 186 details on JSON Views).</TD> 187</TR> 188<TR BGCOLOR="white" CLASS="TableRowColor"> 189<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html#REQUIRE_SETTERS_FOR_GETTERS">REQUIRE_SETTERS_FOR_GETTERS</A></B></CODE> 190 191<BR> 192 Feature that determines whether getters (getter methods) 193 can be auto-detected if there is no matching mutator (setter, 194 constructor parameter or field) or not: if set to true, 195 only getters that match a mutator are auto-discovered; if 196 false, all auto-detectable getters can be discovered.</TD> 197</TR> 198<TR BGCOLOR="white" CLASS="TableRowColor"> 199<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html#SORT_PROPERTIES_ALPHABETICALLY">SORT_PROPERTIES_ALPHABETICALLY</A></B></CODE> 200 201<BR> 202 Feature that defines default property serialization order used 203 for POJO fields (note: does <b>not</b> apply to <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><CODE>Map</CODE></A> 204 serialization!): 205 if enabled, default ordering is alphabetic (similar to 206 how <A HREF="http://fasterxml.github.com/jackson-annotations/javadoc/2.1.0/com/fasterxml/jackson/annotation/JsonPropertyOrder.html?is-external=true#alphabetic()" title="class or interface in com.fasterxml.jackson.annotation"><CODE>JsonPropertyOrder.alphabetic()</CODE></A> 207 works); if disabled, order is unspecified (based on what JDK gives 208 us, which may be declaration order, but is not guaranteed).</TD> 209</TR> 210<TR BGCOLOR="white" CLASS="TableRowColor"> 211<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html#USE_ANNOTATIONS">USE_ANNOTATIONS</A></B></CODE> 212 213<BR> 214 Feature that determines whether annotation introspection 215 is used for configuration; if enabled, configured 216 <A HREF="../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.html" title="class in com.fasterxml.jackson.databind"><CODE>AnnotationIntrospector</CODE></A> will be used: if disabled, 217 no annotations are considered.</TD> 218</TR> 219<TR BGCOLOR="white" CLASS="TableRowColor"> 220<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html#USE_GETTERS_AS_SETTERS">USE_GETTERS_AS_SETTERS</A></B></CODE> 221 222<BR> 223 Feature that determines whether otherwise regular "getter" 224 methods (but only ones that handle Collections and Maps, 225 not getters of other type) 226 can be used for purpose of getting a reference to a Collection 227 and Map to modify the property, without requiring a setter 228 method.</TD> 229</TR> 230<TR BGCOLOR="white" CLASS="TableRowColor"> 231<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html#USE_STATIC_TYPING">USE_STATIC_TYPING</A></B></CODE> 232 233<BR> 234 Feature that determines whether the type detection for 235 serialization should be using actual dynamic runtime type, 236 or declared static type.</TD> 237</TR> 238<TR BGCOLOR="white" CLASS="TableRowColor"> 239<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html#USE_WRAPPER_NAME_AS_PROPERTY_NAME">USE_WRAPPER_NAME_AS_PROPERTY_NAME</A></B></CODE> 240 241<BR> 242 Feature that can be enabled to make property names be 243 overridden by wrapper name (usually detected with annotations 244 as defined by <A HREF="../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.html#findWrapperName(com.fasterxml.jackson.databind.introspect.Annotated)"><CODE>AnnotationIntrospector.findWrapperName(com.fasterxml.jackson.databind.introspect.Annotated)</CODE></A>.</TD> 245</TR> 246</TABLE> 247 248<!-- ========== METHOD SUMMARY =========== --> 249 250<A NAME="method_summary"><!-- --></A> 251<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 252<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 253<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 254<B>Method Summary</B></FONT></TH> 255</TR> 256<TR BGCOLOR="white" CLASS="TableRowColor"> 257<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 258<CODE> boolean</CODE></FONT></TD> 259<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html#enabledByDefault()">enabledByDefault</A></B>()</CODE> 260 261<BR> 262 Accessor for checking whether this feature is enabled by default.</TD> 263</TR> 264<TR BGCOLOR="white" CLASS="TableRowColor"> 265<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 266<CODE> int</CODE></FONT></TD> 267<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html#getMask()">getMask</A></B>()</CODE> 268 269<BR> 270 Returns bit mask for this feature instance</TD> 271</TR> 272<TR BGCOLOR="white" CLASS="TableRowColor"> 273<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 274<CODE>static <A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</A></CODE></FONT></TD> 275<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html#valueOf(java.lang.String)">valueOf</A></B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE> 276 277<BR> 278 Returns the enum constant of this type with the specified name.</TD> 279</TR> 280<TR BGCOLOR="white" CLASS="TableRowColor"> 281<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 282<CODE>static <A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</A>[]</CODE></FONT></TD> 283<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html#values()">values</A></B>()</CODE> 284 285<BR> 286 Returns an array containing the constants of this enum type, in 287the order they are declared.</TD> 288</TR> 289</TABLE> 290 <A NAME="methods_inherited_from_class_java.lang.Enum"><!-- --></A> 291<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 292<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 293<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</A></B></TH> 294</TR> 295<TR BGCOLOR="white" CLASS="TableRowColor"> 296<TD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang">compareTo</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang">getDeclaringClass</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#name()" title="class or interface in java.lang">name</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang">ordinal</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class, java.lang.String)" title="class or interface in java.lang">valueOf</A></CODE></TD> 297</TR> 298</TABLE> 299 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 300<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 301<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 302<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> 303</TR> 304<TR BGCOLOR="white" CLASS="TableRowColor"> 305<TD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> 306</TR> 307</TABLE> 308 309<P> 310 311<!-- ============ ENUM CONSTANT DETAIL =========== --> 312 313<A NAME="enum_constant_detail"><!-- --></A> 314<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 315<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 316<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 317<B>Enum Constant Detail</B></FONT></TH> 318</TR> 319</TABLE> 320 321<A NAME="USE_ANNOTATIONS"><!-- --></A><H3> 322USE_ANNOTATIONS</H3> 323<PRE> 324public static final <A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</A> <B>USE_ANNOTATIONS</B></PRE> 325<DL> 326<DD>Feature that determines whether annotation introspection 327 is used for configuration; if enabled, configured 328 <A HREF="../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.html" title="class in com.fasterxml.jackson.databind"><CODE>AnnotationIntrospector</CODE></A> will be used: if disabled, 329 no annotations are considered. 330<p> 331 Feature is enabled by default. 332<P> 333<DL> 334</DL> 335</DL> 336<HR> 337 338<A NAME="AUTO_DETECT_CREATORS"><!-- --></A><H3> 339AUTO_DETECT_CREATORS</H3> 340<PRE> 341public static final <A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</A> <B>AUTO_DETECT_CREATORS</B></PRE> 342<DL> 343<DD>Feature that determines whether "creator" methods are 344 automatically detected by consider public constructors, 345 and static single argument methods with name "valueOf". 346 If disabled, only methods explicitly annotated are considered 347 creator methods (except for the no-arg default constructor which 348 is always considered a factory method). 349<p> 350 Note that this feature has lower precedence than per-class 351 annotations, and is only used if there isn't more granular 352 configuration available. 353<P> 354 Feature is enabled by default. 355<P> 356<DL> 357</DL> 358</DL> 359<HR> 360 361<A NAME="AUTO_DETECT_FIELDS"><!-- --></A><H3> 362AUTO_DETECT_FIELDS</H3> 363<PRE> 364public static final <A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</A> <B>AUTO_DETECT_FIELDS</B></PRE> 365<DL> 366<DD>Feature that determines whether non-static fields are recognized as 367 properties. 368 If yes, then all public member fields 369 are considered as properties. If disabled, only fields explicitly 370 annotated are considered property fields. 371<p> 372 Note that this feature has lower precedence than per-class 373 annotations, and is only used if there isn't more granular 374 configuration available. 375<p> 376 Feature is enabled by default. 377<P> 378<DL> 379</DL> 380</DL> 381<HR> 382 383<A NAME="AUTO_DETECT_GETTERS"><!-- --></A><H3> 384AUTO_DETECT_GETTERS</H3> 385<PRE> 386public static final <A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</A> <B>AUTO_DETECT_GETTERS</B></PRE> 387<DL> 388<DD>Feature that determines whether regualr "getter" methods are 389 automatically detected based on standard Bean naming convention 390 or not. If yes, then all public zero-argument methods that 391 start with prefix "get" 392 are considered as getters. 393 If disabled, only methods explicitly annotated are considered getters. 394<p> 395 Note that since version 1.3, this does <b>NOT</b> include 396 "is getters" (see <A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html#AUTO_DETECT_IS_GETTERS"><CODE>AUTO_DETECT_IS_GETTERS</CODE></A> for details) 397<p> 398 Note that this feature has lower precedence than per-class 399 annotations, and is only used if there isn't more granular 400 configuration available. 401<p> 402 Feature is enabled by default. 403<P> 404<DL> 405</DL> 406</DL> 407<HR> 408 409<A NAME="AUTO_DETECT_IS_GETTERS"><!-- --></A><H3> 410AUTO_DETECT_IS_GETTERS</H3> 411<PRE> 412public static final <A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</A> <B>AUTO_DETECT_IS_GETTERS</B></PRE> 413<DL> 414<DD>Feature that determines whether "is getter" methods are 415 automatically detected based on standard Bean naming convention 416 or not. If yes, then all public zero-argument methods that 417 start with prefix "is", and whose return type is boolean 418 are considered as "is getters". 419 If disabled, only methods explicitly annotated are considered getters. 420<p> 421 Note that this feature has lower precedence than per-class 422 annotations, and is only used if there isn't more granular 423 configuration available. 424<p> 425 Feature is enabled by default. 426<P> 427<DL> 428</DL> 429</DL> 430<HR> 431 432<A NAME="AUTO_DETECT_SETTERS"><!-- --></A><H3> 433AUTO_DETECT_SETTERS</H3> 434<PRE> 435public static final <A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</A> <B>AUTO_DETECT_SETTERS</B></PRE> 436<DL> 437<DD>Feature that determines whether "setter" methods are 438 automatically detected based on standard Bean naming convention 439 or not. If yes, then all public one-argument methods that 440 start with prefix "set" 441 are considered setters. If disabled, only methods explicitly 442 annotated are considered setters. 443<p> 444 Note that this feature has lower precedence than per-class 445 annotations, and is only used if there isn't more granular 446 configuration available. 447<P> 448 Feature is enabled by default. 449<P> 450<DL> 451</DL> 452</DL> 453<HR> 454 455<A NAME="REQUIRE_SETTERS_FOR_GETTERS"><!-- --></A><H3> 456REQUIRE_SETTERS_FOR_GETTERS</H3> 457<PRE> 458public static final <A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</A> <B>REQUIRE_SETTERS_FOR_GETTERS</B></PRE> 459<DL> 460<DD>Feature that determines whether getters (getter methods) 461 can be auto-detected if there is no matching mutator (setter, 462 constructor parameter or field) or not: if set to true, 463 only getters that match a mutator are auto-discovered; if 464 false, all auto-detectable getters can be discovered. 465<p> 466 Feature is disabled by default. 467<P> 468<DL> 469</DL> 470</DL> 471<HR> 472 473<A NAME="USE_GETTERS_AS_SETTERS"><!-- --></A><H3> 474USE_GETTERS_AS_SETTERS</H3> 475<PRE> 476public static final <A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</A> <B>USE_GETTERS_AS_SETTERS</B></PRE> 477<DL> 478<DD>Feature that determines whether otherwise regular "getter" 479 methods (but only ones that handle Collections and Maps, 480 not getters of other type) 481 can be used for purpose of getting a reference to a Collection 482 and Map to modify the property, without requiring a setter 483 method. 484 This is similar to how JAXB framework sets Collections and 485 Maps: no setter is involved, just setter. 486<p> 487 Note that such getters-as-setters methods have lower 488 precedence than setters, so they are only used if no 489 setter is found for the Map/Collection property. 490<p> 491 Feature is enabled by default. 492<P> 493<DL> 494</DL> 495</DL> 496<HR> 497 498<A NAME="CAN_OVERRIDE_ACCESS_MODIFIERS"><!-- --></A><H3> 499CAN_OVERRIDE_ACCESS_MODIFIERS</H3> 500<PRE> 501public static final <A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</A> <B>CAN_OVERRIDE_ACCESS_MODIFIERS</B></PRE> 502<DL> 503<DD>Feature that determines whether method and field access 504 modifier settings can be overridden when accessing 505 properties. If enabled, method 506 <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true#setAccessible(java.lang.reflect.AccessibleObject[], boolean)" title="class or interface in java.lang.reflect"><CODE>AccessibleObject.setAccessible(java.lang.reflect.AccessibleObject[], boolean)</CODE></A> 507 may be called to enable access to otherwise unaccessible 508 objects. 509<p> 510 Feature is enabled by default. 511<P> 512<DL> 513</DL> 514</DL> 515<HR> 516 517<A NAME="USE_STATIC_TYPING"><!-- --></A><H3> 518USE_STATIC_TYPING</H3> 519<PRE> 520public static final <A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</A> <B>USE_STATIC_TYPING</B></PRE> 521<DL> 522<DD>Feature that determines whether the type detection for 523 serialization should be using actual dynamic runtime type, 524 or declared static type. 525 Note that deserialization always uses declared static types 526 since no runtime types are available (as we are creating 527 instances after using type information). 528<p> 529 This global default value can be overridden at class, method 530 or field level by using <A HREF="../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.html#typing()"><CODE>JsonSerialize.typing()</CODE></A> annotation 531 property. 532<p> 533 Feature is disabled by default which means that dynamic runtime types 534 are used (instead of declared static types) for serialization. 535<P> 536<DL> 537</DL> 538</DL> 539<HR> 540 541<A NAME="DEFAULT_VIEW_INCLUSION"><!-- --></A><H3> 542DEFAULT_VIEW_INCLUSION</H3> 543<PRE> 544public static final <A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</A> <B>DEFAULT_VIEW_INCLUSION</B></PRE> 545<DL> 546<DD>Feature that determines whether properties that have no view 547 annotations are included in JSON serialization views (see 548 <A HREF="http://fasterxml.github.com/jackson-annotations/javadoc/2.1.0/com/fasterxml/jackson/annotation/JsonView.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation"><CODE>JsonView</CODE></A> for more 549 details on JSON Views). 550 If enabled, non-annotated properties will be included; 551 when disabled, they will be excluded. So this feature 552 changes between "opt-in" (feature disabled) and 553 "opt-out" (feature enabled) modes. 554<p> 555 Default value is enabled, meaning that non-annotated 556 properties are included in all views if there is no 557 <A HREF="http://fasterxml.github.com/jackson-annotations/javadoc/2.1.0/com/fasterxml/jackson/annotation/JsonView.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation"><CODE>JsonView</CODE></A> annotation. 558<p> 559 Feature is enabled by default. 560<P> 561<DL> 562</DL> 563</DL> 564<HR> 565 566<A NAME="SORT_PROPERTIES_ALPHABETICALLY"><!-- --></A><H3> 567SORT_PROPERTIES_ALPHABETICALLY</H3> 568<PRE> 569public static final <A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</A> <B>SORT_PROPERTIES_ALPHABETICALLY</B></PRE> 570<DL> 571<DD>Feature that defines default property serialization order used 572 for POJO fields (note: does <b>not</b> apply to <A HREF="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><CODE>Map</CODE></A> 573 serialization!): 574 if enabled, default ordering is alphabetic (similar to 575 how <A HREF="http://fasterxml.github.com/jackson-annotations/javadoc/2.1.0/com/fasterxml/jackson/annotation/JsonPropertyOrder.html?is-external=true#alphabetic()" title="class or interface in com.fasterxml.jackson.annotation"><CODE>JsonPropertyOrder.alphabetic()</CODE></A> 576 works); if disabled, order is unspecified (based on what JDK gives 577 us, which may be declaration order, but is not guaranteed). 578<p> 579 Note that this is just the default behavior, and can be overridden by 580 explicit overrides in classes. 581<p> 582 Feature is disabled by default. 583<P> 584<DL> 585</DL> 586</DL> 587<HR> 588 589<A NAME="USE_WRAPPER_NAME_AS_PROPERTY_NAME"><!-- --></A><H3> 590USE_WRAPPER_NAME_AS_PROPERTY_NAME</H3> 591<PRE> 592public static final <A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</A> <B>USE_WRAPPER_NAME_AS_PROPERTY_NAME</B></PRE> 593<DL> 594<DD>Feature that can be enabled to make property names be 595 overridden by wrapper name (usually detected with annotations 596 as defined by <A HREF="../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.html#findWrapperName(com.fasterxml.jackson.databind.introspect.Annotated)"><CODE>AnnotationIntrospector.findWrapperName(com.fasterxml.jackson.databind.introspect.Annotated)</CODE></A>. 597 If enabled, all properties that have associated non-empty Wrapper 598 name will use that wrapper name instead of property name. 599 If disabled, wrapper name is only used for wrapping (if anything). 600<p> 601 Feature is disabled by default. 602<P> 603<DL> 604<DT><B>Since:</B></DT> 605 <DD>2.1</DD> 606</DL> 607</DL> 608 609<!-- ============ METHOD DETAIL ========== --> 610 611<A NAME="method_detail"><!-- --></A> 612<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 613<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 614<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 615<B>Method Detail</B></FONT></TH> 616</TR> 617</TABLE> 618 619<A NAME="values()"><!-- --></A><H3> 620values</H3> 621<PRE> 622public static <A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</A>[] <B>values</B>()</PRE> 623<DL> 624<DD>Returns an array containing the constants of this enum type, in 625the order they are declared. This method may be used to iterate 626over the constants as follows: 627<pre> 628for (MapperFeature c : MapperFeature.values()) 629 System.out.println(c); 630</pre> 631<P> 632<DD><DL> 633</DL> 634</DD> 635<DD><DL> 636 637<DT><B>Returns:</B><DD>an array containing the constants of this enum type, in 638the order they are declared</DL> 639</DD> 640</DL> 641<HR> 642 643<A NAME="valueOf(java.lang.String)"><!-- --></A><H3> 644valueOf</H3> 645<PRE> 646public static <A HREF="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</A> <B>valueOf</B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE> 647<DL> 648<DD>Returns the enum constant of this type with the specified name. 649The string must match <I>exactly</I> an identifier used to declare an 650enum constant in this type. (Extraneous whitespace characters are 651not permitted.) 652<P> 653<DD><DL> 654</DL> 655</DD> 656<DD><DL> 657<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the enum constant to be returned. 658<DT><B>Returns:</B><DD>the enum constant with the specified name 659<DT><B>Throws:</B> 660<DD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if this enum type has no constant 661with the specified name 662<DD><CODE><A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</A></CODE> - if the argument is null</DL> 663</DD> 664</DL> 665<HR> 666 667<A NAME="enabledByDefault()"><!-- --></A><H3> 668enabledByDefault</H3> 669<PRE> 670public boolean <B>enabledByDefault</B>()</PRE> 671<DL> 672<DD><B>Description copied from interface: <CODE><A HREF="../../../../com/fasterxml/jackson/databind/cfg/ConfigFeature.html#enabledByDefault()">ConfigFeature</A></CODE></B></DD> 673<DD>Accessor for checking whether this feature is enabled by default. 674<P> 675<DD><DL> 676<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/fasterxml/jackson/databind/cfg/ConfigFeature.html#enabledByDefault()">enabledByDefault</A></CODE> in interface <CODE><A HREF="../../../../com/fasterxml/jackson/databind/cfg/ConfigFeature.html" title="interface in com.fasterxml.jackson.databind.cfg">ConfigFeature</A></CODE></DL> 677</DD> 678<DD><DL> 679</DL> 680</DD> 681</DL> 682<HR> 683 684<A NAME="getMask()"><!-- --></A><H3> 685getMask</H3> 686<PRE> 687public int <B>getMask</B>()</PRE> 688<DL> 689<DD><B>Description copied from interface: <CODE><A HREF="../../../../com/fasterxml/jackson/databind/cfg/ConfigFeature.html#getMask()">ConfigFeature</A></CODE></B></DD> 690<DD>Returns bit mask for this feature instance 691<P> 692<DD><DL> 693<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../com/fasterxml/jackson/databind/cfg/ConfigFeature.html#getMask()">getMask</A></CODE> in interface <CODE><A HREF="../../../../com/fasterxml/jackson/databind/cfg/ConfigFeature.html" title="interface in com.fasterxml.jackson.databind.cfg">ConfigFeature</A></CODE></DL> 694</DD> 695<DD><DL> 696</DL> 697</DD> 698</DL> 699<!-- ========= END OF CLASS DATA ========= --> 700<HR> 701 702 703<!-- ======= START OF BOTTOM NAVBAR ====== --> 704<A NAME="navbar_bottom"><!-- --></A> 705<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 706<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 707<TR> 708<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 709<A NAME="navbar_bottom_firstrow"><!-- --></A> 710<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 711 <TR ALIGN="center" VALIGN="top"> 712 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 713 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 714 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 715 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MapperFeature.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 716 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 717 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 718 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 719 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 720 </TR> 721</TABLE> 722</TD> 723<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 724</EM> 725</TD> 726</TR> 727 728<TR> 729<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 730 <A HREF="../../../../com/fasterxml/jackson/databind/KeyDeserializer.None.html" title="class in com.fasterxml.jackson.databind"><B>PREV CLASS</B></A> 731 <A HREF="../../../../com/fasterxml/jackson/databind/MappingIterator.html" title="class in com.fasterxml.jackson.databind"><B>NEXT CLASS</B></A></FONT></TD> 732<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 733 <A HREF="../../../../index.html?com/fasterxml/jackson/databind/MapperFeature.html" target="_top"><B>FRAMES</B></A> 734 <A HREF="MapperFeature.html" target="_top"><B>NO FRAMES</B></A> 735 <SCRIPT type="text/javascript"> 736 <!-- 737 if(window==top) { 738 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 739 } 740 //--> 741</SCRIPT> 742<NOSCRIPT> 743 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 744</NOSCRIPT> 745 746 747</FONT></TD> 748</TR> 749<TR> 750<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 751 SUMMARY: NESTED | <A HREF="#enum_constant_summary">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_summary">METHOD</A></FONT></TD> 752<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 753DETAIL: <A HREF="#enum_constant_detail">ENUM CONSTANTS</A> | FIELD | <A HREF="#method_detail">METHOD</A></FONT></TD> 754</TR> 755</TABLE> 756<A NAME="skip-navbar_bottom"></A> 757<!-- ======== END OF BOTTOM NAVBAR ======= --> 758 759<HR> 760Copyright © 2012 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved. 761</BODY> 762</HTML> 763
