<!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_79) on Fri Jan 15 20:28:41 PST 2016 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>JsonAppend.Prop (jackson-databind 2.7.0 API)</title> <meta name="date" content="2016-01-15"> <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="JsonAppend.Prop (jackson-databind 2.7.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="../../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/JsonAppend.Prop.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><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Attr.html" title="annotation in com.fasterxml.jackson.databind.annotation"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonDeserialize.html" title="annotation in com.fasterxml.jackson.databind.annotation"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?com/fasterxml/jackson/databind/annotation/JsonAppend.Prop.html" target="_top">Frames</a></li> <li><a href="JsonAppend.Prop.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> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#annotation_type_required_element_summary">Required</a> | </li> <li><a href="#annotation_type_optional_element_summary">Optional</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#annotation_type_element_detail">Element</a></li> </ul> </div> <a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">com.fasterxml.jackson.databind.annotation</div> <h2 title="Annotation Type JsonAppend.Prop" class="title">Annotation Type JsonAppend.Prop</h2> </div> <div class="contentContainer"> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public static @interface <span class="strong">JsonAppend.Prop</span></pre> <div class="block">Definition of a single general virtual property.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="annotation_type_required_element_summary"> <!-- --> </a> <h3>Required Element Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> <caption><span>Required Elements</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Required Element and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../../com/fasterxml/jackson/databind/ser/VirtualBeanPropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser">VirtualBeanPropertyWriter</a>></code></td> <td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Prop.html#value()">value</a></strong></code> <div class="block">Actual implementation class (a subtype of <a href="../../../../../com/fasterxml/jackson/databind/ser/VirtualBeanPropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser"><code>VirtualBeanPropertyWriter</code></a>) of the property to instantiate (using the no-argument default constructor).</div> </td> </tr> </table> </li> </ul> <!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="annotation_type_optional_element_summary"> <!-- --> </a> <h3>Optional Element Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> <caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Optional Element and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.7/com/fasterxml/jackson/annotation/JsonInclude.Include.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonInclude.Include</a></code></td> <td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Prop.html#include()">include</a></strong></code> <div class="block">When to include value of the property.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> <td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Prop.html#name()">name</a></strong></code> <div class="block">Name of the property to possibly use for serializing (although implementation may choose to not use this information).</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> <td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Prop.html#namespace()">namespace</a></strong></code> <div class="block">Optional namespace to use along with <a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Prop.html#name()"><code>name()</code></a>; only relevant for data formats that use namespaces (like XML).</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Prop.html#required()">required</a></strong></code> <div class="block">Metadata about property, similar to <a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.7/com/fasterxml/jackson/annotation/JsonProperty.html?is-external=true#required()" title="class or interface in com.fasterxml.jackson.annotation"><code>JsonProperty.required()</code></a>.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> <td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Prop.html#type()">type</a></strong></code> <div class="block">Nominal type of the property.</div> </td> </tr> </table> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="annotation_type_element_detail"> <!-- --> </a> <h3>Element Detail</h3> <a name="value()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>value</h4> <pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../../com/fasterxml/jackson/databind/ser/VirtualBeanPropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser">VirtualBeanPropertyWriter</a>> value</pre> <div class="block">Actual implementation class (a subtype of <a href="../../../../../com/fasterxml/jackson/databind/ser/VirtualBeanPropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser"><code>VirtualBeanPropertyWriter</code></a>) of the property to instantiate (using the no-argument default constructor).</div> </li> </ul> <a name="name()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>name</h4> <pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name</pre> <div class="block">Name of the property to possibly use for serializing (although implementation may choose to not use this information).</div> <dl> <dt>Default:</dt> <dd>""</dd> </dl> </li> </ul> <a name="namespace()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>namespace</h4> <pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> namespace</pre> <div class="block">Optional namespace to use along with <a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Prop.html#name()"><code>name()</code></a>; only relevant for data formats that use namespaces (like XML).</div> <dl> <dt>Default:</dt> <dd>""</dd> </dl> </li> </ul> <a name="include()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>include</h4> <pre>public abstract <a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.7/com/fasterxml/jackson/annotation/JsonInclude.Include.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonInclude.Include</a> include</pre> <div class="block">When to include value of the property. Default value indicates that property should only be written if specified attribute has a non-null value. As with other properties, actual property implementation may or may not choose to use this inclusion information.</div> <dl> <dt>Default:</dt> <dd>com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL</dd> </dl> </li> </ul> <a name="required()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>required</h4> <pre>public abstract boolean required</pre> <div class="block">Metadata about property, similar to <a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.7/com/fasterxml/jackson/annotation/JsonProperty.html?is-external=true#required()" title="class or interface in com.fasterxml.jackson.annotation"><code>JsonProperty.required()</code></a>.</div> <dl> <dt>Default:</dt> <dd>false</dd> </dl> </li> </ul> <a name="type()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>type</h4> <pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type</pre> <div class="block">Nominal type of the property. Passed as type information for related virtual objects, and may (or may not be) used by implementation for choosing serializer to use.</div> <dl> <dt>Default:</dt> <dd>java.lang.Object.class</dd> </dl> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= 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="../../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/JsonAppend.Prop.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><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Attr.html" title="annotation in com.fasterxml.jackson.databind.annotation"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonDeserialize.html" title="annotation in com.fasterxml.jackson.databind.annotation"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?com/fasterxml/jackson/databind/annotation/JsonAppend.Prop.html" target="_top">Frames</a></li> <li><a href="JsonAppend.Prop.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> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#annotation_type_required_element_summary">Required</a> | </li> <li><a href="#annotation_type_optional_element_summary">Optional</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#annotation_type_element_detail">Element</a></li> </ul> </div> <a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small>Copyright © 2008–2016 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> </body> </html>