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 Tue Jan 23 20:10:06 PST 2018 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>com.fasterxml.jackson.annotation (Jackson-annotations 2.9.0 API)</title> 8<meta name="date" content="2018-01-23"> 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.9.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/JacksonInject.Value.html" title="class in com.fasterxml.jackson.annotation">JacksonInject.Value</a></td> 112<td class="colLast"> 113<div class="block">Helper class used to contain information from a single <a href="../../../../com/fasterxml/jackson/annotation/JacksonInject.html" title="annotation in com.fasterxml.jackson.annotation"><code>JacksonInject</code></a> 114 annotation, as well as to provide possible overrides from non-annotation sources.</div> 115</td> 116</tr> 117<tr class="rowColor"> 118<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Value.html" title="class in com.fasterxml.jackson.annotation">JsonAutoDetect.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/JsonIgnoreProperties.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonIgnoreProperties</code></a> 121 annotation, as well as to provide possible overrides from non-annotation sources.</div> 122</td> 123</tr> 124<tr class="altColor"> 125<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Features.html" title="class in com.fasterxml.jackson.annotation">JsonFormat.Features</a></td> 126<td class="colLast"> 127<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> 128 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> 129</td> 130</tr> 131<tr class="rowColor"> 132<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Value.html" title="class in com.fasterxml.jackson.annotation">JsonFormat.Value</a></td> 133<td class="colLast"> 134<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> 135 annotation.</div> 136</td> 137</tr> 138<tr class="altColor"> 139<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIgnoreProperties.Value.html" title="class in com.fasterxml.jackson.annotation">JsonIgnoreProperties.Value</a></td> 140<td class="colLast"> 141<div class="block">Helper class used to contain information from a single <a href="../../../../com/fasterxml/jackson/annotation/JsonIgnoreProperties.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonIgnoreProperties</code></a> 142 annotation, as well as to provide possible overrides from non-annotation sources.</div> 143</td> 144</tr> 145<tr class="rowColor"> 146<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Value.html" title="class in com.fasterxml.jackson.annotation">JsonInclude.Value</a></td> 147<td class="colLast"> 148<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> 149 annotation.</div> 150</td> 151</tr> 152<tr class="altColor"> 153<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonSetter.Value.html" title="class in com.fasterxml.jackson.annotation">JsonSetter.Value</a></td> 154<td class="colLast"> 155<div class="block">Helper class used to contain information from a single <a href="../../../../com/fasterxml/jackson/annotation/JsonSetter.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonSetter</code></a> 156 annotation, as well as to provide possible overrides from non-annotation sources.</div> 157</td> 158</tr> 159<tr class="rowColor"> 160<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.None.html" title="class in com.fasterxml.jackson.annotation">JsonTypeInfo.None</a></td> 161<td class="colLast">Deprecated 162<div class="block"><i>Since 2.5, use any Annotation type (such as <a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonTypeInfo</code></a>, 163 if such behavior is needed; this is rarely necessary.</i></div> 164</td> 165</tr> 166<tr class="altColor"> 167<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerator</a><T></td> 168<td class="colLast"> 169<div class="block">Definition of API used for constructing Object Identifiers 170 (as annotated using <a href="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonIdentityInfo</code></a>).</div> 171</td> 172</tr> 173<tr class="rowColor"> 174<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerator.IdKey</a></td> 175<td class="colLast"> 176<div class="block">Simple key class that can be used as a key for 177 ObjectId-to-POJO mappings, when multiple ObjectId types 178 and scopes are used.</div> 179</td> 180</tr> 181<tr class="altColor"> 182<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators</a></td> 183<td class="colLast"> 184<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: 185 186 <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.IntSequenceGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerators.IntSequenceGenerator</code></a> 187 <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.PropertyGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerators.PropertyGenerator</code></a> 188 <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.StringIdGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerators.StringIdGenerator</code></a> (since 2.7) 189 <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.UUIDGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerators.UUIDGenerator</code></a> 190</div> 191</td> 192</tr> 193<tr class="rowColor"> 194<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.IntSequenceGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.IntSequenceGenerator</a></td> 195<td class="colLast"> 196<div class="block">Simple sequence-number based generator, which uses basic Java 197 <code>int</code>s (starting with value 1) as Object Identifiers.</div> 198</td> 199</tr> 200<tr class="altColor"> 201<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.None.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.None</a></td> 202<td class="colLast"> 203<div class="block">Abstract marker class used to allow explicitly specifying 204 that no generator is used; which also implies that no 205 Object Id is to be included or used.</div> 206</td> 207</tr> 208<tr class="rowColor"> 209<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.PropertyGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.PropertyGenerator</a></td> 210<td class="colLast"> 211<div class="block">Abstract place-holder class which is used to denote case 212 where Object Identifier to use comes from a POJO property 213 (getter method or field).</div> 214</td> 215</tr> 216<tr class="altColor"> 217<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.StringIdGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.StringIdGenerator</a></td> 218<td class="colLast"> 219<div class="block">Implementation that will accept arbitrary (but unique) String Ids on 220 deserialization, and (by default) use random UUID generation similar 221 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> 222</td> 223</tr> 224<tr class="rowColor"> 225<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.UUIDGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.UUIDGenerator</a></td> 226<td class="colLast"> 227<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 228 unique identifiers: downside is that resulting String is 229 36 characters long.</div> 230</td> 231</tr> 232<tr class="altColor"> 233<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/SimpleObjectIdResolver.html" title="class in com.fasterxml.jackson.annotation">SimpleObjectIdResolver</a></td> 234<td class="colLast"> 235<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> 236</td> 237</tr> 238</tbody> 239</table> 240</li> 241<li class="blockList"> 242<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> 243<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> 244<tr> 245<th class="colFirst" scope="col">Enum</th> 246<th class="colLast" scope="col">Description</th> 247</tr> 248<tbody> 249<tr class="altColor"> 250<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</a></td> 251<td class="colLast"> 252<div class="block">Enumeration for possible visibility thresholds (minimum visibility) 253 that can be used to limit which methods (and fields) are 254 auto-detected.</div> 255</td> 256</tr> 257<tr class="rowColor"> 258<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html" title="enum in com.fasterxml.jackson.annotation">JsonCreator.Mode</a></td> 259<td class="colLast"> </td> 260</tr> 261<tr class="altColor"> 262<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Feature.html" title="enum in com.fasterxml.jackson.annotation">JsonFormat.Feature</a></td> 263<td class="colLast"> 264<div class="block">Set of features that can be enabled/disabled for property annotated.</div> 265</td> 266</tr> 267<tr class="rowColor"> 268<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Shape.html" title="enum in com.fasterxml.jackson.annotation">JsonFormat.Shape</a></td> 269<td class="colLast"> 270<div class="block">Value enumeration used for indicating preferred Shape; translates 271 loosely to JSON types, with some extra values to indicate less precise 272 choices (i.e.</div> 273</td> 274</tr> 275<tr class="altColor"> 276<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a></td> 277<td class="colLast"> 278<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> 279 to define which properties 280 of Java Beans are to be included in serialization.</div> 281</td> 282</tr> 283<tr class="rowColor"> 284<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation">JsonProperty.Access</a></td> 285<td class="colLast"> 286<div class="block">Various options for <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html#access()"><code>JsonProperty.access()</code></a> property, specifying how property 287 may be accessed during serialization ("read") and deserialization ("write") 288 (note that the direction of read and write is from perspective of the property, 289 not from external data format: this may be confusing in some contexts).</div> 290</td> 291</tr> 292<tr class="altColor"> 293<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.As.html" title="enum in com.fasterxml.jackson.annotation">JsonTypeInfo.As</a></td> 294<td class="colLast"> 295<div class="block">Definition of standard type inclusion mechanisms for type metadata.</div> 296</td> 297</tr> 298<tr class="rowColor"> 299<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.Id.html" title="enum in com.fasterxml.jackson.annotation">JsonTypeInfo.Id</a></td> 300<td class="colLast"> 301<div class="block">Definition of different type identifiers that can be included in JSON 302 during serialization, and used for deserialization.</div> 303</td> 304</tr> 305<tr class="altColor"> 306<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/Nulls.html" title="enum in com.fasterxml.jackson.annotation">Nulls</a></td> 307<td class="colLast"> 308<div class="block">Enumeration used with <a href="../../../../com/fasterxml/jackson/annotation/JsonSetter.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonSetter</code></a> (for properties `nulls` 309 and `contentNulls`) 310 to define how explicit `null` values from input (if input format 311 has the concept; JSON, for example does) are handled.</div> 312</td> 313</tr> 314<tr class="rowColor"> 315<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html" title="enum in com.fasterxml.jackson.annotation">OptBoolean</a></td> 316<td class="colLast"> 317<div class="block">Optional Boolean value ("nullean").</div> 318</td> 319</tr> 320<tr class="altColor"> 321<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/PropertyAccessor.html" title="enum in com.fasterxml.jackson.annotation">PropertyAccessor</a></td> 322<td class="colLast"> 323<div class="block">Enumeration used to define kinds of elements (called "property accessors") 324 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> 325</td> 326</tr> 327</tbody> 328</table> 329</li> 330<li class="blockList"> 331<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation"> 332<caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption> 333<tr> 334<th class="colFirst" scope="col">Annotation Type</th> 335<th class="colLast" scope="col">Description</th> 336</tr> 337<tbody> 338<tr class="altColor"> 339<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JacksonAnnotation.html" title="annotation in com.fasterxml.jackson.annotation">JacksonAnnotation</a></td> 340<td class="colLast"> 341<div class="block">Meta-annotation (annotations used on other annotations) 342 used for marking all annotations that are 343 part of Jackson package.</div> 344</td> 345</tr> 346<tr class="rowColor"> 347<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JacksonAnnotationsInside.html" title="annotation in com.fasterxml.jackson.annotation">JacksonAnnotationsInside</a></td> 348<td class="colLast"> 349<div class="block">Meta-annotation (annotations used on other annotations) 350 used for indicating that instead of using target annotation 351 (annotation annotated with this annotation), 352 Jackson should use meta-annotations it has.</div> 353</td> 354</tr> 355<tr class="altColor"> 356<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JacksonInject.html" title="annotation in com.fasterxml.jackson.annotation">JacksonInject</a></td> 357<td class="colLast"> 358<div class="block">Jackson-specific annotation used for indicating that value of 359 annotated property will be "injected", i.e.</div> 360</td> 361</tr> 362<tr class="rowColor"> 363<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAlias.html" title="annotation in com.fasterxml.jackson.annotation">JsonAlias</a></td> 364<td class="colLast"> 365<div class="block">Annotation that can be used to define one or more alternative names for 366 a property, accepted during deserialization as alternative to the official 367 name.</div> 368</td> 369</tr> 370<tr class="altColor"> 371<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAnyGetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonAnyGetter</a></td> 372<td class="colLast"> 373<div class="block">Marker annotation that can be used to define a non-static, 374 no-argument method to be an "any getter"; accessor for getting 375 a set of key/value pairs, to be serialized as part of containing POJO 376 (similar to unwrapping) along with regular property values it has.</div> 377</td> 378</tr> 379<tr class="rowColor"> 380<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonAnySetter</a></td> 381<td class="colLast"> 382<div class="block">Marker annotation that can be used to define a logical "any setter" mutator -- 383 either using non-static 384 two-argument method (first argument name of property, second value 385 to set) or a field (of type <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> or POJO) - 386 to be used as a "fallback" handler 387 for all otherwise unrecognized properties found from JSON content.</div> 388</td> 389</tr> 390<tr class="altColor"> 391<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html" title="annotation in com.fasterxml.jackson.annotation">JsonAutoDetect</a></td> 392<td class="colLast"> 393<div class="block">Class annotation that can be used to define which kinds of Methods 394 are to be detected by auto-detection, and with what minimum access level.</div> 395</td> 396</tr> 397<tr class="rowColor"> 398<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonBackReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonBackReference</a></td> 399<td class="colLast"> 400<div class="block">Annotation used to indicate that associated property is part of 401 two-way linkage between fields; and that its role is "child" (or "back") link.</div> 402</td> 403</tr> 404<tr class="altColor"> 405<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonClassDescription.html" title="annotation in com.fasterxml.jackson.annotation">JsonClassDescription</a></td> 406<td class="colLast"> 407<div class="block">Annotation used to define a human readable description for annotated 408 type (class).</div> 409</td> 410</tr> 411<tr class="rowColor"> 412<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.html" title="annotation in com.fasterxml.jackson.annotation">JsonCreator</a></td> 413<td class="colLast"> 414<div class="block">Marker annotation that can be used to define constructors and factory 415 methods as one to use for instantiating new instances of the associated 416 class.</div> 417</td> 418</tr> 419<tr class="altColor"> 420<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonEnumDefaultValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonEnumDefaultValue</a></td> 421<td class="colLast"> 422<div class="block">Marker annotation that can be used to define a default value 423 used when trying to deserialize unknown Enum values.</div> 424</td> 425</tr> 426<tr class="rowColor"> 427<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFilter.html" title="annotation in com.fasterxml.jackson.annotation">JsonFilter</a></td> 428<td class="colLast"> 429<div class="block">Annotation used to indicate which logical filter is to be used 430 for filtering out properties of type (class) annotated; 431 association made by this annotation declaring ids of filters, 432 and <code>com.fasterxml.jackson.databind.ObjectMapper</code> (or objects 433 it delegates to) providing matching filters by id.</div> 434</td> 435</tr> 436<tr class="altColor"> 437<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.html" title="annotation in com.fasterxml.jackson.annotation">JsonFormat</a></td> 438<td class="colLast"> 439<div class="block">General-purpose annotation used for configuring details of how 440 values of properties are to be serialized.</div> 441</td> 442</tr> 443<tr class="rowColor"> 444<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonGetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonGetter</a></td> 445<td class="colLast"> 446<div class="block">Marker annotation that can be used to define a non-static, 447 no-argument value-returning (non-void) method to be used as a "getter" 448 for a logical property.</div> 449</td> 450</tr> 451<tr class="altColor"> 452<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation">JsonIdentityInfo</a></td> 453<td class="colLast"> 454<div class="block">Annotation used for indicating that values of annotated type 455 or property should be serializing so that instances either 456 contain additional object identifier (in addition actual object 457 properties), or as a reference that consists of an object id 458 that refers to a full serialization.</div> 459</td> 460</tr> 461<tr class="rowColor"> 462<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIdentityReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonIdentityReference</a></td> 463<td class="colLast"> 464<div class="block">Optional annotation that can be used for customizing details of a reference 465 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> 466</td> 467</tr> 468<tr class="altColor"> 469<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIgnore.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnore</a></td> 470<td class="colLast"> 471<div class="block">Marker annotation that indicates that the logical property that 472 the accessor (field, getter/setter method or Creator parameter 473 [of <a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonCreator</code></a>-annotated constructor or factory method]) 474 is to be ignored by introspection-based 475 serialization and deserialization functionality.</div> 476</td> 477</tr> 478<tr class="rowColor"> 479<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIgnoreProperties.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnoreProperties</a></td> 480<td class="colLast"> 481<div class="block">Annotation that can be used to either suppress serialization of 482 properties (during serialization), or ignore processing of 483 JSON properties read (during deserialization).</div> 484</td> 485</tr> 486<tr class="altColor"> 487<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIgnoreType.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnoreType</a></td> 488<td class="colLast"> 489<div class="block">Marker annotation that indicates that all properties of annotated 490 type are to be ignored during serialization and deserialization.</div> 491</td> 492</tr> 493<tr class="rowColor"> 494<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.html" title="annotation in com.fasterxml.jackson.annotation">JsonInclude</a></td> 495<td class="colLast"> 496<div class="block">Annotation used to indicate when value of the annotated property (when 497 used for a field, method or constructor parameter), or all 498 properties of the annotated class, is to be serialized.</div> 499</td> 500</tr> 501<tr class="altColor"> 502<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonManagedReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonManagedReference</a></td> 503<td class="colLast"> 504<div class="block">Annotation used to indicate that annotated property is part of 505 two-way linkage between fields; and that its role is "parent" (or "forward") link.</div> 506</td> 507</tr> 508<tr class="rowColor"> 509<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonMerge.html" title="annotation in com.fasterxml.jackson.annotation">JsonMerge</a></td> 510<td class="colLast"> 511<div class="block">Annotation to specify whether annotated property value should use "merging" approach, 512 in which current value is first accessed (with a getter or field) and then modified 513 with incoming data, or not: if not, assignment happens without considering current state.</div> 514</td> 515</tr> 516<tr class="altColor"> 517<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation">JsonProperty</a></td> 518<td class="colLast"> 519<div class="block">Marker annotation that can be used to define a non-static 520 method as a "setter" or "getter" for a logical property 521 (depending on its signature), 522 or non-static object field to be used (serialized, deserialized) as 523 a logical property.</div> 524</td> 525</tr> 526<tr class="rowColor"> 527<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyDescription.html" title="annotation in com.fasterxml.jackson.annotation">JsonPropertyDescription</a></td> 528<td class="colLast"> 529<div class="block">Annotation used to define a human readable description for a logical 530 property.</div> 531</td> 532</tr> 533<tr class="altColor"> 534<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyOrder.html" title="annotation in com.fasterxml.jackson.annotation">JsonPropertyOrder</a></td> 535<td class="colLast"> 536<div class="block">Annotation that can be used to define ordering (possibly partial) to use 537 when serializing object properties.</div> 538</td> 539</tr> 540<tr class="rowColor"> 541<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonRawValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonRawValue</a></td> 542<td class="colLast"> 543<div class="block">Marker annotation that indicates that the annotated method 544 or field should be serialized by including literal String value 545 of the property as is, without quoting of characters.</div> 546</td> 547</tr> 548<tr class="altColor"> 549<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonRootName.html" title="annotation in com.fasterxml.jackson.annotation">JsonRootName</a></td> 550<td class="colLast"> 551<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>, 552 used to indicate name to use for root-level wrapping, if wrapping is 553 enabled.</div> 554</td> 555</tr> 556<tr class="rowColor"> 557<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonSetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonSetter</a></td> 558<td class="colLast"> 559<div class="block">Annotation that can be used to define a non-static, 560 single-argument method to be used as a "setter" for a logical property 561 as an alternative to recommended 562 <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonProperty</code></a> annotation; 563 or (as of 2.9 and later), specify additional aspects of the 564 assigning property a value during serialization.</div> 565</td> 566</tr> 567<tr class="altColor"> 568<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonSubTypes.html" title="annotation in com.fasterxml.jackson.annotation">JsonSubTypes</a></td> 569<td class="colLast"> 570<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 571 polymorphic types, and to associate logical names used within JSON content 572 (which is more portable than using physical Java class names).</div> 573</td> 574</tr> 575<tr class="rowColor"> 576<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonSubTypes.Type.html" title="annotation in com.fasterxml.jackson.annotation">JsonSubTypes.Type</a></td> 577<td class="colLast"> 578<div class="block">Definition of a subtype, along with optional name.</div> 579</td> 580</tr> 581<tr class="altColor"> 582<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeId.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeId</a></td> 583<td class="colLast"> 584<div class="block">Marker annotation that can be used on a property accessor 585 (field, getter or setter, constructor parameter) to indicate that 586 the property is to contain type id to use when including 587 polymorphic type information.</div> 588</td> 589</tr> 590<tr class="rowColor"> 591<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeInfo</a></td> 592<td class="colLast"> 593<div class="block">Annotation used for configuring details of if and how type information is 594 used with JSON serialization and deserialization, to preserve information 595 about actual class of Object instances.</div> 596</td> 597</tr> 598<tr class="altColor"> 599<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeName.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeName</a></td> 600<td class="colLast"> 601<div class="block">Annotation used for binding logical name that the annotated class 602 has.</div> 603</td> 604</tr> 605<tr class="rowColor"> 606<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonUnwrapped.html" title="annotation in com.fasterxml.jackson.annotation">JsonUnwrapped</a></td> 607<td class="colLast"> 608<div class="block">Annotation used to indicate that a property should be serialized 609 "unwrapped"; that is, if it would be serialized as JSON Object, its 610 properties are instead included as properties of its containing 611 Object.</div> 612</td> 613</tr> 614<tr class="altColor"> 615<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonValue</a></td> 616<td class="colLast"> 617<div class="block">Marker annotation 618 that indicates that the value of annotated accessor (either field 619 or "getter" method [a method with non-void return type, no args]) 620 is to be used as the single value to serialize for the instance, 621 instead of the usual method of collecting properties of value.</div> 622</td> 623</tr> 624<tr class="rowColor"> 625<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonView.html" title="annotation in com.fasterxml.jackson.annotation">JsonView</a></td> 626<td class="colLast"> 627<div class="block">Annotation used for indicating view(s) that the property 628 that is defined by method or field annotated is part of.</div> 629</td> 630</tr> 631</tbody> 632</table> 633</li> 634</ul> 635<a name="package_description"> 636<!-- --> 637</a> 638<h2 title="Package com.fasterxml.jackson.annotation Description">Package com.fasterxml.jackson.annotation Description</h2> 639<div class="block">Public core annotations, most of which are used to configure how 640 Data Mapping/Binding works. Annotations in this package can only 641 have dependencies to non-annotation classes in Core package; 642 annotations that have dependencies to Mapper classes are included 643 in Mapper module (under <code>org.codehaus.jackson.map.annotate</code>). 644 Also contains parameter types (mostly enums) needed by annotations. 645<p> 646 Note that prior versions (1.x) contained these annotations within 647 'core' jar, as part of Streaming API.</div> 648</div> 649<!-- ======= START OF BOTTOM NAVBAR ====== --> 650<div class="bottomNav"><a name="navbar_bottom"> 651<!-- --> 652</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 653<!-- --> 654</a> 655<ul class="navList" title="Navigation"> 656<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 657<li>Class</li> 658<li><a href="package-use.html">Use</a></li> 659<li><a href="package-tree.html">Tree</a></li> 660<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 661<li><a href="../../../../index-all.html">Index</a></li> 662<li><a href="../../../../help-doc.html">Help</a></li> 663</ul> 664</div> 665<div class="subNav"> 666<ul class="navList"> 667<li>Prev Package</li> 668<li>Next Package</li> 669</ul> 670<ul class="navList"> 671<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/package-summary.html" target="_top">Frames</a></li> 672<li><a href="package-summary.html" target="_top">No Frames</a></li> 673</ul> 674<ul class="navList" id="allclasses_navbar_bottom"> 675<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 676</ul> 677<div> 678<script type="text/javascript"><!-- 679 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 680 if(window==top) { 681 allClassesLink.style.display = "block"; 682 } 683 else { 684 allClassesLink.style.display = "none"; 685 } 686 //--> 687</script> 688</div> 689<a name="skip-navbar_bottom"> 690<!-- --> 691</a></div> 692<!-- ======== END OF BOTTOM NAVBAR ======= --> 693<p class="legalCopy"><small>Copyright © 2008–2018 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 694</body> 695</html> 696