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 17:14:51 PDT 2020 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>JsonSchema (jackson-databind 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="JsonSchema (jackson-databind 2.11.0 API)"; 17 } 18 } 19 catch(err) { 20 } 21//--> 22var methods = {"i0":42,"i1":41,"i2":42,"i3":42,"i4":42}; 23var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; 24var altColor = "altColor"; 25var rowColor = "rowColor"; 26var tableTab = "tableTab"; 27var activeTableTab = "activeTableTab"; 28</script> 29<noscript> 30<div>JavaScript is disabled on your browser.</div> 31</noscript> 32<!-- ========= START OF TOP NAVBAR ======= --> 33<div class="topNav"><a name="navbar.top"> 34<!-- --> 35</a> 36<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> 37<a name="navbar.top.firstrow"> 38<!-- --> 39</a> 40<ul class="navList" title="Navigation"> 41<li><a href="../../../../../overview-summary.html">Overview</a></li> 42<li><a href="package-summary.html">Package</a></li> 43<li class="navBarCell1Rev">Class</li> 44<li><a href="class-use/JsonSchema.html">Use</a></li> 45<li><a href="package-tree.html">Tree</a></li> 46<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> 47<li><a href="../../../../../index-all.html">Index</a></li> 48<li><a href="../../../../../help-doc.html">Help</a></li> 49</ul> 50</div> 51<div class="subNav"> 52<ul class="navList"> 53<li>Prev Class</li> 54<li><a href="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html" title="annotation in com.fasterxml.jackson.databind.jsonschema"><span class="typeNameLink">Next Class</span></a></li> 55</ul> 56<ul class="navList"> 57<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/jsonschema/JsonSchema.html" target="_top">Frames</a></li> 58<li><a href="JsonSchema.html" target="_top">No Frames</a></li> 59</ul> 60<ul class="navList" id="allclasses_navbar_top"> 61<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> 62</ul> 63<div> 64<script type="text/javascript"><!-- 65 allClassesLink = document.getElementById("allclasses_navbar_top"); 66 if(window==top) { 67 allClassesLink.style.display = "block"; 68 } 69 else { 70 allClassesLink.style.display = "none"; 71 } 72 //--> 73</script> 74</div> 75<div> 76<ul class="subNavList"> 77<li>Summary: </li> 78<li>Nested | </li> 79<li>Field | </li> 80<li><a href="#constructor.summary">Constr</a> | </li> 81<li><a href="#method.summary">Method</a></li> 82</ul> 83<ul class="subNavList"> 84<li>Detail: </li> 85<li>Field | </li> 86<li><a href="#constructor.detail">Constr</a> | </li> 87<li><a href="#method.detail">Method</a></li> 88</ul> 89</div> 90<a name="skip.navbar.top"> 91<!-- --> 92</a></div> 93<!-- ========= END OF TOP NAVBAR ========= --> 94<!-- ======== START OF CLASS DATA ======== --> 95<div class="header"> 96<div class="subTitle">com.fasterxml.jackson.databind.jsonschema</div> 97<h2 title="Class JsonSchema" class="title">Class JsonSchema</h2> 98</div> 99<div class="contentContainer"> 100<ul class="inheritance"> 101<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> 102<li> 103<ul class="inheritance"> 104<li>com.fasterxml.jackson.databind.jsonschema.JsonSchema</li> 105</ul> 106</li> 107</ul> 108<div class="description"> 109<ul class="blockList"> 110<li class="blockList"> 111<hr> 112<div class="block"><span class="deprecatedLabel">Deprecated.</span> 113<div class="block"><span class="deprecationComment">Since 2.2, we recommend use of external 114 <a href="https://github.com/FasterXML/jackson-module-jsonSchema">JSON Schema generator module</a></span></div> 115</div> 116<br> 117<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> 118public class <span class="typeNameLabel">JsonSchema</span> 119extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> 120<div class="block">Container for a logical JSON Schema instance. 121 Internally schema data is stored as a JSON Tree 122 (instance of <a href="../../../../../com/fasterxml/jackson/databind/JsonNode.html" title="class in com.fasterxml.jackson.databind"><code>JsonNode</code></a> is the root 123 of schema document)</div> 124<dl> 125<dt><span class="simpleTagLabel">Author:</span></dt> 126<dd>Ryan Heaton</dd> 127<dt><span class="seeLabel">See Also:</span></dt> 128<dd><a href="http://json-schema.org/">JSON Schema</a></dd> 129</dl> 130</li> 131</ul> 132</div> 133<div class="summary"> 134<ul class="blockList"> 135<li class="blockList"> 136<!-- ======== CONSTRUCTOR SUMMARY ======== --> 137<ul class="blockList"> 138<li class="blockList"><a name="constructor.summary"> 139<!-- --> 140</a> 141<h3>Constructor Summary</h3> 142<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> 143<caption><span>Constructors</span><span class="tabEnd"> </span></caption> 144<tr> 145<th class="colOne" scope="col">Constructor and Description</th> 146</tr> 147<tr class="altColor"> 148<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSchema.html#JsonSchema-com.fasterxml.jackson.databind.node.ObjectNode-">JsonSchema</a></span>(<a href="../../../../../com/fasterxml/jackson/databind/node/ObjectNode.html" title="class in com.fasterxml.jackson.databind.node">ObjectNode</a> schema)</code> 149<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> 150<div class="block">Main constructor for schema instances.</div> 151</td> 152</tr> 153</table> 154</li> 155</ul> 156<!-- ========== METHOD SUMMARY =========== --> 157<ul class="blockList"> 158<li class="blockList"><a name="method.summary"> 159<!-- --> 160</a> 161<h3>Method Summary</h3> 162<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 163<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> 164<tr> 165<th class="colFirst" scope="col">Modifier and Type</th> 166<th class="colLast" scope="col">Method and Description</th> 167</tr> 168<tr id="i0" class="altColor"> 169<td class="colFirst"><code>boolean</code></td> 170<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSchema.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</code> 171<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> 172 </td> 173</tr> 174<tr id="i1" class="rowColor"> 175<td class="colFirst"><code>static <a href="../../../../../com/fasterxml/jackson/databind/JsonNode.html" title="class in com.fasterxml.jackson.databind">JsonNode</a></code></td> 176<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSchema.html#getDefaultSchemaNode--">getDefaultSchemaNode</a></span>()</code> 177<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> 178<div class="block">Get the default schema node.</div> 179</td> 180</tr> 181<tr id="i2" class="altColor"> 182<td class="colFirst"><code><a href="../../../../../com/fasterxml/jackson/databind/node/ObjectNode.html" title="class in com.fasterxml.jackson.databind.node">ObjectNode</a></code></td> 183<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSchema.html#getSchemaNode--">getSchemaNode</a></span>()</code> 184<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> 185<div class="block">Method for accessing root JSON object of the contained schema.</div> 186</td> 187</tr> 188<tr id="i3" class="rowColor"> 189<td class="colFirst"><code>int</code></td> 190<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSchema.html#hashCode--">hashCode</a></span>()</code> 191<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> 192 </td> 193</tr> 194<tr id="i4" class="altColor"> 195<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> 196<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSchema.html#toString--">toString</a></span>()</code> 197<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> 198 </td> 199</tr> 200</table> 201<ul class="blockList"> 202<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> 203<!-- --> 204</a> 205<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> 206<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> 207</ul> 208</li> 209</ul> 210</li> 211</ul> 212</div> 213<div class="details"> 214<ul class="blockList"> 215<li class="blockList"> 216<!-- ========= CONSTRUCTOR DETAIL ======== --> 217<ul class="blockList"> 218<li class="blockList"><a name="constructor.detail"> 219<!-- --> 220</a> 221<h3>Constructor Detail</h3> 222<a name="JsonSchema-com.fasterxml.jackson.databind.node.ObjectNode-"> 223<!-- --> 224</a> 225<ul class="blockListLast"> 226<li class="blockList"> 227<h4>JsonSchema</h4> 228<pre>public JsonSchema(<a href="../../../../../com/fasterxml/jackson/databind/node/ObjectNode.html" title="class in com.fasterxml.jackson.databind.node">ObjectNode</a> schema)</pre> 229<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> 230<div class="block">Main constructor for schema instances. 231<p> 232 This is the creator constructor used by Jackson itself when 233 deserializing instances. It is so-called delegating creator, 234 meaning that its argument will be bound by Jackson before 235 constructor gets called.</div> 236</li> 237</ul> 238</li> 239</ul> 240<!-- ============ METHOD DETAIL ========== --> 241<ul class="blockList"> 242<li class="blockList"><a name="method.detail"> 243<!-- --> 244</a> 245<h3>Method Detail</h3> 246<a name="getSchemaNode--"> 247<!-- --> 248</a> 249<ul class="blockList"> 250<li class="blockList"> 251<h4>getSchemaNode</h4> 252<pre>public <a href="../../../../../com/fasterxml/jackson/databind/node/ObjectNode.html" title="class in com.fasterxml.jackson.databind.node">ObjectNode</a> getSchemaNode()</pre> 253<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> 254<div class="block">Method for accessing root JSON object of the contained schema. 255<p> 256 Note: this method is specified with <a href="http://fasterxml.github.io/jackson-annotations/javadoc/2.11/com/fasterxml/jackson/annotation/JsonValue.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation"><code>JsonValue</code></a> annotation 257 to represent serialization to use; same as if explicitly 258 serializing returned object.</div> 259<dl> 260<dt><span class="returnLabel">Returns:</span></dt> 261<dd>Root node of the schema tree</dd> 262</dl> 263</li> 264</ul> 265<a name="toString--"> 266<!-- --> 267</a> 268<ul class="blockList"> 269<li class="blockList"> 270<h4>toString</h4> 271<pre>public <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> toString()</pre> 272<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> 273<dl> 274<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> 275<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> 276</dl> 277</li> 278</ul> 279<a name="hashCode--"> 280<!-- --> 281</a> 282<ul class="blockList"> 283<li class="blockList"> 284<h4>hashCode</h4> 285<pre>public int hashCode()</pre> 286<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> 287<dl> 288<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> 289<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> 290</dl> 291</li> 292</ul> 293<a name="equals-java.lang.Object-"> 294<!-- --> 295</a> 296<ul class="blockList"> 297<li class="blockList"> 298<h4>equals</h4> 299<pre>public boolean equals(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> o)</pre> 300<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> 301<dl> 302<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> 303<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> 304</dl> 305</li> 306</ul> 307<a name="getDefaultSchemaNode--"> 308<!-- --> 309</a> 310<ul class="blockListLast"> 311<li class="blockList"> 312<h4>getDefaultSchemaNode</h4> 313<pre>public static <a href="../../../../../com/fasterxml/jackson/databind/JsonNode.html" title="class in com.fasterxml.jackson.databind">JsonNode</a> getDefaultSchemaNode()</pre> 314<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> 315<div class="block">Get the default schema node.</div> 316<dl> 317<dt><span class="returnLabel">Returns:</span></dt> 318<dd>The default schema node.</dd> 319</dl> 320</li> 321</ul> 322</li> 323</ul> 324</li> 325</ul> 326</div> 327</div> 328<!-- ========= END OF CLASS DATA ========= --> 329<!-- ======= START OF BOTTOM NAVBAR ====== --> 330<div class="bottomNav"><a name="navbar.bottom"> 331<!-- --> 332</a> 333<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 334<a name="navbar.bottom.firstrow"> 335<!-- --> 336</a> 337<ul class="navList" title="Navigation"> 338<li><a href="../../../../../overview-summary.html">Overview</a></li> 339<li><a href="package-summary.html">Package</a></li> 340<li class="navBarCell1Rev">Class</li> 341<li><a href="class-use/JsonSchema.html">Use</a></li> 342<li><a href="package-tree.html">Tree</a></li> 343<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> 344<li><a href="../../../../../index-all.html">Index</a></li> 345<li><a href="../../../../../help-doc.html">Help</a></li> 346</ul> 347</div> 348<div class="subNav"> 349<ul class="navList"> 350<li>Prev Class</li> 351<li><a href="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html" title="annotation in com.fasterxml.jackson.databind.jsonschema"><span class="typeNameLink">Next Class</span></a></li> 352</ul> 353<ul class="navList"> 354<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/jsonschema/JsonSchema.html" target="_top">Frames</a></li> 355<li><a href="JsonSchema.html" target="_top">No Frames</a></li> 356</ul> 357<ul class="navList" id="allclasses_navbar_bottom"> 358<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> 359</ul> 360<div> 361<script type="text/javascript"><!-- 362 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 363 if(window==top) { 364 allClassesLink.style.display = "block"; 365 } 366 else { 367 allClassesLink.style.display = "none"; 368 } 369 //--> 370</script> 371</div> 372<div> 373<ul class="subNavList"> 374<li>Summary: </li> 375<li>Nested | </li> 376<li>Field | </li> 377<li><a href="#constructor.summary">Constr</a> | </li> 378<li><a href="#method.summary">Method</a></li> 379</ul> 380<ul class="subNavList"> 381<li>Detail: </li> 382<li>Field | </li> 383<li><a href="#constructor.detail">Constr</a> | </li> 384<li><a href="#method.detail">Method</a></li> 385</ul> 386</div> 387<a name="skip.navbar.bottom"> 388<!-- --> 389</a></div> 390<!-- ======== END OF BOTTOM NAVBAR ======= --> 391<p class="legalCopy"><small>Copyright © 2008–2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 392</body> 393</html> 394