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