<!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 (1.8.0_162) on Wed Sep 25 19:26:35 PDT 2019 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>Uses of Class com.fasterxml.jackson.annotation.JacksonAnnotation (Jackson-annotations 2.10.0 API)</title> <meta name="date" content="2019-09-25"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="Uses of Class com.fasterxml.jackson.annotation.JacksonAnnotation (Jackson-annotations 2.10.0 API)"; } } catch(err) { } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar.top"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <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><a href="../../../../../com/fasterxml/jackson/annotation/JacksonAnnotation.html" title="annotation in com.fasterxml.jackson.annotation">Class</a></li> <li class="navBarCell1Rev">Use</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</li> <li>Next</li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?com/fasterxml/jackson/annotation/class-use/JacksonAnnotation.html" target="_top">Frames</a></li> <li><a href="JacksonAnnotation.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"> <h2 title="Uses of Class com.fasterxml.jackson.annotation.JacksonAnnotation" class="title">Uses of Class<br>com.fasterxml.jackson.annotation.JacksonAnnotation</h2> </div> <div class="classUseContainer"> <ul class="blockList"> <li class="blockList"> <ul class="blockList"> <li class="blockList"><a name="com.fasterxml.jackson.annotation"> <!-- --> </a> <h3>Uses of <a href="../../../../../com/fasterxml/jackson/annotation/JacksonAnnotation.html" title="annotation in com.fasterxml.jackson.annotation">JacksonAnnotation</a> in <a href="../../../../../com/fasterxml/jackson/annotation/package-summary.html">com.fasterxml.jackson.annotation</a></h3> <table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> <caption><span>Classes in <a href="../../../../../com/fasterxml/jackson/annotation/package-summary.html">com.fasterxml.jackson.annotation</a> with annotations of type <a href="../../../../../com/fasterxml/jackson/annotation/JacksonAnnotation.html" title="annotation in com.fasterxml.jackson.annotation">JacksonAnnotation</a></span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Class and Description</th> </tr> <tbody> <tr class="altColor"> <td class="colFirst"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JacksonAnnotationsInside.html" title="annotation in com.fasterxml.jackson.annotation">JacksonAnnotationsInside</a></span></code> <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="rowColor"> <td class="colFirst"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JacksonInject.html" title="annotation in com.fasterxml.jackson.annotation">JacksonInject</a></span></code> <div class="block">Jackson-specific annotation used for indicating that value of annotated property will be "injected", i.e.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonAlias.html" title="annotation in com.fasterxml.jackson.annotation">JsonAlias</a></span></code> <div class="block">Annotation that can be used to define one or more alternative names for a property, accepted during deserialization as alternative to the official name.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonAnyGetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonAnyGetter</a></span></code> <div class="block">Marker annotation that can be used to define a non-static, no-argument method to be an "any getter"; accessor for getting a set of key/value pairs, to be serialized as part of containing POJO (similar to unwrapping) along with regular property values it has.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonAnySetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonAnySetter</a></span></code> <div class="block">Marker annotation that can be used to define a logical "any setter" mutator -- either using non-static two-argument method (first argument name of property, second value to set) or a field (of type <a href="https://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> or POJO) - 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"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.html" title="annotation in com.fasterxml.jackson.annotation">JsonAutoDetect</a></span></code> <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"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonBackReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonBackReference</a></span></code> <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"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonClassDescription.html" title="annotation in com.fasterxml.jackson.annotation">JsonClassDescription</a></span></code> <div class="block">Annotation used to define a human readable description for annotated type (class).</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonCreator.html" title="annotation in com.fasterxml.jackson.annotation">JsonCreator</a></span></code> <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="rowColor"> <td class="colFirst"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonEnumDefaultValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonEnumDefaultValue</a></span></code> <div class="block">Marker annotation that can be used to define a default value used when trying to deserialize unknown Enum values.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonFilter.html" title="annotation in com.fasterxml.jackson.annotation">JsonFilter</a></span></code> <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"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonFormat.html" title="annotation in com.fasterxml.jackson.annotation">JsonFormat</a></span></code> <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"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonGetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonGetter</a></span></code> <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"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation">JsonIdentityInfo</a></span></code> <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"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonIdentityReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonIdentityReference</a></span></code> <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"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonIgnore.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnore</a></span></code> <div class="block">Marker annotation that indicates that the logical property that the accessor (field, getter/setter method or Creator parameter [of <a href="../../../../../com/fasterxml/jackson/annotation/JsonCreator.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonCreator</code></a>-annotated constructor or factory method]) is to be ignored by introspection-based serialization and deserialization functionality.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonIgnoreProperties.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnoreProperties</a></span></code> <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"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonIgnoreType.html" title="annotation in com.fasterxml.jackson.annotation">JsonIgnoreType</a></span></code> <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"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonInclude.html" title="annotation in com.fasterxml.jackson.annotation">JsonInclude</a></span></code> <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"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonManagedReference.html" title="annotation in com.fasterxml.jackson.annotation">JsonManagedReference</a></span></code> <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"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonMerge.html" title="annotation in com.fasterxml.jackson.annotation">JsonMerge</a></span></code> <div class="block">Annotation to specify whether annotated property value should use "merging" approach: merging meaning that the current value is first accessed (with a getter or field) and then modified with incoming data.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation">JsonProperty</a></span></code> <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="altColor"> <td class="colFirst"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonPropertyDescription.html" title="annotation in com.fasterxml.jackson.annotation">JsonPropertyDescription</a></span></code> <div class="block">Annotation used to define a human readable description for a logical property.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonPropertyOrder.html" title="annotation in com.fasterxml.jackson.annotation">JsonPropertyOrder</a></span></code> <div class="block">Annotation that can be used to define ordering (possibly partial) to use when serializing object properties.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonRawValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonRawValue</a></span></code> <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="rowColor"> <td class="colFirst"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonRootName.html" title="annotation in com.fasterxml.jackson.annotation">JsonRootName</a></span></code> <div class="block">Annotation similar to <a href="https://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="altColor"> <td class="colFirst"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonSetter.html" title="annotation in com.fasterxml.jackson.annotation">JsonSetter</a></span></code> <div class="block">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; or (as of 2.9 and later), specify additional aspects of the assigning property a value during serialization.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonSubTypes.html" title="annotation in com.fasterxml.jackson.annotation">JsonSubTypes</a></span></code> <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="altColor"> <td class="colFirst"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonTypeId.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeId</a></span></code> <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"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonTypeInfo.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeInfo</a></span></code> <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"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonTypeName.html" title="annotation in com.fasterxml.jackson.annotation">JsonTypeName</a></span></code> <div class="block">Annotation used for binding logical name that the annotated class has.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonUnwrapped.html" title="annotation in com.fasterxml.jackson.annotation">JsonUnwrapped</a></span></code> <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"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonValue.html" title="annotation in com.fasterxml.jackson.annotation">JsonValue</a></span></code> <div class="block">Marker annotation that indicates that the value of annotated accessor (either field or "getter" method [a method with non-void return type, no args]) is to be used as the single value to serialize for the instance, instead of the usual method of collecting properties of value.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>interface </code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/annotation/JsonView.html" title="annotation in com.fasterxml.jackson.annotation">JsonView</a></span></code> <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> </li> </ul> </div> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar.bottom"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <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><a href="../../../../../com/fasterxml/jackson/annotation/JacksonAnnotation.html" title="annotation in com.fasterxml.jackson.annotation">Class</a></li> <li class="navBarCell1Rev">Use</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</li> <li>Next</li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?com/fasterxml/jackson/annotation/class-use/JacksonAnnotation.html" target="_top">Frames</a></li> <li><a href="JacksonAnnotation.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 © 2008–2019 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> </body> </html>