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