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 Tue Mar 24 11:44:39 PDT 2020 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>JsonSerializableSchema (jackson-databind 2.11.0.rc1 API)</title> 8<meta name="date" content="2020-03-24"> 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="JsonSerializableSchema (jackson-databind 2.11.0.rc1 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="../../../../../overview-summary.html">Overview</a></li> 36<li><a href="package-summary.html">Package</a></li> 37<li class="navBarCell1Rev">Class</li> 38<li><a href="class-use/JsonSerializableSchema.html">Use</a></li> 39<li><a href="package-tree.html">Tree</a></li> 40<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> 41<li><a href="../../../../../index-all.html">Index</a></li> 42<li><a href="../../../../../help-doc.html">Help</a></li> 43</ul> 44</div> 45<div class="subNav"> 46<ul class="navList"> 47<li><a href="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSchema.html" title="class in com.fasterxml.jackson.databind.jsonschema"><span class="typeNameLink">Prev Class</span></a></li> 48<li><a href="../../../../../com/fasterxml/jackson/databind/jsonschema/SchemaAware.html" title="interface in com.fasterxml.jackson.databind.jsonschema"><span class="typeNameLink">Next Class</span></a></li> 49</ul> 50<ul class="navList"> 51<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html" target="_top">Frames</a></li> 52<li><a href="JsonSerializableSchema.html" target="_top">No Frames</a></li> 53</ul> 54<ul class="navList" id="allclasses_navbar_top"> 55<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> 56</ul> 57<div> 58<script type="text/javascript"><!-- 59 allClassesLink = document.getElementById("allclasses_navbar_top"); 60 if(window==top) { 61 allClassesLink.style.display = "block"; 62 } 63 else { 64 allClassesLink.style.display = "none"; 65 } 66 //--> 67</script> 68</div> 69<div> 70<ul class="subNavList"> 71<li>Summary: </li> 72<li><a href="#annotation.type.field.summary">Field</a> | </li> 73<li>Required | </li> 74<li><a href="#annotation.type.optional.element.summary">Optional</a></li> 75</ul> 76<ul class="subNavList"> 77<li>Detail: </li> 78<li><a href="#annotation.type.field.detail">Field</a> | </li> 79<li><a href="#annotation.type.element.detail">Element</a></li> 80</ul> 81</div> 82<a name="skip.navbar.top"> 83<!-- --> 84</a></div> 85<!-- ========= END OF TOP NAVBAR ========= --> 86<!-- ======== START OF CLASS DATA ======== --> 87<div class="header"> 88<div class="subTitle">com.fasterxml.jackson.databind.jsonschema</div> 89<h2 title="Annotation Type JsonSerializableSchema" class="title">Annotation Type JsonSerializableSchema</h2> 90</div> 91<div class="contentContainer"> 92<div class="description"> 93<ul class="blockList"> 94<li class="blockList"> 95<hr> 96<br> 97<pre><a href="https://docs.oracle.com/javase/8/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/8/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/8/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>) 98 <a href="https://docs.oracle.com/javase/8/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/8/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/8/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) 99public @interface <span class="memberNameLabel">JsonSerializableSchema</span></pre> 100<div class="block">Annotation that can be used to define JSON Schema definition for 101 the annotated class. 102<p> 103 Note that annotation is often not needed: for example, regular 104 Jackson beans that Jackson can introspect can be used without 105 annotations, to produce JSON schema definition.</div> 106<dl> 107<dt><span class="simpleTagLabel">Author:</span></dt> 108<dd>Ryan Heaton, Tatu Saloranta</dd> 109</dl> 110</li> 111</ul> 112</div> 113<div class="summary"> 114<ul class="blockList"> 115<li class="blockList"> 116<!-- =========== ANNOTATION TYPE FIELD SUMMARY =========== --> 117<ul class="blockList"> 118<li class="blockList"><a name="annotation.type.field.summary"> 119<!-- --> 120</a> 121<h3>Field Summary</h3> 122<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> 123<caption><span>Fields</span><span class="tabEnd"> </span></caption> 124<tr> 125<th class="colFirst" scope="col">Modifier and Type</th> 126<th class="colLast" scope="col">Fields and Description</th> 127</tr> 128<tr class="altColor"> 129<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> 130<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html#NO_VALUE">NO_VALUE</a></span></code> 131<div class="block">Marker value used to indicate that property has "no value"; 132 needed because annotations cannot have null as default 133 value.</div> 134</td> 135</tr> 136</table> 137</li> 138</ul> 139<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 140<ul class="blockList"> 141<li class="blockList"><a name="annotation.type.optional.element.summary"> 142<!-- --> 143</a> 144<h3>Optional Element Summary</h3> 145<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> 146<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> 147<tr> 148<th class="colFirst" scope="col">Modifier and Type</th> 149<th class="colLast" scope="col">Optional Element and Description</th> 150</tr> 151<tr class="altColor"> 152<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> 153<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html#id--">id</a></span></code> 154<div class="block">Property that can be used to indicate id of the type when 155 generating JSON Schema; empty String indicates that no id 156 is defined.</div> 157</td> 158</tr> 159<tr class="rowColor"> 160<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> 161<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html#schemaItemDefinition--">schemaItemDefinition</a></span></code> 162<div class="block"><span class="deprecatedLabel">Deprecated.</span> 163<div class="block"><span class="deprecationComment">(since 2.1) -- support will be dropped in future, since JSON-as-String is 164 fundamentally bad way for customizing anything. No direct replacements offered.</span></div> 165</div> 166</td> 167</tr> 168<tr class="altColor"> 169<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> 170<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html#schemaObjectPropertiesDefinition--">schemaObjectPropertiesDefinition</a></span></code> 171<div class="block"><span class="deprecatedLabel">Deprecated.</span> 172<div class="block"><span class="deprecationComment">(since 2.1) -- support will be dropped in future, since JSON-as-String is 173 fundamentally bad way for customizing anything. No direct replacements offered.</span></div> 174</div> 175</td> 176</tr> 177<tr class="rowColor"> 178<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> 179<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html#schemaType--">schemaType</a></span></code> 180<div class="block">The schema type for this JsonSerializable instance.</div> 181</td> 182</tr> 183</table> 184</li> 185</ul> 186</li> 187</ul> 188</div> 189<div class="details"> 190<ul class="blockList"> 191<li class="blockList"> 192<!-- ============ ANNOTATION TYPE FIELD DETAIL =========== --> 193<ul class="blockList"> 194<li class="blockList"><a name="annotation.type.field.detail"> 195<!-- --> 196</a> 197<h3>Field Detail</h3> 198<a name="NO_VALUE"> 199<!-- --> 200</a> 201<ul class="blockListLast"> 202<li class="blockList"> 203<h4>NO_VALUE</h4> 204<pre>public static final <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> NO_VALUE</pre> 205<div class="block">Marker value used to indicate that property has "no value"; 206 needed because annotations cannot have null as default 207 value.</div> 208</li> 209</ul> 210</li> 211</ul> 212<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 213<ul class="blockList"> 214<li class="blockList"><a name="annotation.type.element.detail"> 215<!-- --> 216</a> 217<h3>Element Detail</h3> 218<a name="id--"> 219<!-- --> 220</a> 221<ul class="blockList"> 222<li class="blockList"> 223<h4>id</h4> 224<pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> id</pre> 225<div class="block">Property that can be used to indicate id of the type when 226 generating JSON Schema; empty String indicates that no id 227 is defined.</div> 228<dl> 229<dt>Default:</dt> 230<dd>""</dd> 231</dl> 232</li> 233</ul> 234</li> 235</ul> 236<ul class="blockList"> 237<li class="blockList"><a name="schemaType--"> 238<!-- --> 239</a> 240<ul class="blockList"> 241<li class="blockList"> 242<h4>schemaType</h4> 243<pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> schemaType</pre> 244<div class="block">The schema type for this JsonSerializable instance. 245 Possible values: "string", "number", "boolean", "object", "array", "null", "any"</div> 246<dl> 247<dt><span class="returnLabel">Returns:</span></dt> 248<dd>The schema type for this JsonSerializable instance.</dd> 249</dl> 250<dl> 251<dt>Default:</dt> 252<dd>"any"</dd> 253</dl> 254</li> 255</ul> 256</li> 257</ul> 258<ul class="blockList"> 259<li class="blockList"><a name="schemaObjectPropertiesDefinition--"> 260<!-- --> 261</a> 262<ul class="blockList"> 263<li class="blockList"> 264<h4>schemaObjectPropertiesDefinition</h4> 265<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> 266public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> schemaObjectPropertiesDefinition</pre> 267<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">(since 2.1) -- support will be dropped in future, since JSON-as-String is 268 fundamentally bad way for customizing anything. No direct replacements offered.</span></div> 269<div class="block">If the schema type is "object", JSON definition of properties of the object as 270 a String.</div> 271<dl> 272<dt><span class="returnLabel">Returns:</span></dt> 273<dd>The node representing the schema properties, or "##irrelevant" if irrelevant.</dd> 274</dl> 275<dl> 276<dt>Default:</dt> 277<dd>"##irrelevant"</dd> 278</dl> 279</li> 280</ul> 281</li> 282</ul> 283<ul class="blockList"> 284<li class="blockList"><a name="schemaItemDefinition--"> 285<!-- --> 286</a> 287<ul class="blockListLast"> 288<li class="blockList"> 289<h4>schemaItemDefinition</h4> 290<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> 291public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> schemaItemDefinition</pre> 292<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">(since 2.1) -- support will be dropped in future, since JSON-as-String is 293 fundamentally bad way for customizing anything. No direct replacements offered.</span></div> 294<div class="block">If the schema type if "array", JSON definition of the schema for item types contained.</div> 295<dl> 296<dt><span class="returnLabel">Returns:</span></dt> 297<dd>The schema for the items in the array, or "##irrelevant" if irrelevant.</dd> 298</dl> 299<dl> 300<dt>Default:</dt> 301<dd>"##irrelevant"</dd> 302</dl> 303</li> 304</ul> 305</li> 306</ul> 307</li> 308</ul> 309</div> 310</div> 311<!-- ========= END OF CLASS DATA ========= --> 312<!-- ======= START OF BOTTOM NAVBAR ====== --> 313<div class="bottomNav"><a name="navbar.bottom"> 314<!-- --> 315</a> 316<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 317<a name="navbar.bottom.firstrow"> 318<!-- --> 319</a> 320<ul class="navList" title="Navigation"> 321<li><a href="../../../../../overview-summary.html">Overview</a></li> 322<li><a href="package-summary.html">Package</a></li> 323<li class="navBarCell1Rev">Class</li> 324<li><a href="class-use/JsonSerializableSchema.html">Use</a></li> 325<li><a href="package-tree.html">Tree</a></li> 326<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> 327<li><a href="../../../../../index-all.html">Index</a></li> 328<li><a href="../../../../../help-doc.html">Help</a></li> 329</ul> 330</div> 331<div class="subNav"> 332<ul class="navList"> 333<li><a href="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSchema.html" title="class in com.fasterxml.jackson.databind.jsonschema"><span class="typeNameLink">Prev Class</span></a></li> 334<li><a href="../../../../../com/fasterxml/jackson/databind/jsonschema/SchemaAware.html" title="interface in com.fasterxml.jackson.databind.jsonschema"><span class="typeNameLink">Next Class</span></a></li> 335</ul> 336<ul class="navList"> 337<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html" target="_top">Frames</a></li> 338<li><a href="JsonSerializableSchema.html" target="_top">No Frames</a></li> 339</ul> 340<ul class="navList" id="allclasses_navbar_bottom"> 341<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> 342</ul> 343<div> 344<script type="text/javascript"><!-- 345 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 346 if(window==top) { 347 allClassesLink.style.display = "block"; 348 } 349 else { 350 allClassesLink.style.display = "none"; 351 } 352 //--> 353</script> 354</div> 355<div> 356<ul class="subNavList"> 357<li>Summary: </li> 358<li><a href="#annotation.type.field.summary">Field</a> | </li> 359<li>Required | </li> 360<li><a href="#annotation.type.optional.element.summary">Optional</a></li> 361</ul> 362<ul class="subNavList"> 363<li>Detail: </li> 364<li><a href="#annotation.type.field.detail">Field</a> | </li> 365<li><a href="#annotation.type.element.detail">Element</a></li> 366</ul> 367</div> 368<a name="skip.navbar.bottom"> 369<!-- --> 370</a></div> 371<!-- ======== END OF BOTTOM NAVBAR ======= --> 372<p class="legalCopy"><small>Copyright © 2008–2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 373</body> 374</html> 375