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>JsonSerializableSchema (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="JsonSerializableSchema (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/JsonSerializableSchema.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><a href="../../../../org/codehaus/jackson/schema/JsonSchema.html" title="class in org.codehaus.jackson.schema"><span class="strong">Prev Class</span></a></li> 40<li><a href="../../../../org/codehaus/jackson/schema/SchemaAware.html" title="interface 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/JsonSerializableSchema.html" target="_top">Frames</a></li> 44<li><a href="JsonSerializableSchema.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: </li> 64<li>Required | </li> 65<li><a href="#annotation_type_optional_element_summary">Optional</a></li> 66</ul> 67<ul class="subNavList"> 68<li>Detail: </li> 69<li><a href="#annotation_type_element_detail">Element</a></li> 70</ul> 71</div> 72<a name="skip-navbar_top"> 73<!-- --> 74</a></div> 75<!-- ========= END OF TOP NAVBAR ========= --> 76<!-- ======== START OF CLASS DATA ======== --> 77<div class="header"> 78<div class="subTitle">org.codehaus.jackson.schema</div> 79<h2 title="Annotation Type JsonSerializableSchema" class="title">Annotation Type JsonSerializableSchema</h2> 80</div> 81<div class="contentContainer"> 82<div class="description"> 83<ul class="blockList"> 84<li class="blockList"> 85<hr> 86<br> 87<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>) 88<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) 89public @interface <span class="strong">JsonSerializableSchema</span></pre> 90<div class="block">Annotation that can be used to define JSON Schema definition for 91 the annotated class. 92<p> 93 Note that annotation is often not needed: for example, regular 94 Jackson beans that Jackson can introspect can be used without 95 annotations, to produce JSON schema definition.</div> 96<dl><dt><span class="strong">Author:</span></dt> 97 <dd>Ryan Heaton</dd></dl> 98</li> 99</ul> 100</div> 101<div class="summary"> 102<ul class="blockList"> 103<li class="blockList"> 104<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 105<ul class="blockList"> 106<li class="blockList"><a name="annotation_type_optional_element_summary"> 107<!-- --> 108</a> 109<h3>Optional Element Summary</h3> 110<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> 111<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> 112<tr> 113<th class="colFirst" scope="col">Modifier and Type</th> 114<th class="colLast" scope="col">Optional Element and Description</th> 115</tr> 116<tr class="altColor"> 117<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> 118<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/schema/JsonSerializableSchema.html#schemaItemDefinition()">schemaItemDefinition</a></strong></code> 119<div class="block">If the schema type if "array", the node that defines the schema for the items in the array.</div> 120</td> 121</tr> 122<tr class="rowColor"> 123<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> 124<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/schema/JsonSerializableSchema.html#schemaObjectPropertiesDefinition()">schemaObjectPropertiesDefinition</a></strong></code> 125<div class="block">If the schema type is "object", the node that defines the properties of the object.</div> 126</td> 127</tr> 128<tr class="altColor"> 129<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> 130<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/schema/JsonSerializableSchema.html#schemaType()">schemaType</a></strong></code> 131<div class="block">The schema type for this JsonSerializable instance.</div> 132</td> 133</tr> 134</table> 135</li> 136</ul> 137</li> 138</ul> 139</div> 140<div class="details"> 141<ul class="blockList"> 142<li class="blockList"> 143<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 144<ul class="blockList"> 145<li class="blockList"><a name="annotation_type_element_detail"> 146<!-- --> 147</a> 148<h3>Element Detail</h3> 149<a name="schemaType()"> 150<!-- --> 151</a> 152<ul class="blockList"> 153<li class="blockList"> 154<h4>schemaType</h4> 155<pre>public abstract <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> schemaType</pre> 156<div class="block">The schema type for this JsonSerializable instance. 157 Possible values: "string", "number", "boolean", "object", "array", "null", "any"</div> 158<dl><dt><span class="strong">Returns:</span></dt><dd>The schema type for this JsonSerializable instance.</dd></dl> 159<dl> 160<dt>Default:</dt> 161<dd>"any"</dd> 162</dl> 163</li> 164</ul> 165<a name="schemaObjectPropertiesDefinition()"> 166<!-- --> 167</a> 168<ul class="blockList"> 169<li class="blockList"> 170<h4>schemaObjectPropertiesDefinition</h4> 171<pre>public abstract <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> schemaObjectPropertiesDefinition</pre> 172<div class="block">If the schema type is "object", the node that defines the properties of the object.</div> 173<dl><dt><span class="strong">Returns:</span></dt><dd>The node representing the schema properties, or "##irrelevant" if irrelevant.</dd></dl> 174<dl> 175<dt>Default:</dt> 176<dd>"##irrelevant"</dd> 177</dl> 178</li> 179</ul> 180<a name="schemaItemDefinition()"> 181<!-- --> 182</a> 183<ul class="blockListLast"> 184<li class="blockList"> 185<h4>schemaItemDefinition</h4> 186<pre>public abstract <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> schemaItemDefinition</pre> 187<div class="block">If the schema type if "array", the node that defines the schema for the items in the array.</div> 188<dl><dt><span class="strong">Returns:</span></dt><dd>The schema for the items in the array, or "##irrelevant" if irrelevant.</dd></dl> 189<dl> 190<dt>Default:</dt> 191<dd>"##irrelevant"</dd> 192</dl> 193</li> 194</ul> 195</li> 196</ul> 197</li> 198</ul> 199</div> 200</div> 201<!-- ========= END OF CLASS DATA ========= --> 202<!-- ======= START OF BOTTOM NAVBAR ====== --> 203<div class="bottomNav"><a name="navbar_bottom"> 204<!-- --> 205</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 206<!-- --> 207</a> 208<ul class="navList" title="Navigation"> 209<li><a href="../../../../overview-summary.html">Overview</a></li> 210<li><a href="package-summary.html">Package</a></li> 211<li class="navBarCell1Rev">Class</li> 212<li><a href="class-use/JsonSerializableSchema.html">Use</a></li> 213<li><a href="package-tree.html">Tree</a></li> 214<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 215<li><a href="../../../../index-all.html">Index</a></li> 216<li><a href="../../../../help-doc.html">Help</a></li> 217</ul> 218</div> 219<div class="subNav"> 220<ul class="navList"> 221<li><a href="../../../../org/codehaus/jackson/schema/JsonSchema.html" title="class in org.codehaus.jackson.schema"><span class="strong">Prev Class</span></a></li> 222<li><a href="../../../../org/codehaus/jackson/schema/SchemaAware.html" title="interface in org.codehaus.jackson.schema"><span class="strong">Next Class</span></a></li> 223</ul> 224<ul class="navList"> 225<li><a href="../../../../index.html?org/codehaus/jackson/schema/JsonSerializableSchema.html" target="_top">Frames</a></li> 226<li><a href="JsonSerializableSchema.html" target="_top">No Frames</a></li> 227</ul> 228<ul class="navList" id="allclasses_navbar_bottom"> 229<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 230</ul> 231<div> 232<script type="text/javascript"><!-- 233 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 234 if(window==top) { 235 allClassesLink.style.display = "block"; 236 } 237 else { 238 allClassesLink.style.display = "none"; 239 } 240 //--> 241</script> 242</div> 243<div> 244<ul class="subNavList"> 245<li>Summary: </li> 246<li>Required | </li> 247<li><a href="#annotation_type_optional_element_summary">Optional</a></li> 248</ul> 249<ul class="subNavList"> 250<li>Detail: </li> 251<li><a href="#annotation_type_element_detail">Element</a></li> 252</ul> 253</div> 254<a name="skip-navbar_bottom"> 255<!-- --> 256</a></div> 257<!-- ======== END OF BOTTOM NAVBAR ======= --> 258</body> 259</html> 260