1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_35) on Tue Oct 09 17:08:17 PDT 2012 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8JsonSchema (jackson-databind 2.1.0 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2012-10-09"> 12 13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> 14 15<SCRIPT type="text/javascript"> 16function windowTitle() 17{ 18 if (location.href.indexOf('is-external=true') == -1) { 19 parent.document.title="JsonSchema (jackson-databind 2.1.0 API)"; 20 } 21} 22</SCRIPT> 23<NOSCRIPT> 24</NOSCRIPT> 25 26</HEAD> 27 28<BODY BGCOLOR="white" onload="windowTitle();"> 29<HR> 30 31 32<!-- ========= START OF TOP NAVBAR ======= --> 33<A NAME="navbar_top"><!-- --></A> 34<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 36<TR> 37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 38<A NAME="navbar_top_firstrow"><!-- --></A> 39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 40 <TR ALIGN="center" VALIGN="top"> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 43 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonSchema.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 49 </TR> 50</TABLE> 51</TD> 52<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 53</EM> 54</TD> 55</TR> 56 57<TR> 58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 59 PREV CLASS 60 <A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html" title="annotation in com.fasterxml.jackson.databind.jsonschema"><B>NEXT CLASS</B></A></FONT></TD> 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 62 <A HREF="../../../../../index.html?com/fasterxml/jackson/databind/jsonschema/JsonSchema.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="JsonSchema.html" target="_top"><B>NO FRAMES</B></A> 64 <SCRIPT type="text/javascript"> 65 <!-- 66 if(window==top) { 67 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 68 } 69 //--> 70</SCRIPT> 71<NOSCRIPT> 72 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> 73</NOSCRIPT> 74 75 76</FONT></TD> 77</TR> 78<TR> 79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 80 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 82DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 83</TR> 84</TABLE> 85<A NAME="skip-navbar_top"></A> 86<!-- ========= END OF TOP NAVBAR ========= --> 87 88<HR> 89<!-- ======== START OF CLASS DATA ======== --> 90<H2> 91<FONT SIZE="-1"> 92com.fasterxml.jackson.databind.jsonschema</FONT> 93<BR> 94Class JsonSchema</H2> 95<PRE> 96<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> 97 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.fasterxml.jackson.databind.jsonschema.JsonSchema</B> 98</PRE> 99<HR> 100<DL> 101<DT><PRE>public class <B>JsonSchema</B><DT>extends <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL> 102</PRE> 103 104<P> 105Container for a logical JSON Schema instance. 106 Internally schema data is stored as a JSON Tree 107 (instance of <A HREF="../../../../../com/fasterxml/jackson/databind/JsonNode.html" title="class in com.fasterxml.jackson.databind"><CODE>JsonNode</CODE></A> is the root 108 of schema document) 109<P> 110 111<P> 112<DL> 113<DT><B>Author:</B></DT> 114 <DD>Ryan Heaton</DD> 115<DT><B>See Also:</B><DD><a href="http://json-schema.org/">JSON Schema</a></DL> 116<HR> 117 118<P> 119 120<!-- ======== CONSTRUCTOR SUMMARY ======== --> 121 122<A NAME="constructor_summary"><!-- --></A> 123<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 124<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 125<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 126<B>Constructor Summary</B></FONT></TH> 127</TR> 128<TR BGCOLOR="white" CLASS="TableRowColor"> 129<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSchema.html#JsonSchema(com.fasterxml.jackson.databind.node.ObjectNode)">JsonSchema</A></B>(<A HREF="../../../../../com/fasterxml/jackson/databind/node/ObjectNode.html" title="class in com.fasterxml.jackson.databind.node">ObjectNode</A> schema)</CODE> 130 131<BR> 132 Main constructor for schema instances.</TD> 133</TR> 134</TABLE> 135 136<!-- ========== METHOD SUMMARY =========== --> 137 138<A NAME="method_summary"><!-- --></A> 139<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 140<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 141<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 142<B>Method Summary</B></FONT></TH> 143</TR> 144<TR BGCOLOR="white" CLASS="TableRowColor"> 145<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 146<CODE> boolean</CODE></FONT></TD> 147<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSchema.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> o)</CODE> 148 149<BR> 150 </TD> 151</TR> 152<TR BGCOLOR="white" CLASS="TableRowColor"> 153<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 154<CODE>static <A HREF="../../../../../com/fasterxml/jackson/databind/JsonNode.html" title="class in com.fasterxml.jackson.databind">JsonNode</A></CODE></FONT></TD> 155<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSchema.html#getDefaultSchemaNode()">getDefaultSchemaNode</A></B>()</CODE> 156 157<BR> 158 Get the default schema node.</TD> 159</TR> 160<TR BGCOLOR="white" CLASS="TableRowColor"> 161<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 162<CODE> <A HREF="../../../../../com/fasterxml/jackson/databind/node/ObjectNode.html" title="class in com.fasterxml.jackson.databind.node">ObjectNode</A></CODE></FONT></TD> 163<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSchema.html#getSchemaNode()">getSchemaNode</A></B>()</CODE> 164 165<BR> 166 Method for accessing root JSON object of the contained schema.</TD> 167</TR> 168<TR BGCOLOR="white" CLASS="TableRowColor"> 169<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 170<CODE> <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> 171<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSchema.html#toString()">toString</A></B>()</CODE> 172 173<BR> 174 </TD> 175</TR> 176</TABLE> 177 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 178<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 179<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 180<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> 181</TR> 182<TR BGCOLOR="white" CLASS="TableRowColor"> 183<TD><CODE><A HREF="http://docs.oracle.com/javase/6/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/6/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/6/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/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://docs.oracle.com/javase/6/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/6/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/6/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/6/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/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> 184</TR> 185</TABLE> 186 187<P> 188 189<!-- ========= CONSTRUCTOR DETAIL ======== --> 190 191<A NAME="constructor_detail"><!-- --></A> 192<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 193<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 194<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 195<B>Constructor Detail</B></FONT></TH> 196</TR> 197</TABLE> 198 199<A NAME="JsonSchema(com.fasterxml.jackson.databind.node.ObjectNode)"><!-- --></A><H3> 200JsonSchema</H3> 201<PRE> 202public <B>JsonSchema</B>(<A HREF="../../../../../com/fasterxml/jackson/databind/node/ObjectNode.html" title="class in com.fasterxml.jackson.databind.node">ObjectNode</A> schema)</PRE> 203<DL> 204<DD>Main constructor for schema instances. 205<p> 206 This is the creator constructor used by Jackson itself when 207 deserializing instances. It is so-called delegating creator, 208 meaning that its argument will be bound by Jackson before 209 constructor gets called. 210<P> 211</DL> 212 213<!-- ============ METHOD DETAIL ========== --> 214 215<A NAME="method_detail"><!-- --></A> 216<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 217<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 218<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 219<B>Method Detail</B></FONT></TH> 220</TR> 221</TABLE> 222 223<A NAME="getSchemaNode()"><!-- --></A><H3> 224getSchemaNode</H3> 225<PRE> 226public <A HREF="../../../../../com/fasterxml/jackson/databind/node/ObjectNode.html" title="class in com.fasterxml.jackson.databind.node">ObjectNode</A> <B>getSchemaNode</B>()</PRE> 227<DL> 228<DD>Method for accessing root JSON object of the contained schema. 229<p> 230 Note: this method is specified with <A HREF="http://fasterxml.github.com/jackson-annotations/javadoc/2.1.0/com/fasterxml/jackson/annotation/JsonValue.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation"><CODE>JsonValue</CODE></A> annotation 231 to represent serialization to use; same as if explicitly 232 serializing returned object. 233<P> 234<DD><DL> 235 236<DT><B>Returns:</B><DD>Root node of the schema tree</DL> 237</DD> 238</DL> 239<HR> 240 241<A NAME="toString()"><!-- --></A><H3> 242toString</H3> 243<PRE> 244public <A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE> 245<DL> 246<DD><DL> 247<DT><B>Overrides:</B><DD><CODE><A HREF="http://docs.oracle.com/javase/6/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/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> 248</DD> 249<DD><DL> 250</DL> 251</DD> 252</DL> 253<HR> 254 255<A NAME="equals(java.lang.Object)"><!-- --></A><H3> 256equals</H3> 257<PRE> 258public boolean <B>equals</B>(<A HREF="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> o)</PRE> 259<DL> 260<DD><DL> 261<DT><B>Overrides:</B><DD><CODE><A HREF="http://docs.oracle.com/javase/6/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/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> 262</DD> 263<DD><DL> 264</DL> 265</DD> 266</DL> 267<HR> 268 269<A NAME="getDefaultSchemaNode()"><!-- --></A><H3> 270getDefaultSchemaNode</H3> 271<PRE> 272public static <A HREF="../../../../../com/fasterxml/jackson/databind/JsonNode.html" title="class in com.fasterxml.jackson.databind">JsonNode</A> <B>getDefaultSchemaNode</B>()</PRE> 273<DL> 274<DD>Get the default schema node. 275<P> 276<DD><DL> 277 278<DT><B>Returns:</B><DD>The default schema node.</DL> 279</DD> 280</DL> 281<!-- ========= END OF CLASS DATA ========= --> 282<HR> 283 284 285<!-- ======= START OF BOTTOM NAVBAR ====== --> 286<A NAME="navbar_bottom"><!-- --></A> 287<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 288<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 289<TR> 290<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 291<A NAME="navbar_bottom_firstrow"><!-- --></A> 292<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 293 <TR ALIGN="center" VALIGN="top"> 294 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 295 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 296 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 297 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonSchema.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 298 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 299 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 300 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 301 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 302 </TR> 303</TABLE> 304</TD> 305<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 306</EM> 307</TD> 308</TR> 309 310<TR> 311<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 312 PREV CLASS 313 <A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html" title="annotation in com.fasterxml.jackson.databind.jsonschema"><B>NEXT CLASS</B></A></FONT></TD> 314<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 315 <A HREF="../../../../../index.html?com/fasterxml/jackson/databind/jsonschema/JsonSchema.html" target="_top"><B>FRAMES</B></A> 316 <A HREF="JsonSchema.html" target="_top"><B>NO FRAMES</B></A> 317 <SCRIPT type="text/javascript"> 318 <!-- 319 if(window==top) { 320 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 321 } 322 //--> 323</SCRIPT> 324<NOSCRIPT> 325 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> 326</NOSCRIPT> 327 328 329</FONT></TD> 330</TR> 331<TR> 332<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 333 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 334<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 335DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 336</TR> 337</TABLE> 338<A NAME="skip-navbar_bottom"></A> 339<!-- ======== END OF BOTTOM NAVBAR ======= --> 340 341<HR> 342Copyright © 2012 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved. 343</BODY> 344</HTML> 345
