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 Sat Jan 09 21:46:11 PST 2016 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>JsonPropertyDescription (Jackson-annotations 2.7.0 API)</title> 8<meta name="date" content="2016-01-09"> 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="JsonPropertyDescription (Jackson-annotations 2.7.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="navBarCell1Rev">Class</li> 30<li><a href="class-use/JsonPropertyDescription.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><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 40<li><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyOrder.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li> 41</ul> 42<ul class="navList"> 43<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonPropertyDescription.html" target="_top">Frames</a></li> 44<li><a href="JsonPropertyDescription.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<div> 62<ul class="subNavList"> 63<li>Summary: </li> 64<li>Required | </li> 65<li><a href="#annotation_type_optional_element_summary">Optional</a></li> 66</ul> 67<ul class="subNavList"> 68<li>Detail: </li> 69<li><a href="#annotation_type_element_detail">Element</a></li> 70</ul> 71</div> 72<a name="skip-navbar_top"> 73<!-- --> 74</a></div> 75<!-- ========= END OF TOP NAVBAR ========= --> 76<!-- ======== START OF CLASS DATA ======== --> 77<div class="header"> 78<div class="subTitle">com.fasterxml.jackson.annotation</div> 79<h2 title="Annotation Type JsonPropertyDescription" class="title">Annotation Type JsonPropertyDescription</h2> 80</div> 81<div class="contentContainer"> 82<div class="description"> 83<ul class="blockList"> 84<li class="blockList"> 85<hr> 86<br> 87<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>={<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#ANNOTATION_TYPE" title="class or interface in java.lang.annotation">ANNOTATION_TYPE</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER" title="class or interface in java.lang.annotation">PARAMETER</a>}) 88<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) 89<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Documented.html?is-external=true" title="class or interface in java.lang.annotation">@Documented</a> 90public @interface <span class="strong">JsonPropertyDescription</span></pre> 91<div class="block">Annotation used to define a human readable description for a logical 92 property. 93 Currently used to populate the description field in generated JSON 94 Schemas.</div> 95<dl><dt><span class="strong">Since:</span></dt> 96 <dd>2.3</dd></dl> 97</li> 98</ul> 99</div> 100<div class="summary"> 101<ul class="blockList"> 102<li class="blockList"> 103<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 104<ul class="blockList"> 105<li class="blockList"><a name="annotation_type_optional_element_summary"> 106<!-- --> 107</a> 108<h3>Optional Element Summary</h3> 109<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> 110<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> 111<tr> 112<th class="colFirst" scope="col">Modifier and Type</th> 113<th class="colLast" scope="col">Optional Element and Description</th> 114</tr> 115<tr class="altColor"> 116<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> 117<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyDescription.html#value()">value</a></strong></code> 118<div class="block">Defines a human readable description of the logical property.</div> 119</td> 120</tr> 121</table> 122</li> 123</ul> 124</li> 125</ul> 126</div> 127<div class="details"> 128<ul class="blockList"> 129<li class="blockList"> 130<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 131<ul class="blockList"> 132<li class="blockList"><a name="annotation_type_element_detail"> 133<!-- --> 134</a> 135<h3>Element Detail</h3> 136<a name="value()"> 137<!-- --> 138</a> 139<ul class="blockListLast"> 140<li class="blockList"> 141<h4>value</h4> 142<pre>public abstract <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value</pre> 143<div class="block">Defines a human readable description of the logical property. 144 Currently used to populate the description field in generated JSON 145 Schemas.</div> 146<dl> 147<dt>Default:</dt> 148<dd>""</dd> 149</dl> 150</li> 151</ul> 152</li> 153</ul> 154</li> 155</ul> 156</div> 157</div> 158<!-- ========= END OF CLASS DATA ========= --> 159<!-- ======= START OF BOTTOM NAVBAR ====== --> 160<div class="bottomNav"><a name="navbar_bottom"> 161<!-- --> 162</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 163<!-- --> 164</a> 165<ul class="navList" title="Navigation"> 166<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 167<li class="navBarCell1Rev">Class</li> 168<li><a href="class-use/JsonPropertyDescription.html">Use</a></li> 169<li><a href="package-tree.html">Tree</a></li> 170<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 171<li><a href="../../../../index-all.html">Index</a></li> 172<li><a href="../../../../help-doc.html">Help</a></li> 173</ul> 174</div> 175<div class="subNav"> 176<ul class="navList"> 177<li><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 178<li><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyOrder.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li> 179</ul> 180<ul class="navList"> 181<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonPropertyDescription.html" target="_top">Frames</a></li> 182<li><a href="JsonPropertyDescription.html" target="_top">No Frames</a></li> 183</ul> 184<ul class="navList" id="allclasses_navbar_bottom"> 185<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 186</ul> 187<div> 188<script type="text/javascript"><!-- 189 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 190 if(window==top) { 191 allClassesLink.style.display = "block"; 192 } 193 else { 194 allClassesLink.style.display = "none"; 195 } 196 //--> 197</script> 198</div> 199<div> 200<ul class="subNavList"> 201<li>Summary: </li> 202<li>Required | </li> 203<li><a href="#annotation_type_optional_element_summary">Optional</a></li> 204</ul> 205<ul class="subNavList"> 206<li>Detail: </li> 207<li><a href="#annotation_type_element_detail">Element</a></li> 208</ul> 209</div> 210<a name="skip-navbar_bottom"> 211<!-- --> 212</a></div> 213<!-- ======== END OF BOTTOM NAVBAR ======= --> 214<p class="legalCopy"><small>Copyright © 2008–2016 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 215</body> 216</html> 217