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:30 PDT 2012 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8com.fasterxml.jackson.annotation (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="com.fasterxml.jackson.annotation (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="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.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 PREV PACKAGE 68 NEXT PACKAGE</FONT></TD> 69<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 70 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/package-summary.html" target="_top"><B>FRAMES</B></A> 71 <A HREF="package-summary.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</TABLE> 87<A NAME="skip-navbar_top"></A> 88<!-- ========= END OF TOP NAVBAR ========= --> 89 90<HR> 91<H2> 92Package com.fasterxml.jackson.annotation 93</H2> 94Public core annotations, most of which are used to configure how 95 Data Mapping/Binding works. 96<P> 97<B>See:</B> 98<BR> 99 <A HREF="#package_description"><B>Description</B></A> 100<P> 101 102<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 103<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 104<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 105<B>Class Summary</B></FONT></TH> 106</TR> 107<TR BGCOLOR="white" CLASS="TableRowColor"> 108<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonFormat.Value.html" title="class in com.fasterxml.jackson.annotation">JsonFormat.Value</A></B></TD> 109<TD>Helper class used to contain information from a single <A HREF="../../../../com/fasterxml/jackson/annotation/JsonFormat.html" title="annotation in com.fasterxml.jackson.annotation"><CODE>JsonFormat</CODE></A> 110 annotation.</TD> 111</TR> 112<TR BGCOLOR="white" CLASS="TableRowColor"> 113<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.None.html" title="class in com.fasterxml.jackson.annotation">JsonTypeInfo.None</A></B></TD> 114<TD>This marker class that is only to be used with <code>defaultImpl</code> 115 annotation property, to indicate that there is no default implementation 116 specified.</TD> 117</TR> 118<TR BGCOLOR="white" CLASS="TableRowColor"> 119<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerator<T></A></B></TD> 120<TD>Definition of API used for constructing Object Identifiers 121 (as annotated using <A HREF="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation"><CODE>JsonIdentityInfo</CODE></A>).</TD> 122</TR> 123<TR BGCOLOR="white" CLASS="TableRowColor"> 124<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerator.IdKey</A></B></TD> 125<TD>Simple key class that can be used as a key for 126 ObjectId-to-POJO mappings, when multiple ObjectId types 127 and scopes are used.</TD> 128</TR> 129<TR BGCOLOR="white" CLASS="TableRowColor"> 130<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators</A></B></TD> 131<TD>Container class for standard <A HREF="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.html" title="class in com.fasterxml.jackson.annotation"><CODE>ObjectIdGenerator</CODE></A> implementations.</TD> 132</TR> 133<TR BGCOLOR="white" CLASS="TableRowColor"> 134<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.IntSequenceGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.IntSequenceGenerator</A></B></TD> 135<TD>Simple sequence-number based generator, which uses basic Java 136 <code>int</code>s (starting with value 1) as Object Identifiers.</TD> 137</TR> 138<TR BGCOLOR="white" CLASS="TableRowColor"> 139<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.None.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.None</A></B></TD> 140<TD>Abstract marker class used to allow explicitly specifying 141 that no generator is used; which also implies that no 142 Object Id is to be included or used.</TD> 143</TR> 144<TR BGCOLOR="white" CLASS="TableRowColor"> 145<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.PropertyGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.PropertyGenerator</A></B></TD> 146<TD>Abstract place-holder class which is used to denote case 147 where Object Identifier to use comes from a POJO property 148 (getter method or field).</TD> 149</TR> 150<TR BGCOLOR="white" CLASS="TableRowColor"> 151<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.UUIDGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.UUIDGenerator</A></B></TD> 152<TD>Implementation that just uses <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util"><CODE>UUID</CODE></A>s as reliably 153 unique identifiers: downside is that resulting String is 154 36 characters long.</TD> 155</TR> 156</TABLE> 157 158 159<P> 160 161<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 162<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 163<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 164<B>Enum Summary</B></FONT></TH> 165</TR> 166<TR BGCOLOR="white" CLASS="TableRowColor"> 167<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</A></B></TD> 168<TD>Enumeration for possible visibility thresholds (minimum visibility) 169 that can be used to limit which methods (and fields) are 170 auto-detected.</TD> 171</TR> 172<TR BGCOLOR="white" CLASS="TableRowColor"> 173<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonFormat.Shape.html" title="enum in com.fasterxml.jackson.annotation">JsonFormat.Shape</A></B></TD> 174<TD>Value enumeration used for indicating preferred Shape; translates 175 loosely to JSON types, with some extra values to indicate less precise 176 choices (i.e.</TD> 177</TR> 178<TR BGCOLOR="white" CLASS="TableRowColor"> 179<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</A></B></TD> 180<TD>Enumeration used with <A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.html" title="annotation in com.fasterxml.jackson.annotation"><CODE>JsonInclude</CODE></A> 181 to define which properties 182 of Java Beans are to be included in serialization.</TD> 183</TR> 184<TR BGCOLOR="white" CLASS="TableRowColor"> 185<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.As.html" title="enum in com.fasterxml.jackson.annotation">JsonTypeInfo.As</A></B></TD> 186<TD>Definition of standard type inclusion mechanisms for type metadata.</TD> 187</TR> 188<TR BGCOLOR="white" CLASS="TableRowColor"> 189<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.Id.html" title="enum in com.fasterxml.jackson.annotation">JsonTypeInfo.Id</A></B></TD> 190<TD>Definition of different type identifiers that can be included in JSON 191 during serialization, and used for deserialization.</TD> 192</TR> 193<TR BGCOLOR="white" CLASS="TableRowColor"> 194<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/PropertyAccessor.html" title="enum in com.fasterxml.jackson.annotation">PropertyAccessor</A></B></TD> 195<TD>Enumeration used to define kinds of elements (called "property accessors") 196 that annotations like <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html" title="annotation in com.fasterxml.jackson.annotation"><CODE>JsonAutoDetect</CODE></A> apply to.</TD> 197</TR> 198</TABLE> 199 200 201<P> 202 203<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 204<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 205<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 206<B>Annotation Types Summary</B></FONT></TH> 207</TR> 208<TR BGCOLOR="white" CLASS="TableRowColor"> 209<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JacksonAnnotation.html" title="annotation in com.fasterxml.jackson.annotation">JacksonAnnotation</A></B></TD> 210<TD>Meta-annotation (annotations used on other annotations) 211 used for marking all annotations that are 212 part of Jackson package.</TD> 213</TR> 214<TR BGCOLOR="white" CLASS="TableRowColor"> 215<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JacksonAnnotationsInside.html" title="annotation in com.fasterxml.jackson.annotation">JacksonAnnotationsInside</A></B></TD> 216<TD>Meta-annotation (annotations used on other annotations) 217 used for indicating that instead of using target annotation 218 (annotation annotated with this annotation), 219 Jackson should use meta-annotations it has.</TD> 220</TR> 221<TR BGCOLOR="white" CLASS="TableRowColor"> 222<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JacksonInject.html" title="annotation in com.fasterxml.jackson.annotation">JacksonInject</A></B></TD> 223<TD>Jackson-specific annotation used for indicating that value of 224 annotated property will be "injected", i.e.</TD> 225</TR> 226<TR BGCOLOR="white" CLASS="TableRowColor"> 227<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonAnyGetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonAnyGetter</A></B></TD> 228<TD>Marker annotation that can be used to define a non-static, 229 no-argument method or member field as something of a reverse of 230 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html" title="annotation in com.fasterxml.jackson.annotation"><CODE>JsonAnySetter</CODE></A> method; basically being used like a 231 getter but such that contents of the returned Map (type <b>must</b> be 232 <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><CODE>Map</CODE></A>) are serialized as if they were actual properties 233 of the bean that contains method/field with this annotations.</TD> 234</TR> 235<TR BGCOLOR="white" CLASS="TableRowColor"> 236<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonAnySetter</A></B></TD> 237<TD>Marker annotation that can be used to define a non-static, 238 two-argument method (first argument name of property, second value 239 to set), to be used as a "fallback" handler 240 for all otherwise unrecognized properties found from JSON content.</TD> 241</TR> 242<TR BGCOLOR="white" CLASS="TableRowColor"> 243<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html" title="annotation in com.fasterxml.jackson.annotation">JsonAutoDetect</A></B></TD> 244<TD>Class annotation that can be used to define which kinds of Methods 245 are to be detected by auto-detection.</TD> 246</TR> 247<TR BGCOLOR="white" CLASS="TableRowColor"> 248<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonBackReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonBackReference</A></B></TD> 249<TD>Annotation used to indicate that associated property is part of 250 two-way linkage between fields; and that its role is "child" (or "back") link.</TD> 251</TR> 252<TR BGCOLOR="white" CLASS="TableRowColor"> 253<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonCreator.html" title="annotation in com.fasterxml.jackson.annotation">JsonCreator</A></B></TD> 254<TD>Marker annotation that can be used to define constructors and factory 255 methods as one to use for instantiating new instances of the associated 256 class.</TD> 257</TR> 258<TR BGCOLOR="white" CLASS="TableRowColor"> 259<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonFilter.html" title="annotation in com.fasterxml.jackson.annotation">JsonFilter</A></B></TD> 260<TD>Annotation used to indicate which logical filter is to be used 261 for filtering out properties of type (class) annotated; 262 association made by this annotation declaring ids of filters, 263 and <code>com.fasterxml.jackson.databind.ObjectMapper</code> (or objects 264 it delegates to) providing matching filters by id.</TD> 265</TR> 266<TR BGCOLOR="white" CLASS="TableRowColor"> 267<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonFormat.html" title="annotation in com.fasterxml.jackson.annotation">JsonFormat</A></B></TD> 268<TD>General-purpose annotation used for configuring details of how 269 values of properties are to be serialized.</TD> 270</TR> 271<TR BGCOLOR="white" CLASS="TableRowColor"> 272<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonGetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonGetter</A></B></TD> 273<TD>Marker annotation that can be used to define a non-static, 274 no-argument value-returning (non-void) method to be used as a "getter" 275 for a logical property.</TD> 276</TR> 277<TR BGCOLOR="white" CLASS="TableRowColor"> 278<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation">JsonIdentityInfo</A></B></TD> 279<TD>Annotation used for indicating that values of annotated type 280 or property should be serializing so that instances either 281 contain additional object identifier (in addition actual object 282 properties), or as a reference that consists of an object id 283 that refers to a full serialization.</TD> 284</TR> 285<TR BGCOLOR="white" CLASS="TableRowColor"> 286<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonIdentityReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonIdentityReference</A></B></TD> 287<TD>Optional annotation that can be used for customizing details of a reference 288 to Objects for which "Object Identity" is enabled (see <A HREF="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation"><CODE>JsonIdentityInfo</CODE></A>).</TD> 289</TR> 290<TR BGCOLOR="white" CLASS="TableRowColor"> 291<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonIgnore.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnore</A></B></TD> 292<TD>Marker annotation that indicates that the annotated method or field is to be 293 ignored by introspection-based 294 serialization and deserialization functionality.</TD> 295</TR> 296<TR BGCOLOR="white" CLASS="TableRowColor"> 297<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonIgnoreProperties.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnoreProperties</A></B></TD> 298<TD>Annotation that can be used to either suppress serialization of 299 properties (during serialization), or ignore processing of 300 JSON properties read (during deserialization).</TD> 301</TR> 302<TR BGCOLOR="white" CLASS="TableRowColor"> 303<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonIgnoreType.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnoreType</A></B></TD> 304<TD>Marker annotation that indicates that all properties of annotated 305 type are to be ignored during serialization and deserialization.</TD> 306</TR> 307<TR BGCOLOR="white" CLASS="TableRowColor"> 308<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.html" title="annotation in com.fasterxml.jackson.annotation">JsonInclude</A></B></TD> 309<TD>Annotation used to indicate when value of the annotated property (when 310 used for a field, method or constructor parameter), or all 311 properties of the annotated class, is to be serialized.</TD> 312</TR> 313<TR BGCOLOR="white" CLASS="TableRowColor"> 314<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonManagedReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonManagedReference</A></B></TD> 315<TD>Annotation used to indicate that annotated property is part of 316 two-way linkage between fields; and that its role is "parent" (or "forward") link.</TD> 317</TR> 318<TR BGCOLOR="white" CLASS="TableRowColor"> 319<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation">JsonProperty</A></B></TD> 320<TD>Marker annotation that can be used to define a non-static 321 method as a "setter" or "getter" for a logical property 322 (depending on its signature), 323 or non-static object field to be used (serialized, deserialized) as 324 a logical property.</TD> 325</TR> 326<TR BGCOLOR="white" CLASS="TableRowColor"> 327<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonPropertyOrder.html" title="annotation in com.fasterxml.jackson.annotation">JsonPropertyOrder</A></B></TD> 328<TD>Annotation that can be used to define ordering (possibly partial) to use 329 when serializing object properties.</TD> 330</TR> 331<TR BGCOLOR="white" CLASS="TableRowColor"> 332<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonRawValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonRawValue</A></B></TD> 333<TD>Marker annotation that indicates that the annotated method 334 or field should be serialized by including literal String value 335 of the property as is, without quoting of characters.</TD> 336</TR> 337<TR BGCOLOR="white" CLASS="TableRowColor"> 338<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonRootName.html" title="annotation in com.fasterxml.jackson.annotation">JsonRootName</A></B></TD> 339<TD>Annotation similar to <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/javax/xml/bind.annotation.XmlRootElement.html?is-external=true" title="class or interface in javax.xml"><CODE>bind.annotation.XmlRootElement</CODE></A>, 340 used to indicate name to use for root-level wrapping, if wrapping is 341 enabled.</TD> 342</TR> 343<TR BGCOLOR="white" CLASS="TableRowColor"> 344<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonSetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonSetter</A></B></TD> 345<TD>Marker annotation that can be used to define a non-static, 346 single-argument method to be used as a "setter" for a logical property 347 as an alternative to recommended 348 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><CODE>JsonProperty</CODE></A> annotation (which was introduced in version 1.1).</TD> 349</TR> 350<TR BGCOLOR="white" CLASS="TableRowColor"> 351<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonSubTypes.html" title="annotation in com.fasterxml.jackson.annotation">JsonSubTypes</A></B></TD> 352<TD>Annotation used with <A HREF="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.html" title="annotation in com.fasterxml.jackson.annotation"><CODE>JsonTypeInfo</CODE></A> to indicate sub types of serializable 353 polymorphic types, and to associate logical names used within JSON content 354 (which is more portable than using physical Java class names).</TD> 355</TR> 356<TR BGCOLOR="white" CLASS="TableRowColor"> 357<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonSubTypes.Type.html" title="annotation in com.fasterxml.jackson.annotation">JsonSubTypes.Type</A></B></TD> 358<TD>Definition of a subtype, along with optional name.</TD> 359</TR> 360<TR BGCOLOR="white" CLASS="TableRowColor"> 361<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonTypeId.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeId</A></B></TD> 362<TD>Marker annotation that can be used on a property accessor 363 (field, getter or setter, constructor parameter) to indicate that 364 the property is to contain type id to use when including 365 polymorphic type information.</TD> 366</TR> 367<TR BGCOLOR="white" CLASS="TableRowColor"> 368<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeInfo</A></B></TD> 369<TD>Annotation used for configuring details of if and how type information is 370 used with JSON serialization and deserialization, to preserve information 371 about actual class of Object instances.</TD> 372</TR> 373<TR BGCOLOR="white" CLASS="TableRowColor"> 374<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonTypeName.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeName</A></B></TD> 375<TD>Annotation used for binding logical name that the annotated class 376 has.</TD> 377</TR> 378<TR BGCOLOR="white" CLASS="TableRowColor"> 379<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonUnwrapped.html" title="annotation in com.fasterxml.jackson.annotation">JsonUnwrapped</A></B></TD> 380<TD>Annotation used to indicate that a property should be serialized 381 "unwrapped"; that is, if it would be serialized as JSON Object, its 382 properties are instead included as properties of its containing 383 Object.</TD> 384</TR> 385<TR BGCOLOR="white" CLASS="TableRowColor"> 386<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonValue</A></B></TD> 387<TD>Marker annotation similar to 388 <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/javax/xml/bind.annotation.XmlValue.html?is-external=true" title="class or interface in javax.xml"><CODE>bind.annotation.XmlValue</CODE></A> 389 that indicates that results of the annotated "getter" method 390 (which means signature must be that of getters; non-void return 391 type, no args) is to be used as the single value to serialize 392 for the instance.</TD> 393</TR> 394<TR BGCOLOR="white" CLASS="TableRowColor"> 395<TD WIDTH="15%"><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonView.html" title="annotation in com.fasterxml.jackson.annotation">JsonView</A></B></TD> 396<TD>Annotation used for indicating view(s) that the property 397 that is defined by method or field annotated is part of.</TD> 398</TR> 399</TABLE> 400 401 402<P> 403<A NAME="package_description"><!-- --></A><H2> 404Package com.fasterxml.jackson.annotation Description 405</H2> 406 407<P> 408Public core annotations, most of which are used to configure how 409 Data Mapping/Binding works. Annotations in this package can only 410 have dependencies to non-annotation classes in Core package; 411 annotations that have dependencies to Mapper classes are included 412 in Mapper module (under <code>org.codehaus.jackson.map.annotate</code>). 413 Also contains parameter types (mostly enums) needed by annotations. 414<p> 415 Note that prior versions (1.x) contained these annotations within 416 'core' jar, as part of Streaming API. 417<P> 418 419<P> 420<DL> 421</DL> 422<HR> 423 424 425<!-- ======= START OF BOTTOM NAVBAR ====== --> 426<A NAME="navbar_bottom"><!-- --></A> 427<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 428<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 429<TR><td rowspan='3'><script type="text/javascript"><!-- 430google_ad_client = "pub-1467773697956887"; 431/* Jackson-ad-small */ 432google_ad_slot = "6699487946"; 433google_ad_width = 234; 434google_ad_height = 60; 435//--> 436</script> 437<script type="text/javascript" 438src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> 439</script> 440<!-- GA --> 441<script type="text/javascript"> 442var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); 443document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); 444</script> 445<script type="text/javascript"> 446try { 447var pageTracker = _gat._getTracker("UA-140287-6"); 448pageTracker._trackPageview(); 449} catch(err) {} 450</script> 451</td> 452<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 453<A NAME="navbar_bottom_firstrow"><!-- --></A> 454<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 455 <TR ALIGN="center" VALIGN="top"> 456 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 457 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> 458 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 459 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 460 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 461 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 462 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 463 </TR> 464</TABLE> 465</TD> 466<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 467</EM> 468</TD> 469</TR> 470 471<TR> 472<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 473 PREV PACKAGE 474 NEXT PACKAGE</FONT></TD> 475<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 476 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/package-summary.html" target="_top"><B>FRAMES</B></A> 477 <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> 478 <SCRIPT type="text/javascript"> 479 <!-- 480 if(window==top) { 481 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 482 } 483 //--> 484</SCRIPT> 485<NOSCRIPT> 486 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 487</NOSCRIPT> 488 489 490</FONT></TD> 491</TR> 492</TABLE> 493<A NAME="skip-navbar_bottom"></A> 494<!-- ======== END OF BOTTOM NAVBAR ======= --> 495 496<HR> 497Copyright © 2012 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved. 498</BODY> 499</HTML> 500