• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 Thu Jul 07 10:49:28 PDT 2016 -->
6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<title>com.fasterxml.jackson.annotation (Jackson-annotations 2.8.0 API)</title>
8<meta name="date" content="2016-07-07">
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="com.fasterxml.jackson.annotation (Jackson-annotations 2.8.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><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>Prev Package</li>
40<li>Next Package</li>
41</ul>
42<ul class="navList">
43<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/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&nbsp;com.fasterxml.jackson.annotation</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:&nbsp;<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="Interface Summary table, listing interfaces, and an explanation">
77<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
78<tr>
79<th class="colFirst" scope="col">Interface</th>
80<th class="colLast" scope="col">Description</th>
81</tr>
82<tbody>
83<tr class="altColor">
84<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JacksonAnnotationValue.html" title="interface in com.fasterxml.jackson.annotation">JacksonAnnotationValue</a>&lt;A extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Annotation.html?is-external=true" title="class or interface in java.lang.annotation">Annotation</a>&gt;</td>
85<td class="colLast">
86<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
87 to contain information from one of Jackson annotations, and can be directly
88 instantiated from those annotations, as well as programmatically constructed
89 and possibly merged.</div>
90</td>
91</tr>
92<tr class="rowColor">
93<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdResolver.html" title="interface in com.fasterxml.jackson.annotation">ObjectIdResolver</a></td>
94<td class="colLast">
95<div class="block">Definition of API used for resolving actual Java object from
96 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>
97</td>
98</tr>
99</tbody>
100</table>
101</li>
102<li class="blockList">
103<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
104<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
105<tr>
106<th class="colFirst" scope="col">Class</th>
107<th class="colLast" scope="col">Description</th>
108</tr>
109<tbody>
110<tr class="altColor">
111<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Features.html" title="class in com.fasterxml.jackson.annotation">JsonFormat.Features</a></td>
112<td class="colLast">
113<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>
114 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>
115</td>
116</tr>
117<tr class="rowColor">
118<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Value.html" title="class in com.fasterxml.jackson.annotation">JsonFormat.Value</a></td>
119<td class="colLast">
120<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>
121 annotation.</div>
122</td>
123</tr>
124<tr class="altColor">
125<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIgnoreProperties.Value.html" title="class in com.fasterxml.jackson.annotation">JsonIgnoreProperties.Value</a></td>
126<td class="colLast">
127<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>
128 annotation, as well as to provide possible overrides from non-annotation sources.</div>
129</td>
130</tr>
131<tr class="rowColor">
132<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Value.html" title="class in com.fasterxml.jackson.annotation">JsonInclude.Value</a></td>
133<td class="colLast">
134<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>
135 annotation.</div>
136</td>
137</tr>
138<tr class="altColor">
139<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.None.html" title="class in com.fasterxml.jackson.annotation">JsonTypeInfo.None</a></td>
140<td class="colLast">Deprecated
141<div class="block"><i>Since 2.5, use any Annotation type (such as <a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonTypeInfo</code></a>,
142    if such behavior is needed; this is rarely necessary.</i></div>
143</td>
144</tr>
145<tr class="rowColor">
146<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerator</a>&lt;T&gt;</td>
147<td class="colLast">
148<div class="block">Definition of API used for constructing Object Identifiers
149 (as annotated using <a href="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonIdentityInfo</code></a>).</div>
150</td>
151</tr>
152<tr class="altColor">
153<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerator.IdKey</a></td>
154<td class="colLast">
155<div class="block">Simple key class that can be used as a key for
156 ObjectId-to-POJO mappings, when multiple ObjectId types
157 and scopes are used.</div>
158</td>
159</tr>
160<tr class="rowColor">
161<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators</a></td>
162<td class="colLast">
163<div class="block">Container class for standard <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerator</code></a> implementations:
164
165  <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.IntSequenceGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerators.IntSequenceGenerator</code></a>
166  <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.PropertyGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerators.PropertyGenerator</code></a>
167  <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.StringIdGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerators.StringIdGenerator</code></a> (since 2.7)
168  <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.UUIDGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerators.UUIDGenerator</code></a>
169</div>
170</td>
171</tr>
172<tr class="altColor">
173<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.IntSequenceGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.IntSequenceGenerator</a></td>
174<td class="colLast">
175<div class="block">Simple sequence-number based generator, which uses basic Java
176 <code>int</code>s (starting with value 1) as Object Identifiers.</div>
177</td>
178</tr>
179<tr class="rowColor">
180<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.None.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.None</a></td>
181<td class="colLast">
182<div class="block">Abstract marker class used to allow explicitly specifying
183 that no generator is used; which also implies that no
184 Object Id is to be included or used.</div>
185</td>
186</tr>
187<tr class="altColor">
188<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.PropertyGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.PropertyGenerator</a></td>
189<td class="colLast">
190<div class="block">Abstract place-holder class which is used to denote case
191 where Object Identifier to use comes from a POJO property
192 (getter method or field).</div>
193</td>
194</tr>
195<tr class="rowColor">
196<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.StringIdGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.StringIdGenerator</a></td>
197<td class="colLast">
198<div class="block">Implementation that will accept arbitrary (but unique) String Ids on
199 deserialization, and (by default) use random UUID generation similar
200 to <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.UUIDGenerator.html" title="class in com.fasterxml.jackson.annotation"><code>ObjectIdGenerators.UUIDGenerator</code></a> for generation ids.</div>
201</td>
202</tr>
203<tr class="altColor">
204<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.UUIDGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.UUIDGenerator</a></td>
205<td class="colLast">
206<div class="block">Implementation that just uses <a href="http://docs.oracle.com/javase/6/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util"><code>UUID</code></a>s as reliably
207 unique identifiers: downside is that resulting String is
208 36 characters long.</div>
209</td>
210</tr>
211<tr class="rowColor">
212<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/SimpleObjectIdResolver.html" title="class in com.fasterxml.jackson.annotation">SimpleObjectIdResolver</a></td>
213<td class="colLast">
214<div class="block">Simple implementation of <a href="../../../../com/fasterxml/jackson/annotation/ObjectIdResolver.html" title="interface in com.fasterxml.jackson.annotation"><code>ObjectIdResolver</code></a></div>
215</td>
216</tr>
217</tbody>
218</table>
219</li>
220<li class="blockList">
221<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
222<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
223<tr>
224<th class="colFirst" scope="col">Enum</th>
225<th class="colLast" scope="col">Description</th>
226</tr>
227<tbody>
228<tr class="altColor">
229<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</a></td>
230<td class="colLast">
231<div class="block">Enumeration for possible visibility thresholds (minimum visibility)
232 that can be used to limit which methods (and fields) are
233 auto-detected.</div>
234</td>
235</tr>
236<tr class="rowColor">
237<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html" title="enum in com.fasterxml.jackson.annotation">JsonCreator.Mode</a></td>
238<td class="colLast">&nbsp;</td>
239</tr>
240<tr class="altColor">
241<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Feature.html" title="enum in com.fasterxml.jackson.annotation">JsonFormat.Feature</a></td>
242<td class="colLast">
243<div class="block">Set of features that can be enabled/disabled for property annotated.</div>
244</td>
245</tr>
246<tr class="rowColor">
247<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Shape.html" title="enum in com.fasterxml.jackson.annotation">JsonFormat.Shape</a></td>
248<td class="colLast">
249<div class="block">Value enumeration used for indicating preferred Shape; translates
250 loosely to JSON types, with some extra values to indicate less precise
251 choices (i.e.</div>
252</td>
253</tr>
254<tr class="altColor">
255<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a></td>
256<td class="colLast">
257<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>
258 to define which properties
259 of Java Beans are to be included in serialization.</div>
260</td>
261</tr>
262<tr class="rowColor">
263<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation">JsonProperty.Access</a></td>
264<td class="colLast">
265<div class="block">Various options for <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html#access()"><code>JsonProperty.access()</code></a> property, specifying how property
266 may be accessed during serialization ("read") and deserialization ("write")
267 (note that the direction of read and write is from perspective of the property,
268 not from external data format: this may be confusing in some contexts).</div>
269</td>
270</tr>
271<tr class="altColor">
272<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.As.html" title="enum in com.fasterxml.jackson.annotation">JsonTypeInfo.As</a></td>
273<td class="colLast">
274<div class="block">Definition of standard type inclusion mechanisms for type metadata.</div>
275</td>
276</tr>
277<tr class="rowColor">
278<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.Id.html" title="enum in com.fasterxml.jackson.annotation">JsonTypeInfo.Id</a></td>
279<td class="colLast">
280<div class="block">Definition of different type identifiers that can be included in JSON
281 during serialization, and used for deserialization.</div>
282</td>
283</tr>
284<tr class="altColor">
285<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html" title="enum in com.fasterxml.jackson.annotation">OptBoolean</a></td>
286<td class="colLast">
287<div class="block">Optional Boolean value ("nullean").</div>
288</td>
289</tr>
290<tr class="rowColor">
291<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/PropertyAccessor.html" title="enum in com.fasterxml.jackson.annotation">PropertyAccessor</a></td>
292<td class="colLast">
293<div class="block">Enumeration used to define kinds of elements (called "property accessors")
294 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>
295</td>
296</tr>
297</tbody>
298</table>
299</li>
300<li class="blockList">
301<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation">
302<caption><span>Annotation Types Summary</span><span class="tabEnd">&nbsp;</span></caption>
303<tr>
304<th class="colFirst" scope="col">Annotation Type</th>
305<th class="colLast" scope="col">Description</th>
306</tr>
307<tbody>
308<tr class="altColor">
309<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JacksonAnnotation.html" title="annotation in com.fasterxml.jackson.annotation">JacksonAnnotation</a></td>
310<td class="colLast">
311<div class="block">Meta-annotation (annotations used on other annotations)
312 used for marking all annotations that are
313 part of Jackson package.</div>
314</td>
315</tr>
316<tr class="rowColor">
317<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JacksonAnnotationsInside.html" title="annotation in com.fasterxml.jackson.annotation">JacksonAnnotationsInside</a></td>
318<td class="colLast">
319<div class="block">Meta-annotation (annotations used on other annotations)
320 used for indicating that instead of using target annotation
321 (annotation annotated with this annotation),
322 Jackson should use meta-annotations it has.</div>
323</td>
324</tr>
325<tr class="altColor">
326<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JacksonInject.html" title="annotation in com.fasterxml.jackson.annotation">JacksonInject</a></td>
327<td class="colLast">
328<div class="block">Jackson-specific annotation used for indicating that value of
329 annotated property will be "injected", i.e.</div>
330</td>
331</tr>
332<tr class="rowColor">
333<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAnyGetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonAnyGetter</a></td>
334<td class="colLast">
335<div class="block">Marker annotation that can be used to define a non-static,
336 no-argument method or member field as something of a reverse of
337 <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
338 getter but such that contents of the returned Map (type <b>must</b> be
339 <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
340 of the bean that contains method/field with this annotations.</div>
341</td>
342</tr>
343<tr class="altColor">
344<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonAnySetter</a></td>
345<td class="colLast">
346<div class="block">Marker annotation that can be used to define a non-static,
347 two-argument method (first argument name of property, second value
348 to set), to be used as a "fallback" handler
349 for all otherwise unrecognized properties found from JSON content.</div>
350</td>
351</tr>
352<tr class="rowColor">
353<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html" title="annotation in com.fasterxml.jackson.annotation">JsonAutoDetect</a></td>
354<td class="colLast">
355<div class="block">Class annotation that can be used to define which kinds of Methods
356 are to be detected by auto-detection, and with what minimum access level.</div>
357</td>
358</tr>
359<tr class="altColor">
360<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonBackReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonBackReference</a></td>
361<td class="colLast">
362<div class="block">Annotation used to indicate that associated property is part of
363 two-way linkage between fields; and that its role is "child" (or "back") link.</div>
364</td>
365</tr>
366<tr class="rowColor">
367<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonClassDescription.html" title="annotation in com.fasterxml.jackson.annotation">JsonClassDescription</a></td>
368<td class="colLast">
369<div class="block">Annotation used to define a human readable description for annotated
370 type (class).</div>
371</td>
372</tr>
373<tr class="altColor">
374<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.html" title="annotation in com.fasterxml.jackson.annotation">JsonCreator</a></td>
375<td class="colLast">
376<div class="block">Marker annotation that can be used to define constructors and factory
377 methods as one to use for instantiating new instances of the associated
378 class.</div>
379</td>
380</tr>
381<tr class="rowColor">
382<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonEnumDefaultValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonEnumDefaultValue</a></td>
383<td class="colLast">
384<div class="block">Marker annotation that can be used to define a default value
385 used when trying to deserialize unknown Enum values.</div>
386</td>
387</tr>
388<tr class="altColor">
389<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFilter.html" title="annotation in com.fasterxml.jackson.annotation">JsonFilter</a></td>
390<td class="colLast">
391<div class="block">Annotation used to indicate which logical filter is to be used
392 for filtering out properties of type (class) annotated;
393 association made by this annotation declaring ids of filters,
394 and  <code>com.fasterxml.jackson.databind.ObjectMapper</code> (or objects
395 it delegates to) providing matching filters by id.</div>
396</td>
397</tr>
398<tr class="rowColor">
399<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.html" title="annotation in com.fasterxml.jackson.annotation">JsonFormat</a></td>
400<td class="colLast">
401<div class="block">General-purpose annotation used for configuring details of how
402 values of properties are to be serialized.</div>
403</td>
404</tr>
405<tr class="altColor">
406<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonGetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonGetter</a></td>
407<td class="colLast">
408<div class="block">Marker annotation that can be used to define a non-static,
409 no-argument value-returning (non-void) method to be used as a "getter"
410 for a logical property.</div>
411</td>
412</tr>
413<tr class="rowColor">
414<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation">JsonIdentityInfo</a></td>
415<td class="colLast">
416<div class="block">Annotation used for indicating that values of annotated type
417 or property should be serializing so that instances either
418 contain additional object identifier (in addition actual object
419 properties), or as a reference that consists of an object id
420 that refers to a full serialization.</div>
421</td>
422</tr>
423<tr class="altColor">
424<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIdentityReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonIdentityReference</a></td>
425<td class="colLast">
426<div class="block">Optional annotation that can be used for customizing details of a reference
427 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>
428</td>
429</tr>
430<tr class="rowColor">
431<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIgnore.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnore</a></td>
432<td class="colLast">
433<div class="block">Marker annotation that indicates that the annotated method or field is to be
434 ignored by introspection-based
435 serialization and deserialization functionality.</div>
436</td>
437</tr>
438<tr class="altColor">
439<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIgnoreProperties.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnoreProperties</a></td>
440<td class="colLast">
441<div class="block">Annotation that can be used to either suppress serialization of
442 properties (during serialization), or ignore processing of
443 JSON properties read (during deserialization).</div>
444</td>
445</tr>
446<tr class="rowColor">
447<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIgnoreType.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnoreType</a></td>
448<td class="colLast">
449<div class="block">Marker annotation that indicates that all properties of annotated
450 type are to be ignored during serialization and deserialization.</div>
451</td>
452</tr>
453<tr class="altColor">
454<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.html" title="annotation in com.fasterxml.jackson.annotation">JsonInclude</a></td>
455<td class="colLast">
456<div class="block">Annotation used to indicate when value of the annotated property (when
457 used for a field, method or constructor parameter), or all
458 properties of the annotated class, is to be serialized.</div>
459</td>
460</tr>
461<tr class="rowColor">
462<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonManagedReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonManagedReference</a></td>
463<td class="colLast">
464<div class="block">Annotation used to indicate that annotated property is part of
465 two-way linkage between fields; and that its role is "parent" (or "forward") link.</div>
466</td>
467</tr>
468<tr class="altColor">
469<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation">JsonProperty</a></td>
470<td class="colLast">
471<div class="block">Marker annotation that can be used to define a non-static
472 method as a "setter" or "getter" for a logical property
473 (depending on its signature),
474 or non-static object field to be used (serialized, deserialized) as
475 a logical property.</div>
476</td>
477</tr>
478<tr class="rowColor">
479<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyDescription.html" title="annotation in com.fasterxml.jackson.annotation">JsonPropertyDescription</a></td>
480<td class="colLast">
481<div class="block">Annotation used to define a human readable description for a logical
482 property.</div>
483</td>
484</tr>
485<tr class="altColor">
486<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyOrder.html" title="annotation in com.fasterxml.jackson.annotation">JsonPropertyOrder</a></td>
487<td class="colLast">
488<div class="block">Annotation that can be used to define ordering (possibly partial) to use
489 when serializing object properties.</div>
490</td>
491</tr>
492<tr class="rowColor">
493<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonRawValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonRawValue</a></td>
494<td class="colLast">
495<div class="block">Marker annotation that indicates that the annotated method
496 or field should be serialized by including literal String value
497 of the property as is, without quoting of characters.</div>
498</td>
499</tr>
500<tr class="altColor">
501<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonRootName.html" title="annotation in com.fasterxml.jackson.annotation">JsonRootName</a></td>
502<td class="colLast">
503<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>,
504 used to indicate name to use for root-level wrapping, if wrapping is
505 enabled.</div>
506</td>
507</tr>
508<tr class="rowColor">
509<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonSetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonSetter</a></td>
510<td class="colLast">
511<div class="block">Marker annotation that can be used to define a non-static,
512 single-argument method to be used as a "setter" for a logical property
513 as an alternative to recommended
514 <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>
515</td>
516</tr>
517<tr class="altColor">
518<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonSubTypes.html" title="annotation in com.fasterxml.jackson.annotation">JsonSubTypes</a></td>
519<td class="colLast">
520<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
521 polymorphic types, and to associate logical names used within JSON content
522 (which is more portable than using physical Java class names).</div>
523</td>
524</tr>
525<tr class="rowColor">
526<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonSubTypes.Type.html" title="annotation in com.fasterxml.jackson.annotation">JsonSubTypes.Type</a></td>
527<td class="colLast">
528<div class="block">Definition of a subtype, along with optional name.</div>
529</td>
530</tr>
531<tr class="altColor">
532<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeId.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeId</a></td>
533<td class="colLast">
534<div class="block">Marker annotation that can be used on a property accessor
535 (field, getter or setter, constructor parameter) to indicate that
536 the property is to contain type id to use when including
537 polymorphic type information.</div>
538</td>
539</tr>
540<tr class="rowColor">
541<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeInfo</a></td>
542<td class="colLast">
543<div class="block">Annotation used for configuring details of if and how type information is
544 used with JSON serialization and deserialization, to preserve information
545 about actual class of Object instances.</div>
546</td>
547</tr>
548<tr class="altColor">
549<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeName.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeName</a></td>
550<td class="colLast">
551<div class="block">Annotation used for binding logical name that the annotated class
552 has.</div>
553</td>
554</tr>
555<tr class="rowColor">
556<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonUnwrapped.html" title="annotation in com.fasterxml.jackson.annotation">JsonUnwrapped</a></td>
557<td class="colLast">
558<div class="block">Annotation used to indicate that a property should be serialized
559 "unwrapped"; that is, if it would be serialized as JSON Object, its
560 properties are instead included as properties of its containing
561 Object.</div>
562</td>
563</tr>
564<tr class="altColor">
565<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonValue</a></td>
566<td class="colLast">
567<div class="block">Marker annotation similar to
568 <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>
569 that indicates that results of the annotated "getter" method
570 (which means signature must be that of getters; non-void return
571 type, no args) is to be used as the single value to serialize
572 for the instance.</div>
573</td>
574</tr>
575<tr class="rowColor">
576<td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonView.html" title="annotation in com.fasterxml.jackson.annotation">JsonView</a></td>
577<td class="colLast">
578<div class="block">Annotation used for indicating view(s) that the property
579 that is defined by method or field annotated is part of.</div>
580</td>
581</tr>
582</tbody>
583</table>
584</li>
585</ul>
586<a name="package_description">
587<!--   -->
588</a>
589<h2 title="Package com.fasterxml.jackson.annotation Description">Package com.fasterxml.jackson.annotation Description</h2>
590<div class="block">Public core annotations, most of which are used to configure how
591 Data Mapping/Binding works. Annotations in this package can only
592 have dependencies to non-annotation classes in Core package;
593 annotations that have dependencies to Mapper classes are included
594 in Mapper module (under <code>org.codehaus.jackson.map.annotate</code>).
595 Also contains parameter types (mostly enums) needed by annotations.
596<p>
597 Note that prior versions (1.x) contained these annotations within
598 'core' jar, as part of Streaming API.</div>
599</div>
600<!-- ======= START OF BOTTOM NAVBAR ====== -->
601<div class="bottomNav"><a name="navbar_bottom">
602<!--   -->
603</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
604<!--   -->
605</a>
606<ul class="navList" title="Navigation">
607<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li>
608<li>Class</li>
609<li><a href="package-use.html">Use</a></li>
610<li><a href="package-tree.html">Tree</a></li>
611<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
612<li><a href="../../../../index-all.html">Index</a></li>
613<li><a href="../../../../help-doc.html">Help</a></li>
614</ul>
615</div>
616<div class="subNav">
617<ul class="navList">
618<li>Prev Package</li>
619<li>Next Package</li>
620</ul>
621<ul class="navList">
622<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/package-summary.html" target="_top">Frames</a></li>
623<li><a href="package-summary.html" target="_top">No Frames</a></li>
624</ul>
625<ul class="navList" id="allclasses_navbar_bottom">
626<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
627</ul>
628<div>
629<script type="text/javascript"><!--
630  allClassesLink = document.getElementById("allclasses_navbar_bottom");
631  if(window==top) {
632    allClassesLink.style.display = "block";
633  }
634  else {
635    allClassesLink.style.display = "none";
636  }
637  //-->
638</script>
639</div>
640<a name="skip-navbar_bottom">
641<!--   -->
642</a></div>
643<!-- ======== END OF BOTTOM NAVBAR ======= -->
644<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2016 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
645</body>
646</html>
647