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_67) on Thu Jul 16 17:03:18 PDT 2015 --> 6<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> 7<title>com.fasterxml.jackson.annotation (Jackson-annotations 2.6.0 API)</title> 8<meta name="date" content="2015-07-16"> 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.6.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.</div> 156</td> 157</tr> 158<tr class="rowColor"> 159<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.IntSequenceGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.IntSequenceGenerator</a></td> 160<td class="colLast"> 161<div class="block">Simple sequence-number based generator, which uses basic Java 162 <code>int</code>s (starting with value 1) as Object Identifiers.</div> 163</td> 164</tr> 165<tr class="altColor"> 166<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.None.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.None</a></td> 167<td class="colLast"> 168<div class="block">Abstract marker class used to allow explicitly specifying 169 that no generator is used; which also implies that no 170 Object Id is to be included or used.</div> 171</td> 172</tr> 173<tr class="rowColor"> 174<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.PropertyGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.PropertyGenerator</a></td> 175<td class="colLast"> 176<div class="block">Abstract place-holder class which is used to denote case 177 where Object Identifier to use comes from a POJO property 178 (getter method or field).</div> 179</td> 180</tr> 181<tr class="altColor"> 182<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.UUIDGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.UUIDGenerator</a></td> 183<td class="colLast"> 184<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 185 unique identifiers: downside is that resulting String is 186 36 characters long.</div> 187</td> 188</tr> 189<tr class="rowColor"> 190<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/SimpleObjectIdResolver.html" title="class in com.fasterxml.jackson.annotation">SimpleObjectIdResolver</a></td> 191<td class="colLast"> 192<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> 193</td> 194</tr> 195</tbody> 196</table> 197</li> 198<li class="blockList"> 199<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> 200<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> 201<tr> 202<th class="colFirst" scope="col">Enum</th> 203<th class="colLast" scope="col">Description</th> 204</tr> 205<tbody> 206<tr class="altColor"> 207<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</a></td> 208<td class="colLast"> 209<div class="block">Enumeration for possible visibility thresholds (minimum visibility) 210 that can be used to limit which methods (and fields) are 211 auto-detected.</div> 212</td> 213</tr> 214<tr class="rowColor"> 215<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html" title="enum in com.fasterxml.jackson.annotation">JsonCreator.Mode</a></td> 216<td class="colLast"> </td> 217</tr> 218<tr class="altColor"> 219<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Feature.html" title="enum in com.fasterxml.jackson.annotation">JsonFormat.Feature</a></td> 220<td class="colLast"> 221<div class="block">Set of features that can be enabled/disabled for property annotated.</div> 222</td> 223</tr> 224<tr class="rowColor"> 225<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Shape.html" title="enum in com.fasterxml.jackson.annotation">JsonFormat.Shape</a></td> 226<td class="colLast"> 227<div class="block">Value enumeration used for indicating preferred Shape; translates 228 loosely to JSON types, with some extra values to indicate less precise 229 choices (i.e.</div> 230</td> 231</tr> 232<tr class="altColor"> 233<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a></td> 234<td class="colLast"> 235<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> 236 to define which properties 237 of Java Beans are to be included in serialization.</div> 238</td> 239</tr> 240<tr class="rowColor"> 241<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation">JsonProperty.Access</a></td> 242<td class="colLast"> 243<div class="block">Various options for <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html#access()"><code>JsonProperty.access()</code></a> property, specifying how property 244 may be accessed during serialization ("read") and deserialization ("write") 245 (note that the direction of read and write is from perspective of the property, 246 not from external data format: this may be confusing in some contexts).</div> 247</td> 248</tr> 249<tr class="altColor"> 250<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.As.html" title="enum in com.fasterxml.jackson.annotation">JsonTypeInfo.As</a></td> 251<td class="colLast"> 252<div class="block">Definition of standard type inclusion mechanisms for type metadata.</div> 253</td> 254</tr> 255<tr class="rowColor"> 256<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.Id.html" title="enum in com.fasterxml.jackson.annotation">JsonTypeInfo.Id</a></td> 257<td class="colLast"> 258<div class="block">Definition of different type identifiers that can be included in JSON 259 during serialization, and used for deserialization.</div> 260</td> 261</tr> 262<tr class="altColor"> 263<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html" title="enum in com.fasterxml.jackson.annotation">OptBoolean</a></td> 264<td class="colLast"> 265<div class="block">Optional Boolean value ("nullean").</div> 266</td> 267</tr> 268<tr class="rowColor"> 269<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/PropertyAccessor.html" title="enum in com.fasterxml.jackson.annotation">PropertyAccessor</a></td> 270<td class="colLast"> 271<div class="block">Enumeration used to define kinds of elements (called "property accessors") 272 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> 273</td> 274</tr> 275</tbody> 276</table> 277</li> 278<li class="blockList"> 279<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation"> 280<caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption> 281<tr> 282<th class="colFirst" scope="col">Annotation Type</th> 283<th class="colLast" scope="col">Description</th> 284</tr> 285<tbody> 286<tr class="altColor"> 287<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JacksonAnnotation.html" title="annotation in com.fasterxml.jackson.annotation">JacksonAnnotation</a></td> 288<td class="colLast"> 289<div class="block">Meta-annotation (annotations used on other annotations) 290 used for marking all annotations that are 291 part of Jackson package.</div> 292</td> 293</tr> 294<tr class="rowColor"> 295<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JacksonAnnotationsInside.html" title="annotation in com.fasterxml.jackson.annotation">JacksonAnnotationsInside</a></td> 296<td class="colLast"> 297<div class="block">Meta-annotation (annotations used on other annotations) 298 used for indicating that instead of using target annotation 299 (annotation annotated with this annotation), 300 Jackson should use meta-annotations it has.</div> 301</td> 302</tr> 303<tr class="altColor"> 304<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JacksonInject.html" title="annotation in com.fasterxml.jackson.annotation">JacksonInject</a></td> 305<td class="colLast"> 306<div class="block">Jackson-specific annotation used for indicating that value of 307 annotated property will be "injected", i.e.</div> 308</td> 309</tr> 310<tr class="rowColor"> 311<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAnyGetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonAnyGetter</a></td> 312<td class="colLast"> 313<div class="block">Marker annotation that can be used to define a non-static, 314 no-argument method or member field as something of a reverse of 315 <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 316 getter but such that contents of the returned Map (type <b>must</b> be 317 <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 318 of the bean that contains method/field with this annotations.</div> 319</td> 320</tr> 321<tr class="altColor"> 322<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonAnySetter</a></td> 323<td class="colLast"> 324<div class="block">Marker annotation that can be used to define a non-static, 325 two-argument method (first argument name of property, second value 326 to set), to be used as a "fallback" handler 327 for all otherwise unrecognized properties found from JSON content.</div> 328</td> 329</tr> 330<tr class="rowColor"> 331<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html" title="annotation in com.fasterxml.jackson.annotation">JsonAutoDetect</a></td> 332<td class="colLast"> 333<div class="block">Class annotation that can be used to define which kinds of Methods 334 are to be detected by auto-detection, and with what minimum access level.</div> 335</td> 336</tr> 337<tr class="altColor"> 338<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonBackReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonBackReference</a></td> 339<td class="colLast"> 340<div class="block">Annotation used to indicate that associated property is part of 341 two-way linkage between fields; and that its role is "child" (or "back") link.</div> 342</td> 343</tr> 344<tr class="rowColor"> 345<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.html" title="annotation in com.fasterxml.jackson.annotation">JsonCreator</a></td> 346<td class="colLast"> 347<div class="block">Marker annotation that can be used to define constructors and factory 348 methods as one to use for instantiating new instances of the associated 349 class.</div> 350</td> 351</tr> 352<tr class="altColor"> 353<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFilter.html" title="annotation in com.fasterxml.jackson.annotation">JsonFilter</a></td> 354<td class="colLast"> 355<div class="block">Annotation used to indicate which logical filter is to be used 356 for filtering out properties of type (class) annotated; 357 association made by this annotation declaring ids of filters, 358 and <code>com.fasterxml.jackson.databind.ObjectMapper</code> (or objects 359 it delegates to) providing matching filters by id.</div> 360</td> 361</tr> 362<tr class="rowColor"> 363<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.html" title="annotation in com.fasterxml.jackson.annotation">JsonFormat</a></td> 364<td class="colLast"> 365<div class="block">General-purpose annotation used for configuring details of how 366 values of properties are to be serialized.</div> 367</td> 368</tr> 369<tr class="altColor"> 370<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonGetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonGetter</a></td> 371<td class="colLast"> 372<div class="block">Marker annotation that can be used to define a non-static, 373 no-argument value-returning (non-void) method to be used as a "getter" 374 for a logical property.</div> 375</td> 376</tr> 377<tr class="rowColor"> 378<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation">JsonIdentityInfo</a></td> 379<td class="colLast"> 380<div class="block">Annotation used for indicating that values of annotated type 381 or property should be serializing so that instances either 382 contain additional object identifier (in addition actual object 383 properties), or as a reference that consists of an object id 384 that refers to a full serialization.</div> 385</td> 386</tr> 387<tr class="altColor"> 388<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIdentityReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonIdentityReference</a></td> 389<td class="colLast"> 390<div class="block">Optional annotation that can be used for customizing details of a reference 391 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> 392</td> 393</tr> 394<tr class="rowColor"> 395<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIgnore.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnore</a></td> 396<td class="colLast"> 397<div class="block">Marker annotation that indicates that the annotated method or field is to be 398 ignored by introspection-based 399 serialization and deserialization functionality.</div> 400</td> 401</tr> 402<tr class="altColor"> 403<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIgnoreProperties.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnoreProperties</a></td> 404<td class="colLast"> 405<div class="block">Annotation that can be used to either suppress serialization of 406 properties (during serialization), or ignore processing of 407 JSON properties read (during deserialization).</div> 408</td> 409</tr> 410<tr class="rowColor"> 411<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIgnoreType.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnoreType</a></td> 412<td class="colLast"> 413<div class="block">Marker annotation that indicates that all properties of annotated 414 type are to be ignored during serialization and deserialization.</div> 415</td> 416</tr> 417<tr class="altColor"> 418<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.html" title="annotation in com.fasterxml.jackson.annotation">JsonInclude</a></td> 419<td class="colLast"> 420<div class="block">Annotation used to indicate when value of the annotated property (when 421 used for a field, method or constructor parameter), or all 422 properties of the annotated class, is to be serialized.</div> 423</td> 424</tr> 425<tr class="rowColor"> 426<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonManagedReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonManagedReference</a></td> 427<td class="colLast"> 428<div class="block">Annotation used to indicate that annotated property is part of 429 two-way linkage between fields; and that its role is "parent" (or "forward") link.</div> 430</td> 431</tr> 432<tr class="altColor"> 433<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation">JsonProperty</a></td> 434<td class="colLast"> 435<div class="block">Marker annotation that can be used to define a non-static 436 method as a "setter" or "getter" for a logical property 437 (depending on its signature), 438 or non-static object field to be used (serialized, deserialized) as 439 a logical property.</div> 440</td> 441</tr> 442<tr class="rowColor"> 443<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyDescription.html" title="annotation in com.fasterxml.jackson.annotation">JsonPropertyDescription</a></td> 444<td class="colLast"> 445<div class="block">Annotation used to define a human readable description for a logical 446 property.</div> 447</td> 448</tr> 449<tr class="altColor"> 450<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyOrder.html" title="annotation in com.fasterxml.jackson.annotation">JsonPropertyOrder</a></td> 451<td class="colLast"> 452<div class="block">Annotation that can be used to define ordering (possibly partial) to use 453 when serializing object properties.</div> 454</td> 455</tr> 456<tr class="rowColor"> 457<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonRawValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonRawValue</a></td> 458<td class="colLast"> 459<div class="block">Marker annotation that indicates that the annotated method 460 or field should be serialized by including literal String value 461 of the property as is, without quoting of characters.</div> 462</td> 463</tr> 464<tr class="altColor"> 465<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonRootName.html" title="annotation in com.fasterxml.jackson.annotation">JsonRootName</a></td> 466<td class="colLast"> 467<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>, 468 used to indicate name to use for root-level wrapping, if wrapping is 469 enabled.</div> 470</td> 471</tr> 472<tr class="rowColor"> 473<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonSetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonSetter</a></td> 474<td class="colLast"> 475<div class="block">Marker annotation that can be used to define a non-static, 476 single-argument method to be used as a "setter" for a logical property 477 as an alternative to recommended 478 <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> 479</td> 480</tr> 481<tr class="altColor"> 482<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonSubTypes.html" title="annotation in com.fasterxml.jackson.annotation">JsonSubTypes</a></td> 483<td class="colLast"> 484<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 485 polymorphic types, and to associate logical names used within JSON content 486 (which is more portable than using physical Java class names).</div> 487</td> 488</tr> 489<tr class="rowColor"> 490<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonSubTypes.Type.html" title="annotation in com.fasterxml.jackson.annotation">JsonSubTypes.Type</a></td> 491<td class="colLast"> 492<div class="block">Definition of a subtype, along with optional name.</div> 493</td> 494</tr> 495<tr class="altColor"> 496<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeId.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeId</a></td> 497<td class="colLast"> 498<div class="block">Marker annotation that can be used on a property accessor 499 (field, getter or setter, constructor parameter) to indicate that 500 the property is to contain type id to use when including 501 polymorphic type information.</div> 502</td> 503</tr> 504<tr class="rowColor"> 505<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeInfo</a></td> 506<td class="colLast"> 507<div class="block">Annotation used for configuring details of if and how type information is 508 used with JSON serialization and deserialization, to preserve information 509 about actual class of Object instances.</div> 510</td> 511</tr> 512<tr class="altColor"> 513<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeName.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeName</a></td> 514<td class="colLast"> 515<div class="block">Annotation used for binding logical name that the annotated class 516 has.</div> 517</td> 518</tr> 519<tr class="rowColor"> 520<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonUnwrapped.html" title="annotation in com.fasterxml.jackson.annotation">JsonUnwrapped</a></td> 521<td class="colLast"> 522<div class="block">Annotation used to indicate that a property should be serialized 523 "unwrapped"; that is, if it would be serialized as JSON Object, its 524 properties are instead included as properties of its containing 525 Object.</div> 526</td> 527</tr> 528<tr class="altColor"> 529<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonValue</a></td> 530<td class="colLast"> 531<div class="block">Marker annotation similar to 532 <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> 533 that indicates that results of the annotated "getter" method 534 (which means signature must be that of getters; non-void return 535 type, no args) is to be used as the single value to serialize 536 for the instance.</div> 537</td> 538</tr> 539<tr class="rowColor"> 540<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonView.html" title="annotation in com.fasterxml.jackson.annotation">JsonView</a></td> 541<td class="colLast"> 542<div class="block">Annotation used for indicating view(s) that the property 543 that is defined by method or field annotated is part of.</div> 544</td> 545</tr> 546</tbody> 547</table> 548</li> 549</ul> 550<a name="package_description"> 551<!-- --> 552</a> 553<h2 title="Package com.fasterxml.jackson.annotation Description">Package com.fasterxml.jackson.annotation Description</h2> 554<div class="block">Public core annotations, most of which are used to configure how 555 Data Mapping/Binding works. Annotations in this package can only 556 have dependencies to non-annotation classes in Core package; 557 annotations that have dependencies to Mapper classes are included 558 in Mapper module (under <code>org.codehaus.jackson.map.annotate</code>). 559 Also contains parameter types (mostly enums) needed by annotations. 560<p> 561 Note that prior versions (1.x) contained these annotations within 562 'core' jar, as part of Streaming API.</div> 563</div> 564<!-- ======= START OF BOTTOM NAVBAR ====== --> 565<div class="bottomNav"><a name="navbar_bottom"> 566<!-- --> 567</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 568<!-- --> 569</a> 570<ul class="navList" title="Navigation"> 571<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 572<li>Class</li> 573<li><a href="package-use.html">Use</a></li> 574<li><a href="package-tree.html">Tree</a></li> 575<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 576<li><a href="../../../../index-all.html">Index</a></li> 577<li><a href="../../../../help-doc.html">Help</a></li> 578</ul> 579</div> 580<div class="subNav"> 581<ul class="navList"> 582<li>Prev Package</li> 583<li>Next Package</li> 584</ul> 585<ul class="navList"> 586<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/package-summary.html" target="_top">Frames</a></li> 587<li><a href="package-summary.html" target="_top">No Frames</a></li> 588</ul> 589<ul class="navList" id="allclasses_navbar_bottom"> 590<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 591</ul> 592<div> 593<script type="text/javascript"><!-- 594 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 595 if(window==top) { 596 allClassesLink.style.display = "block"; 597 } 598 else { 599 allClassesLink.style.display = "none"; 600 } 601 //--> 602</script> 603</div> 604<a name="skip-navbar_bottom"> 605<!-- --> 606</a></div> 607<!-- ======== END OF BOTTOM NAVBAR ======= --> 608<p class="legalCopy"><small>Copyright © 2014–2015 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 609</body> 610</html> 611