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 Sat Apr 25 16:37:31 PDT 2020 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>JsonClassDescription (Jackson-annotations 2.11.0 API)</title> 8<meta name="date" content="2020-04-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="JsonClassDescription (Jackson-annotations 2.11.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/JsonClassDescription.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/JsonBackReference.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev Class</span></a></li> 47<li><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.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/JsonClassDescription.html" target="_top">Frames</a></li> 51<li><a href="JsonClassDescription.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 JsonClassDescription" class="title">Annotation Type JsonClassDescription</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#TYPE" title="class or interface in java.lang.annotation">TYPE</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">JsonClassDescription</span></pre> 100<div class="block">Annotation used to define a human readable description for annotated 101 type (class). 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.7</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/JsonClassDescription.html#value--">value</a></span></code> 129<div class="block">Defines a human readable description of the class.</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 class.</div> 155<dl> 156<dt>Default:</dt> 157<dd>""</dd> 158</dl> 159</li> 160</ul> 161</li> 162</ul> 163</li> 164</ul> 165</div> 166</div> 167<!-- ========= END OF CLASS DATA ========= --> 168<!-- ======= START OF BOTTOM NAVBAR ====== --> 169<div class="bottomNav"><a name="navbar.bottom"> 170<!-- --> 171</a> 172<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 173<a name="navbar.bottom.firstrow"> 174<!-- --> 175</a> 176<ul class="navList" title="Navigation"> 177<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 178<li class="navBarCell1Rev">Class</li> 179<li><a href="class-use/JsonClassDescription.html">Use</a></li> 180<li><a href="package-tree.html">Tree</a></li> 181<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 182<li><a href="../../../../index-all.html">Index</a></li> 183<li><a href="../../../../help-doc.html">Help</a></li> 184</ul> 185</div> 186<div class="subNav"> 187<ul class="navList"> 188<li><a href="../../../../com/fasterxml/jackson/annotation/JsonBackReference.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Prev Class</span></a></li> 189<li><a href="../../../../com/fasterxml/jackson/annotation/JsonCreator.html" title="annotation in com.fasterxml.jackson.annotation"><span class="typeNameLink">Next Class</span></a></li> 190</ul> 191<ul class="navList"> 192<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonClassDescription.html" target="_top">Frames</a></li> 193<li><a href="JsonClassDescription.html" target="_top">No Frames</a></li> 194</ul> 195<ul class="navList" id="allclasses_navbar_bottom"> 196<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 197</ul> 198<div> 199<script type="text/javascript"><!-- 200 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 201 if(window==top) { 202 allClassesLink.style.display = "block"; 203 } 204 else { 205 allClassesLink.style.display = "none"; 206 } 207 //--> 208</script> 209</div> 210<div> 211<ul class="subNavList"> 212<li>Summary: </li> 213<li>Field | </li> 214<li>Required | </li> 215<li><a href="#annotation.type.optional.element.summary">Optional</a></li> 216</ul> 217<ul class="subNavList"> 218<li>Detail: </li> 219<li>Field | </li> 220<li><a href="#annotation.type.element.detail">Element</a></li> 221</ul> 222</div> 223<a name="skip.navbar.bottom"> 224<!-- --> 225</a></div> 226<!-- ======== END OF BOTTOM NAVBAR ======= --> 227<p class="legalCopy"><small>Copyright © 2008–2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 228</body> 229</html> 230