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:07 PST 2018 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>Uses of Class com.fasterxml.jackson.annotation.JacksonAnnotation (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="Uses of Class com.fasterxml.jackson.annotation.JacksonAnnotation (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><a href="../../../../../com/fasterxml/jackson/annotation/JacksonAnnotation.html" title="annotation in com.fasterxml.jackson.annotation">Class</a></li> 30<li class="navBarCell1Rev">Use</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</li> 40<li>Next</li> 41</ul> 42<ul class="navList"> 43<li><a href="../../../../../index.html?com/fasterxml/jackson/annotation/class-use/JacksonAnnotation.html" target="_top">Frames</a></li> 44<li><a href="JacksonAnnotation.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<h2 title="Uses of Class com.fasterxml.jackson.annotation.JacksonAnnotation" class="title">Uses of Class<br>com.fasterxml.jackson.annotation.JacksonAnnotation</h2> 67</div> 68<div class="classUseContainer"> 69<ul class="blockList"> 70<li class="blockList"> 71<ul class="blockList"> 72<li class="blockList"><a name="com.fasterxml.jackson.annotation"> 73<!-- --> 74</a> 75<h3>Uses of <a href="../../../../../com/fasterxml/jackson/annotation/JacksonAnnotation.html" title="annotation in com.fasterxml.jackson.annotation">JacksonAnnotation</a> in <a href="../../../../../com/fasterxml/jackson/annotation/package-summary.html">com.fasterxml.jackson.annotation</a></h3> 76<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> 77<caption><span>Classes in <a href="../../../../../com/fasterxml/jackson/annotation/package-summary.html">com.fasterxml.jackson.annotation</a> with annotations of type <a href="../../../../../com/fasterxml/jackson/annotation/JacksonAnnotation.html" title="annotation in com.fasterxml.jackson.annotation">JacksonAnnotation</a></span><span class="tabEnd"> </span></caption> 78<tr> 79<th class="colFirst" scope="col">Modifier and Type</th> 80<th class="colLast" scope="col">Class and Description</th> 81</tr> 82<tbody> 83<tr class="altColor"> 84<td class="colFirst"><code>interface </code></td> 85<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JacksonAnnotationsInside.html" title="annotation in com.fasterxml.jackson.annotation">JacksonAnnotationsInside</a></strong></code> 86<div class="block">Meta-annotation (annotations used on other annotations) 87 used for indicating that instead of using target annotation 88 (annotation annotated with this annotation), 89 Jackson should use meta-annotations it has.</div> 90</td> 91</tr> 92<tr class="rowColor"> 93<td class="colFirst"><code>interface </code></td> 94<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JacksonInject.html" title="annotation in com.fasterxml.jackson.annotation">JacksonInject</a></strong></code> 95<div class="block">Jackson-specific annotation used for indicating that value of 96 annotated property will be "injected", i.e.</div> 97</td> 98</tr> 99<tr class="altColor"> 100<td class="colFirst"><code>interface </code></td> 101<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonAlias.html" title="annotation in com.fasterxml.jackson.annotation">JsonAlias</a></strong></code> 102<div class="block">Annotation that can be used to define one or more alternative names for 103 a property, accepted during deserialization as alternative to the official 104 name.</div> 105</td> 106</tr> 107<tr class="rowColor"> 108<td class="colFirst"><code>interface </code></td> 109<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonAnyGetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonAnyGetter</a></strong></code> 110<div class="block">Marker annotation that can be used to define a non-static, 111 no-argument method to be an "any getter"; accessor for getting 112 a set of key/value pairs, to be serialized as part of containing POJO 113 (similar to unwrapping) along with regular property values it has.</div> 114</td> 115</tr> 116<tr class="altColor"> 117<td class="colFirst"><code>interface </code></td> 118<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonAnySetter</a></strong></code> 119<div class="block">Marker annotation that can be used to define a logical "any setter" mutator -- 120 either using non-static 121 two-argument method (first argument name of property, second value 122 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) - 123 to be used as a "fallback" handler 124 for all otherwise unrecognized properties found from JSON content.</div> 125</td> 126</tr> 127<tr class="rowColor"> 128<td class="colFirst"><code>interface </code></td> 129<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html" title="annotation in com.fasterxml.jackson.annotation">JsonAutoDetect</a></strong></code> 130<div class="block">Class annotation that can be used to define which kinds of Methods 131 are to be detected by auto-detection, and with what minimum access level.</div> 132</td> 133</tr> 134<tr class="altColor"> 135<td class="colFirst"><code>interface </code></td> 136<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonBackReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonBackReference</a></strong></code> 137<div class="block">Annotation used to indicate that associated property is part of 138 two-way linkage between fields; and that its role is "child" (or "back") link.</div> 139</td> 140</tr> 141<tr class="rowColor"> 142<td class="colFirst"><code>interface </code></td> 143<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonClassDescription.html" title="annotation in com.fasterxml.jackson.annotation">JsonClassDescription</a></strong></code> 144<div class="block">Annotation used to define a human readable description for annotated 145 type (class).</div> 146</td> 147</tr> 148<tr class="altColor"> 149<td class="colFirst"><code>interface </code></td> 150<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonCreator.html" title="annotation in com.fasterxml.jackson.annotation">JsonCreator</a></strong></code> 151<div class="block">Marker annotation that can be used to define constructors and factory 152 methods as one to use for instantiating new instances of the associated 153 class.</div> 154</td> 155</tr> 156<tr class="rowColor"> 157<td class="colFirst"><code>interface </code></td> 158<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonEnumDefaultValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonEnumDefaultValue</a></strong></code> 159<div class="block">Marker annotation that can be used to define a default value 160 used when trying to deserialize unknown Enum values.</div> 161</td> 162</tr> 163<tr class="altColor"> 164<td class="colFirst"><code>interface </code></td> 165<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonFilter.html" title="annotation in com.fasterxml.jackson.annotation">JsonFilter</a></strong></code> 166<div class="block">Annotation used to indicate which logical filter is to be used 167 for filtering out properties of type (class) annotated; 168 association made by this annotation declaring ids of filters, 169 and <code>com.fasterxml.jackson.databind.ObjectMapper</code> (or objects 170 it delegates to) providing matching filters by id.</div> 171</td> 172</tr> 173<tr class="rowColor"> 174<td class="colFirst"><code>interface </code></td> 175<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonFormat.html" title="annotation in com.fasterxml.jackson.annotation">JsonFormat</a></strong></code> 176<div class="block">General-purpose annotation used for configuring details of how 177 values of properties are to be serialized.</div> 178</td> 179</tr> 180<tr class="altColor"> 181<td class="colFirst"><code>interface </code></td> 182<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonGetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonGetter</a></strong></code> 183<div class="block">Marker annotation that can be used to define a non-static, 184 no-argument value-returning (non-void) method to be used as a "getter" 185 for a logical property.</div> 186</td> 187</tr> 188<tr class="rowColor"> 189<td class="colFirst"><code>interface </code></td> 190<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation">JsonIdentityInfo</a></strong></code> 191<div class="block">Annotation used for indicating that values of annotated type 192 or property should be serializing so that instances either 193 contain additional object identifier (in addition actual object 194 properties), or as a reference that consists of an object id 195 that refers to a full serialization.</div> 196</td> 197</tr> 198<tr class="altColor"> 199<td class="colFirst"><code>interface </code></td> 200<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonIdentityReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonIdentityReference</a></strong></code> 201<div class="block">Optional annotation that can be used for customizing details of a reference 202 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> 203</td> 204</tr> 205<tr class="rowColor"> 206<td class="colFirst"><code>interface </code></td> 207<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonIgnore.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnore</a></strong></code> 208<div class="block">Marker annotation that indicates that the logical property that 209 the accessor (field, getter/setter method or Creator parameter 210 [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]) 211 is to be ignored by introspection-based 212 serialization and deserialization functionality.</div> 213</td> 214</tr> 215<tr class="altColor"> 216<td class="colFirst"><code>interface </code></td> 217<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonIgnoreProperties.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnoreProperties</a></strong></code> 218<div class="block">Annotation that can be used to either suppress serialization of 219 properties (during serialization), or ignore processing of 220 JSON properties read (during deserialization).</div> 221</td> 222</tr> 223<tr class="rowColor"> 224<td class="colFirst"><code>interface </code></td> 225<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonIgnoreType.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnoreType</a></strong></code> 226<div class="block">Marker annotation that indicates that all properties of annotated 227 type are to be ignored during serialization and deserialization.</div> 228</td> 229</tr> 230<tr class="altColor"> 231<td class="colFirst"><code>interface </code></td> 232<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonInclude.html" title="annotation in com.fasterxml.jackson.annotation">JsonInclude</a></strong></code> 233<div class="block">Annotation used to indicate when value of the annotated property (when 234 used for a field, method or constructor parameter), or all 235 properties of the annotated class, is to be serialized.</div> 236</td> 237</tr> 238<tr class="rowColor"> 239<td class="colFirst"><code>interface </code></td> 240<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonManagedReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonManagedReference</a></strong></code> 241<div class="block">Annotation used to indicate that annotated property is part of 242 two-way linkage between fields; and that its role is "parent" (or "forward") link.</div> 243</td> 244</tr> 245<tr class="altColor"> 246<td class="colFirst"><code>interface </code></td> 247<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonMerge.html" title="annotation in com.fasterxml.jackson.annotation">JsonMerge</a></strong></code> 248<div class="block">Annotation to specify whether annotated property value should use "merging" approach, 249 in which current value is first accessed (with a getter or field) and then modified 250 with incoming data, or not: if not, assignment happens without considering current state.</div> 251</td> 252</tr> 253<tr class="rowColor"> 254<td class="colFirst"><code>interface </code></td> 255<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation">JsonProperty</a></strong></code> 256<div class="block">Marker annotation that can be used to define a non-static 257 method as a "setter" or "getter" for a logical property 258 (depending on its signature), 259 or non-static object field to be used (serialized, deserialized) as 260 a logical property.</div> 261</td> 262</tr> 263<tr class="altColor"> 264<td class="colFirst"><code>interface </code></td> 265<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonPropertyDescription.html" title="annotation in com.fasterxml.jackson.annotation">JsonPropertyDescription</a></strong></code> 266<div class="block">Annotation used to define a human readable description for a logical 267 property.</div> 268</td> 269</tr> 270<tr class="rowColor"> 271<td class="colFirst"><code>interface </code></td> 272<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonPropertyOrder.html" title="annotation in com.fasterxml.jackson.annotation">JsonPropertyOrder</a></strong></code> 273<div class="block">Annotation that can be used to define ordering (possibly partial) to use 274 when serializing object properties.</div> 275</td> 276</tr> 277<tr class="altColor"> 278<td class="colFirst"><code>interface </code></td> 279<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonRawValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonRawValue</a></strong></code> 280<div class="block">Marker annotation that indicates that the annotated method 281 or field should be serialized by including literal String value 282 of the property as is, without quoting of characters.</div> 283</td> 284</tr> 285<tr class="rowColor"> 286<td class="colFirst"><code>interface </code></td> 287<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonRootName.html" title="annotation in com.fasterxml.jackson.annotation">JsonRootName</a></strong></code> 288<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>, 289 used to indicate name to use for root-level wrapping, if wrapping is 290 enabled.</div> 291</td> 292</tr> 293<tr class="altColor"> 294<td class="colFirst"><code>interface </code></td> 295<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonSetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonSetter</a></strong></code> 296<div class="block">Annotation that can be used to define a non-static, 297 single-argument method to be used as a "setter" for a logical property 298 as an alternative to recommended 299 <a href="../../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonProperty</code></a> annotation; 300 or (as of 2.9 and later), specify additional aspects of the 301 assigning property a value during serialization.</div> 302</td> 303</tr> 304<tr class="rowColor"> 305<td class="colFirst"><code>interface </code></td> 306<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonSubTypes.html" title="annotation in com.fasterxml.jackson.annotation">JsonSubTypes</a></strong></code> 307<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 308 polymorphic types, and to associate logical names used within JSON content 309 (which is more portable than using physical Java class names).</div> 310</td> 311</tr> 312<tr class="altColor"> 313<td class="colFirst"><code>interface </code></td> 314<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonTypeId.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeId</a></strong></code> 315<div class="block">Marker annotation that can be used on a property accessor 316 (field, getter or setter, constructor parameter) to indicate that 317 the property is to contain type id to use when including 318 polymorphic type information.</div> 319</td> 320</tr> 321<tr class="rowColor"> 322<td class="colFirst"><code>interface </code></td> 323<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeInfo</a></strong></code> 324<div class="block">Annotation used for configuring details of if and how type information is 325 used with JSON serialization and deserialization, to preserve information 326 about actual class of Object instances.</div> 327</td> 328</tr> 329<tr class="altColor"> 330<td class="colFirst"><code>interface </code></td> 331<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonTypeName.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeName</a></strong></code> 332<div class="block">Annotation used for binding logical name that the annotated class 333 has.</div> 334</td> 335</tr> 336<tr class="rowColor"> 337<td class="colFirst"><code>interface </code></td> 338<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonUnwrapped.html" title="annotation in com.fasterxml.jackson.annotation">JsonUnwrapped</a></strong></code> 339<div class="block">Annotation used to indicate that a property should be serialized 340 "unwrapped"; that is, if it would be serialized as JSON Object, its 341 properties are instead included as properties of its containing 342 Object.</div> 343</td> 344</tr> 345<tr class="altColor"> 346<td class="colFirst"><code>interface </code></td> 347<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonValue</a></strong></code> 348<div class="block">Marker annotation 349 that indicates that the value of annotated accessor (either field 350 or "getter" method [a method with non-void return type, no args]) 351 is to be used as the single value to serialize for the instance, 352 instead of the usual method of collecting properties of value.</div> 353</td> 354</tr> 355<tr class="rowColor"> 356<td class="colFirst"><code>interface </code></td> 357<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonView.html" title="annotation in com.fasterxml.jackson.annotation">JsonView</a></strong></code> 358<div class="block">Annotation used for indicating view(s) that the property 359 that is defined by method or field annotated is part of.</div> 360</td> 361</tr> 362</tbody> 363</table> 364</li> 365</ul> 366</li> 367</ul> 368</div> 369<!-- ======= START OF BOTTOM NAVBAR ====== --> 370<div class="bottomNav"><a name="navbar_bottom"> 371<!-- --> 372</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 373<!-- --> 374</a> 375<ul class="navList" title="Navigation"> 376<li><a href="../../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 377<li><a href="../../../../../com/fasterxml/jackson/annotation/JacksonAnnotation.html" title="annotation in com.fasterxml.jackson.annotation">Class</a></li> 378<li class="navBarCell1Rev">Use</li> 379<li><a href="../package-tree.html">Tree</a></li> 380<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> 381<li><a href="../../../../../index-all.html">Index</a></li> 382<li><a href="../../../../../help-doc.html">Help</a></li> 383</ul> 384</div> 385<div class="subNav"> 386<ul class="navList"> 387<li>Prev</li> 388<li>Next</li> 389</ul> 390<ul class="navList"> 391<li><a href="../../../../../index.html?com/fasterxml/jackson/annotation/class-use/JacksonAnnotation.html" target="_top">Frames</a></li> 392<li><a href="JacksonAnnotation.html" target="_top">No Frames</a></li> 393</ul> 394<ul class="navList" id="allclasses_navbar_bottom"> 395<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> 396</ul> 397<div> 398<script type="text/javascript"><!-- 399 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 400 if(window==top) { 401 allClassesLink.style.display = "block"; 402 } 403 else { 404 allClassesLink.style.display = "none"; 405 } 406 //--> 407</script> 408</div> 409<a name="skip-navbar_bottom"> 410<!-- --> 411</a></div> 412<!-- ======== END OF BOTTOM NAVBAR ======= --> 413<p class="legalCopy"><small>Copyright © 2008–2018 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 414</body> 415</html> 416