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