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_29) on Mon Mar 26 19:07:16 PDT 2012 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8JsonSerializableSchema (jackson-databind 2.0.0 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2012-03-26"> 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="JsonSerializableSchema (jackson-databind 2.0.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/JsonSerializableSchema.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 <A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSchema.html" title="class in com.fasterxml.jackson.databind.jsonschema"><B>PREV CLASS</B></A> 60 <A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/SchemaAware.html" title="interface 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/JsonSerializableSchema.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="JsonSerializableSchema.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: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 82DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</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> 94Annotation Type JsonSerializableSchema</H2> 95<HR> 96<DL> 97<DT><PRE><FONT SIZE="-1"><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>) 98<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>) 99</FONT>public @interface <B>JsonSerializableSchema</B></DL> 100</PRE> 101 102<P> 103Annotation that can be used to define JSON Schema definition for 104 the annotated class. 105<p> 106 Note that annotation is often not needed: for example, regular 107 Jackson beans that Jackson can introspect can be used without 108 annotations, to produce JSON schema definition. 109<P> 110 111<P> 112<DL> 113<DT><B>Author:</B></DT> 114 <DD>Ryan Heaton, Tatu Saloranta</DD> 115</DL> 116<HR> 117 118<P> 119<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 120 121<A NAME="annotation_type_optional_element_summary"><!-- --></A> 122<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 123<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 124<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 125<B>Optional Element Summary</B></FONT></TH> 126</TR> 127<TR BGCOLOR="white" CLASS="TableRowColor"> 128<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 129<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> 130<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html#id()">id</A></B></CODE> 131 132<BR> 133 Property that can be used to indicate id of the type when 134 generating JSON Schema; empty String indicates that no id 135 is defined.</TD> 136</TR> 137<TR BGCOLOR="white" CLASS="TableRowColor"> 138<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 139<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> 140<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html#schemaItemDefinition()">schemaItemDefinition</A></B></CODE> 141 142<BR> 143 If the schema type if "array", JSON definition of the schema for item types contained.</TD> 144</TR> 145<TR BGCOLOR="white" CLASS="TableRowColor"> 146<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 147<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> 148<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html#schemaObjectPropertiesDefinition()">schemaObjectPropertiesDefinition</A></B></CODE> 149 150<BR> 151 If the schema type is "object", JSON definition of properties of the object as 152 a String.</TD> 153</TR> 154<TR BGCOLOR="white" CLASS="TableRowColor"> 155<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 156<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> 157<TD><CODE><B><A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html#schemaType()">schemaType</A></B></CODE> 158 159<BR> 160 The schema type for this JsonSerializable instance.</TD> 161</TR> 162</TABLE> 163 164<P> 165<A NAME="id()"><!-- --></A><H3> 166id</H3> 167<PRE> 168public 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> <B>id</B></PRE> 169<DL> 170<DD>Property that can be used to indicate id of the type when 171 generating JSON Schema; empty String indicates that no id 172 is defined. 173<P> 174<DD><DL> 175</DL> 176</DD> 177<DD><DL> 178</DL> 179<DL> 180<DT><B>Default:</B><DD>""</DD> 181</DL> 182</DL> 183<HR> 184 185<A NAME="schemaType()"><!-- --></A><H3> 186schemaType</H3> 187<PRE> 188public 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> <B>schemaType</B></PRE> 189<DL> 190<DD>The schema type for this JsonSerializable instance. 191 Possible values: "string", "number", "boolean", "object", "array", "null", "any" 192<P> 193<DD><DL> 194</DL> 195</DD> 196<DD><DL> 197 198<DT><B>Returns:</B><DD>The schema type for this JsonSerializable instance.</DL> 199<DL> 200<DT><B>Default:</B><DD>"any"</DD> 201</DL> 202</DL> 203<HR> 204 205<A NAME="schemaObjectPropertiesDefinition()"><!-- --></A><H3> 206schemaObjectPropertiesDefinition</H3> 207<PRE> 208public 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> <B>schemaObjectPropertiesDefinition</B></PRE> 209<DL> 210<DD>If the schema type is "object", JSON definition of properties of the object as 211 a String. 212<P> 213<DD><DL> 214</DL> 215</DD> 216<DD><DL> 217 218<DT><B>Returns:</B><DD>The node representing the schema properties, or "##irrelevant" if irrelevant.</DL> 219<DL> 220<DT><B>Default:</B><DD>"##irrelevant"</DD> 221</DL> 222</DL> 223<HR> 224 225<A NAME="schemaItemDefinition()"><!-- --></A><H3> 226schemaItemDefinition</H3> 227<PRE> 228public 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> <B>schemaItemDefinition</B></PRE> 229<DL> 230<DD>If the schema type if "array", JSON definition of the schema for item types contained. 231<P> 232<DD><DL> 233</DL> 234</DD> 235<DD><DL> 236 237<DT><B>Returns:</B><DD>The schema for the items in the array, or "##irrelevant" if irrelevant.</DL> 238<DL> 239<DT><B>Default:</B><DD>"##irrelevant"</DD> 240</DL> 241</DL> 242<!-- ========= END OF CLASS DATA ========= --> 243<HR> 244 245 246<!-- ======= START OF BOTTOM NAVBAR ====== --> 247<A NAME="navbar_bottom"><!-- --></A> 248<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 249<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 250<TR> 251<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 252<A NAME="navbar_bottom_firstrow"><!-- --></A> 253<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 254 <TR ALIGN="center" VALIGN="top"> 255 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 256 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 257 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 258 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonSerializableSchema.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 259 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 260 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 261 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 262 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 263 </TR> 264</TABLE> 265</TD> 266<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 267</EM> 268</TD> 269</TR> 270 271<TR> 272<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 273 <A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/JsonSchema.html" title="class in com.fasterxml.jackson.databind.jsonschema"><B>PREV CLASS</B></A> 274 <A HREF="../../../../../com/fasterxml/jackson/databind/jsonschema/SchemaAware.html" title="interface in com.fasterxml.jackson.databind.jsonschema"><B>NEXT CLASS</B></A></FONT></TD> 275<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 276 <A HREF="../../../../../index.html?com/fasterxml/jackson/databind/jsonschema/JsonSerializableSchema.html" target="_top"><B>FRAMES</B></A> 277 <A HREF="JsonSerializableSchema.html" target="_top"><B>NO FRAMES</B></A> 278 <SCRIPT type="text/javascript"> 279 <!-- 280 if(window==top) { 281 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 282 } 283 //--> 284</SCRIPT> 285<NOSCRIPT> 286 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> 287</NOSCRIPT> 288 289 290</FONT></TD> 291</TR> 292<TR> 293<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 294 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 295<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 296DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 297</TR> 298</TABLE> 299<A NAME="skip-navbar_bottom"></A> 300<!-- ======== END OF BOTTOM NAVBAR ======= --> 301 302<HR> 303Copyright © 2012 <a href="http://fasterxml.com">fasterxml.com</a>. All Rights Reserved. 304</BODY> 305</HTML> 306