<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (version 1.7.0_67) on Thu Jul 16 17:03:18 PDT 2015 --> <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> <title>com.fasterxml.jackson.annotation (Jackson-annotations 2.6.0 API)</title> <meta name="date" content="2015-07-16"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="com.fasterxml.jackson.annotation (Jackson-annotations 2.6.0 API)"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar_top"> <!-- --> </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> <li>Class</li> <li><a href="package-use.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li>Prev Package</li> <li>Next Package</li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/fasterxml/jackson/annotation/package-summary.html" target="_top">Frames</a></li> <li><a href="package-summary.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <div class="header"> <h1 title="Package" class="title">Package com.fasterxml.jackson.annotation</h1> <div class="docSummary"> <div class="block">Public core annotations, most of which are used to configure how Data Mapping/Binding works.</div> </div> <p>See: <a href="#package_description">Description</a></p> </div> <div class="contentContainer"> <ul class="blockList"> <li class="blockList"> <table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Interface</th> <th class="colLast" scope="col">Description</th> </tr> <tbody> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JacksonAnnotationValue.html" title="interface in com.fasterxml.jackson.annotation">JacksonAnnotationValue</a><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>></td> <td class="colLast"> <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 to contain information from one of Jackson annotations, and can be directly instantiated from those annotations, as well as programmatically constructed and possibly merged.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdResolver.html" title="interface in com.fasterxml.jackson.annotation">ObjectIdResolver</a></td> <td class="colLast"> <div class="block">Definition of API used for resolving actual Java object from 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> </td> </tr> </tbody> </table> </li> <li class="blockList"> <table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Class</th> <th class="colLast" scope="col">Description</th> </tr> <tbody> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Features.html" title="class in com.fasterxml.jackson.annotation">JsonFormat.Features</a></td> <td class="colLast"> <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> 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> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Value.html" title="class in com.fasterxml.jackson.annotation">JsonFormat.Value</a></td> <td class="colLast"> <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> annotation.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Value.html" title="class in com.fasterxml.jackson.annotation">JsonInclude.Value</a></td> <td class="colLast"> <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> annotation.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.None.html" title="class in com.fasterxml.jackson.annotation">JsonTypeInfo.None</a></td> <td class="colLast">Deprecated <div class="block"><i>Since 2.5, use <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Void.html?is-external=true" title="class or interface in java.lang"><code>Void</code></a> instead.</i></div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerator</a><T></td> <td class="colLast"> <div class="block">Definition of API used for constructing 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> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.IdKey.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerator.IdKey</a></td> <td class="colLast"> <div class="block">Simple key class that can be used as a key for ObjectId-to-POJO mappings, when multiple ObjectId types and scopes are used.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators</a></td> <td class="colLast"> <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.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.IntSequenceGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.IntSequenceGenerator</a></td> <td class="colLast"> <div class="block">Simple sequence-number based generator, which uses basic Java <code>int</code>s (starting with value 1) as Object Identifiers.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.None.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.None</a></td> <td class="colLast"> <div class="block">Abstract marker class used to allow explicitly specifying that no generator is used; which also implies that no Object Id is to be included or used.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.PropertyGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.PropertyGenerator</a></td> <td class="colLast"> <div class="block">Abstract place-holder class which is used to denote case where Object Identifier to use comes from a POJO property (getter method or field).</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerators.UUIDGenerator.html" title="class in com.fasterxml.jackson.annotation">ObjectIdGenerators.UUIDGenerator</a></td> <td class="colLast"> <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 unique identifiers: downside is that resulting String is 36 characters long.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/SimpleObjectIdResolver.html" title="class in com.fasterxml.jackson.annotation">SimpleObjectIdResolver</a></td> <td class="colLast"> <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> </td> </tr> </tbody> </table> </li> <li class="blockList"> <table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Enum</th> <th class="colLast" scope="col">Description</th> </tr> <tbody> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation">JsonAutoDetect.Visibility</a></td> <td class="colLast"> <div class="block">Enumeration for possible visibility thresholds (minimum visibility) that can be used to limit which methods (and fields) are auto-detected.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.Mode.html" title="enum in com.fasterxml.jackson.annotation">JsonCreator.Mode</a></td> <td class="colLast"> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Feature.html" title="enum in com.fasterxml.jackson.annotation">JsonFormat.Feature</a></td> <td class="colLast"> <div class="block">Set of features that can be enabled/disabled for property annotated.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.Shape.html" title="enum in com.fasterxml.jackson.annotation">JsonFormat.Shape</a></td> <td class="colLast"> <div class="block">Value enumeration used for indicating preferred Shape; translates loosely to JSON types, with some extra values to indicate less precise choices (i.e.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a></td> <td class="colLast"> <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> to define which properties of Java Beans are to be included in serialization.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation">JsonProperty.Access</a></td> <td class="colLast"> <div class="block">Various options for <a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html#access()"><code>JsonProperty.access()</code></a> property, specifying how property may be accessed during serialization ("read") and deserialization ("write") (note that the direction of read and write is from perspective of the property, not from external data format: this may be confusing in some contexts).</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.As.html" title="enum in com.fasterxml.jackson.annotation">JsonTypeInfo.As</a></td> <td class="colLast"> <div class="block">Definition of standard type inclusion mechanisms for type metadata.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.Id.html" title="enum in com.fasterxml.jackson.annotation">JsonTypeInfo.Id</a></td> <td class="colLast"> <div class="block">Definition of different type identifiers that can be included in JSON during serialization, and used for deserialization.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/OptBoolean.html" title="enum in com.fasterxml.jackson.annotation">OptBoolean</a></td> <td class="colLast"> <div class="block">Optional Boolean value ("nullean").</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/PropertyAccessor.html" title="enum in com.fasterxml.jackson.annotation">PropertyAccessor</a></td> <td class="colLast"> <div class="block">Enumeration used to define kinds of elements (called "property accessors") 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> </td> </tr> </tbody> </table> </li> <li class="blockList"> <table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Annotation Types Summary table, listing annotation types, and an explanation"> <caption><span>Annotation Types Summary</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Annotation Type</th> <th class="colLast" scope="col">Description</th> </tr> <tbody> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JacksonAnnotation.html" title="annotation in com.fasterxml.jackson.annotation">JacksonAnnotation</a></td> <td class="colLast"> <div class="block">Meta-annotation (annotations used on other annotations) used for marking all annotations that are part of Jackson package.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JacksonAnnotationsInside.html" title="annotation in com.fasterxml.jackson.annotation">JacksonAnnotationsInside</a></td> <td class="colLast"> <div class="block">Meta-annotation (annotations used on other annotations) used for indicating that instead of using target annotation (annotation annotated with this annotation), Jackson should use meta-annotations it has.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JacksonInject.html" title="annotation in com.fasterxml.jackson.annotation">JacksonInject</a></td> <td class="colLast"> <div class="block">Jackson-specific annotation used for indicating that value of annotated property will be "injected", i.e.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAnyGetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonAnyGetter</a></td> <td class="colLast"> <div class="block">Marker annotation that can be used to define a non-static, no-argument method or member field as something of a reverse of <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 getter but such that contents of the returned Map (type <b>must</b> be <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 of the bean that contains method/field with this annotations.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonAnySetter</a></td> <td class="colLast"> <div class="block">Marker annotation that can be used to define a non-static, two-argument method (first argument name of property, second value to set), to be used as a "fallback" handler for all otherwise unrecognized properties found from JSON content.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html" title="annotation in com.fasterxml.jackson.annotation">JsonAutoDetect</a></td> <td class="colLast"> <div class="block">Class annotation that can be used to define which kinds of Methods are to be detected by auto-detection, and with what minimum access level.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonBackReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonBackReference</a></td> <td class="colLast"> <div class="block">Annotation used to indicate that associated property is part of two-way linkage between fields; and that its role is "child" (or "back") link.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.html" title="annotation in com.fasterxml.jackson.annotation">JsonCreator</a></td> <td class="colLast"> <div class="block">Marker annotation that can be used to define constructors and factory methods as one to use for instantiating new instances of the associated class.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFilter.html" title="annotation in com.fasterxml.jackson.annotation">JsonFilter</a></td> <td class="colLast"> <div class="block">Annotation used to indicate which logical filter is to be used for filtering out properties of type (class) annotated; association made by this annotation declaring ids of filters, and <code>com.fasterxml.jackson.databind.ObjectMapper</code> (or objects it delegates to) providing matching filters by id.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonFormat.html" title="annotation in com.fasterxml.jackson.annotation">JsonFormat</a></td> <td class="colLast"> <div class="block">General-purpose annotation used for configuring details of how values of properties are to be serialized.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonGetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonGetter</a></td> <td class="colLast"> <div class="block">Marker annotation that can be used to define a non-static, no-argument value-returning (non-void) method to be used as a "getter" for a logical property.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation">JsonIdentityInfo</a></td> <td class="colLast"> <div class="block">Annotation used for indicating that values of annotated type or property should be serializing so that instances either contain additional object identifier (in addition actual object properties), or as a reference that consists of an object id that refers to a full serialization.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIdentityReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonIdentityReference</a></td> <td class="colLast"> <div class="block">Optional annotation that can be used for customizing details of a reference 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> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIgnore.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnore</a></td> <td class="colLast"> <div class="block">Marker annotation that indicates that the annotated method or field is to be ignored by introspection-based serialization and deserialization functionality.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIgnoreProperties.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnoreProperties</a></td> <td class="colLast"> <div class="block">Annotation that can be used to either suppress serialization of properties (during serialization), or ignore processing of JSON properties read (during deserialization).</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonIgnoreType.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnoreType</a></td> <td class="colLast"> <div class="block">Marker annotation that indicates that all properties of annotated type are to be ignored during serialization and deserialization.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.html" title="annotation in com.fasterxml.jackson.annotation">JsonInclude</a></td> <td class="colLast"> <div class="block">Annotation used to indicate when value of the annotated property (when used for a field, method or constructor parameter), or all properties of the annotated class, is to be serialized.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonManagedReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonManagedReference</a></td> <td class="colLast"> <div class="block">Annotation used to indicate that annotated property is part of two-way linkage between fields; and that its role is "parent" (or "forward") link.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation">JsonProperty</a></td> <td class="colLast"> <div class="block">Marker annotation that can be used to define a non-static method as a "setter" or "getter" for a logical property (depending on its signature), or non-static object field to be used (serialized, deserialized) as a logical property.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyDescription.html" title="annotation in com.fasterxml.jackson.annotation">JsonPropertyDescription</a></td> <td class="colLast"> <div class="block">Annotation used to define a human readable description for a logical property.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyOrder.html" title="annotation in com.fasterxml.jackson.annotation">JsonPropertyOrder</a></td> <td class="colLast"> <div class="block">Annotation that can be used to define ordering (possibly partial) to use when serializing object properties.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonRawValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonRawValue</a></td> <td class="colLast"> <div class="block">Marker annotation that indicates that the annotated method or field should be serialized by including literal String value of the property as is, without quoting of characters.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonRootName.html" title="annotation in com.fasterxml.jackson.annotation">JsonRootName</a></td> <td class="colLast"> <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>, used to indicate name to use for root-level wrapping, if wrapping is enabled.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonSetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonSetter</a></td> <td class="colLast"> <div class="block">Marker annotation that can be used to define a non-static, single-argument method to be used as a "setter" for a logical property as an alternative to recommended <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> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonSubTypes.html" title="annotation in com.fasterxml.jackson.annotation">JsonSubTypes</a></td> <td class="colLast"> <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 polymorphic types, and to associate logical names used within JSON content (which is more portable than using physical Java class names).</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonSubTypes.Type.html" title="annotation in com.fasterxml.jackson.annotation">JsonSubTypes.Type</a></td> <td class="colLast"> <div class="block">Definition of a subtype, along with optional name.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeId.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeId</a></td> <td class="colLast"> <div class="block">Marker annotation that can be used on a property accessor (field, getter or setter, constructor parameter) to indicate that the property is to contain type id to use when including polymorphic type information.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeInfo</a></td> <td class="colLast"> <div class="block">Annotation used for configuring details of if and how type information is used with JSON serialization and deserialization, to preserve information about actual class of Object instances.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonTypeName.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeName</a></td> <td class="colLast"> <div class="block">Annotation used for binding logical name that the annotated class has.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonUnwrapped.html" title="annotation in com.fasterxml.jackson.annotation">JsonUnwrapped</a></td> <td class="colLast"> <div class="block">Annotation used to indicate that a property should be serialized "unwrapped"; that is, if it would be serialized as JSON Object, its properties are instead included as properties of its containing Object.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonValue</a></td> <td class="colLast"> <div class="block">Marker annotation similar to <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> that indicates that results of the annotated "getter" method (which means signature must be that of getters; non-void return type, no args) is to be used as the single value to serialize for the instance.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/annotation/JsonView.html" title="annotation in com.fasterxml.jackson.annotation">JsonView</a></td> <td class="colLast"> <div class="block">Annotation used for indicating view(s) that the property that is defined by method or field annotated is part of.</div> </td> </tr> </tbody> </table> </li> </ul> <a name="package_description"> <!-- --> </a> <h2 title="Package com.fasterxml.jackson.annotation Description">Package com.fasterxml.jackson.annotation Description</h2> <div class="block">Public core annotations, most of which are used to configure how Data Mapping/Binding works. Annotations in this package can only have dependencies to non-annotation classes in Core package; annotations that have dependencies to Mapper classes are included in Mapper module (under <code>org.codehaus.jackson.map.annotate</code>). Also contains parameter types (mostly enums) needed by annotations. <p> Note that prior versions (1.x) contained these annotations within 'core' jar, as part of Streaming API.</div> </div> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar_bottom"> <!-- --> </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> <li>Class</li> <li><a href="package-use.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li>Prev Package</li> <li>Next Package</li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/fasterxml/jackson/annotation/package-summary.html" target="_top">Frames</a></li> <li><a href="package-summary.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small>Copyright © 2014–2015 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> </body> </html>