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_25) on Wed Nov 13 20:23:19 PST 2013 --> 6<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> 7<title>JsonPropertyDescription (Jackson-annotations 2.3.0 API)</title> 8<meta name="date" content="2013-11-13"> 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.3.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.html" title="annotation 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://download.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://download.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://download.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://download.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://download.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://download.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://download.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://download.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://download.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>) 89public @interface <span class="strong">JsonPropertyDescription</span></pre> 90<div class="block">Annotaion used to define a human readable description for a logical 91 property. 92 Currently used to populate the description field in generated JSON 93 Schemas.</div> 94</li> 95</ul> 96</div> 97<div class="summary"> 98<ul class="blockList"> 99<li class="blockList"> 100<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 101<ul class="blockList"> 102<li class="blockList"><a name="annotation_type_optional_element_summary"> 103<!-- --> 104</a> 105<h3>Optional Element Summary</h3> 106<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> 107<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> 108<tr> 109<th class="colFirst" scope="col">Modifier and Type</th> 110<th class="colLast" scope="col">Optional Element and Description</th> 111</tr> 112<tr class="altColor"> 113<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> 114<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyDescription.html#value()">value</a></strong></code> 115<div class="block">Defines a human readable description of the logical property.</div> 116</td> 117</tr> 118</table> 119</li> 120</ul> 121</li> 122</ul> 123</div> 124<div class="details"> 125<ul class="blockList"> 126<li class="blockList"> 127<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 128<ul class="blockList"> 129<li class="blockList"><a name="annotation_type_element_detail"> 130<!-- --> 131</a> 132<h3>Element Detail</h3> 133<a name="value()"> 134<!-- --> 135</a> 136<ul class="blockListLast"> 137<li class="blockList"> 138<h4>value</h4> 139<pre>public abstract <a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> value</pre> 140<div class="block">Defines a human readable description of the logical property. 141 Currently used to populate the description field in generated JSON 142 Schemas.</div> 143<dl> 144<dt>Default:</dt> 145<dd>""</dd> 146</dl> 147</li> 148</ul> 149</li> 150</ul> 151</li> 152</ul> 153</div> 154</div> 155<!-- ========= END OF CLASS DATA ========= --> 156<!-- ======= START OF BOTTOM NAVBAR ====== --> 157<div class="bottomNav"><a name="navbar_bottom"> 158<!-- --> 159</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 160<!-- --> 161</a> 162<ul class="navList" title="Navigation"> 163<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 164<li class="navBarCell1Rev">Class</li> 165<li><a href="class-use/JsonPropertyDescription.html">Use</a></li> 166<li><a href="package-tree.html">Tree</a></li> 167<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 168<li><a href="../../../../index-all.html">Index</a></li> 169<li><a href="../../../../help-doc.html">Help</a></li> 170</ul> 171</div> 172<div class="subNav"> 173<ul class="navList"> 174<li><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 175<li><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyOrder.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li> 176</ul> 177<ul class="navList"> 178<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonPropertyDescription.html" target="_top">Frames</a></li> 179<li><a href="JsonPropertyDescription.html" target="_top">No Frames</a></li> 180</ul> 181<ul class="navList" id="allclasses_navbar_bottom"> 182<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 183</ul> 184<div> 185<script type="text/javascript"><!-- 186 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 187 if(window==top) { 188 allClassesLink.style.display = "block"; 189 } 190 else { 191 allClassesLink.style.display = "none"; 192 } 193 //--> 194</script> 195</div> 196<div> 197<ul class="subNavList"> 198<li>Summary: </li> 199<li>Required | </li> 200<li><a href="#annotation_type_optional_element_summary">Optional</a></li> 201</ul> 202<ul class="subNavList"> 203<li>Detail: </li> 204<li><a href="#annotation_type_element_detail">Element</a></li> 205</ul> 206</div> 207<a name="skip-navbar_bottom"> 208<!-- --> 209</a></div> 210<!-- ======== END OF BOTTOM NAVBAR ======= --> 211<p class="legalCopy"><small>Copyright © 2012-2013 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved.</small></p> 212</body> 213</html> 214