1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!-- NewPage --> 3<html lang="en"> 4<head> 5<!-- Generated by javadoc (version 1.7.0_79) on Sat Jan 09 21:46:11 PST 2016 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>com.fasterxml.jackson.annotation (Jackson-annotations 2.7.0 API)</title> 8<meta name="date" content="2016-01-09"> 9<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> 10</head> 11<body> 12<script type="text/javascript"><!-- 13 if (location.href.indexOf('is-external=true') == -1) { 14 parent.document.title="com.fasterxml.jackson.annotation (Jackson-annotations 2.7.0 API)"; 15 } 16//--> 17</script> 18<noscript> 19<div>JavaScript is disabled on your browser.</div> 20</noscript> 21<!-- ========= START OF TOP NAVBAR ======= --> 22<div class="topNav"><a name="navbar_top"> 23<!-- --> 24</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> 25<!-- --> 26</a> 27<ul class="navList" title="Navigation"> 28<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 29<li>Class</li> 30<li><a href="package-use.html">Use</a></li> 31<li><a href="package-tree.html">Tree</a></li> 32<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 33<li><a href="../../../../index-all.html">Index</a></li> 34<li><a href="../../../../help-doc.html">Help</a></li> 35</ul> 36</div> 37<div class="subNav"> 38<ul class="navList"> 39<li>Prev Package</li> 40<li>Next Package</li> 41</ul> 42<ul class="navList"> 43<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/package-summary.html" target="_top">Frames</a></li> 44<li><a href="package-summary.html" target="_top">No Frames</a></li> 45</ul> 46<ul class="navList" id="allclasses_navbar_top"> 47<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 48</ul> 49<div> 50<script type="text/javascript"><!-- 51 allClassesLink = document.getElementById("allclasses_navbar_top"); 52 if(window==top) { 53 allClassesLink.style.display = "block"; 54 } 55 else { 56 allClassesLink.style.display = "none"; 57 } 58 //--> 59</script> 60</div> 61<a name="skip-navbar_top"> 62<!-- --> 63</a></div> 64<!-- ========= END OF TOP NAVBAR ========= --> 65<div class="header"> 66<h1 title="Package" class="title">Package com.fasterxml.jackson.annotation</h1> 67<div class="docSummary"> 68<div class="block">Public core annotations, most of which are used to configure how 69 Data Mapping/Binding works.</div> 70</div> 71<p>See: <a href="#package_description">Description</a></p> 72</div> 73<div class="contentContainer"> 74<ul class="blockList"> 75<li class="blockList"> 76<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> 77<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> 78<tr> 79<th class="colFirst" scope="col">Interface</th> 80<th class="colLast" scope="col">Description</th> 81</tr> 82<tbody> 83<tr class="altColor"> 84<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JacksonAnnotationValue.html" title="interface in com.fasterxml.jackson.annotation">JacksonAnnotationValue</a><A extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>></td> 85<td class="colLast"> 86<div class="block">Marker interface used by value classes like <a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Value.html" title="class in com.fasterxml.jackson.annotation"><code>JsonFormat.Value</code></a> that are used 87 to contain information from one of Jackson annotations, and can be directly 88 instantiated from those annotations, as well as programmatically constructed 89 and possibly merged.</div> 90</td> 91</tr> 92<tr class="rowColor"> 93<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdResolver.html" title="interface in com.fasterxml.jackson.annotation">ObjectIdResolver</a></td> 94<td class="colLast"> 95<div class="block">Definition of API used for resolving actual Java object from 96 Object Identifiers (as annotated using <a href="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonIdentityInfo</code></a>).</div> 97</td> 98</tr> 99</tbody> 100</table> 101</li> 102<li class="blockList"> 103<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> 104<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> 105<tr> 106<th class="colFirst" scope="col">Class</th> 107<th class="colLast" scope="col">Description</th> 108</tr> 109<tbody> 110<tr class="altColor"> 111<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Features.html" title="class in com.fasterxml.jackson.annotation">JsonFormat.Features</a></td> 112<td class="colLast"> 113<div class="block">Helper class that encapsulates information equivalent to <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang"><code>Boolean</code></a> 114 valued <a href="http://docs.oracle.com/javase/6/docs/api/java/util/EnumMap.html?is-external=true" title="class or interface in java.util"><code>EnumMap</code></a>.</div> 115</td> 116</tr> 117<tr class="rowColor"> 118<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Value.html" title="class in com.fasterxml.jackson.annotation">JsonFormat.Value</a></td> 119<td class="colLast"> 120<div class="block">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> 121 annotation.</div> 122</td> 123</tr> 124<tr class="altColor"> 125<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Value.html" title="class in com.fasterxml.jackson.annotation">JsonInclude.Value</a></td> 126<td class="colLast"> 127<div class="block">Helper class used to contain information from a single <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonInclude</code></a> 128 annotation.</div> 129</td> 130</tr> 131<tr class="rowColor"> 132<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.None.html" title="class in com.fasterxml.jackson.annotation">JsonTypeInfo.None</a></td> 133<td class="colLast">Deprecated 134<div class="block"><i>Since 2.5, use <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang"><code>Void</code></a> instead.</i></div> 135</td> 136</tr> 137<tr class="altColor"> 138<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerator</a><T></td> 139<td class="colLast"> 140<div class="block">Definition of API used for constructing Object Identifiers 141 (as annotated using <a href="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonIdentityInfo</code></a>).</div> 142</td> 143</tr> 144<tr class="rowColor"> 145<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerator.IdKey</a></td> 146<td class="colLast"> 147<div class="block">Simple key class that can be used as a key for 148 ObjectId-to-POJO mappings, when multiple ObjectId types 149 and scopes are used.</div> 150</td> 151</tr> 152<tr class="altColor"> 153<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators</a></td> 154<td class="colLast"> 155<div class="block">Container class for standard <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerator</code></a> implementations: 156 157 <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.IntSequenceGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerators.IntSequenceGenerator</code></a> 158 <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.PropertyGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerators.PropertyGenerator</code></a> 159 <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.StringIdGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerators.StringIdGenerator</code></a> (since 2.7) 160 <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.UUIDGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerators.UUIDGenerator</code></a> 161</div> 162</td> 163</tr> 164<tr class="rowColor"> 165<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.IntSequenceGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.IntSequenceGenerator</a></td> 166<td class="colLast"> 167<div class="block">Simple sequence-number based generator, which uses basic Java 168 <code>int</code>s (starting with value 1) as Object Identifiers.</div> 169</td> 170</tr> 171<tr class="altColor"> 172<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.None.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.None</a></td> 173<td class="colLast"> 174<div class="block">Abstract marker class used to allow explicitly specifying 175 that no generator is used; which also implies that no 176 Object Id is to be included or used.</div> 177</td> 178</tr> 179<tr class="rowColor"> 180<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.PropertyGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.PropertyGenerator</a></td> 181<td class="colLast"> 182<div class="block">Abstract place-holder class which is used to denote case 183 where Object Identifier to use comes from a POJO property 184 (getter method or field).</div> 185</td> 186</tr> 187<tr class="altColor"> 188<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.StringIdGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.StringIdGenerator</a></td> 189<td class="colLast"> 190<div class="block">Implementation that will accept arbitrary (but unique) String Ids on 191 deserialization, and (by default) use random UUID generation similar 192 to <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.UUIDGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerators.UUIDGenerator</code></a> for generation ids.</div> 193</td> 194</tr> 195<tr class="rowColor"> 196<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.UUIDGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.UUIDGenerator</a></td> 197<td class="colLast"> 198<div class="block">Implementation that just uses <a href="http://docs.oracle.com/javase/6/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util"><code>UUID</code></a>s as reliably 199 unique identifiers: downside is that resulting String is 200 36 characters long.</div> 201</td> 202</tr> 203<tr class="altColor"> 204<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/SimpleObjectIdResolver.html" title="class in com.fasterxml.jackson.annotation">SimpleObjectIdResolver</a></td> 205<td class="colLast"> 206<div class="block">Simple implementation of <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdResolver.html" title="interface in com.fasterxml.jackson.annotation"><code>ObjectIdResolver</code></a></div> 207</td> 208</tr> 209</tbody> 210</table> 211</li> 212<li class="blockList"> 213<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> 214<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> 215<tr> 216<th class="colFirst" scope="col">Enum</th> 217<th class="colLast" scope="col">Description</th> 218</tr> 219<tbody> 220<tr class="altColor"> 221<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</a></td> 222<td class="colLast"> 223<div class="block">Enumeration for possible visibility thresholds (minimum visibility) 224 that can be used to limit which methods (and fields) are 225 auto-detected.</div> 226</td> 227</tr> 228<tr class="rowColor"> 229<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html" title="enum in com.fasterxml.jackson.annotation">JsonCreator.Mode</a></td> 230<td class="colLast"> </td> 231</tr> 232<tr class="altColor"> 233<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Feature.html" title="enum in com.fasterxml.jackson.annotation">JsonFormat.Feature</a></td> 234<td class="colLast"> 235<div class="block">Set of features that can be enabled/disabled for property annotated.</div> 236</td> 237</tr> 238<tr class="rowColor"> 239<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Shape.html" title="enum in com.fasterxml.jackson.annotation">JsonFormat.Shape</a></td> 240<td class="colLast"> 241<div class="block">Value enumeration used for indicating preferred Shape; translates 242 loosely to JSON types, with some extra values to indicate less precise 243 choices (i.e.</div> 244</td> 245</tr> 246<tr class="altColor"> 247<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a></td> 248<td class="colLast"> 249<div class="block">Enumeration used with <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonInclude</code></a> 250 to define which properties 251 of Java Beans are to be included in serialization.</div> 252</td> 253</tr> 254<tr class="rowColor"> 255<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation">JsonProperty.Access</a></td> 256<td class="colLast"> 257<div class="block">Various options for <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html#access()"><code>JsonProperty.access()</code></a> property, specifying how property 258 may be accessed during serialization ("read") and deserialization ("write") 259 (note that the direction of read and write is from perspective of the property, 260 not from external data format: this may be confusing in some contexts).</div> 261</td> 262</tr> 263<tr class="altColor"> 264<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.As.html" title="enum in com.fasterxml.jackson.annotation">JsonTypeInfo.As</a></td> 265<td class="colLast"> 266<div class="block">Definition of standard type inclusion mechanisms for type metadata.</div> 267</td> 268</tr> 269<tr class="rowColor"> 270<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.Id.html" title="enum in com.fasterxml.jackson.annotation">JsonTypeInfo.Id</a></td> 271<td class="colLast"> 272<div class="block">Definition of different type identifiers that can be included in JSON 273 during serialization, and used for deserialization.</div> 274</td> 275</tr> 276<tr class="altColor"> 277<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html" title="enum in com.fasterxml.jackson.annotation">OptBoolean</a></td> 278<td class="colLast"> 279<div class="block">Optional Boolean value ("nullean").</div> 280</td> 281</tr> 282<tr class="rowColor"> 283<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/PropertyAccessor.html" title="enum in com.fasterxml.jackson.annotation">PropertyAccessor</a></td> 284<td class="colLast"> 285<div class="block">Enumeration used to define kinds of elements (called "property accessors") 286 that annotations like <a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonAutoDetect</code></a> apply to.</div> 287</td> 288</tr> 289</tbody> 290</table> 291</li> 292<li class="blockList"> 293<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation"> 294<caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption> 295<tr> 296<th class="colFirst" scope="col">Annotation Type</th> 297<th class="colLast" scope="col">Description</th> 298</tr> 299<tbody> 300<tr class="altColor"> 301<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JacksonAnnotation.html" title="annotation in com.fasterxml.jackson.annotation">JacksonAnnotation</a></td> 302<td class="colLast"> 303<div class="block">Meta-annotation (annotations used on other annotations) 304 used for marking all annotations that are 305 part of Jackson package.</div> 306</td> 307</tr> 308<tr class="rowColor"> 309<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JacksonAnnotationsInside.html" title="annotation in com.fasterxml.jackson.annotation">JacksonAnnotationsInside</a></td> 310<td class="colLast"> 311<div class="block">Meta-annotation (annotations used on other annotations) 312 used for indicating that instead of using target annotation 313 (annotation annotated with this annotation), 314 Jackson should use meta-annotations it has.</div> 315</td> 316</tr> 317<tr class="altColor"> 318<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JacksonInject.html" title="annotation in com.fasterxml.jackson.annotation">JacksonInject</a></td> 319<td class="colLast"> 320<div class="block">Jackson-specific annotation used for indicating that value of 321 annotated property will be "injected", i.e.</div> 322</td> 323</tr> 324<tr class="rowColor"> 325<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAnyGetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonAnyGetter</a></td> 326<td class="colLast"> 327<div class="block">Marker annotation that can be used to define a non-static, 328 no-argument method or member field as something of a reverse of 329 <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 330 getter but such that contents of the returned Map (type <b>must</b> be 331 <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>) are serialized as if they were actual properties 332 of the bean that contains method/field with this annotations.</div> 333</td> 334</tr> 335<tr class="altColor"> 336<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonAnySetter</a></td> 337<td class="colLast"> 338<div class="block">Marker annotation that can be used to define a non-static, 339 two-argument method (first argument name of property, second value 340 to set), to be used as a "fallback" handler 341 for all otherwise unrecognized properties found from JSON content.</div> 342</td> 343</tr> 344<tr class="rowColor"> 345<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html" title="annotation in com.fasterxml.jackson.annotation">JsonAutoDetect</a></td> 346<td class="colLast"> 347<div class="block">Class annotation that can be used to define which kinds of Methods 348 are to be detected by auto-detection, and with what minimum access level.</div> 349</td> 350</tr> 351<tr class="altColor"> 352<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonBackReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonBackReference</a></td> 353<td class="colLast"> 354<div class="block">Annotation used to indicate that associated property is part of 355 two-way linkage between fields; and that its role is "child" (or "back") link.</div> 356</td> 357</tr> 358<tr class="rowColor"> 359<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonClassDescription.html" title="annotation in com.fasterxml.jackson.annotation">JsonClassDescription</a></td> 360<td class="colLast"> 361<div class="block">Annotation used to define a human readable description for annotated 362 type (class).</div> 363</td> 364</tr> 365<tr class="altColor"> 366<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.html" title="annotation in com.fasterxml.jackson.annotation">JsonCreator</a></td> 367<td class="colLast"> 368<div class="block">Marker annotation that can be used to define constructors and factory 369 methods as one to use for instantiating new instances of the associated 370 class.</div> 371</td> 372</tr> 373<tr class="rowColor"> 374<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFilter.html" title="annotation in com.fasterxml.jackson.annotation">JsonFilter</a></td> 375<td class="colLast"> 376<div class="block">Annotation used to indicate which logical filter is to be used 377 for filtering out properties of type (class) annotated; 378 association made by this annotation declaring ids of filters, 379 and <code>com.fasterxml.jackson.databind.ObjectMapper</code> (or objects 380 it delegates to) providing matching filters by id.</div> 381</td> 382</tr> 383<tr class="altColor"> 384<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.html" title="annotation in com.fasterxml.jackson.annotation">JsonFormat</a></td> 385<td class="colLast"> 386<div class="block">General-purpose annotation used for configuring details of how 387 values of properties are to be serialized.</div> 388</td> 389</tr> 390<tr class="rowColor"> 391<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonGetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonGetter</a></td> 392<td class="colLast"> 393<div class="block">Marker annotation that can be used to define a non-static, 394 no-argument value-returning (non-void) method to be used as a "getter" 395 for a logical property.</div> 396</td> 397</tr> 398<tr class="altColor"> 399<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation">JsonIdentityInfo</a></td> 400<td class="colLast"> 401<div class="block">Annotation used for indicating that values of annotated type 402 or property should be serializing so that instances either 403 contain additional object identifier (in addition actual object 404 properties), or as a reference that consists of an object id 405 that refers to a full serialization.</div> 406</td> 407</tr> 408<tr class="rowColor"> 409<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIdentityReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonIdentityReference</a></td> 410<td class="colLast"> 411<div class="block">Optional annotation that can be used for customizing details of a reference 412 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>).</div> 413</td> 414</tr> 415<tr class="altColor"> 416<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIgnore.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnore</a></td> 417<td class="colLast"> 418<div class="block">Marker annotation that indicates that the annotated method or field is to be 419 ignored by introspection-based 420 serialization and deserialization functionality.</div> 421</td> 422</tr> 423<tr class="rowColor"> 424<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIgnoreProperties.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnoreProperties</a></td> 425<td class="colLast"> 426<div class="block">Annotation that can be used to either suppress serialization of 427 properties (during serialization), or ignore processing of 428 JSON properties read (during deserialization).</div> 429</td> 430</tr> 431<tr class="altColor"> 432<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIgnoreType.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnoreType</a></td> 433<td class="colLast"> 434<div class="block">Marker annotation that indicates that all properties of annotated 435 type are to be ignored during serialization and deserialization.</div> 436</td> 437</tr> 438<tr class="rowColor"> 439<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.html" title="annotation in com.fasterxml.jackson.annotation">JsonInclude</a></td> 440<td class="colLast"> 441<div class="block">Annotation used to indicate when value of the annotated property (when 442 used for a field, method or constructor parameter), or all 443 properties of the annotated class, is to be serialized.</div> 444</td> 445</tr> 446<tr class="altColor"> 447<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonManagedReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonManagedReference</a></td> 448<td class="colLast"> 449<div class="block">Annotation used to indicate that annotated property is part of 450 two-way linkage between fields; and that its role is "parent" (or "forward") link.</div> 451</td> 452</tr> 453<tr class="rowColor"> 454<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation">JsonProperty</a></td> 455<td class="colLast"> 456<div class="block">Marker annotation that can be used to define a non-static 457 method as a "setter" or "getter" for a logical property 458 (depending on its signature), 459 or non-static object field to be used (serialized, deserialized) as 460 a logical property.</div> 461</td> 462</tr> 463<tr class="altColor"> 464<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyDescription.html" title="annotation in com.fasterxml.jackson.annotation">JsonPropertyDescription</a></td> 465<td class="colLast"> 466<div class="block">Annotation used to define a human readable description for a logical 467 property.</div> 468</td> 469</tr> 470<tr class="rowColor"> 471<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyOrder.html" title="annotation in com.fasterxml.jackson.annotation">JsonPropertyOrder</a></td> 472<td class="colLast"> 473<div class="block">Annotation that can be used to define ordering (possibly partial) to use 474 when serializing object properties.</div> 475</td> 476</tr> 477<tr class="altColor"> 478<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonRawValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonRawValue</a></td> 479<td class="colLast"> 480<div class="block">Marker annotation that indicates that the annotated method 481 or field should be serialized by including literal String value 482 of the property as is, without quoting of characters.</div> 483</td> 484</tr> 485<tr class="rowColor"> 486<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonRootName.html" title="annotation in com.fasterxml.jackson.annotation">JsonRootName</a></td> 487<td class="colLast"> 488<div class="block">Annotation similar to <a href="http://docs.oracle.com/javase/6/docs/api/javax/xml/bind/annotation/XmlRootElement.html?is-external=true" title="class or interface in javax.xml.bind.annotation"><code>XmlRootElement</code></a>, 489 used to indicate name to use for root-level wrapping, if wrapping is 490 enabled.</div> 491</td> 492</tr> 493<tr class="altColor"> 494<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonSetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonSetter</a></td> 495<td class="colLast"> 496<div class="block">Marker annotation that can be used to define a non-static, 497 single-argument method to be used as a "setter" for a logical property 498 as an alternative to recommended 499 <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).</div> 500</td> 501</tr> 502<tr class="rowColor"> 503<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonSubTypes.html" title="annotation in com.fasterxml.jackson.annotation">JsonSubTypes</a></td> 504<td class="colLast"> 505<div class="block">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 506 polymorphic types, and to associate logical names used within JSON content 507 (which is more portable than using physical Java class names).</div> 508</td> 509</tr> 510<tr class="altColor"> 511<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonSubTypes.Type.html" title="annotation in com.fasterxml.jackson.annotation">JsonSubTypes.Type</a></td> 512<td class="colLast"> 513<div class="block">Definition of a subtype, along with optional name.</div> 514</td> 515</tr> 516<tr class="rowColor"> 517<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeId.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeId</a></td> 518<td class="colLast"> 519<div class="block">Marker annotation that can be used on a property accessor 520 (field, getter or setter, constructor parameter) to indicate that 521 the property is to contain type id to use when including 522 polymorphic type information.</div> 523</td> 524</tr> 525<tr class="altColor"> 526<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeInfo</a></td> 527<td class="colLast"> 528<div class="block">Annotation used for configuring details of if and how type information is 529 used with JSON serialization and deserialization, to preserve information 530 about actual class of Object instances.</div> 531</td> 532</tr> 533<tr class="rowColor"> 534<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeName.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeName</a></td> 535<td class="colLast"> 536<div class="block">Annotation used for binding logical name that the annotated class 537 has.</div> 538</td> 539</tr> 540<tr class="altColor"> 541<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonUnwrapped.html" title="annotation in com.fasterxml.jackson.annotation">JsonUnwrapped</a></td> 542<td class="colLast"> 543<div class="block">Annotation used to indicate that a property should be serialized 544 "unwrapped"; that is, if it would be serialized as JSON Object, its 545 properties are instead included as properties of its containing 546 Object.</div> 547</td> 548</tr> 549<tr class="rowColor"> 550<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonValue</a></td> 551<td class="colLast"> 552<div class="block">Marker annotation similar to 553 <a href="http://docs.oracle.com/javase/6/docs/api/javax/xml/bind/annotation/XmlValue.html?is-external=true" title="class or interface in javax.xml.bind.annotation"><code>XmlValue</code></a> 554 that indicates that results of the annotated "getter" method 555 (which means signature must be that of getters; non-void return 556 type, no args) is to be used as the single value to serialize 557 for the instance.</div> 558</td> 559</tr> 560<tr class="altColor"> 561<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonView.html" title="annotation in com.fasterxml.jackson.annotation">JsonView</a></td> 562<td class="colLast"> 563<div class="block">Annotation used for indicating view(s) that the property 564 that is defined by method or field annotated is part of.</div> 565</td> 566</tr> 567</tbody> 568</table> 569</li> 570</ul> 571<a name="package_description"> 572<!-- --> 573</a> 574<h2 title="Package com.fasterxml.jackson.annotation Description">Package com.fasterxml.jackson.annotation Description</h2> 575<div class="block">Public core annotations, most of which are used to configure how 576 Data Mapping/Binding works. Annotations in this package can only 577 have dependencies to non-annotation classes in Core package; 578 annotations that have dependencies to Mapper classes are included 579 in Mapper module (under <code>org.codehaus.jackson.map.annotate</code>). 580 Also contains parameter types (mostly enums) needed by annotations. 581<p> 582 Note that prior versions (1.x) contained these annotations within 583 'core' jar, as part of Streaming API.</div> 584</div> 585<!-- ======= START OF BOTTOM NAVBAR ====== --> 586<div class="bottomNav"><a name="navbar_bottom"> 587<!-- --> 588</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 589<!-- --> 590</a> 591<ul class="navList" title="Navigation"> 592<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 593<li>Class</li> 594<li><a href="package-use.html">Use</a></li> 595<li><a href="package-tree.html">Tree</a></li> 596<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 597<li><a href="../../../../index-all.html">Index</a></li> 598<li><a href="../../../../help-doc.html">Help</a></li> 599</ul> 600</div> 601<div class="subNav"> 602<ul class="navList"> 603<li>Prev Package</li> 604<li>Next Package</li> 605</ul> 606<ul class="navList"> 607<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/package-summary.html" target="_top">Frames</a></li> 608<li><a href="package-summary.html" target="_top">No Frames</a></li> 609</ul> 610<ul class="navList" id="allclasses_navbar_bottom"> 611<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 612</ul> 613<div> 614<script type="text/javascript"><!-- 615 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 616 if(window==top) { 617 allClassesLink.style.display = "block"; 618 } 619 else { 620 allClassesLink.style.display = "none"; 621 } 622 //--> 623</script> 624</div> 625<a name="skip-navbar_bottom"> 626<!-- --> 627</a></div> 628<!-- ======== END OF BOTTOM NAVBAR ======= --> 629<p class="legalCopy"><small>Copyright © 2008–2016 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 630</body> 631</html> 632