• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_10-ea) on Sun Jul 14 20:03:32 PDT 2013 -->
6<title>JsonSchema (Jackson JSON Processor)</title>
7<meta name="date" content="2013-07-14">
8<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
9</head>
10<body>
11<script type="text/javascript"><!--
12    if (location.href.indexOf('is-external=true') == -1) {
13        parent.document.title="JsonSchema (Jackson JSON Processor)";
14    }
15//-->
16</script>
17<noscript>
18<div>JavaScript is disabled on your browser.</div>
19</noscript>
20<!-- ========= START OF TOP NAVBAR ======= -->
21<div class="topNav"><a name="navbar_top">
22<!--   -->
23</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
24<!--   -->
25</a>
26<ul class="navList" title="Navigation">
27<li><a href="../../../../overview-summary.html">Overview</a></li>
28<li><a href="package-summary.html">Package</a></li>
29<li class="navBarCell1Rev">Class</li>
30<li><a href="class-use/JsonSchema.html">Use</a></li>
31<li><a href="package-tree.html">Tree</a></li>
32<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
33<li><a href="../../../../index-all.html">Index</a></li>
34<li><a href="../../../../help-doc.html">Help</a></li>
35</ul>
36</div>
37<div class="subNav">
38<ul class="navList">
39<li>Prev Class</li>
40<li><a href="../../../../org/codehaus/jackson/schema/JsonSerializableSchema.html" title="annotation in org.codehaus.jackson.schema"><span class="strong">Next Class</span></a></li>
41</ul>
42<ul class="navList">
43<li><a href="../../../../index.html?org/codehaus/jackson/schema/JsonSchema.html" target="_top">Frames</a></li>
44<li><a href="JsonSchema.html" target="_top">No Frames</a></li>
45</ul>
46<ul class="navList" id="allclasses_navbar_top">
47<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
48</ul>
49<div>
50<script type="text/javascript"><!--
51  allClassesLink = document.getElementById("allclasses_navbar_top");
52  if(window==top) {
53    allClassesLink.style.display = "block";
54  }
55  else {
56    allClassesLink.style.display = "none";
57  }
58  //-->
59</script>
60</div>
61<div>
62<ul class="subNavList">
63<li>Summary:&nbsp;</li>
64<li>Nested&nbsp;|&nbsp;</li>
65<li>Field&nbsp;|&nbsp;</li>
66<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
67<li><a href="#method_summary">Method</a></li>
68</ul>
69<ul class="subNavList">
70<li>Detail:&nbsp;</li>
71<li>Field&nbsp;|&nbsp;</li>
72<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
73<li><a href="#method_detail">Method</a></li>
74</ul>
75</div>
76<a name="skip-navbar_top">
77<!--   -->
78</a></div>
79<!-- ========= END OF TOP NAVBAR ========= -->
80<!-- ======== START OF CLASS DATA ======== -->
81<div class="header">
82<div class="subTitle">org.codehaus.jackson.schema</div>
83<h2 title="Class JsonSchema" class="title">Class JsonSchema</h2>
84</div>
85<div class="contentContainer">
86<ul class="inheritance">
87<li><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></li>
88<li>
89<ul class="inheritance">
90<li>org.codehaus.jackson.schema.JsonSchema</li>
91</ul>
92</li>
93</ul>
94<div class="description">
95<ul class="blockList">
96<li class="blockList">
97<hr>
98<br>
99<pre>public class <span class="strong">JsonSchema</span>
100extends <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></pre>
101<div class="block">A <a href="../../../../org/codehaus/jackson/JsonNode.html" title="class in org.codehaus.jackson"><code>JsonNode</code></a> that represents a JSON-Schema instance.</div>
102<dl><dt><span class="strong">Author:</span></dt>
103  <dd>Ryan Heaton</dd>
104<dt><span class="strong">See Also:</span></dt><dd><a href="http://json-schema.org/">JSON Schema</a></dd></dl>
105</li>
106</ul>
107</div>
108<div class="summary">
109<ul class="blockList">
110<li class="blockList">
111<!-- ======== CONSTRUCTOR SUMMARY ======== -->
112<ul class="blockList">
113<li class="blockList"><a name="constructor_summary">
114<!--   -->
115</a>
116<h3>Constructor Summary</h3>
117<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
118<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
119<tr>
120<th class="colOne" scope="col">Constructor and Description</th>
121</tr>
122<tr class="altColor">
123<td class="colOne"><code><strong><a href="../../../../org/codehaus/jackson/schema/JsonSchema.html#JsonSchema(org.codehaus.jackson.node.ObjectNode)">JsonSchema</a></strong>(<a href="../../../../org/codehaus/jackson/node/ObjectNode.html" title="class in org.codehaus.jackson.node">ObjectNode</a>&nbsp;schema)</code>
124<div class="block">Main constructor for schema instances.</div>
125</td>
126</tr>
127</table>
128</li>
129</ul>
130<!-- ========== METHOD SUMMARY =========== -->
131<ul class="blockList">
132<li class="blockList"><a name="method_summary">
133<!--   -->
134</a>
135<h3>Method Summary</h3>
136<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
137<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
138<tr>
139<th class="colFirst" scope="col">Modifier and Type</th>
140<th class="colLast" scope="col">Method and Description</th>
141</tr>
142<tr class="altColor">
143<td class="colFirst"><code>boolean</code></td>
144<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/schema/JsonSchema.html#equals(java.lang.Object)">equals</a></strong>(<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>&nbsp;o)</code>&nbsp;</td>
145</tr>
146<tr class="rowColor">
147<td class="colFirst"><code>static <a href="../../../../org/codehaus/jackson/JsonNode.html" title="class in org.codehaus.jackson">JsonNode</a></code></td>
148<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/schema/JsonSchema.html#getDefaultSchemaNode()">getDefaultSchemaNode</a></strong>()</code>
149<div class="block">Get the default schema node.</div>
150</td>
151</tr>
152<tr class="altColor">
153<td class="colFirst"><code><a href="../../../../org/codehaus/jackson/node/ObjectNode.html" title="class in org.codehaus.jackson.node">ObjectNode</a></code></td>
154<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/schema/JsonSchema.html#getSchemaNode()">getSchemaNode</a></strong>()</code>
155<div class="block">Method for accessing root JSON object of the contained schema.</div>
156</td>
157</tr>
158<tr class="rowColor">
159<td class="colFirst"><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></td>
160<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/schema/JsonSchema.html#toString()">toString</a></strong>()</code>&nbsp;</td>
161</tr>
162</table>
163<ul class="blockList">
164<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
165<!--   -->
166</a>
167<h3>Methods inherited from class&nbsp;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></h3>
168<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></li>
169</ul>
170</li>
171</ul>
172</li>
173</ul>
174</div>
175<div class="details">
176<ul class="blockList">
177<li class="blockList">
178<!-- ========= CONSTRUCTOR DETAIL ======== -->
179<ul class="blockList">
180<li class="blockList"><a name="constructor_detail">
181<!--   -->
182</a>
183<h3>Constructor Detail</h3>
184<a name="JsonSchema(org.codehaus.jackson.node.ObjectNode)">
185<!--   -->
186</a>
187<ul class="blockListLast">
188<li class="blockList">
189<h4>JsonSchema</h4>
190<pre>public&nbsp;JsonSchema(<a href="../../../../org/codehaus/jackson/node/ObjectNode.html" title="class in org.codehaus.jackson.node">ObjectNode</a>&nbsp;schema)</pre>
191<div class="block">Main constructor for schema instances.
192<p>
193 This is the creator constructor used by Jackson itself when
194 deserializing instances. It is so-called delegating creator,
195 meaning that its argument will be bound by Jackson before
196 constructor gets called.</div>
197</li>
198</ul>
199</li>
200</ul>
201<!-- ============ METHOD DETAIL ========== -->
202<ul class="blockList">
203<li class="blockList"><a name="method_detail">
204<!--   -->
205</a>
206<h3>Method Detail</h3>
207<a name="getSchemaNode()">
208<!--   -->
209</a>
210<ul class="blockList">
211<li class="blockList">
212<h4>getSchemaNode</h4>
213<pre>public&nbsp;<a href="../../../../org/codehaus/jackson/node/ObjectNode.html" title="class in org.codehaus.jackson.node">ObjectNode</a>&nbsp;getSchemaNode()</pre>
214<div class="block">Method for accessing root JSON object of the contained schema.
215<p>
216 Note: this method is specified with <a href="../../../../org/codehaus/jackson/annotate/JsonValue.html" title="annotation in org.codehaus.jackson.annotate"><code>JsonValue</code></a> annotation
217 to represent serialization to use; same as if explicitly
218 serializing returned object.</div>
219<dl><dt><span class="strong">Returns:</span></dt><dd>Root node of the schema tree</dd></dl>
220</li>
221</ul>
222<a name="toString()">
223<!--   -->
224</a>
225<ul class="blockList">
226<li class="blockList">
227<h4>toString</h4>
228<pre>public&nbsp;<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>&nbsp;toString()</pre>
229<dl>
230<dt><strong>Overrides:</strong></dt>
231<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>&nbsp;in class&nbsp;<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></dd>
232</dl>
233</li>
234</ul>
235<a name="equals(java.lang.Object)">
236<!--   -->
237</a>
238<ul class="blockList">
239<li class="blockList">
240<h4>equals</h4>
241<pre>public&nbsp;boolean&nbsp;equals(<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>&nbsp;o)</pre>
242<dl>
243<dt><strong>Overrides:</strong></dt>
244<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>&nbsp;in class&nbsp;<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></dd>
245</dl>
246</li>
247</ul>
248<a name="getDefaultSchemaNode()">
249<!--   -->
250</a>
251<ul class="blockListLast">
252<li class="blockList">
253<h4>getDefaultSchemaNode</h4>
254<pre>public static&nbsp;<a href="../../../../org/codehaus/jackson/JsonNode.html" title="class in org.codehaus.jackson">JsonNode</a>&nbsp;getDefaultSchemaNode()</pre>
255<div class="block">Get the default schema node.</div>
256<dl><dt><span class="strong">Returns:</span></dt><dd>The default schema node.</dd></dl>
257</li>
258</ul>
259</li>
260</ul>
261</li>
262</ul>
263</div>
264</div>
265<!-- ========= END OF CLASS DATA ========= -->
266<!-- ======= START OF BOTTOM NAVBAR ====== -->
267<div class="bottomNav"><a name="navbar_bottom">
268<!--   -->
269</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
270<!--   -->
271</a>
272<ul class="navList" title="Navigation">
273<li><a href="../../../../overview-summary.html">Overview</a></li>
274<li><a href="package-summary.html">Package</a></li>
275<li class="navBarCell1Rev">Class</li>
276<li><a href="class-use/JsonSchema.html">Use</a></li>
277<li><a href="package-tree.html">Tree</a></li>
278<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
279<li><a href="../../../../index-all.html">Index</a></li>
280<li><a href="../../../../help-doc.html">Help</a></li>
281</ul>
282</div>
283<div class="subNav">
284<ul class="navList">
285<li>Prev Class</li>
286<li><a href="../../../../org/codehaus/jackson/schema/JsonSerializableSchema.html" title="annotation in org.codehaus.jackson.schema"><span class="strong">Next Class</span></a></li>
287</ul>
288<ul class="navList">
289<li><a href="../../../../index.html?org/codehaus/jackson/schema/JsonSchema.html" target="_top">Frames</a></li>
290<li><a href="JsonSchema.html" target="_top">No Frames</a></li>
291</ul>
292<ul class="navList" id="allclasses_navbar_bottom">
293<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
294</ul>
295<div>
296<script type="text/javascript"><!--
297  allClassesLink = document.getElementById("allclasses_navbar_bottom");
298  if(window==top) {
299    allClassesLink.style.display = "block";
300  }
301  else {
302    allClassesLink.style.display = "none";
303  }
304  //-->
305</script>
306</div>
307<div>
308<ul class="subNavList">
309<li>Summary:&nbsp;</li>
310<li>Nested&nbsp;|&nbsp;</li>
311<li>Field&nbsp;|&nbsp;</li>
312<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
313<li><a href="#method_summary">Method</a></li>
314</ul>
315<ul class="subNavList">
316<li>Detail:&nbsp;</li>
317<li>Field&nbsp;|&nbsp;</li>
318<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
319<li><a href="#method_detail">Method</a></li>
320</ul>
321</div>
322<a name="skip-navbar_bottom">
323<!--   -->
324</a></div>
325<!-- ======== END OF BOTTOM NAVBAR ======= -->
326</body>
327</html>
328