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_10-ea) on Sun Jul 14 20:03:33 PDT 2013 --> 6<title>org.codehaus.jackson.annotate (Jackson JSON Processor)</title> 7<meta name="date" content="2013-07-14"> 8<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> 9</head> 10<body> 11<script type="text/javascript"><!-- 12 if (location.href.indexOf('is-external=true') == -1) { 13 parent.document.title="org.codehaus.jackson.annotate (Jackson JSON Processor)"; 14 } 15//--> 16</script> 17<noscript> 18<div>JavaScript is disabled on your browser.</div> 19</noscript> 20<!-- ========= START OF TOP NAVBAR ======= --> 21<div class="topNav"><a name="navbar_top"> 22<!-- --> 23</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> 24<!-- --> 25</a> 26<ul class="navList" title="Navigation"> 27<li><a href="../../../../overview-summary.html">Overview</a></li> 28<li class="navBarCell1Rev">Package</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><a href="../../../../org/codehaus/jackson/package-summary.html">Prev Package</a></li> 40<li><a href="../../../../org/codehaus/jackson/format/package-summary.html">Next Package</a></li> 41</ul> 42<ul class="navList"> 43<li><a href="../../../../index.html?org/codehaus/jackson/annotate/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 org.codehaus.jackson.annotate</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="Class Summary table, listing classes, and an explanation"> 77<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> 78<tr> 79<th class="colFirst" scope="col">Class</th> 80<th class="colLast" scope="col">Description</th> 81</tr> 82<tbody> 83<tr class="altColor"> 84<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonTypeInfo.None.html" title="class in org.codehaus.jackson.annotate">JsonTypeInfo.None</a></td> 85<td class="colLast"> 86<div class="block">This marker class that is only to be used with <code>defaultImpl</code> 87 annotation property, to indicate that there is no default implementation 88 specified.</div> 89</td> 90</tr> 91</tbody> 92</table> 93</li> 94<li class="blockList"> 95<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> 96<caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> 97<tr> 98<th class="colFirst" scope="col">Enum</th> 99<th class="colLast" scope="col">Description</th> 100</tr> 101<tbody> 102<tr class="altColor"> 103<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonAutoDetect.Visibility.html" title="enum in org.codehaus.jackson.annotate">JsonAutoDetect.Visibility</a></td> 104<td class="colLast"> 105<div class="block">Enumeration for possible visibility thresholds (minimum visibility) 106 that can be used to limit which methods (and fields) are 107 auto-detected.</div> 108</td> 109</tr> 110<tr class="rowColor"> 111<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonMethod.html" title="enum in org.codehaus.jackson.annotate">JsonMethod</a></td> 112<td class="colLast"> 113<div class="block">Enumeration used to define kinds of methods that annotations like 114 <a href="../../../../org/codehaus/jackson/annotate/JsonAutoDetect.html" title="annotation in org.codehaus.jackson.annotate"><code>JsonAutoDetect</code></a> apply to.</div> 115</td> 116</tr> 117<tr class="altColor"> 118<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonTypeInfo.As.html" title="enum in org.codehaus.jackson.annotate">JsonTypeInfo.As</a></td> 119<td class="colLast"> 120<div class="block">Definition of standard type inclusion mechanisms for type metadata.</div> 121</td> 122</tr> 123<tr class="rowColor"> 124<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonTypeInfo.Id.html" title="enum in org.codehaus.jackson.annotate">JsonTypeInfo.Id</a></td> 125<td class="colLast"> 126<div class="block">Definition of different type identifiers that can be included in JSON 127 during serialization, and used for deserialization.</div> 128</td> 129</tr> 130</tbody> 131</table> 132</li> 133<li class="blockList"> 134<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation"> 135<caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption> 136<tr> 137<th class="colFirst" scope="col">Annotation Type</th> 138<th class="colLast" scope="col">Description</th> 139</tr> 140<tbody> 141<tr class="altColor"> 142<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JacksonAnnotation.html" title="annotation in org.codehaus.jackson.annotate">JacksonAnnotation</a></td> 143<td class="colLast"> 144<div class="block">Meta-annotation (annotations used on other annotations) 145 used for marking all annotations that are 146 part of Jackson package.</div> 147</td> 148</tr> 149<tr class="rowColor"> 150<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonAnyGetter.html" title="annotation in org.codehaus.jackson.annotate">JsonAnyGetter</a></td> 151<td class="colLast"> 152<div class="block">Marker annotation that can be used to define a non-static, 153 no-argument method or member field as something of a reverse of 154 <a href="../../../../org/codehaus/jackson/annotate/JsonAnySetter.html" title="annotation in org.codehaus.jackson.annotate"><code>JsonAnySetter</code></a> method; basically being used like a 155 getter but such that contents of the returned Map (type <b>must</b> be 156 <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 157 of the bean that contains method/field with this annotations.</div> 158</td> 159</tr> 160<tr class="altColor"> 161<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonAnySetter.html" title="annotation in org.codehaus.jackson.annotate">JsonAnySetter</a></td> 162<td class="colLast"> 163<div class="block">Marker annotation that can be used to define a non-static, 164 single-argument method, to be used as a "fallback" handler 165 for all otherwise unrecognized properties found from Json content.</div> 166</td> 167</tr> 168<tr class="rowColor"> 169<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonAutoDetect.html" title="annotation in org.codehaus.jackson.annotate">JsonAutoDetect</a></td> 170<td class="colLast"> 171<div class="block">Class annotation that can be used to define which kinds of Methods 172 are to be detected by auto-detection.</div> 173</td> 174</tr> 175<tr class="altColor"> 176<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonBackReference.html" title="annotation in org.codehaus.jackson.annotate">JsonBackReference</a></td> 177<td class="colLast"> 178<div class="block">Annotation used to indicate that associated property is part of 179 two-way linkage between fields; and that its role is "child" (or "back") link.</div> 180</td> 181</tr> 182<tr class="rowColor"> 183<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonCreator.html" title="annotation in org.codehaus.jackson.annotate">JsonCreator</a></td> 184<td class="colLast"> 185<div class="block">Marker annotation that can be used to define constructors and factory 186 methods as one to use for instantiating new instances of the associated 187 class.</div> 188</td> 189</tr> 190<tr class="altColor"> 191<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonGetter.html" title="annotation in org.codehaus.jackson.annotate">JsonGetter</a></td> 192<td class="colLast">Deprecated 193<div class="block"><i>Use <a href="../../../../org/codehaus/jackson/annotate/JsonProperty.html" title="annotation in org.codehaus.jackson.annotate"><code>JsonProperty</code></a> instead (deprecated since version 1.5)</i></div> 194</td> 195</tr> 196<tr class="rowColor"> 197<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonIgnore.html" title="annotation in org.codehaus.jackson.annotate">JsonIgnore</a></td> 198<td class="colLast"> 199<div class="block">Marker annotation that indicates that the annotated method or field is to be 200 ignored by introspection-based 201 serialization and deserialization functionality.</div> 202</td> 203</tr> 204<tr class="altColor"> 205<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonIgnoreProperties.html" title="annotation in org.codehaus.jackson.annotate">JsonIgnoreProperties</a></td> 206<td class="colLast"> 207<div class="block">Annotation that can be used to either suppress serialization of 208 properties (during serialization), or ignore processing of 209 JSON properties read (during deserialization).</div> 210</td> 211</tr> 212<tr class="rowColor"> 213<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonIgnoreType.html" title="annotation in org.codehaus.jackson.annotate">JsonIgnoreType</a></td> 214<td class="colLast"> 215<div class="block">Marker annotation that indicates that all properties of annotated 216 type are to be ignored during serialization and deserialization.</div> 217</td> 218</tr> 219<tr class="altColor"> 220<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonManagedReference.html" title="annotation in org.codehaus.jackson.annotate">JsonManagedReference</a></td> 221<td class="colLast"> 222<div class="block">Annotation used to indicate that annotated property is part of 223 two-way linkage between fields; and that its role is "parent" (or "forward") link.</div> 224</td> 225</tr> 226<tr class="rowColor"> 227<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonProperty.html" title="annotation in org.codehaus.jackson.annotate">JsonProperty</a></td> 228<td class="colLast"> 229<div class="block">Marker annotation that can be used to define a non-static 230 method as a "setter" or "getter" for a logical property 231 (depending on its signature), 232 or non-static object field to be used (serialized, deserialized) as 233 a logical property.</div> 234</td> 235</tr> 236<tr class="altColor"> 237<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonPropertyOrder.html" title="annotation in org.codehaus.jackson.annotate">JsonPropertyOrder</a></td> 238<td class="colLast"> 239<div class="block">Annotation that can be used to define ordering (possibly partial) to use 240 when serializing object properties.</div> 241</td> 242</tr> 243<tr class="rowColor"> 244<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonRawValue.html" title="annotation in org.codehaus.jackson.annotate">JsonRawValue</a></td> 245<td class="colLast"> 246<div class="block">Marker annotation that indicates that the annotated method 247 or field should be serialized by including literal String value 248 of the property as is, without quoting of characters.</div> 249</td> 250</tr> 251<tr class="altColor"> 252<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonSetter.html" title="annotation in org.codehaus.jackson.annotate">JsonSetter</a></td> 253<td class="colLast"> 254<div class="block">Marker annotation that can be used to define a non-static, 255 single-argument method to be used as a "setter" for a logical property 256 as an alternative to recommended 257 <a href="../../../../org/codehaus/jackson/annotate/JsonProperty.html" title="annotation in org.codehaus.jackson.annotate"><code>JsonProperty</code></a> annotation (which was introduced in version 1.1).</div> 258</td> 259</tr> 260<tr class="rowColor"> 261<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonSubTypes.html" title="annotation in org.codehaus.jackson.annotate">JsonSubTypes</a></td> 262<td class="colLast"> 263<div class="block">Annotation used with <a href="../../../../org/codehaus/jackson/annotate/JsonTypeInfo.html" title="annotation in org.codehaus.jackson.annotate"><code>JsonTypeInfo</code></a> to indicate sub types of serializable 264 polymorphic types, and to associate logical names used within JSON content 265 (which is more portable than using physical Java class names).</div> 266</td> 267</tr> 268<tr class="altColor"> 269<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonSubTypes.Type.html" title="annotation in org.codehaus.jackson.annotate">JsonSubTypes.Type</a></td> 270<td class="colLast"> 271<div class="block">Definition of a subtype, along with optional name.</div> 272</td> 273</tr> 274<tr class="rowColor"> 275<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonTypeInfo.html" title="annotation in org.codehaus.jackson.annotate">JsonTypeInfo</a></td> 276<td class="colLast"> 277<div class="block">Annotation used for configuring details of if and how type information is 278 used with JSON serialization and deserialization, to preserve information 279 about actual class of Object instances.</div> 280</td> 281</tr> 282<tr class="altColor"> 283<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonTypeName.html" title="annotation in org.codehaus.jackson.annotate">JsonTypeName</a></td> 284<td class="colLast"> 285<div class="block">Annotation used for binding logical name that the annotated class 286 has.</div> 287</td> 288</tr> 289<tr class="rowColor"> 290<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonUnwrapped.html" title="annotation in org.codehaus.jackson.annotate">JsonUnwrapped</a></td> 291<td class="colLast"> 292<div class="block">Annotation used to indicate that a property should be serialized 293 "unwrapped"; that is, if it would be serialized as JSON Object, its 294 properties are instead included as properties of its containing 295 Object.</div> 296</td> 297</tr> 298<tr class="altColor"> 299<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonValue.html" title="annotation in org.codehaus.jackson.annotate">JsonValue</a></td> 300<td class="colLast"> 301<div class="block">Marker annotation similar to 302 <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> 303 that indicates that results of the annotated "getter" method 304 (which means signature must be that of getters; non-void return 305 type, no args) is to be used as the single value to serialize 306 for the instance.</div> 307</td> 308</tr> 309<tr class="rowColor"> 310<td class="colFirst"><a href="../../../../org/codehaus/jackson/annotate/JsonWriteNullProperties.html" title="annotation in org.codehaus.jackson.annotate">JsonWriteNullProperties</a></td> 311<td class="colLast">Deprecated 312<div class="block"><i>(since 1.6) Currently recommended annotation to use is 313 <a href="../../../../org/codehaus/jackson/map/annotate/JsonSerialize.html#include()"><code>JsonSerialize.include()</code></a> 314 (with values <code>ALWAYS</code> or <code>NON_NULL</code>)</i></div> 315</td> 316</tr> 317</tbody> 318</table> 319</li> 320</ul> 321<a name="package_description"> 322<!-- --> 323</a> 324<h2 title="Package org.codehaus.jackson.annotate Description">Package org.codehaus.jackson.annotate Description</h2> 325<div class="block">Public core annotations, most of which are used to configure how 326 Data Mapping/Binding works. Annotations in this package can only 327 have dependencies to non-annotation classes in Core package; 328 annotations that have dependencies to Mapper classes are included 329 in Mapper module (under <code>org.codehaus.jackson.map.annotate</code>). 330 Also contains parameter types (mostly enums) needed by annotations. 331<p> 332 In future (version 2.0?), this package will probably be split off 333 as a separate jar/module, to allow use of annotations without 334 including core module. This would be useful for third party value 335 classes that themselves do not depend on Jackson, but may want to 336 be annotated to be automatically and conveniently serializable by 337 Jackson.</div> 338</div> 339<!-- ======= START OF BOTTOM NAVBAR ====== --> 340<div class="bottomNav"><a name="navbar_bottom"> 341<!-- --> 342</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 343<!-- --> 344</a> 345<ul class="navList" title="Navigation"> 346<li><a href="../../../../overview-summary.html">Overview</a></li> 347<li class="navBarCell1Rev">Package</li> 348<li>Class</li> 349<li><a href="package-use.html">Use</a></li> 350<li><a href="package-tree.html">Tree</a></li> 351<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 352<li><a href="../../../../index-all.html">Index</a></li> 353<li><a href="../../../../help-doc.html">Help</a></li> 354</ul> 355</div> 356<div class="subNav"> 357<ul class="navList"> 358<li><a href="../../../../org/codehaus/jackson/package-summary.html">Prev Package</a></li> 359<li><a href="../../../../org/codehaus/jackson/format/package-summary.html">Next Package</a></li> 360</ul> 361<ul class="navList"> 362<li><a href="../../../../index.html?org/codehaus/jackson/annotate/package-summary.html" target="_top">Frames</a></li> 363<li><a href="package-summary.html" target="_top">No Frames</a></li> 364</ul> 365<ul class="navList" id="allclasses_navbar_bottom"> 366<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 367</ul> 368<div> 369<script type="text/javascript"><!-- 370 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 371 if(window==top) { 372 allClassesLink.style.display = "block"; 373 } 374 else { 375 allClassesLink.style.display = "none"; 376 } 377 //--> 378</script> 379</div> 380<a name="skip-navbar_bottom"> 381<!-- --> 382</a></div> 383<!-- ======== END OF BOTTOM NAVBAR ======= --> 384</body> 385</html> 386