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