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 (1.8.0_162) on Wed Sep 25 19:26:34 PDT 2019 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>JsonPropertyDescription (Jackson-annotations 2.10.0 API)</title> 8<meta name="date" content="2019-09-25"> 9<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> 10<script type="text/javascript" src="../../../../script.js"></script> 11</head> 12<body> 13<script type="text/javascript"><!-- 14 try { 15 if (location.href.indexOf('is-external=true') == -1) { 16 parent.document.title="JsonPropertyDescription (Jackson-annotations 2.10.0 API)"; 17 } 18 } 19 catch(err) { 20 } 21//--> 22</script> 23<noscript> 24<div>JavaScript is disabled on your browser.</div> 25</noscript> 26<!-- ========= START OF TOP NAVBAR ======= --> 27<div class="topNav"><a name="navbar.top"> 28<!-- --> 29</a> 30<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> 31<a name="navbar.top.firstrow"> 32<!-- --> 33</a> 34<ul class="navList" title="Navigation"> 35<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 36<li class="navBarCell1Rev">Class</li> 37<li><a href="class-use/JsonPropertyDescription.html">Use</a></li> 38<li><a href="package-tree.html">Tree</a></li> 39<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 40<li><a href="../../../../index-all.html">Index</a></li> 41<li><a href="../../../../help-doc.html">Help</a></li> 42</ul> 43</div> 44<div class="subNav"> 45<ul class="navList"> 46<li><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev Class</span></a></li> 47<li><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyOrder.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Next Class</span></a></li> 48</ul> 49<ul class="navList"> 50<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonPropertyDescription.html" target="_top">Frames</a></li> 51<li><a href="JsonPropertyDescription.html" target="_top">No Frames</a></li> 52</ul> 53<ul class="navList" id="allclasses_navbar_top"> 54<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 55</ul> 56<div> 57<script type="text/javascript"><!-- 58 allClassesLink = document.getElementById("allclasses_navbar_top"); 59 if(window==top) { 60 allClassesLink.style.display = "block"; 61 } 62 else { 63 allClassesLink.style.display = "none"; 64 } 65 //--> 66</script> 67</div> 68<div> 69<ul class="subNavList"> 70<li>Summary: </li> 71<li>Field | </li> 72<li>Required | </li> 73<li><a href="#annotation.type.optional.element.summary">Optional</a></li> 74</ul> 75<ul class="subNavList"> 76<li>Detail: </li> 77<li>Field | </li> 78<li><a href="#annotation.type.element.detail">Element</a></li> 79</ul> 80</div> 81<a name="skip.navbar.top"> 82<!-- --> 83</a></div> 84<!-- ========= END OF TOP NAVBAR ========= --> 85<!-- ======== START OF CLASS DATA ======== --> 86<div class="header"> 87<div class="subTitle">com.fasterxml.jackson.annotation</div> 88<h2 title="Annotation Type JsonPropertyDescription" class="title">Annotation Type JsonPropertyDescription</h2> 89</div> 90<div class="contentContainer"> 91<div class="description"> 92<ul class="blockList"> 93<li class="blockList"> 94<hr> 95<br> 96<pre><a href="https://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="https://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="https://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="https://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="https://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="https://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>}) 97 <a href="https://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="https://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="https://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>) 98 <a href="https://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> 99public @interface <span class="memberNameLabel">JsonPropertyDescription</span></pre> 100<div class="block">Annotation used to define a human readable description for a logical 101 property. 102 Currently used to populate the description field in generated JSON 103 Schemas.</div> 104<dl> 105<dt><span class="simpleTagLabel">Since:</span></dt> 106<dd>2.3</dd> 107</dl> 108</li> 109</ul> 110</div> 111<div class="summary"> 112<ul class="blockList"> 113<li class="blockList"> 114<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 115<ul class="blockList"> 116<li class="blockList"><a name="annotation.type.optional.element.summary"> 117<!-- --> 118</a> 119<h3>Optional Element Summary</h3> 120<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> 121<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> 122<tr> 123<th class="colFirst" scope="col">Modifier and Type</th> 124<th class="colLast" scope="col">Optional Element and Description</th> 125</tr> 126<tr class="altColor"> 127<td class="colFirst"><code><a href="https://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> 128<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyDescription.html#value--">value</a></span></code> 129<div class="block">Defines a human readable description of the logical property.</div> 130</td> 131</tr> 132</table> 133</li> 134</ul> 135</li> 136</ul> 137</div> 138<div class="details"> 139<ul class="blockList"> 140<li class="blockList"> 141<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 142<ul class="blockList"> 143<li class="blockList"><a name="annotation.type.element.detail"> 144<!-- --> 145</a> 146<h3>Element Detail</h3> 147<a name="value--"> 148<!-- --> 149</a> 150<ul class="blockListLast"> 151<li class="blockList"> 152<h4>value</h4> 153<pre>public abstract <a href="https://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> 154<div class="block">Defines a human readable description of the logical property. 155 Currently used to populate the description field in generated JSON 156 Schemas.</div> 157<dl> 158<dt>Default:</dt> 159<dd>""</dd> 160</dl> 161</li> 162</ul> 163</li> 164</ul> 165</li> 166</ul> 167</div> 168</div> 169<!-- ========= END OF CLASS DATA ========= --> 170<!-- ======= START OF BOTTOM NAVBAR ====== --> 171<div class="bottomNav"><a name="navbar.bottom"> 172<!-- --> 173</a> 174<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 175<a name="navbar.bottom.firstrow"> 176<!-- --> 177</a> 178<ul class="navList" title="Navigation"> 179<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 180<li class="navBarCell1Rev">Class</li> 181<li><a href="class-use/JsonPropertyDescription.html">Use</a></li> 182<li><a href="package-tree.html">Tree</a></li> 183<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 184<li><a href="../../../../index-all.html">Index</a></li> 185<li><a href="../../../../help-doc.html">Help</a></li> 186</ul> 187</div> 188<div class="subNav"> 189<ul class="navList"> 190<li><a href="../../../../com/fasterxml/jackson/annotation/JsonProperty.Access.html" title="enum in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev Class</span></a></li> 191<li><a href="../../../../com/fasterxml/jackson/annotation/JsonPropertyOrder.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Next Class</span></a></li> 192</ul> 193<ul class="navList"> 194<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonPropertyDescription.html" target="_top">Frames</a></li> 195<li><a href="JsonPropertyDescription.html" target="_top">No Frames</a></li> 196</ul> 197<ul class="navList" id="allclasses_navbar_bottom"> 198<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 199</ul> 200<div> 201<script type="text/javascript"><!-- 202 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 203 if(window==top) { 204 allClassesLink.style.display = "block"; 205 } 206 else { 207 allClassesLink.style.display = "none"; 208 } 209 //--> 210</script> 211</div> 212<div> 213<ul class="subNavList"> 214<li>Summary: </li> 215<li>Field | </li> 216<li>Required | </li> 217<li><a href="#annotation.type.optional.element.summary">Optional</a></li> 218</ul> 219<ul class="subNavList"> 220<li>Detail: </li> 221<li>Field | </li> 222<li><a href="#annotation.type.element.detail">Element</a></li> 223</ul> 224</div> 225<a name="skip.navbar.bottom"> 226<!-- --> 227</a></div> 228<!-- ======== END OF BOTTOM NAVBAR ======= --> 229<p class="legalCopy"><small>Copyright © 2008–2019 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 230</body> 231</html> 232