1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!-- NewPage --> 3<html lang="en"> 4<head> 5<!-- Generated by javadoc (version 1.7.0_67) on Thu Jul 16 17:03:18 PDT 2015 --> 6<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> 7<title>Uses of Class com.fasterxml.jackson.annotation.JacksonAnnotation (Jackson-annotations 2.6.0 API)</title> 8<meta name="date" content="2015-07-16"> 9<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> 10</head> 11<body> 12<script type="text/javascript"><!-- 13 if (location.href.indexOf('is-external=true') == -1) { 14 parent.document.title="Uses of Class com.fasterxml.jackson.annotation.JacksonAnnotation (Jackson-annotations 2.6.0 API)"; 15 } 16//--> 17</script> 18<noscript> 19<div>JavaScript is disabled on your browser.</div> 20</noscript> 21<!-- ========= START OF TOP NAVBAR ======= --> 22<div class="topNav"><a name="navbar_top"> 23<!-- --> 24</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> 25<!-- --> 26</a> 27<ul class="navList" title="Navigation"> 28<li><a href="../../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 29<li><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/JsonAnyGetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonAnyGetter</a></strong></code> 102<div class="block">Marker annotation that can be used to define a non-static, 103 no-argument method or member field as something of a reverse of 104 <a href="../../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonAnySetter</code></a> method; basically being used like a 105 getter but such that contents of the returned Map (type <b>must</b> be 106 <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a>) are serialized as if they were actual properties 107 of the bean that contains method/field with this annotations.</div> 108</td> 109</tr> 110<tr class="rowColor"> 111<td class="colFirst"><code>interface </code></td> 112<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonAnySetter</a></strong></code> 113<div class="block">Marker annotation that can be used to define a non-static, 114 two-argument method (first argument name of property, second value 115 to set), to be used as a "fallback" handler 116 for all otherwise unrecognized properties found from JSON content.</div> 117</td> 118</tr> 119<tr class="altColor"> 120<td class="colFirst"><code>interface </code></td> 121<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html" title="annotation in com.fasterxml.jackson.annotation">JsonAutoDetect</a></strong></code> 122<div class="block">Class annotation that can be used to define which kinds of Methods 123 are to be detected by auto-detection, and with what minimum access level.</div> 124</td> 125</tr> 126<tr class="rowColor"> 127<td class="colFirst"><code>interface </code></td> 128<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonBackReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonBackReference</a></strong></code> 129<div class="block">Annotation used to indicate that associated property is part of 130 two-way linkage between fields; and that its role is "child" (or "back") link.</div> 131</td> 132</tr> 133<tr class="altColor"> 134<td class="colFirst"><code>interface </code></td> 135<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonCreator.html" title="annotation in com.fasterxml.jackson.annotation">JsonCreator</a></strong></code> 136<div class="block">Marker annotation that can be used to define constructors and factory 137 methods as one to use for instantiating new instances of the associated 138 class.</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/JsonFilter.html" title="annotation in com.fasterxml.jackson.annotation">JsonFilter</a></strong></code> 144<div class="block">Annotation used to indicate which logical filter is to be used 145 for filtering out properties of type (class) annotated; 146 association made by this annotation declaring ids of filters, 147 and <code>com.fasterxml.jackson.databind.ObjectMapper</code> (or objects 148 it delegates to) providing matching filters by id.</div> 149</td> 150</tr> 151<tr class="altColor"> 152<td class="colFirst"><code>interface </code></td> 153<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonFormat.html" title="annotation in com.fasterxml.jackson.annotation">JsonFormat</a></strong></code> 154<div class="block">General-purpose annotation used for configuring details of how 155 values of properties are to be serialized.</div> 156</td> 157</tr> 158<tr class="rowColor"> 159<td class="colFirst"><code>interface </code></td> 160<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonGetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonGetter</a></strong></code> 161<div class="block">Marker annotation that can be used to define a non-static, 162 no-argument value-returning (non-void) method to be used as a "getter" 163 for a logical property.</div> 164</td> 165</tr> 166<tr class="altColor"> 167<td class="colFirst"><code>interface </code></td> 168<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation">JsonIdentityInfo</a></strong></code> 169<div class="block">Annotation used for indicating that values of annotated type 170 or property should be serializing so that instances either 171 contain additional object identifier (in addition actual object 172 properties), or as a reference that consists of an object id 173 that refers to a full serialization.</div> 174</td> 175</tr> 176<tr class="rowColor"> 177<td class="colFirst"><code>interface </code></td> 178<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonIdentityReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonIdentityReference</a></strong></code> 179<div class="block">Optional annotation that can be used for customizing details of a reference 180 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> 181</td> 182</tr> 183<tr class="altColor"> 184<td class="colFirst"><code>interface </code></td> 185<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonIgnore.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnore</a></strong></code> 186<div class="block">Marker annotation that indicates that the annotated method or field is to be 187 ignored by introspection-based 188 serialization and deserialization functionality.</div> 189</td> 190</tr> 191<tr class="rowColor"> 192<td class="colFirst"><code>interface </code></td> 193<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonIgnoreProperties.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnoreProperties</a></strong></code> 194<div class="block">Annotation that can be used to either suppress serialization of 195 properties (during serialization), or ignore processing of 196 JSON properties read (during deserialization).</div> 197</td> 198</tr> 199<tr class="altColor"> 200<td class="colFirst"><code>interface </code></td> 201<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonIgnoreType.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnoreType</a></strong></code> 202<div class="block">Marker annotation that indicates that all properties of annotated 203 type are to be ignored during serialization and deserialization.</div> 204</td> 205</tr> 206<tr class="rowColor"> 207<td class="colFirst"><code>interface </code></td> 208<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonInclude.html" title="annotation in com.fasterxml.jackson.annotation">JsonInclude</a></strong></code> 209<div class="block">Annotation used to indicate when value of the annotated property (when 210 used for a field, method or constructor parameter), or all 211 properties of the annotated class, is to be serialized.</div> 212</td> 213</tr> 214<tr class="altColor"> 215<td class="colFirst"><code>interface </code></td> 216<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonManagedReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonManagedReference</a></strong></code> 217<div class="block">Annotation used to indicate that annotated property is part of 218 two-way linkage between fields; and that its role is "parent" (or "forward") link.</div> 219</td> 220</tr> 221<tr class="rowColor"> 222<td class="colFirst"><code>interface </code></td> 223<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation">JsonProperty</a></strong></code> 224<div class="block">Marker annotation that can be used to define a non-static 225 method as a "setter" or "getter" for a logical property 226 (depending on its signature), 227 or non-static object field to be used (serialized, deserialized) as 228 a logical property.</div> 229</td> 230</tr> 231<tr class="altColor"> 232<td class="colFirst"><code>interface </code></td> 233<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonPropertyDescription.html" title="annotation in com.fasterxml.jackson.annotation">JsonPropertyDescription</a></strong></code> 234<div class="block">Annotation used to define a human readable description for a logical 235 property.</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/JsonPropertyOrder.html" title="annotation in com.fasterxml.jackson.annotation">JsonPropertyOrder</a></strong></code> 241<div class="block">Annotation that can be used to define ordering (possibly partial) to use 242 when serializing object properties.</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/JsonRawValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonRawValue</a></strong></code> 248<div class="block">Marker annotation that indicates that the annotated method 249 or field should be serialized by including literal String value 250 of the property as is, without quoting of characters.</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/JsonRootName.html" title="annotation in com.fasterxml.jackson.annotation">JsonRootName</a></strong></code> 256<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>, 257 used to indicate name to use for root-level wrapping, if wrapping is 258 enabled.</div> 259</td> 260</tr> 261<tr class="altColor"> 262<td class="colFirst"><code>interface </code></td> 263<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonSetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonSetter</a></strong></code> 264<div class="block">Marker annotation that can be used to define a non-static, 265 single-argument method to be used as a "setter" for a logical property 266 as an alternative to recommended 267 <a href="../../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonProperty</code></a> annotation (which was introduced in version 1.1).</div> 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/JsonSubTypes.html" title="annotation in com.fasterxml.jackson.annotation">JsonSubTypes</a></strong></code> 273<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 274 polymorphic types, and to associate logical names used within JSON content 275 (which is more portable than using physical Java class names).</div> 276</td> 277</tr> 278<tr class="altColor"> 279<td class="colFirst"><code>interface </code></td> 280<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonTypeId.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeId</a></strong></code> 281<div class="block">Marker annotation that can be used on a property accessor 282 (field, getter or setter, constructor parameter) to indicate that 283 the property is to contain type id to use when including 284 polymorphic type information.</div> 285</td> 286</tr> 287<tr class="rowColor"> 288<td class="colFirst"><code>interface </code></td> 289<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeInfo</a></strong></code> 290<div class="block">Annotation used for configuring details of if and how type information is 291 used with JSON serialization and deserialization, to preserve information 292 about actual class of Object instances.</div> 293</td> 294</tr> 295<tr class="altColor"> 296<td class="colFirst"><code>interface </code></td> 297<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonTypeName.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeName</a></strong></code> 298<div class="block">Annotation used for binding logical name that the annotated class 299 has.</div> 300</td> 301</tr> 302<tr class="rowColor"> 303<td class="colFirst"><code>interface </code></td> 304<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonUnwrapped.html" title="annotation in com.fasterxml.jackson.annotation">JsonUnwrapped</a></strong></code> 305<div class="block">Annotation used to indicate that a property should be serialized 306 "unwrapped"; that is, if it would be serialized as JSON Object, its 307 properties are instead included as properties of its containing 308 Object.</div> 309</td> 310</tr> 311<tr class="altColor"> 312<td class="colFirst"><code>interface </code></td> 313<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonValue</a></strong></code> 314<div class="block">Marker annotation similar to 315 <a href="http://docs.oracle.com/javase/6/docs/api/javax/xml/bind/annotation/XmlValue.html?is-external=true" title="class or interface in javax.xml.bind.annotation"><code>XmlValue</code></a> 316 that indicates that results of the annotated "getter" method 317 (which means signature must be that of getters; non-void return 318 type, no args) is to be used as the single value to serialize 319 for the instance.</div> 320</td> 321</tr> 322<tr class="rowColor"> 323<td class="colFirst"><code>interface </code></td> 324<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/annotation/JsonView.html" title="annotation in com.fasterxml.jackson.annotation">JsonView</a></strong></code> 325<div class="block">Annotation used for indicating view(s) that the property 326 that is defined by method or field annotated is part of.</div> 327</td> 328</tr> 329</tbody> 330</table> 331</li> 332</ul> 333</li> 334</ul> 335</div> 336<!-- ======= START OF BOTTOM NAVBAR ====== --> 337<div class="bottomNav"><a name="navbar_bottom"> 338<!-- --> 339</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 340<!-- --> 341</a> 342<ul class="navList" title="Navigation"> 343<li><a href="../../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 344<li><a href="../../../../../com/fasterxml/jackson/annotation/JacksonAnnotation.html" title="annotation in com.fasterxml.jackson.annotation">Class</a></li> 345<li class="navBarCell1Rev">Use</li> 346<li><a href="../package-tree.html">Tree</a></li> 347<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> 348<li><a href="../../../../../index-all.html">Index</a></li> 349<li><a href="../../../../../help-doc.html">Help</a></li> 350</ul> 351</div> 352<div class="subNav"> 353<ul class="navList"> 354<li>Prev</li> 355<li>Next</li> 356</ul> 357<ul class="navList"> 358<li><a href="../../../../../index.html?com/fasterxml/jackson/annotation/class-use/JacksonAnnotation.html" target="_top">Frames</a></li> 359<li><a href="JacksonAnnotation.html" target="_top">No Frames</a></li> 360</ul> 361<ul class="navList" id="allclasses_navbar_bottom"> 362<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> 363</ul> 364<div> 365<script type="text/javascript"><!-- 366 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 367 if(window==top) { 368 allClassesLink.style.display = "block"; 369 } 370 else { 371 allClassesLink.style.display = "none"; 372 } 373 //--> 374</script> 375</div> 376<a name="skip-navbar_bottom"> 377<!-- --> 378</a></div> 379<!-- ======== END OF BOTTOM NAVBAR ======= --> 380<p class="legalCopy"><small>Copyright © 2014–2015 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 381</body> 382</html> 383