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>Uses of Package 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="Uses of Package 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 class="navBarCell1Rev">Use</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</li> 47<li>Next</li> 48</ul> 49<ul class="navList"> 50<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/package-use.html" target="_top">Frames</a></li> 51<li><a href="package-use.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="Uses of Package com.fasterxml.jackson.annotation" class="title">Uses of Package<br>com.fasterxml.jackson.annotation</h1> 74</div> 75<div class="contentContainer"> 76<ul class="blockList"> 77<li class="blockList"><a name="com.fasterxml.jackson.annotation"> 78<!-- --> 79</a> 80<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> 81<caption><span>Classes in <a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">com.fasterxml.jackson.annotation</a> used by <a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">com.fasterxml.jackson.annotation</a></span><span class="tabEnd"> </span></caption> 82<tr> 83<th class="colOne" scope="col">Class and Description</th> 84</tr> 85<tbody> 86<tr class="altColor"> 87<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JacksonAnnotation.html#com.fasterxml.jackson.annotation">JacksonAnnotation</a> 88<div class="block">Meta-annotation (annotations used on other annotations) 89 used for marking all annotations that are 90 part of Jackson package.</div> 91</td> 92</tr> 93<tr class="rowColor"> 94<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JacksonAnnotationValue.html#com.fasterxml.jackson.annotation">JacksonAnnotationValue</a> 95<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 96 to contain information from one of Jackson annotations, and can be directly 97 instantiated from those annotations, as well as programmatically constructed 98 and possibly merged.</div> 99</td> 100</tr> 101<tr class="altColor"> 102<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JacksonInject.html#com.fasterxml.jackson.annotation">JacksonInject</a> 103<div class="block">Jackson-specific annotation used for indicating that value of 104 annotated property will be "injected", i.e.</div> 105</td> 106</tr> 107<tr class="rowColor"> 108<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JacksonInject.Value.html#com.fasterxml.jackson.annotation">JacksonInject.Value</a> 109<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> 110 annotation, as well as to provide possible overrides from non-annotation sources.</div> 111</td> 112</tr> 113<tr class="altColor"> 114<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JsonAutoDetect.html#com.fasterxml.jackson.annotation">JsonAutoDetect</a> 115<div class="block">Class annotation that can be used to define which kinds of Methods 116 are to be detected by auto-detection, and with what minimum access level.</div> 117</td> 118</tr> 119<tr class="rowColor"> 120<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JsonAutoDetect.Value.html#com.fasterxml.jackson.annotation">JsonAutoDetect.Value</a> 121<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> 122 annotation, as well as to provide possible overrides from non-annotation sources.</div> 123</td> 124</tr> 125<tr class="altColor"> 126<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JsonAutoDetect.Visibility.html#com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</a> 127<div class="block">Enumeration for possible visibility thresholds (minimum visibility) 128 that can be used to limit which methods (and fields) are 129 auto-detected.</div> 130</td> 131</tr> 132<tr class="rowColor"> 133<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JsonCreator.Mode.html#com.fasterxml.jackson.annotation">JsonCreator.Mode</a> </td> 134</tr> 135<tr class="altColor"> 136<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JsonFormat.html#com.fasterxml.jackson.annotation">JsonFormat</a> 137<div class="block">General-purpose annotation used for configuring details of how 138 values of properties are to be serialized.</div> 139</td> 140</tr> 141<tr class="rowColor"> 142<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JsonFormat.Feature.html#com.fasterxml.jackson.annotation">JsonFormat.Feature</a> 143<div class="block">Set of features that can be enabled/disabled for property annotated.</div> 144</td> 145</tr> 146<tr class="altColor"> 147<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JsonFormat.Features.html#com.fasterxml.jackson.annotation">JsonFormat.Features</a> 148<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> 149 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> 150</td> 151</tr> 152<tr class="rowColor"> 153<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JsonFormat.Shape.html#com.fasterxml.jackson.annotation">JsonFormat.Shape</a> 154<div class="block">Value enumeration used for indicating preferred Shape; translates 155 loosely to JSON types, with some extra values to indicate less precise 156 choices (i.e.</div> 157</td> 158</tr> 159<tr class="altColor"> 160<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JsonFormat.Value.html#com.fasterxml.jackson.annotation">JsonFormat.Value</a> 161<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> 162 annotation.</div> 163</td> 164</tr> 165<tr class="rowColor"> 166<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JsonIgnoreProperties.html#com.fasterxml.jackson.annotation">JsonIgnoreProperties</a> 167<div class="block">Annotation that can be used to either suppress serialization of 168 properties (during serialization), or ignore processing of 169 JSON properties read (during deserialization).</div> 170</td> 171</tr> 172<tr class="altColor"> 173<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JsonIgnoreProperties.Value.html#com.fasterxml.jackson.annotation">JsonIgnoreProperties.Value</a> 174<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> 175 annotation, as well as to provide possible overrides from non-annotation sources.</div> 176</td> 177</tr> 178<tr class="rowColor"> 179<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JsonInclude.html#com.fasterxml.jackson.annotation">JsonInclude</a> 180<div class="block">Annotation used to indicate when value of the annotated property (when 181 used for a field, method or constructor parameter), or all 182 properties of the annotated class, is to be serialized.</div> 183</td> 184</tr> 185<tr class="altColor"> 186<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JsonInclude.Include.html#com.fasterxml.jackson.annotation">JsonInclude.Include</a> 187<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> 188 to define which properties 189 of Java Beans are to be included in serialization.</div> 190</td> 191</tr> 192<tr class="rowColor"> 193<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JsonInclude.Value.html#com.fasterxml.jackson.annotation">JsonInclude.Value</a> 194<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> 195 annotation.</div> 196</td> 197</tr> 198<tr class="altColor"> 199<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JsonProperty.Access.html#com.fasterxml.jackson.annotation">JsonProperty.Access</a> 200<div class="block">Various options for <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html#access--"><code>JsonProperty.access()</code></a> property, specifying how property 201 may be accessed during serialization ("read") and deserialization ("write") 202 (note that the direction of read and write is from perspective of the property, 203 not from external data format: this may be confusing in some contexts).</div> 204</td> 205</tr> 206<tr class="rowColor"> 207<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JsonSetter.html#com.fasterxml.jackson.annotation">JsonSetter</a> 208<div class="block">Annotation that can be used to define a non-static, 209 single-argument method to be used as a "setter" for a logical property 210 as an alternative to recommended 211 <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonProperty</code></a> annotation; 212 or (as of 2.9 and later), specify additional aspects of the 213 assigning property a value during serialization.</div> 214</td> 215</tr> 216<tr class="altColor"> 217<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JsonSetter.Value.html#com.fasterxml.jackson.annotation">JsonSetter.Value</a> 218<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> 219 annotation, as well as to provide possible overrides from non-annotation sources.</div> 220</td> 221</tr> 222<tr class="rowColor"> 223<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JsonTypeInfo.As.html#com.fasterxml.jackson.annotation">JsonTypeInfo.As</a> 224<div class="block">Definition of standard type inclusion mechanisms for type metadata.</div> 225</td> 226</tr> 227<tr class="altColor"> 228<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/JsonTypeInfo.Id.html#com.fasterxml.jackson.annotation">JsonTypeInfo.Id</a> 229<div class="block">Definition of different type identifiers that can be included in JSON 230 during serialization, and used for deserialization.</div> 231</td> 232</tr> 233<tr class="rowColor"> 234<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/Nulls.html#com.fasterxml.jackson.annotation">Nulls</a> 235<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` 236 and `contentNulls`) 237 to define how explicit `null` values from input (if input format 238 has the concept; JSON, for example does) are handled.</div> 239</td> 240</tr> 241<tr class="altColor"> 242<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/ObjectIdGenerator.html#com.fasterxml.jackson.annotation">ObjectIdGenerator</a> 243<div class="block">Definition of API used for constructing Object Identifiers 244 (as annotated using <a href="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonIdentityInfo</code></a>).</div> 245</td> 246</tr> 247<tr class="rowColor"> 248<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/ObjectIdGenerator.IdKey.html#com.fasterxml.jackson.annotation">ObjectIdGenerator.IdKey</a> 249<div class="block">Simple key class that can be used as a key for 250 ObjectId-to-POJO mappings, when multiple ObjectId types 251 and scopes are used.</div> 252</td> 253</tr> 254<tr class="altColor"> 255<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/ObjectIdResolver.html#com.fasterxml.jackson.annotation">ObjectIdResolver</a> 256<div class="block">Definition of API used for resolving actual Java object from 257 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> 258</td> 259</tr> 260<tr class="rowColor"> 261<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/OptBoolean.html#com.fasterxml.jackson.annotation">OptBoolean</a> 262<div class="block">Optional Boolean value ("nullean").</div> 263</td> 264</tr> 265<tr class="altColor"> 266<td class="colOne"><a href="../../../../com/fasterxml/jackson/annotation/class-use/PropertyAccessor.html#com.fasterxml.jackson.annotation">PropertyAccessor</a> 267<div class="block">Enumeration used to define kinds of elements (called "property accessors") 268 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> 269</td> 270</tr> 271</tbody> 272</table> 273</li> 274</ul> 275</div> 276<!-- ======= START OF BOTTOM NAVBAR ====== --> 277<div class="bottomNav"><a name="navbar.bottom"> 278<!-- --> 279</a> 280<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 281<a name="navbar.bottom.firstrow"> 282<!-- --> 283</a> 284<ul class="navList" title="Navigation"> 285<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 286<li>Class</li> 287<li class="navBarCell1Rev">Use</li> 288<li><a href="package-tree.html">Tree</a></li> 289<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 290<li><a href="../../../../index-all.html">Index</a></li> 291<li><a href="../../../../help-doc.html">Help</a></li> 292</ul> 293</div> 294<div class="subNav"> 295<ul class="navList"> 296<li>Prev</li> 297<li>Next</li> 298</ul> 299<ul class="navList"> 300<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/package-use.html" target="_top">Frames</a></li> 301<li><a href="package-use.html" target="_top">No Frames</a></li> 302</ul> 303<ul class="navList" id="allclasses_navbar_bottom"> 304<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 305</ul> 306<div> 307<script type="text/javascript"><!-- 308 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 309 if(window==top) { 310 allClassesLink.style.display = "block"; 311 } 312 else { 313 allClassesLink.style.display = "none"; 314 } 315 //--> 316</script> 317</div> 318<a name="skip.navbar.bottom"> 319<!-- --> 320</a></div> 321<!-- ======== END OF BOTTOM NAVBAR ======= --> 322<p class="legalCopy"><small>Copyright © 2008–2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 323</body> 324</html> 325